STAT-API

NHL game_team_rosters API

game_team_rostersnhl.game_team_rosters
The game-day roster of each NHL game since 2021-22 — every player of each team, with the position, sweater number, whether the player dressed or was scratched, and the starting goalie.
GET/api/v1/nhl/game_team_rosters
Requires one of: game_id — requests satisfying none of these return 400.
Parameters
game_idquerybigintoptional
Filter to a single game.
team_idquerybigintoptional
Filter by team.
player_idquerybigintoptional
Filter to a single player.
is_starting_goaliequerybooleanoptional
Filter to the starting goalies.
limitqueryintegeroptionaldefault 50
Page size. Defaults to 50; max 5000.
from_idquerybigintoptional
Return rows with id strictly greater than this value; page using the previous response's `next_from_id`. Omit on the first page.
Restores the documented defaults (trial keys only accept the unchanged defaults).
Request
curl -sS --compressed \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  'https://api.stat-api.com/api/v1/nhl/game_team_rosters?game_id=1'
Responses
200game_team_rosters rows matching the declared filter set, wrapped in { game_team_rosters, limit, next_from_id, has_more }. has_more is true when another row follows this page. To walk every row, start with ?from_id=0 and pass each next_from_id back as from_id until it is null; the filters stay. A first page without from_id comes in the default order and gives next_from_id null.application/jsonshow example ▸
400No declared filter set was satisfied — response body matches MissingRequiredFiltersError; pick one combo from the accepted-sets hint and resend.application/json
Response Schema(10 fields)show schema ▸
FieldTypeReferencesDescription
idkey
bigint—Primary Key
game_id
bigint—
e.g. 3924
player_id
bigint—
e.g. 7099
team_id
bigint—
e.g. 25
day
integer—YYYYMMDD date of the game
e.g. 20211009
dressed
boolean—True when the player dressed for the game
Values:truefalse
is_scratched
boolean—True when the player was scratched (always the opposite of dressed)
Values:falsetrue
is_starting_goalie
boolean—True for the goalie who started the game (one per team)
Values:falsetrue
position
stringnullable—C, L, R, D or G
Values:DCLRG
sweater_number
integernullable——
e.g. 21
GET/api/v1/nhl/game_team_rosters/{id}
Parameters
idpathbigintrequired
Primary key (id) of the game_team_roster row.
Restores the documented defaults (trial keys only accept the unchanged defaults).
Request
curl -sS --compressed \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  'https://api.stat-api.com/api/v1/nhl/game_team_rosters/{pk_value}'
Responses
200Single game_team_roster row.application/jsonshow example ▸
404Row not found.
Response Schema(10 fields)show schema ▸
FieldTypeReferencesDescription
idkey
bigint—Primary Key
game_id
bigint—
e.g. 3924
player_id
bigint—
e.g. 7099
team_id
bigint—
e.g. 25
day
integer—YYYYMMDD date of the game
e.g. 20211009
dressed
boolean—True when the player dressed for the game
Values:truefalse
is_scratched
boolean—True when the player was scratched (always the opposite of dressed)
Values:falsetrue
is_starting_goalie
boolean—True for the goalie who started the game (one per team)
Values:falsetrue
position
stringnullable—C, L, R, D or G
Values:DCLRG
sweater_number
integernullable——
e.g. 21