{ "openapi": "3.1.0", "info": { "title": "Ice Hockey API", "version": "1", "description": "Ice hockey results, box scores, standings, players and odds." }, "servers": [ { "url": "https://api.icehockeyapi.com/v1" } ], "security": [ { "key": [] }, { "bearer": [] } ], "components": { "securitySchemes": { "key": { "type": "apiKey", "in": "header", "name": "X-API-Key" }, "bearer": { "type": "http", "scheme": "bearer" } } }, "paths": { "/usage": { "get": { "operationId": "usage", "summary": "Your usage", "description": "Your plan, calls used today and this period, limits, reset times and the data your plan covers. Plans: Free key and up.", "tags": [ "Account and coverage" ], "parameters": [], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: unauthorized, rate_limited, quota_exceeded" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/usage" } } }, "/coverage": { "get": { "operationId": "coverage", "summary": "Coverage", "description": "What the data holds: leagues, seasons, teams, finished games, games with detail and with odds, players and venues, and the first and last game dates. Plans: Free key and up.", "tags": [ "Account and coverage" ], "parameters": [], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: unauthorized, rate_limited, quota_exceeded" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/coverage" } } }, "/countries": { "get": { "operationId": "countries", "summary": "Countries", "description": "Every country with the number of leagues and teams it has. Plans: Free key and up.", "tags": [ "Account and coverage" ], "parameters": [], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: unauthorized, rate_limited, quota_exceeded" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/countries" } } }, "/leagues": { "get": { "operationId": "leagues_list", "summary": "List leagues", "description": "Every league and competition, with country, level, age group and gender. Plans: Free key and up.", "tags": [ "Leagues" ], "parameters": [ { "name": "country", "in": "query", "required": false, "description": "Country name, as the leagues list shows it", "schema": { "type": "string" } }, { "name": "kind", "in": "query", "required": false, "description": "The kind of competition.", "schema": { "type": "string", "enum": [ "league", "cup", "friendly", "international" ] } }, { "name": "gender", "in": "query", "required": false, "description": "Men's or women's.", "schema": { "type": "string", "enum": [ "men", "women" ] } }, { "name": "age", "in": "query", "required": false, "description": "The age group.", "schema": { "type": "string", "enum": [ "senior", "junior" ] } }, { "name": "q", "in": "query", "required": false, "description": "Part of the league name", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1.", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "description": "Records a page, default 50, at most 200.", "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "description": "meta.next_cursor from the previous answer.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/leagues" } } }, "/leagues/{league_id}": { "get": { "operationId": "leagues_get", "summary": "One league", "description": "One league, with its number of seasons and its latest season. Plans: Free key and up.", "tags": [ "Leagues" ], "parameters": [ { "name": "league_id", "in": "path", "required": true, "description": "A league, from /v1/leagues.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/league" } } }, "/leagues/{league_id}/seasons": { "get": { "operationId": "leagues_seasons", "summary": "League seasons", "description": "Every season of a league, newest first, with first and last game dates and the number of games. Plans: Free key and up.", "tags": [ "Leagues" ], "parameters": [ { "name": "league_id", "in": "path", "required": true, "description": "A league, from /v1/leagues.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1.", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "description": "Records a page, default 50, at most 200.", "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "description": "meta.next_cursor from the previous answer.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/league-seasons" } } }, "/leagues/{league_id}/teams": { "get": { "operationId": "leagues_teams", "summary": "League teams", "description": "Every team that has played in a league, most recent first, with its first and last season and games played. Plans: Free key and up.", "tags": [ "Leagues" ], "parameters": [ { "name": "league_id", "in": "path", "required": true, "description": "A league, from /v1/leagues.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1.", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "description": "Records a page, default 50, at most 200.", "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "description": "meta.next_cursor from the previous answer.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/league-teams" } } }, "/seasons/{season_id}": { "get": { "operationId": "seasons_get", "summary": "One season", "description": "One season: its league, label, dates and number of games. Plans: Free key and up.", "tags": [ "Seasons" ], "parameters": [ { "name": "season_id", "in": "path", "required": true, "description": "A season, from /v1/leagues/{league_id}/seasons.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/season" } } }, "/seasons/{season_id}/games": { "get": { "operationId": "seasons_games", "summary": "Season games", "description": "Every game of a season, by date, with the same fields as the games list. Plans: Free key and up.", "tags": [ "Seasons" ], "parameters": [ { "name": "season_id", "in": "path", "required": true, "description": "A season, from /v1/leagues/{league_id}/seasons.", "schema": { "type": "string" } }, { "name": "stage", "in": "query", "required": false, "description": "Only this part of the season.", "schema": { "type": "string", "enum": [ "regular", "playoffs", "qualification", "preseason", "friendly", "cup", "other" ] } }, { "name": "status", "in": "query", "required": false, "description": "Only games in this state.", "schema": { "type": "string", "enum": [ "scheduled", "live", "final", "postponed", "cancelled", "awarded" ] } }, { "name": "order", "in": "query", "required": false, "description": "By date: asc (default) or desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1.", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "description": "Records a page, default 50, at most 200.", "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "description": "meta.next_cursor from the previous answer.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/season-games" } } }, "/seasons/{season_id}/standings": { "get": { "operationId": "seasons_standings", "summary": "Standings", "description": "The regular season table built from the results: games, wins, losses, overtime and shootout results, goals and points. The free key reads current seasons. Plans: Free key and up.", "tags": [ "Seasons" ], "parameters": [ { "name": "season_id", "in": "path", "required": true, "description": "A season, from /v1/leagues/{league_id}/seasons.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/season-standings" } } }, "/seasons/{season_id}/teams": { "get": { "operationId": "seasons_teams", "summary": "Season teams", "description": "The teams that took part in a season, with their number of games. The free key reads current seasons. Plans: Free key and up.", "tags": [ "Seasons" ], "parameters": [ { "name": "season_id", "in": "path", "required": true, "description": "A season, from /v1/leagues/{league_id}/seasons.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/season-teams" } } }, "/seasons/{season_id}/playoffs": { "get": { "operationId": "seasons_playoffs", "summary": "Playoffs", "description": "Playoff series in the order they started: the two teams, wins each, the winner and every game. The free key reads current seasons. Plans: Free key and up.", "tags": [ "Seasons" ], "parameters": [ { "name": "season_id", "in": "path", "required": true, "description": "A season, from /v1/leagues/{league_id}/seasons.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/season-playoffs" } } }, "/seasons/{season_id}/leaders": { "get": { "operationId": "seasons_leaders", "summary": "Leaders", "description": "The regular season leaders in points, goals, assists, plus-minus, penalty minutes or shots, for leagues with game detail. Plans: Live and up.", "tags": [ "Seasons" ], "parameters": [ { "name": "season_id", "in": "path", "required": true, "description": "A season, from /v1/leagues/{league_id}/seasons.", "schema": { "type": "string" } }, { "name": "category", "in": "query", "required": false, "description": "What to rank by: points (default)", "schema": { "type": "string", "enum": [ "points", "goals", "assists", "plus_minus", "penalty_minutes", "shots" ] } }, { "name": "limit", "in": "query", "required": false, "description": "How many players: 20 (default) up to 100", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/season-leaders" } } }, "/seasons/{season_id}/summary": { "get": { "operationId": "seasons_summary", "summary": "Season summary", "description": "A season in numbers: goals a game, home and away wins, overtime and shootout share, average attendance and the biggest win. Plans: Live and up.", "tags": [ "Seasons" ], "parameters": [ { "name": "season_id", "in": "path", "required": true, "description": "A season, from /v1/leagues/{league_id}/seasons.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/season-summary" } } }, "/teams": { "get": { "operationId": "teams_list", "summary": "List teams", "description": "Teams, by name, country, or the league or season they played in. Plans: Free key and up.", "tags": [ "Teams" ], "parameters": [ { "name": "league_id", "in": "query", "required": false, "description": "A league, from /v1/leagues.", "schema": { "type": "string" } }, { "name": "season_id", "in": "query", "required": false, "description": "A season, from /v1/leagues/{league_id}/seasons.", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "description": "A country.", "schema": { "type": "string" } }, { "name": "q", "in": "query", "required": false, "description": "Part of the team name", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1.", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "description": "Records a page, default 50, at most 200.", "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "description": "meta.next_cursor from the previous answer.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/teams" } } }, "/teams/{team_id}": { "get": { "operationId": "teams_get", "summary": "One team", "description": "One team: its name, short name, country and the leagues it has played in. Plans: Free key and up.", "tags": [ "Teams" ], "parameters": [ { "name": "team_id", "in": "path", "required": true, "description": "A team, from /v1/teams.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/team" } } }, "/teams/{team_id}/games": { "get": { "operationId": "teams_games", "summary": "Team games", "description": "A team's results and fixtures by date, optionally for one season or a date range. Plans: Free key and up.", "tags": [ "Teams" ], "parameters": [ { "name": "team_id", "in": "path", "required": true, "description": "A team, from /v1/teams.", "schema": { "type": "string" } }, { "name": "season_id", "in": "query", "required": false, "description": "A season, from /v1/leagues/{league_id}/seasons.", "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "description": "First day of a range", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "required": false, "description": "Last day of a range", "schema": { "type": "string", "format": "date" } }, { "name": "stage", "in": "query", "required": false, "description": "Only this part of the season.", "schema": { "type": "string", "enum": [ "regular", "playoffs", "qualification", "preseason", "friendly", "cup", "other" ] } }, { "name": "status", "in": "query", "required": false, "description": "Only games in this state.", "schema": { "type": "string", "enum": [ "scheduled", "live", "final", "postponed", "cancelled", "awarded" ] } }, { "name": "order", "in": "query", "required": false, "description": "By date: asc (default) or desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1.", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "description": "Records a page, default 50, at most 200.", "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "description": "meta.next_cursor from the previous answer.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/team-games" } } }, "/teams/{team_id}/seasons": { "get": { "operationId": "teams_seasons", "summary": "Team seasons", "description": "A team's regular season record, season by season, newest first, with points under each league's rule. Plans: Live and up.", "tags": [ "Teams" ], "parameters": [ { "name": "team_id", "in": "path", "required": true, "description": "A team, from /v1/teams.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/team-seasons" } } }, "/teams/{team_id}/roster": { "get": { "operationId": "teams_roster", "summary": "Roster", "description": "The players who dressed for a team in a season, with number, position and games, for leagues with game detail. Plans: Live and up.", "tags": [ "Teams" ], "parameters": [ { "name": "team_id", "in": "path", "required": true, "description": "A team, from /v1/teams.", "schema": { "type": "string" } }, { "name": "season_id", "in": "query", "required": true, "description": "A season, from /v1/leagues/{league_id}/seasons.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/team-roster" } } }, "/teams/{team_id}/stats": { "get": { "operationId": "teams_stats", "summary": "Team stats", "description": "A team's regular season in one season: overall, home and away records, shots a game and average home attendance. Plans: Live and up.", "tags": [ "Teams" ], "parameters": [ { "name": "team_id", "in": "path", "required": true, "description": "A team, from /v1/teams.", "schema": { "type": "string" } }, { "name": "season_id", "in": "query", "required": true, "description": "A season, from /v1/leagues/{league_id}/seasons.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/team-stats" } } }, "/teams/{team_id}/head-to-head/{other_id}": { "get": { "operationId": "teams_h2h", "summary": "Head to head", "description": "Every meeting of two teams your plan covers, newest first, with the first team's record against the second. Plans: Live and up.", "tags": [ "Teams" ], "parameters": [ { "name": "team_id", "in": "path", "required": true, "description": "A team, from /v1/teams.", "schema": { "type": "string" } }, { "name": "other_id", "in": "path", "required": true, "description": "The other team's", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1.", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "description": "Records a page, default 50, at most 200.", "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "description": "meta.next_cursor from the previous answer.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/head-to-head" } } }, "/games": { "get": { "operationId": "games_list", "summary": "List games", "description": "Games by date, date range, league, season or team: teams, score, how it ended, venue and attendance. Plans: Free key and up.", "tags": [ "Games" ], "parameters": [ { "name": "date", "in": "query", "required": false, "description": "One day, YYYY-MM-DD", "schema": { "type": "string", "format": "date" } }, { "name": "from", "in": "query", "required": false, "description": "First day of a range", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "required": false, "description": "Last day of a range", "schema": { "type": "string", "format": "date" } }, { "name": "league_id", "in": "query", "required": false, "description": "A league, from /v1/leagues.", "schema": { "type": "string" } }, { "name": "season_id", "in": "query", "required": false, "description": "A season, from /v1/leagues/{league_id}/seasons.", "schema": { "type": "string" } }, { "name": "team_id", "in": "query", "required": false, "description": "A team, from /v1/teams.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "description": "Only games in this state.", "schema": { "type": "string", "enum": [ "scheduled", "live", "final", "postponed", "cancelled", "awarded" ] } }, { "name": "stage", "in": "query", "required": false, "description": "Only this part of the season.", "schema": { "type": "string", "enum": [ "regular", "playoffs", "qualification", "preseason", "friendly", "cup", "other" ] } }, { "name": "order", "in": "query", "required": false, "description": "By date: asc (default) or desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1.", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "description": "Records a page, default 50, at most 200.", "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "description": "meta.next_cursor from the previous answer.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/games" } } }, "/games/upcoming": { "get": { "operationId": "games_upcoming", "summary": "Upcoming games", "description": "Scheduled games from today over the next two days, optionally for one league. Plans: Free key and up.", "tags": [ "Games" ], "parameters": [ { "name": "league_id", "in": "query", "required": false, "description": "A league, from /v1/leagues.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1.", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "description": "Records a page, default 50, at most 200.", "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "description": "meta.next_cursor from the previous answer.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/games-upcoming" } } }, "/games/{game_id}": { "get": { "operationId": "games_get", "summary": "One game", "description": "One game, with its odds on paid plans. Plans: Free key and up.", "tags": [ "Games" ], "parameters": [ { "name": "game_id", "in": "path", "required": true, "description": "A game, from /v1/games.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/game" } } }, "/results/yesterday": { "get": { "operationId": "results_yesterday", "summary": "Yesterday's results", "description": "Every finished game from yesterday (UTC), on every plan. Plans: Free key and up.", "tags": [ "Games" ], "parameters": [ { "name": "league_id", "in": "query", "required": false, "description": "A league, from /v1/leagues.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1.", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "description": "Records a page, default 50, at most 200.", "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "description": "meta.next_cursor from the previous answer.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/results-yesterday" } } }, "/results": { "get": { "operationId": "results_list", "summary": "Results by date", "description": "Finished games for one day or a date range, optionally for one league. Give date, or from (and to). Plans: Free key and up.", "tags": [ "Games" ], "parameters": [ { "name": "date", "in": "query", "required": false, "description": "One day, YYYY-MM-DD", "schema": { "type": "string", "format": "date" } }, { "name": "from", "in": "query", "required": false, "description": "First day of a range", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "required": false, "description": "Last day of a range", "schema": { "type": "string", "format": "date" } }, { "name": "league_id", "in": "query", "required": false, "description": "A league, from /v1/leagues.", "schema": { "type": "string" } }, { "name": "stage", "in": "query", "required": false, "description": "Only this part of the season.", "schema": { "type": "string", "enum": [ "regular", "playoffs", "qualification", "preseason", "friendly", "cup", "other" ] } }, { "name": "order", "in": "query", "required": false, "description": "By date: asc (default) or desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1.", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "description": "Records a page, default 50, at most 200.", "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "description": "meta.next_cursor from the previous answer.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/results" } } }, "/games/{game_id}/periods": { "get": { "operationId": "games_periods", "summary": "Periods", "description": "Goals and shots for each side, period by period, overtime and shootout included. Plans: Free key and up.", "tags": [ "Inside a game" ], "parameters": [ { "name": "game_id", "in": "path", "required": true, "description": "A game, from /v1/games.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/game-periods" } } }, "/games/{game_id}/goals": { "get": { "operationId": "games_goals", "summary": "Goals", "description": "Every goal in order: period, time, side, scorer, assists, strength, empty net and the score after it. Plans: Free key and up.", "tags": [ "Inside a game" ], "parameters": [ { "name": "game_id", "in": "path", "required": true, "description": "A game, from /v1/games.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/game-goals" } } }, "/games/{game_id}/penalties": { "get": { "operationId": "games_penalties", "summary": "Penalties", "description": "Every penalty in order: period, time, side, player, who drew it, minutes, kind and offence. Plans: Live and up.", "tags": [ "Inside a game" ], "parameters": [ { "name": "game_id", "in": "path", "required": true, "description": "A game, from /v1/games.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/game-penalties" } } }, "/games/{game_id}/lineups": { "get": { "operationId": "games_lineups", "summary": "Lineups", "description": "Who dressed for each side, with number, position, line, captaincy and the starting goalie. Plans: Live and up.", "tags": [ "Inside a game" ], "parameters": [ { "name": "game_id", "in": "path", "required": true, "description": "A game, from /v1/games.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/game-lineups" } } }, "/games/{game_id}/skaters": { "get": { "operationId": "games_skaters", "summary": "Skater stats", "description": "Each skater's line: goals, assists, points, plus-minus, penalty minutes, shots, hits, blocks, faceoffs and ice time; in North American top league games from 2009-10, his expected goals too. Plans: Live and up.", "tags": [ "Inside a game" ], "parameters": [ { "name": "game_id", "in": "path", "required": true, "description": "A game, from /v1/games.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/game-skaters" } } }, "/games/{game_id}/goalies": { "get": { "operationId": "games_goalies", "summary": "Goalie stats", "description": "Each goalie's line: ice time, shots against, saves, goals against, save percentage and decision. Plans: Live and up.", "tags": [ "Inside a game" ], "parameters": [ { "name": "game_id", "in": "path", "required": true, "description": "A game, from /v1/games.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/game-goalies" } } }, "/games/{game_id}/team-stats": { "get": { "operationId": "games_team_stats", "summary": "Game team stats", "description": "Team totals for the game side by side: shots, faceoffs, power play, penalty minutes, hits, blocks, giveaways and takeaways; in North American top league games from 2009-10, expected goals too. Plans: Live and up.", "tags": [ "Inside a game" ], "parameters": [ { "name": "game_id", "in": "path", "required": true, "description": "A game, from /v1/games.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/game-team-stats" } } }, "/games/{game_id}/events": { "get": { "operationId": "games_events", "summary": "Play by play", "description": "Every event in order: type, period, time, side, players, goalie, zone, rink position and shot type, with the expected goals of each unblocked shot (our own model, North American top league from 2009-10). While a North American top league game is being played it is read again every minute, and meta.live gives the period, clock and score as they stand. Plans: Live and up.", "tags": [ "Inside a game" ], "parameters": [ { "name": "game_id", "in": "path", "required": true, "description": "A game, from /v1/games.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/game-events" } } }, "/games/{game_id}/officials": { "get": { "operationId": "games_officials", "summary": "Officials", "description": "The referees and linesmen of the game. Plans: Live and up.", "tags": [ "Inside a game" ], "parameters": [ { "name": "game_id", "in": "path", "required": true, "description": "A game, from /v1/games.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/game-officials" } } }, "/games/{game_id}/coaches": { "get": { "operationId": "games_coaches", "summary": "Coaches", "description": "The head coach behind each bench, with side. Plans: Live and up.", "tags": [ "Inside a game" ], "parameters": [ { "name": "game_id", "in": "path", "required": true, "description": "A game, from /v1/games.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/game-coaches" } } }, "/games/{game_id}/stars": { "get": { "operationId": "games_stars", "summary": "Three stars", "description": "The three stars of the game, with side. Plans: Free key and up.", "tags": [ "Inside a game" ], "parameters": [ { "name": "game_id", "in": "path", "required": true, "description": "A game, from /v1/games.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/game-stars" } } }, "/games/{game_id}/odds": { "get": { "operationId": "games_odds", "summary": "Game odds", "description": "Odds for one game: three-way, moneyline, puck line and totals, opening, closing or average prices. Plans: Live and up.", "tags": [ "Odds" ], "parameters": [ { "name": "game_id", "in": "path", "required": true, "description": "A game, from /v1/games.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/game-odds" } } }, "/odds": { "get": { "operationId": "odds_list", "summary": "Odds by date", "description": "Games with odds for one day or a date range, each with its prices. Give date, or from (and to). Plans: Live and up.", "tags": [ "Odds" ], "parameters": [ { "name": "date", "in": "query", "required": false, "description": "One day, YYYY-MM-DD", "schema": { "type": "string", "format": "date" } }, { "name": "from", "in": "query", "required": false, "description": "First day of a range", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "required": false, "description": "Last day of a range", "schema": { "type": "string", "format": "date" } }, { "name": "league_id", "in": "query", "required": false, "description": "A league, from /v1/leagues.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1.", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "description": "Records a page, default 50, at most 200.", "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "description": "meta.next_cursor from the previous answer.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/odds" } } }, "/players": { "get": { "operationId": "players_list", "summary": "List players", "description": "Players by part of the name, position, nationality or birth year. Plans: Free key and up.", "tags": [ "Players" ], "parameters": [ { "name": "q", "in": "query", "required": false, "description": "Part of the name", "schema": { "type": "string" } }, { "name": "position", "in": "query", "required": false, "description": "A position.", "schema": { "type": "string", "enum": [ "center", "left_wing", "right_wing", "defense", "goalie", "forward" ] } }, { "name": "nationality", "in": "query", "required": false, "description": "Nationality as players show it, like FIN or CAN", "schema": { "type": "string" } }, { "name": "born", "in": "query", "required": false, "description": "Birth year", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1.", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "description": "Records a page, default 50, at most 200.", "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "description": "meta.next_cursor from the previous answer.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/players" } } }, "/players/{player_id}": { "get": { "operationId": "players_get", "summary": "One player", "description": "One player: name, position, shoots, birth date and place, nationality, height, weight, draft and number of awards. Plans: Free key and up.", "tags": [ "Players" ], "parameters": [ { "name": "player_id", "in": "path", "required": true, "description": "A player, from /v1/players.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/player" } } }, "/players/{player_id}/seasons": { "get": { "operationId": "players_seasons", "summary": "Career", "description": "A player's career season by season, every league and team, regular season and playoffs, with skater or goalie numbers. Plans: Live and up.", "tags": [ "Players" ], "parameters": [ { "name": "player_id", "in": "path", "required": true, "description": "A player, from /v1/players.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/player-seasons" } } }, "/players/{player_id}/games": { "get": { "operationId": "players_games", "summary": "Game log", "description": "Every game your plan covers in which the player has a line, newest first, with his goals, assists, shots and ice time. Plans: Live and up.", "tags": [ "Players" ], "parameters": [ { "name": "player_id", "in": "path", "required": true, "description": "A player, from /v1/players.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1.", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "description": "Records a page, default 50, at most 200.", "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "description": "meta.next_cursor from the previous answer.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/player-games" } } }, "/players/{player_id}/awards": { "get": { "operationId": "players_awards", "summary": "Awards", "description": "The trophies and awards a player has won, by season. Plans: Free key and up.", "tags": [ "Players" ], "parameters": [ { "name": "player_id", "in": "path", "required": true, "description": "A player, from /v1/players.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/player-awards" } } }, "/draft/{year}": { "get": { "operationId": "draft", "summary": "Draft", "description": "Every pick of one draft year in order: round, pick, overall, the drafting team's code and the player. Plans: Free key and up.", "tags": [ "Players" ], "parameters": [ { "name": "year", "in": "path", "required": true, "description": "Draft year", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/draft" } } }, "/venues": { "get": { "operationId": "venues_list", "summary": "List venues", "description": "Arenas by part of the name or city, or by country. Plans: Free key and up.", "tags": [ "Venues" ], "parameters": [ { "name": "q", "in": "query", "required": false, "description": "Part of the name or city", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "description": "A country.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1.", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "description": "Records a page, default 50, at most 200.", "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "description": "meta.next_cursor from the previous answer.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/venues" } } }, "/venues/{venue_id}": { "get": { "operationId": "venues_get", "summary": "One venue", "description": "One arena: name, city, country and the teams that have played home games there. Plans: Free key and up.", "tags": [ "Venues" ], "parameters": [ { "name": "venue_id", "in": "path", "required": true, "description": "An arena, from /v1/venues.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/venue" } } }, "/venues/{venue_id}/games": { "get": { "operationId": "venues_games", "summary": "Venue games", "description": "Games played at an arena that your plan covers, newest first. Plans: Free key and up.", "tags": [ "Venues" ], "parameters": [ { "name": "venue_id", "in": "path", "required": true, "description": "An arena, from /v1/venues.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1.", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "description": "Records a page, default 50, at most 200.", "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "description": "meta.next_cursor from the previous answer.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "data and meta" }, "4XX": { "description": "An error: bad_request, unknown_parameter, unauthorized, rate_limited, quota_exceeded, not_found, upgrade_required" } }, "externalDocs": { "url": "https://icehockeyapi.com/documentation/venue-games" } } } } }