This document aims to serve as an unofficial reference for the NHL APIs. Corrections and/or suggestions are welcome.
Please note that there appears to be two primary sources for official NHL APIs. (api-web.nhle.com and api.nhle.com/stats/rest). This document is broken into distinct sections detailing each API.
This section provides documentation for the NHL Web API (https://api-web.nhle.com/).
All endpoints described in this section are relative to the following base URL:
https://api-web.nhle.com/
/v1/player/{player}/game-log/{season}/{game-type}
player
(int) - Player IDseason
(int) - Season in YYYYYYYY format, where the first four digits represent the start year of the season, and the last four digits represent the end year.game-type
(int) - Game type (guessing 2 for regular season, 3 for playoffs)curl -X GET "https://api-web.nhle.com/v1/player/8478402/game-log/20232024/2"
/v1/player/{player}/landing
player
(int) - Player IDcurl -X GET "https://api-web.nhle.com/v1/player/8478402/landing"
/v1/player/{player}/game-log/now
player
(int) - Player IDcurl -L -X GET "https://api-web.nhle.com/v1/player/8478402/game-log/now"Get Current Skater Stats Leaders
/v1/skater-stats-leaders/current
categories
(query, string) - Optionallimit
(query, int) - Optional (Note: a limit of -1 will return all results)curl -L -X GET "https://api-web.nhle.com/v1/skater-stats-leaders/current?categories=goals&limit=5"Get Skater Stats Leaders for a Specific Season and Game Type
/v1/skater-stats-leaders/{season}/{game-type}
season
(int) - Season in YYYYYYYY format, where the first four digits represent the start year of the season, and the last four digits represent the end year.game-type
(int) - Game type (guessing 2 for regular season, 3 for playoffs)categories
(query, string) - Optionallimit
(query, int) - Optional (Note: a limit of -1 will return all results)curl -X GET "https://api-web.nhle.com/v1/skater-stats-leaders/20222023/2?categories=assists&limit=3"Get Current Goalie Stats Leaders
/v1/goalie-stats-leaders/current
categories
(query, string) - Optionallimit
(query, int) - Optional (Note: a limit of -1 will return all results)curl -L -X GET "https://api-web.nhle.com/v1/goalie-stats-leaders/current?categories=wins&limit=5"Get Goalie Stats Leaders by Season
/v1/goalie-stats-leaders/{season}/{game-type}
season
(int) - Season in YYYYYYYY format, where the first four digits represent the start year of the season, and the last four digits represent the end year.game-type
(int) - Game type (guessing 2 for regular season, 3 for playoffs)categories
(query, string) - Optionallimit
(query, int) - Optional (Note: a limit of -1 will return all results)curl -X GET "https://api-web.nhle.com/v1/goalie-stats-leaders/20232024/2?categories=wins&limit=3"
/v1/player-spotlight
curl -X GET "https://api-web.nhle.com/v1/player-spotlight"
/v1/standings/now
curl -L -X GET "https://api-web.nhle.com/v1/standings/now"
/v1/standings/{date}
date
(string) - Date in YYYY-MM-DD formatcurl -X GET "https://api-web.nhle.com/v1/standings/2023-11-10"Get Standings information for each Season
/v1/standings-season
curl -X GET "https://api-web.nhle.com/v1/standings-season"
/v1/club-stats/{team}/now
team
(string) - Three-letter team codecurl -L -X GET "https://api-web.nhle.com/v1/club-stats/TOR/now"Get Club Stats for the Season for a Team
/v1/club-stats-season/{team}
team
(string) - Three-letter team codecurl -X GET "https://api-web.nhle.com/v1/club-stats-season/TOR"Get Club Stats by Season and Game Type
/v1/club-stats/{team}/{season}/{game-type}
team
(string) - Three-letter team codeseason
(int) - Season in YYYYYYYY format, where the first four digits represent the start year of the season, and the last four digits represent the end year.game-type
(int) - Game type (guessing 2 for regular season, 3 for playoffs)curl -X GET "https://api-web.nhle.com/v1/club-stats/TOR/20232024/2"
/v1/scoreboard/{team}/now
team
(string) - Three-letter team codecurl -L -X GET "https://api-web.nhle.com/v1/scoreboard/TOR/now"Get Team Roster As of Now
/v1/roster/{team}/current
team
(string) - Three-letter team codecurl -L -X GET "https://api-web.nhle.com/v1/roster/TOR/current"Get Team Roster by Season
/v1/roster/{team}/{season}
team
(string) - Three-letter team codeseason
(int) - Season in YYYYYYYY format, where the first four digits represent the start year of the season, and the last four digits represent the end year.curl -X GET "https://api-web.nhle.com/v1/roster/TOR/20232024"Get Roster Season for Team
/v1/roster-season/{team}
team
(string) - Three-letter team codecurl -X GET "https://api-web.nhle.com/v1/roster-season/TOR"
/v1/prospects/{team}
team
(string) - Three-letter team codecurl -X GET "https://api-web.nhle.com/v1/prospects/TOR"Get Team Season Schedule As of Now
/v1/club-schedule-season/{team}/now
team
(string) - Three-letter team codecurl -L -X GET "https://api-web.nhle.com/v1/club-schedule-season/TOR/now"
/v1/club-schedule-season/{team}/{season}
team
(string) - Three-letter team codeseason
(int) - Season in YYYYYYYY format, where the first four digits represent the start year of the season, and the last four digits represent the end year.curl -X GET "https://api-web.nhle.com/v1/club-schedule-season/TOR/20232024"Get Month Schedule As of Now
/v1/club-schedule/{team}/month/now
team
(string) - Three-letter team codecurl -L -X GET "https://api-web.nhle.com/v1/club-schedule/TOR/month/now"
/v1/club-schedule/{team}/month/{month}
team
(string) - Three-letter team codemonth
(string) - Month in YYYY-MM formatcurl -X GET "https://api-web.nhle.com/v1/club-schedule/TOR/month/2023-11"
/v1/club-schedule/{team}/week/{date}
team
(string) - Three-letter team codedate
(string) - Date in YYYY-MM-DD formatcurl -X GET "https://api-web.nhle.com/v1/club-schedule/TOR/week/2023-11-10"Get Week Schedule As of Now
/v1/club-schedule/{team}/week/now
team
(string) - Three-letter team codecurl -L -X GET "https://api-web.nhle.com/v1/club-schedule/TOR/week/now"League Schedule Information
/v1/schedule/now
curl -L -X GET "https://api-web.nhle.com/v1/schedule/now"
/v1/schedule/{date}
date
(string) - Date format: YYYY-MM-DDcurl -X GET "https://api-web.nhle.com/v1/schedule/2023-11-10"Get Schedule Calendar As of Now
/v1/schedule-calendar/now
curl -L -X GET "https://api-web.nhle.com/v1/schedule-calendar/now"Get Schedule Calendar for a Specific Date
/v1/schedule-calendar/{date}
date
(string) - Date in YYYY-MM-DD formatcurl -X GET "https://api-web.nhle.com/v1/schedule-calendar/2023-11-10"Get Daily Scores As of Now
/v1/score/now
curl -L -X GET "https://api-web.nhle.com/v1/score/now"
/v1/score/{date}
date
(string) - Date format: YYYY-MM-DDcurl -X GET "https://api-web.nhle.com/v1/score/2023-11-10"
/v1/scoreboard/now
curl -L -X GET "https://api-web.nhle.com/v1/scoreboard/now"
/v1/where-to-watch
include
(query, string) - Optionalcurl -X GET "https://api-web.nhle.com/v1/where-to-watch"
/v1/gamecenter/{game-id}/play-by-play
game-id
(int) - Game IDcurl -X GET "https://api-web.nhle.com/v1/gamecenter/2023020204/play-by-play"
/v1/gamecenter/{game-id}/landing
game-id
(int) - Game IDcurl -X GET "https://api-web.nhle.com/v1/gamecenter/2023020204/landing"
/v1/gamecenter/{game-id}/boxscore
game-id
(int) - Game IDcurl -X GET "https://api-web.nhle.com/v1/gamecenter/2023020204/boxscore"
/v1/wsc/game-story/{game-id}
game-id
(int) - Game IDcurl -X GET "https://api-web.nhle.com/v1/wsc/game-story/2023020204"Get TV Schedule for a Specific Date
/v1/network/tv-schedule/{date}
date
(string) - Date in YYYY-MM-DD formatcurl -X GET "https://api-web.nhle.com/v1/network/tv-schedule/2023-11-10"
/v1/network/tv-schedule/now
curl -L -X GET "https://api-web.nhle.com/v1/network/tv-schedule/now"
/v1/partner-game/{country-code}/now
country-code
(string) - Country codecurl -L -X GET "https://api-web.nhle.com/v1/partner-game/US/now"
/v1/playoff-series/carousel/{season}/
season
(int) - Season in YYYYYYYY format, where the first four digits represent the start year of the season, and the last four digits represent the end year.curl -X GET "https://api-web.nhle.com/v1/playoff-series/carousel/20232024/"Get Playoff Series Schedule
/v1/schedule/playoff-series/{season}/{series_letter}/
season
(int) - Season in YYYYYYYY format, where the first four digits represent the start year of the season, and the last four digits represent the end year.series_letter
(string) - Single letter indicating which series to retrieve. Is sequential in alphabetical order.curl -X GET "https://api-web.nhle.com/v1/schedule/playoff-series/20232024/a"
/v1/playoff-bracket/{year}
year
(int) - Year in YYYY formatcurl -X GET "https://api-web.nhle.com/v1/playoff-bracket/2022"
/v1/season
curl -X GET "https://api-web.nhle.com/v1/season"
/v1/draft/rankings/now
curl -X GET "https://api-web.nhle.com/v1/draft/rankings/now"Get Draft Rankings by Date
/v1/draft/rankings/{season}/{prospect_category}
season
(int) - Season in YYYY formatprospect_category
(int) - Prospect Category (1 - North American Skater, 2 - International Skater, 3 - North American Goalie, 4 - International Goalie)curl -X GET "https://api-web.nhle.com/v1/draft/rankings/2023/1"
/v1/draft-tracker/picks/now
curl -X GET "https://api-web.nhle.com/v1/draft-tracker/picks/now"
/v1/draft/picks/now
curl -X GET "https://api-web.nhle.com/v1/draft/picks/now"
https://api-web.nhle.com/v1/draft/picks/{season}/{round}
season
(int) - Season in YYYY formatround
(string) - Selectable round (1-7, 1 for round 1 etc.) or all
for all selectable roundscurl -X GET "https://api-web.nhle.com/v1/draft/picks/2023/all"
/v1/meta
players
(query, string) - Optionalteams
(query, string) - OptionalseasonStates
(query, string) - Optional (Unsure what the options might be here)curl -X GET "https://api-web.nhle.com/v1/meta?players=8478402&teams=EDM,TOR"
/v1/meta/game/{game-id}
game-id
(int) - Game IDcurl -X GET "https://api-web.nhle.com/v1/meta/game/2023020204"
/v1/location
curl -X GET "https://api-web.nhle.com/v1/location"Get Playoff Series Metadata
/v1/meta/playoff-series/{year}/{series_letter}
year
(int) - Year in YYYY formatseries_letter
(string) - Single letter identifying the playoff seriescurl -X GET "https://api-web.nhle.com/v1/meta/playoff-series/2023/a"Get Postal Code Information
/v1/postal-lookup/{postalCode}
postalCode
(string) - Postal (or zip) code to look upcurl -X GET "https://api-web.nhle.com/v1/postal-lookup/90210"
/v1/ppt-replay/goal/{game-id}/{event-number}
game-id
(int) - Game IDevent-number
(int) - Event number within the gamecurl -X GET "https://api-web.nhle.com/v1/ppt-replay/goal/2023020204/12"
/v1/ppt-replay/{game-id}/{event-number}
game-id
(int) - Game IDevent-number
(int) - Event number within the gamecurl -X GET "https://api-web.nhle.com/v1/ppt-replay/2023020204/12"Get Game Right Rail Content
/v1/gamecenter/{game-id}/right-rail
game-id
(int) - Game IDcurl -X GET "https://api-web.nhle.com/v1/gamecenter/2023020204/right-rail"
/v1/wsc/play-by-play/{game-id}
game-id
(int) - Game IDcurl -X GET "https://api-web.nhle.com/v1/wsc/play-by-play/2023020204"Get OpenAPI Specification
/model/v1/openapi.json
curl -X GET "https://api-web.nhle.com/model/v1/openapi.json"
For the full WADL with extended resources: WADL Link
NHL Stats API DocumentationThis section provides documentation for the NHL Stats API (https://api.nhle.com/stats/rest).
All endpoints described in this section are relative to the following base URL:
https://api.nhle.com/stats/rest
/{lang}/players
lang
(string) - Language codecurl -X GET "https://api.nhle.com/stats/rest/en/players"
/{lang}/leaders/skaters/{attribute}
attribute
(string) - Skater attributelang
(string) - Language codecurl -X GET "https://api.nhle.com/stats/rest/en/leaders/skaters/points"
/{lang}/milestones/skaters
lang
(string) - Language codecurl -X GET "https://api.nhle.com/stats/rest/en/milestones/skaters"
/{lang}/skater
lang
(string) - Language codecurl -X GET "https://api.nhle.com/stats/rest/en/skater"
/{lang}/skater/{report}
report
(string) - Skater reportlang
(string) - Language codeisAggregate
(query, boolean) - OptionalisGame
(query, boolean) - OptionalfactCayenneExp
(query, string) - Optionalinclude
(query, string) - Optionalexclude
(query, string) - OptionalcayenneExp
(query, string) - Requiredsort
(query, string) - Optionaldir
(query, string) - Optionalstart
(query, int) - Optionallimit
(query, int) - Optional (Note: a limit of -1 will return all results)curl -X GET "https://api.nhle.com/stats/rest/en/skater/summary?limit=72&start=17&sort=points&cayenneExp=seasonId=20232024"
/{lang}/leaders/goalies/{attribute}
attribute
(string) - Goalie attributelang
(string) - Language codecurl -X GET "https://api.nhle.com/stats/rest/en/leaders/goalies/gaa"
/{lang}/goalie/{report}
report
(string) - Goalie reportlang
(string) - Language codeisAggregate
(query, boolean) - OptionalisGame
(query, boolean) - OptionalfactCayenneExp
(query, string) - Optionalinclude
(query, string) - Optionalexclude
(query, string) - OptionalcayenneExp
(query, string) - Requiredsort
(query, string) - Optionaldir
(query, string) - Optionalstart
(query, int) - Optionallimit
(query, int) - Optional (Note: a limit of -1 will return all results)curl -X GET "https://api.nhle.com/stats/rest/en/goalie/summary?limit=72&start=15&sort=wins&cayenneExp=seasonId=20232024"
/{lang}/milestones/goalies
lang
(string) - Language codecurl -X GET "https://api.nhle.com/stats/rest/en/milestones/goalies"
/{lang}/draft
curl -X GET "https://api.nhle.com/stats/rest/en/draft"
/{lang}/team
lang
(string) - Language codecurl -X GET "https://api.nhle.com/stats/rest/en/team"
/{lang}/team/id/{id}
lang
(string) - Language codeid
(string) - Team IDcurl -X GET "https://api.nhle.com/stats/rest/en/team/id/10"
/{lang}/team/{report}
report
(string) - Team reportlang
(string) - Language codeisAggregate
(query, boolean) - OptionalisGame
(query, boolean) - OptionalfactCayenneExp
(query, string) - Optionalinclude
(query, string) - Optionalexclude
(query, string) - OptionalcayenneExp
(query, string) - Optionalsort
(query, string) - Optionaldir
(query, string) - Optionalstart
(query, int) - Optionallimit
(query, int) - Optional (Note: a limit of -1 will return all results)curl -X GET "https://api.nhle.com/stats/rest/en/team/summary?sort=shotsForPerGame&cayenneExp=seasonId=20232024%20and%20gameTypeId=2"Get Franchise Information
/{lang}/franchise
lang
(string) - Language codecurl -X GET "https://api.nhle.com/stats/rest/en/franchise"
/{lang}/componentSeason
curl -X GET "https://api.nhle.com/stats/rest/en/componentSeason"
/{lang}/season
curl -X GET "https://api.nhle.com/stats/rest/en/season"
/{lang}/game
curl -X GET "https://api.nhle.com/stats/rest/en/game"
/{lang}/game/meta
lang
(string) - Language codecurl -X GET "https://api.nhle.com/stats/rest/en/game/meta"
/{lang}/config
lang
(string) - Language codecurl -X GET "https://api.nhle.com/stats/rest/en/config"
/ping
curl -X GET "https://api.nhle.com/stats/rest/ping"
/{lang}/country
lang
(string) - Language codecurl -X GET "https://api.nhle.com/stats/rest/en/country"
/{lang}/shiftcharts?cayenneExp=gameId={game_id}
lang
(string) - Language codegame-id
(int) - Game IDcurl -X GET "https://api.nhle.com/stats/rest/en/shiftcharts?cayenneExp=gameId=2021020001"
/{lang}/glossary
lang
(string) - Language codecurl -X GET "https://api.nhle.com/stats/rest/en/glossary"
/{lang}/content/module/{templateKey}
lang
(string) - Language codetemplateKey
(string) - Template key/namecurl -X GET "https://api.nhle.com/stats/rest/en/content/module/overview"
For the full WADL with extended resources: WADL Link
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4