Documentation / Inside a game
Lineups
GET /v1/games/{game_id}/lineupsLive and up
Who dressed for each side, with number, position, line, captaincy and the starting goalie.
GET
https://api.icehockeyapi.com/v1/games/{game_id}/lineupshttps://api.icehockeyapi.com/v1/games/gm_seyr9d88/lineupscurl "https://api.icehockeyapi.com/v1/games/gm_seyr9d88/lineups" \ -H "X-API-Key: YOUR_KEY"
200 OKExample answer from the data, 12 Oct
{
"data": [
{
"player": {
"id": "pl_zgna58ee",
"name": "Matt Rempe"
},
"side": "home",
"number": null,
"position": null,
"line": null,
"captain": null,
"status": "scratched",
"started": null
},
{
"player": {
"id": "pl_3twte27m",
"name": "Scott Morrow"
},
"side": "home",
"number": null,
"position": null,
"line": null,
"captain": null,
"status": "scratched",
"started": null
},
{
"player": {
"id": "pl_1rp3dfd1",
"name": "J.T. Miller"
},
"side": "home",
"number": "10",
"position": "center",
"line": null,
"captain": null,
"status": "dressed",
"started": null
}
],
"meta": {
"game_id": "gm_seyr9d88",
"count": 45,
"detail": true,
"plan": "Complete"
}
}Run works once the API is live; the code above works now.
Parameters
| Name | In | Type | What it does |
|---|---|---|---|
game_id required | path | id | A game, from /v1/games. |
Returns
| Field | Type |
|---|---|
player | object |
player.id | string |
player.name | string |
side | string |
number | null |
position | null |
line | null |
captain | null |
status | string |
started | null |