Skip to content

hockay.com Get a key

One game

GET/games/{id}

Authorization

x-api-keyAPI key · headerrequired

Path parameters

idstringrequired

Game id, e.g. "S04D05-MTL-ANC"

Responses

200

OK

dataGamerequired

Show properties

idstringrequired

e.g. "S04D01-MTL-ANC"

seasonIdstringrequired

matchdayIdstringrequired

statusstringrequired

Allowed:scheduledperiod_1intermission_1period_2intermission_2period_3overtimeshootoutfinal

homeTeamIdstringrequired

awayTeamIdstringrequired

homeScoreintegerrequired

min -9007199254740991 · max 9007199254740991

awayScoreintegerrequired

min -9007199254740991 · max 9007199254740991

periodScoresobject[]required

Show properties

Array of object

periodintegerrequired

min -9007199254740991 · max 9007199254740991

homeScoreintegerrequired

min -9007199254740991 · max 9007199254740991

awayScoreintegerrequired

min -9007199254740991 · max 9007199254740991

scheduledStartstringrequired

ISO 8601 date-time (UTC)

playoffRoundstring | nullrequired

gameInSeriesinteger | nullrequired

Show properties

Any of:

integer

integer

null

null

venuestring | nullrequired

A neutral site's slug, or null at the home arena

isFinalbooleanrequired

The season's Final

isExhibitionbooleanrequired

An All-Star game: kept out of standings and stats

arenaModifierIdstring | nullrequired

matchModifierIdsstring[]required

weekdayRuleIdstring | nullrequired

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*Game id, e.g. "S04D05-MTL-ANC"

Request

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

import requests

response = requests.get(
    "https://hockay.com/api/v1/games/string",
    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")!)
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",
    "seasonId": "string",
    "matchdayId": "string",
    "status": "scheduled",
    "homeTeamId": "string",
    "awayTeamId": "string",
    "homeScore": -9007199254740991,
    "awayScore": -9007199254740991,
    "periodScores": [
      {
        "period": -9007199254740991,
        "homeScore": -9007199254740991,
        "awayScore": -9007199254740991
      }
    ],
    "scheduledStart": "string",
    "playoffRound": "string",
    "gameInSeries": -9007199254740991,
    "venue": "string",
    "isFinal": true,
    "isExhibition": true,
    "arenaModifierId": "string",
    "matchModifierIds": [
      "string"
    ],
    "weekdayRuleId": "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?