Skip to content
Hockay API
Esc
↑↓navigate↵open⌘Jpreview

The bracket

GET/playoffs
Authorization
x-api-keyAPI key · headerrequired
Query parameters
seasonstring

A season id ("S04"). Default: the current season.

Responses
200

OK

dataPlayoffsrequired
Show properties
seasonIdstringrequired
phasestringrequired
conferenceBracketsbooleanrequired
roundsobject[]required
Show properties
Array of object
roundstringrequired
labelstringrequired
seriesobject[]required
Show properties
Array of object
idstringrequired
roundstringrequired
slotintegerrequired
min -9007199254740991 · max 9007199254740991
bestOfintegerrequired
min -9007199254740991 · max 9007199254740991
conferencestring | nullrequired
Show properties
Any of:
string
string
null
null
teamAstringrequired
teamBstringrequired
seedAinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
seedBinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
winsAintegerrequired
min -9007199254740991 · max 9007199254740991
winsBintegerrequired
min -9007199254740991 · max 9007199254740991
winnerTeamIdstring | nullrequired
statusstringrequired
gamesobject[]required
Show properties
Array of object
idstringrequired
gameInSeriesintegerrequired
min -9007199254740991 · max 9007199254740991
statusstringrequired
Allowed:scheduledperiod_1intermission_1period_2intermission_2period_3overtimeshootoutfinal
homeTeamIdstringrequired
awayTeamIdstringrequired
homeScoreinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
awayScoreinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
scheduledStartstringrequired

ISO 8601 date-time (UTC)

matchModifierIdstring | nullrequired
finalobject | nullrequired
Show properties
Any of:
object
idstringrequired
roundstringrequired
slotintegerrequired
min -9007199254740991 · max 9007199254740991
bestOfintegerrequired
min -9007199254740991 · max 9007199254740991
conferencestring | nullrequired
Show properties
Any of:
string
string
null
null
teamAstringrequired
teamBstringrequired
seedAinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
seedBinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
winsAintegerrequired
min -9007199254740991 · max 9007199254740991
winsBintegerrequired
min -9007199254740991 · max 9007199254740991
winnerTeamIdstring | nullrequired
statusstringrequired
gamesobject[]required
Show properties
Array of object
idstringrequired
gameInSeriesintegerrequired
min -9007199254740991 · max 9007199254740991
statusstringrequired
Allowed:scheduledperiod_1intermission_1period_2intermission_2period_3overtimeshootoutfinal
homeTeamIdstringrequired
awayTeamIdstringrequired
homeScoreinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
awayScoreinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
scheduledStartstringrequired

ISO 8601 date-time (UTC)

matchModifierIdstring | nullrequired
null
null
championTeamIdstring | nullrequired
puckQuotestring | nullrequired

The Puck's line, once there is a champion

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
429

Rate limited; retry after the Retry-After seconds

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://hockay.com/api/v1/playoffs' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "data": {
    "seasonId": "string",
    "phase": "string",
    "conferenceBrackets": true,
    "rounds": [
      {
        "round": "string",
        "label": "string",
        "series": [
          {
            "id": "string",
            "round": "string",
            "slot": -9007199254740991,
            "bestOf": -9007199254740991,
            "conference": "verglas",
            "teamA": "string",
            "teamB": "string",
            "seedA": -9007199254740991,
            "seedB": -9007199254740991,
            "winsA": -9007199254740991,
            "winsB": -9007199254740991,
            "winnerTeamId": "string",
            "status": "string",
            "games": [
              {
                "id": "string",
                "gameInSeries": -9007199254740991,
                "status": "scheduled",
                "homeTeamId": "string",
                "awayTeamId": "string",
                "homeScore": -9007199254740991,
                "awayScore": -9007199254740991,
                "scheduledStart": "string",
                "matchModifierId": "string"
              }
            ]
          }
        ]
      }
    ],
    "final": {
      "id": "string",
      "round": "string",
      "slot": -9007199254740991,
      "bestOf": -9007199254740991,
      "conference": "verglas",
      "teamA": "string",
      "teamB": "string",
      "seedA": -9007199254740991,
      "seedB": -9007199254740991,
      "winsA": -9007199254740991,
      "winsB": -9007199254740991,
      "winnerTeamId": "string",
      "status": "string",
      "games": [
        {
          "id": "string",
          "gameInSeries": -9007199254740991,
          "status": "scheduled",
          "homeTeamId": "string",
          "awayTeamId": "string",
          "homeScore": -9007199254740991,
          "awayScore": -9007199254740991,
          "scheduledStart": "string",
          "matchModifierId": "string"
        }
      ]
    },
    "championTeamId": "string",
    "puckQuote": "string"
  }
}

Was this page helpful?