Integration GuideDocs
Coverage MatrixDocumentationChange LogLog InContact Us
Integration Guide

Endpoints

Daily Change Log

Provides IDs and timestamps for teams, players, game statistics, schedules, and standings that have been modified on a given date. To receive the data updates, use these unique IDs to pull relevant API feeds.

https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/league/{year}/{month}/{day}/changes.{format}?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production) or Trial (trial).
versionVersion number of the API you are accessing (Current Version: v5).
language_code2 letter code for supported languages: en (English), ru (Russian), and zh (simplified Chinese).
yearYear in 4 digit format (YYYY).
monthMonth in 2 digit format (MM).
dayDay in 2 digit format (DD).
formatxml or json.
your_api_keyYour API key.

Daily Schedule

Date, time, location, and other event details for every match-up taking place in the league defined day.

https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/games/{year}/{month}/{day}/schedule.{format}?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production) or Trial (trial).
versionVersion number of the API you are accessing (Current Version: v5).
language_code2 letter code for supported languages: en (English), ru (Russian), and zh (simplified Chinese).
yearYear in 4 digit format (YYYY).
monthMonth in 2 digit format (MM).
dayDay in 2 digit format (DD).
formatxml or json.
your_api_keyYour API key.

Daily Transfers

Information for all transfers added or edited during the league-defined day.

https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/league/{year}/{month}/{day}/transfers.{format}?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production) or Trial (trial).
versionVersion number of the API you are accessing (Current Version: v5).
language_code2 letter code for supported languages: en (English), ru (Russian), and zh (simplified Chinese).
yearYear in 4 digit format (YYYY).
monthMonth in 2 digit format (MM).
dayDay in 2 digit format (DD).
formatxml or json.
your_api_keyYour API key.

Game Boxscore

Top-level team scores by quarter and full statistics for team leaders in assists, goals, and points.

https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/games/{game_id}/boxscore.{format}?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production), Trial (trial), or Simulation (simulation).
versionVersion number of the API you are accessing (Current Version: v5).
language_code2 letter code for supported languages: en (English), ru (Russian), and zh (simplified Chinese).
game_idID for a given game.
formatxml or json.
your_api_keyYour API key.

Game Faceoffs

Detailed faceoff information for teams and players, including period, zone, and strength breakdowns, for a given game.

https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/games/{game_id}/faceoffs.{format}?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production), Trial (trial), or Simulation (simulation).
versionVersion number of the API you are accessing (Current Version: v5).
language_code2 letter code for supported languages: en (English), ru (Russian), and zh (simplified Chinese).
game_idID for a given game.
formatxml or json.
your_api_keyYour API key.

Game Play-By-Play

Detailed, real-time information on every team possession and game event.

https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/games/{game_id}/pbp.{format}?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production), Trial (trial), or Simulation (simulation).
versionVersion number of the API you are accessing (Current Version: v5).
language_code2 letter code for supported languages: en (English), ru (Russian), and zh (simplified Chinese).
game_idID for a given game.
formatxml or json.
your_api_keyYour API key.

Game Summary

Top-level boxscore information with detailed team and player levels game stats.

https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/games/{game_id}/summary.{format}?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production), Trial (trial), or Simulation (simulation).
versionVersion number of the API you are accessing (Current Version: v5).
language_code2 letter code for supported languages: en (English), ru (Russian), and zh (simplified Chinese).
game_idID for a given game.
formatxml or json.
your_api_keyYour API key.

Game Time On Ice

Time on ice totals for every player for a given game, including detailed shift information.

https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/games/{game_id}/time_on_ice.{format}?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production), Trial (trial), or Simulation (simulation).
versionVersion number of the API you are accessing (Current Version: v5).
language_code2 letter code for supported languages: en (English), ru (Russian), and zh (simplified Chinese).
game_idID for a given game.
formatxml or json.
your_api_keyYour API key.

Injuries

Information concerning all active player injuries for all teams within the league.

https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/league/injuries.{format}?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production) or Trial (trial).
versionVersion number of the API you are accessing (Current Version: v5).
language_code2 letter code for supported languages: en (English), ru (Russian), and zh (simplified Chinese).
formatxml or json.
your_api_keyYour API key.

League Hierarchy

Provides top-level information for each team, including conference and division distinction, and venue information.

https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/league/hierarchy.{format}?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production) or Trial (trial).
versionVersion number of the API you are accessing (Current Version: v5).
language_code2 letter code for supported languages: en (English), ru (Russian), and zh (simplified Chinese).
formatxml or json.
your_api_keyYour API key.

League Leaders - Goaltending

NHL leader information for various goaltending categories including full player seasonal statistics for each player in each category.

https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/seasons/{season_year}/{nhl_season}/leaders/goaltending.{format}?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production), Trial (trial), or Simulation (simulation).
versionVersion number of the API you are accessing (Current Version: v5).
language_code2 letter code for supported languages: en (English), ru (Russian), and zh (simplified Chinese).
season_yearYear in 4 digit format (YYYY).
nhl_seasonPreseason (PRE), Regular Season (REG), or Postseason (PST).
formatxml or json.
your_api_keyYour API key.

League Leaders - Skaters

NHL leader information for various skater categories including full player seasonal statistics for each player in each category.

https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/seasons/{season_year}/{nhl_season}/leaders/offense.{format}?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production), Trial (trial), or Simulation (simulation).
versionVersion number of the API you are accessing (Current Version: v5).
language_code2 letter code for supported languages: en (English), ru (Russian), and zh (simplified Chinese).
season_yearYear in 4 digit format (YYYY).
nhl_seasonPreseason (PRE), Regular Season (REG), or Postseason (PST).
formatxml or json.
your_api_keyYour API key.

League Leaders - Daily

NHL daily league leader information for various skater and goaltending categories including points, goals, and plus/minus.

https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/seasons/{season_year}/{nhl_season}/{year}/{month}/{day}/leaders.{format}?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production) or Trial (trial).
versionVersion number of the API you are accessing (Current Version: v5).
language_code2 letter code for supported languages: en (English), ru (Russian), and zh (simplified Chinese).
season_yearYear in 4 digit format (YYYY).
nhl_seasonPreseason (PRE), Regular Season (REG), or Postseason (PST).
yearYear in 4 digit format (YYYY).
monthMonth in 2 digit format (MM).
dayDay in 2 digit format (DD).
formatxml or json.
your_api_keyYour API key.

League Leaders - Seasonal

NHL seasonal league leader information for various skater and goaltending categories including points, goals, and plus/minus.

https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/seasons/{season_year}/{nhl_season}/leaders.{format}?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production) or Trial (trial).
versionVersion number of the API you are accessing (Current Version: v5).
language_code2 letter code for supported languages: en (English), ru (Russian), and zh (simplified Chinese).
season_yearYear in 4 digit format (YYYY).
nhl_seasonPreseason (PRE), Regular Season (REG), or Postseason (PST).
formatxml or json.
your_api_keyYour API key.

Player Profile

Provides player biographical information, draft information, and seasonal statistics for the regular season and playoffs.

https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/players/{player_id}/profile.{format}?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production) or Trial (trial).
versionVersion number of the API you are accessing (Current Version: v5).
language_code2 letter code for supported languages: en (English), ru (Russian), and zh (simplified Chinese).
player_idID for a given player.
formatxml or json.
your_api_keyYour API key.

Rankings

Conference and division rank for each team, including playoff clinching status.

https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/seasons/{season_year}/{nhl_season}/rankings.{format}?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production) or Trial (trial).
versionVersion number of the API you are accessing (Current Version: v5).
language_code2 letter code for supported languages: en (English), ru (Russian), and zh (simplified Chinese).
season_yearYear in 4 digit format (YYYY).
nhl_seasonRegular Season (REG).
formatxml or json.
your_api_keyYour API key.

Schedule

Date, time, location, and other event details for every match-up taking place in the full league season.

https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/league/{year}/{month}/{day}/changes.{format}?api_key={your_api_key}


https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/games/{season_year}/{nhl_season}/schedule.{format}?api_key={your_api_key}

ParameterDescription
access_levelDefines the access level of your API key as Production (production), Trial (trial), or Simulation (simulation).
versionVersion number of the API you are accessing (Current Version: v5).
language_code2 letter code for supported languages: en (English), ru (Russian), and zh (simplified Chinese).
season_yearYear in 4 digit format (YYYY).
nhl_seasonPreseason (PRE), Regular Season (REG), or Postseason (PST).
formatxml or json.
your_api_keyYour API key.

Seasonal Faceoffs

Detailed faceoff information for teams and players, including period, zone, and strength breakdowns, for a given team and season.

https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/seasons/{season_year}/{nhl_season}/teams/{team_id}/faceoffs.{format}?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production), Trial (trial), or Simulation (simulation).
versionVersion number of the API you are accessing (Current Version: v5).
language_code2 letter code for supported languages: en (English), ru (Russian), and zh (simplified Chinese).
season_yearYear in 4 digit format (YYYY).
nhl_seasonRegular Season (REG), or Postseason (PST).
team_idID of a given team.
formatxml or json.
your_api_keyYour API key.

Seasonal Statistics (Season To Date)

Detailed team and player statistics for a given team and season.

https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/seasons/{season_year}/{nhl_season}/teams/{team_id}/statistics.{format}?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production), Trial (trial), or Simulation (simulation).
versionVersion number of the API you are accessing (Current Version: v5).
language_code2 letter code for supported languages: en (English), ru (Russian), and zh (simplified Chinese).
season_yearYear in 4 digit format (YYYY).
nhl_seasonRegular Season (REG), or Postseason (PST).
team_idID for a given team.
formatxml or json.
your_api_keyYour API key.

Series Faceoffs

Detailed faceoff information for teams and players for a given series, including period, zone, and strength breakdowns.

https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/series/{series_id}/teams/{team_id}/faceoffs.{format}?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production) or Trial (trial).
versionVersion number of the API you are accessing (Current Version: v5).
language_code2 letter code for supported languages: en (English), ru (Russian), and zh (simplified Chinese).
series_idID of a given series.
team_idID of a given team.
formatxml or json.
your_api_keyYour API key.

Series Schedule

Playoff participant information and the date, time, location, and other event details for every match-up taking place for the entire playoffs.

https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/series/{season_year}/{nhl_season}/schedule.{format}?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production) or Trial (trial).
versionVersion number of the API you are accessing (Current Version: v5).
language_code2 letter code for supported languages: en (English), ru (Russian), and zh (simplified Chinese).
season_yearYear in 4 digit format (YYYY).
nhl_seasonPostseason (PST).
formatxml or json.
your_api_keyYour API key.

Series Statistics

Detailed team and player statistics for the defined series.

https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/series/{series_id}/teams/{team_id}/statistics.{format}?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production) or Trial (trial).
versionVersion number of the API you are accessing (Current Version: v5).
language_code2 letter code for supported languages: en (English), ru (Russian), and zh (simplified Chinese).
series_idID of a given series.
team_idID of a given team.
formatxml or json.
your_api_keyYour API key.

Standings

Detailed team records across various views including, overall, conference, and division.

https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/seasons/{season_year}/{nhl_season}/standings.{format}?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production), Trial (trial), or Simulation (simulation).
versionVersion number of the API you are accessing (Current Version: v5).
language_code2 letter code for supported languages: en (English), ru (Russian), and zh (simplified Chinese).
season_yearYear in 4 digit format (YYYY).
nhl_seasonPreseason (PRE), Regular Season (REG), or Postseason (PST).
formatxml or json.
your_api_keyYour API key.

Team Leaders - Daily

NHL daily leader information for various skater and goaltending categories, including full player seasonal statistics for each player in each category.

https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/seasons/{season_year}/{nhl_season}/{year}/{month}/{day}/teams/{team_id}/leaders.{format}?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production) or Trial (trial).
versionVersion number of the API you are accessing (Current Version: v5).
language_code2 letter code for supported languages: en (English), ru (Russian), and zh (simplified Chinese).
season_yearYear in 4 digit format (YYYY).
nhl_seasonRegular Season (REG), or Postseason (PST).
yearYear in 4 digit format (YYYY).
monthMonth in 2 digit format (MM).
dayDay in 2 digit format (DD).
team_idID of a given team.
formatxml or json.
your_api_keyYour API key.

Team Leaders - Seasonal

NHL seasonal leader information for various skater and goaltending categories, including full player seasonal statistics for each player in each category.

https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/seasons/{season_year}/{nhl_season}/teams/{team_id}/leaders.{format}?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production) or Trial (trial).
versionVersion number of the API you are accessing (Current Version: v5).
language_code2 letter code for supported languages: en (English), ru (Russian), and zh (simplified Chinese).
season_yearYear in 4 digit format (YYYY).
nhl_seasonRegular Season (REG), or Postseason (PST).
team_idID of a given team.
formatxml or json.
your_api_keyYour API key.

Team Profile (Rosters)

Provides top-level team information and a full roster of active players.

https://api.sportradar.us/nhl/{access_level}/{version}/{language_code}/teams/{team_id}/profile.{format}?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production), Trial (trial), or Simulation (simulation).
versionVersion number of the API you are accessing (Current Version: v5).
language_code2 letter code for supported languages: en (English), ru (Russian), and zh (simplified Chinese).
team_idID for a given team.
formatxml or json.
your_api_keyYour API key.

Push Clock

Game clock feed with high level scoring and strength information, including the most recent game event.

https://api.sportradar.us/nhl/{access_level}/stream/{language_code}/clock/subscribe?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production) or Trial (trial).
language_codeOptional code for supported languages: en (English) or translations (Any other language translations. See optional query string parameters for locale.)
your_api_keyYour API key.

Optional Query String Parameters

📘

Optional query string parameters must be added after your API key with an ampersand (&). If you are filtering for more than one result, separate the results with a comma (,) and no spaces.

Replace placeholders with the following query parameters:

ParameterDescription
localeLocale expressed as 2 letter code: locale={language_code}
Example: locale:en
matchMatch id expressed as: sd:match:{match_id}.
Example: match=sd:match:4d1c4eb9-69d4-46fc-a42b-12be98227964
statusStatus type expressed as: inprogress or created.
Example: status=inprogress

Push Events

Detailed, real-time information on every game event.

https://api.sportradar.us/nhl/{access_level}/stream/{language_code}/events/subscribe?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production), Trial (trial), or Simulation (simulation).
language_codeOptional code for supported languages: en (English) or translations (Any other language translations. See optional query string parameters for locale.)
your_api_keyYour API key.

Optional Query String Parameters

📘

Optional query string parameters must be added after your API key with an ampersand (&). If you are filtering for more than one result, separate the results with a comma (,) and no spaces.

Replace placeholders with the following query parameters:

ParameterDescription
event_categoryEvent category expressed as: {event_category}.
Example: event_category=shot
event_typeEvent type expressed as: {event_type}.
Example: event_type=stoppage
localeLocale expressed as 2 letter code: locale={language_code}
Example: locale:en
matchMatch id expressed as: sd:match:{match_id}.
Example: match=sd:match:4d1c4eb9-69d4-46fc-a42b-12be98227964
statusStatus type expressed as: inprogress or created.
Example: status=inprogress
strengthStrength type expressed as: {strength}. Example: strength=even
teamTeam id expressed as: sd:team:{team_id}.
Example: team=sd:team:4415b0a7-0f24-11e2-8525-18a905767e44
zoneZone expressed as: {zone}. Example: zone=offensive

Push Statistics

Detailed, real-time game stats at the team and player level.

https://api.sportradar.us/nhl/{access_level}/stream/{language_code}/statistics/subscribe?api_key={your_api_key}


ParameterDescription
access_levelDefines the access level of your API key as Production (production), Trial (trial), or Simulation (simulation).
language_codeen (English)
your_api_keyYour API key.

Optional Query String Parameters

📘

Optional query string parameters must be added after your API key with an ampersand (&). If you are filtering for more than one result, separate the results with a comma (,) and no spaces.

Replace placeholders with the following query parameters:

ParameterDescription
matchMatch id expressed as: sd:match:{match_id}.
Example: match=sd:match:4d1c4eb9-69d4-46fc-a42b-12be98227964
playerPlayer id expressed as: sd:player:{player_id}.
Example: player=sd:player:436a6c0e-0f24-11e2-8525-18a905767e44
stats_typeStat type expressed as {stats_type}. Example: stats_type=player
statusStatus type expressed as: inprogress or created.
Example: status=inprogress
strengthStrength type expressed as: {strength}. Example: strength=even
teamTeam id expressed as: sd:team:{team_id}.
Example: team=sd:team:4415b0a7-0f24-11e2-8525-18a905767e44