Skip to content

hockay.com Get a key

Player lines, totals, and lineups

GET/games/{id}/boxscore

Authorization

x-api-keyAPI key · headerrequired

Path parameters

idstringrequired

Game id

Responses

200

OK

dataBoxScorerequired

Show properties

gameIdstringrequired

playersobject[]required

Show properties

Array of object

playerIdstringrequired

sidestring | nullrequired

Show properties

Any of:

string

string

null

null

goalsintegerrequired

min -9007199254740991 · max 9007199254740991

assistsintegerrequired

min -9007199254740991 · max 9007199254740991

hitsintegerrequired

min -9007199254740991 · max 9007199254740991

shotsintegerrequired

min -9007199254740991 · max 9007199254740991

shotsOnGoalintegerrequired

min -9007199254740991 · max 9007199254740991

penaltiesintegerrequired

min -9007199254740991 · max 9007199254740991

penaltyMinutesintegerrequired

min -9007199254740991 · max 9007199254740991

fightsintegerrequired

min -9007199254740991 · max 9007199254740991

savesintegerrequired

min -9007199254740991 · max 9007199254740991

goalsAgainstintegerrequired

min -9007199254740991 · max 9007199254740991

timeOnIceintegerrequired

Seconds

min -9007199254740991 · max 9007199254740991

totalsobjectrequired

Show properties

homeobjectrequired

Show properties

goalsintegerrequired

min -9007199254740991 · max 9007199254740991

shotsintegerrequired

min -9007199254740991 · max 9007199254740991

shotsOnGoalintegerrequired

min -9007199254740991 · max 9007199254740991

hitsintegerrequired

min -9007199254740991 · max 9007199254740991

penaltyMinutesintegerrequired

min -9007199254740991 · max 9007199254740991

fightsintegerrequired

min -9007199254740991 · max 9007199254740991

savesintegerrequired

min -9007199254740991 · max 9007199254740991

awayobjectrequired

Show properties

goalsintegerrequired

min -9007199254740991 · max 9007199254740991

shotsintegerrequired

min -9007199254740991 · max 9007199254740991

shotsOnGoalintegerrequired

min -9007199254740991 · max 9007199254740991

hitsintegerrequired

min -9007199254740991 · max 9007199254740991

penaltyMinutesintegerrequired

min -9007199254740991 · max 9007199254740991

fightsintegerrequired

min -9007199254740991 · max 9007199254740991

savesintegerrequired

min -9007199254740991 · max 9007199254740991

lineupsobjectrequired

Show properties

homeobject[]required

Show properties

Array of object

playerIdstringrequired

positionstringrequired

Allowed:LWCRWDG

lineAssignmentstring | nullrequired

Show properties

Any of:

string

string

null

null

isStartingGoaliebooleanrequired

awayobject[]required

Show properties

Array of object

playerIdstringrequired

positionstringrequired

Allowed:LWCRWDG

lineAssignmentstring | nullrequired

Show properties

Any of:

string

string

null

null

isStartingGoaliebooleanrequired

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

409

The game is not final 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*Game id

Request

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

import requests

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

import Foundation

var request = URLRequest(url: URL(string: "https://hockay.com/api/v1/games/string/boxscore")!)
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": {
    "gameId": "string",
    "players": [
      {
        "playerId": "string",
        "side": "home",
        "goals": -9007199254740991,
        "assists": -9007199254740991,
        "hits": -9007199254740991,
        "shots": -9007199254740991,
        "shotsOnGoal": -9007199254740991,
        "penalties": -9007199254740991,
        "penaltyMinutes": -9007199254740991,
        "fights": -9007199254740991,
        "saves": -9007199254740991,
        "goalsAgainst": -9007199254740991,
        "timeOnIce": -9007199254740991
      }
    ],
    "totals": {
      "home": {
        "goals": -9007199254740991,
        "shots": -9007199254740991,
        "shotsOnGoal": -9007199254740991,
        "hits": -9007199254740991,
        "penaltyMinutes": -9007199254740991,
        "fights": -9007199254740991,
        "saves": -9007199254740991
      },
      "away": {
        "goals": -9007199254740991,
        "shots": -9007199254740991,
        "shotsOnGoal": -9007199254740991,
        "hits": -9007199254740991,
        "penaltyMinutes": -9007199254740991,
        "fights": -9007199254740991,
        "saves": -9007199254740991
      }
    },
    "lineups": {
      "home": [
        {
          "playerId": "string",
          "position": "LW",
          "lineAssignment": "F1",
          "isStartingGoalie": true
        }
      ],
      "away": [
        {
          "playerId": "string",
          "position": "LW",
          "lineAssignment": "F1",
          "isStartingGoalie": true
        }
      ]
    }
  }
}

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

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

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

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

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

Was this page helpful?