One team, its roster, and its rivalries

GET/teams/{id}

Authorization

x-api-keyAPI key · headerrequired

Path parameters

idstringrequired

Team id, e.g. "mtl"

Responses

200

dataTeamDetailrequired

Show properties

idstringrequired

Short slug, e.g. "mtl"

namestringrequired

citystringrequired

countrystringrequired

categorystringrequired

Allowed:heartlandsurprisewild

conferencestringrequired

Allowed:verglasgivre

arenaobjectrequired

Show properties

namestringrequired

nameTranslationstring | nullrequired

capacityintegerrequired

min -9007199254740991 · max 9007199254740991

modifierobjectrequired

Show properties

namestringrequired

descriptionstringrequired

paletteobjectrequired

Show properties

primarystringrequired

secondarystringrequired

vibestringrequired

fanCountintegerrequired

Fans who chose this team. A count only.

min -9007199254740991 · max 9007199254740991

rosterobject[]required

Show properties

Array of object

playerIdstringrequired

namestringrequired

positionstringrequired

Allowed:LWCRWDG

lineAssignmentstring | nullrequired

Show properties

Any of:

string

string

null

null

rivalriesobject[]required

Show properties

Array of object

teamIdstringrequired

The rival

rankintegerrequired

min -9007199254740991 · max 9007199254740991

mutualbooleanrequired

settledAtstringrequired

ISO 8601 date-time (UTC)

304

Not modified (If-None-Match matched the ETag)

401

Missing, unknown, revoked, or expired key

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

403

This account cannot use this key class

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

404

Not found (or not public yet)

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

429

Rate limited; retry after the Retry-After seconds

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

idpath*Team id, e.g. "mtl"

Request

curl -X GET 'https://hockay.com/api/v1/teams/string' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Accept: application/json'

import axios from "axios";

const response = await axios.request({
  method: "GET",
  url: "https://hockay.com/api/v1/teams/string",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://hockay.com/api/v1/teams/string",
    headers={
        "x-api-key": "YOUR_API_KEY",
        "Accept": "application/json"
    },
)

import Foundation

var request = URLRequest(url: URL(string: "https://hockay.com/api/v1/teams/string")!)
request.httpMethod = "GET"
request.setValue("YOUR_API_KEY", forHTTPHeaderField: "x-api-key")
request.setValue("application/json", forHTTPHeaderField: "Accept")

let (data, response) = try await URLSession.shared.data(for: request)

Response

{
  "data": {
    "id": "string",
    "name": "string",
    "city": "string",
    "country": "string",
    "category": "heartland",
    "conference": "verglas",
    "arena": {
      "name": "string",
      "nameTranslation": "string",
      "capacity": -9007199254740991
    },
    "modifier": {
      "name": "string",
      "description": "string"
    },
    "palette": {
      "primary": "string",
      "secondary": "string"
    },
    "vibe": "string",
    "fanCount": -9007199254740991,
    "roster": [
      {
        "playerId": "string",
        "name": "string",
        "position": "LW",
        "lineAssignment": "F1"
      }
    ],
    "rivalries": [
      {
        "teamId": "string",
        "rank": -9007199254740991,
        "mutual": true,
        "settledAt": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}