One player

GET/players/{id}

Authorization

x-api-keyAPI key · headerrequired

Path parameters

idstringrequired

Player id

Responses

200

dataPlayerrequired

Show properties

idstringrequired

namestringrequired

positionstringrequired

Allowed:LWCRWDG

pronounsstring | nullrequired

Show properties

Any of:

string

string

null

null

teamIdstring | nullrequired

Null for a free agent

lineAssignmentstring | nullrequired

Show properties

Any of:

string

string

null

null

starRatingnumberrequired

retiredbooleanrequired

ratingsobjectrequired

Show properties

skatingnumberrequired

shootingnumberrequired

passingnumberrequired

defensenumberrequired

physicalitynumberrequired

goaltendingnumberrequired

modifiersobject[]required

Show properties

Array of object

modifierIdstringrequired

namestringrequired

categorystringrequired

Allowed:positivenegativeambiguousweird

acquiredAtstringrequired

ISO 8601 date-time (UTC)

acquiredInSeasonintegerrequired

min -9007199254740991 · max 9007199254740991

acquiredInMatchdaystring | nullrequired

acquiredInGamestring | nullrequired

seasonsPlayedintegerrequired

min -9007199254740991 · max 9007199254740991

totalSixthVisitsintegerrequired

min -9007199254740991 · max 9007199254740991

careerobject[]required

Show properties

Array of object

teamIdstringrequired

teamNamestringrequired

seasonJoinedintegerrequired

min -9007199254740991 · max 9007199254740991

seasonLeftinteger | nullrequired

Show properties

Any of:

integer

integer

null

null

reasonstringrequired

currentbooleanrequired

injuriesobject[]required

Show properties

Array of object

injuryIdstringrequired

seasonIdstringrequired

severitystringrequired

Allowed:minormajorcareer_ending

causestringrequired

gamesOutinteger | nullrequired

Show properties

Any of:

integer

integer

null

null

sourceGameIdstringrequired

teamIdstringrequired

revealedAtstringrequired

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*Player id

Request

curl -X GET 'https://hockay.com/api/v1/players/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/players/string",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "Accept": "application/json"
  }
});

import requests

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

import Foundation

var request = URLRequest(url: URL(string: "https://hockay.com/api/v1/players/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",
    "position": "LW",
    "pronouns": "he/him",
    "teamId": "string",
    "lineAssignment": "F1",
    "starRating": 0,
    "retired": true,
    "ratings": {
      "skating": 0,
      "shooting": 0,
      "passing": 0,
      "defense": 0,
      "physicality": 0,
      "goaltending": 0
    },
    "modifiers": [
      {
        "modifierId": "string",
        "name": "string",
        "category": "positive",
        "acquiredAt": "string",
        "acquiredInSeason": -9007199254740991,
        "acquiredInMatchday": "string",
        "acquiredInGame": "string"
      }
    ],
    "seasonsPlayed": -9007199254740991,
    "totalSixthVisits": -9007199254740991,
    "career": [
      {
        "teamId": "string",
        "teamName": "string",
        "seasonJoined": -9007199254740991,
        "seasonLeft": -9007199254740991,
        "reason": "string",
        "current": true
      }
    ],
    "injuries": [
      {
        "injuryId": "string",
        "seasonId": "string",
        "severity": "minor",
        "cause": "string",
        "gamesOut": -9007199254740991,
        "sourceGameId": "string",
        "teamId": "string",
        "revealedAt": "string"
      }
    ]
  }
}

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

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

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

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