Docs
Coverage MatrixDocumentationRelease LogLog InContact Us

NHL v7 Overview

Introduction

As NHL’s official data partner, Sportradar offers the most detailed and complete live NHL data available. This includes official and accurate scoring, faceoffs, substitutions, hits, giveaways, and more. Game analytics and seasonal statistics are also available to provide a robust hockey experience.

The NHL API is consistent in structure, format, and behavior with our other League Specific APIs. Our primary feeds return schedules, standings, team/player data, and real-time scores.

Our other NHL feeds provide a host of complimentary statistics and information, including:

  • Rankings
  • League leaders
  • Injuries
  • Depth charts
  • In-game substitution info
  • Live event positional data
  • Seasonal statistics
  • Game analytics
  • Shot zones
  • Faceoff statistics

Real-time customers are also offered three delivery Push Feeds to enhance speed.

🗝️

Authentication is required for all API calls.

API Map

To best utilize the NHL API, you will need several parameters to create your API calls. The map below illustrates how you can obtain the parameters you need.

The primary feeds require only a date or season to call the endpoints. Those feeds provide Game, Team, or Player Ids which can be used to generate the game, team, and player feeds. All of the other feeds require no variables.


Endpoint Descriptions

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.

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

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

Depth Charts – Positional depth chart for a given team, including player position information.

Game Analytics – Provides detailed team and player analytics for a given game, including corsi, fenwick, on ice shots, and shots by type.

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

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

Game Play-by-Play – Detailed, real-time information on every team possession and game event.

Game Shot Zones – Provides goals, shots, saves, shooting percentage, shots faced, total shot attempts, and other game statistics for players in each zone.

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

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

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

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

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

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

League Leaders – Goaltending – NHL league leader information for various goaltending categories including full player seasonal statistics for each player in each category.

League Leaders – Skaters – NHL league leader information for various skater categories including full player seasonal statistics for each player in each category.

Player Profile – Provides player biographical information, draft information, and seasonal statistics. 

Rankings – Conference and division rank for each team, including post season clinching status.

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

Seasonal Analytics – Detailed team and player analytics for a given team and season, including corsi, fenwick, on ice shots, and shots by type.

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

Seasonal Shot Zones – Provides goals, shots, saves, shooting percentage, shots faced, total shot attempts, and other seasonal statistics for a player in each zone.

Seasonal Statistics – Detailed team and player statistics for a given team and season.

Seasons – Provides a list of all available seasons.

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

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

Series Statistics – Detailed team and player statistics for the defined series.

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

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

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

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

Teams – Provides a complete list of active teams in the NHL API database.

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

Push Events – Detailed, real-time information on every game event.

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


Data Retrieval Examples

To find a players assists for a given game:

  1. Call the schedule or daily schedule and find the Game Id for the chosen game
  2. Call the Game Boxscore using the Game Id
  3. Find the assists statistics and locate the player full_name

The number of the players's assists is displayed.


To find the coach's name for a given team:

  1. Call the season or series schedule and find id for the coach's team
  2. Call the Team Profile using the Team ID
  3. Find the coach element and locate the full_name attribute

The coach's full name is displayed.


Coverage Levels

We provide two different levels of detail to ensure maximum coverage. We combine coverage levels with the correct feeds to ensure you are getting the most comprehensive data offering in the most efficient manner possible.

Full – We provide live play-by-play coverage for the entire game. We provide updated scores and time remaining as well as team- and player-level data in near real time. Full coverage is available for all regular and postseason games as well as those preseason games available live via a broadcast.

Boxscore – We provide scores and time remaining, in a timely manner, as the game progresses. In-game updates are always subject to availability of sources. Boxscore coverage is available for any preseason game that is not in an NHL venue, as those games are not covered by NHL statisticians.

Failover Details

In some rare instances it will be necessary to failover from on-rink NHL game data to in-house Sportradar data entry. NHL data will be reconciled subsequent to the conclusion of the game.

Reference this document for a list of data points lost during a failover.


Integration Links

Postman Workspace

Our entire Media APIs are available on Postman. Click the link above to be taken directly to our NHL API collection.

Feel free to follow and/or fork any collections to receive updates.

Schema Download

Open the zip file below to access our entire NHL API XSD schema.

NHL v7 Schema


Data Entry Workflow

See below for a daily breakdown of data updates for the NHL API.

Sunday

  • Final game times set for the day's games (10am CT)
  • Games stats validated and moved to closed status (60 Minutes after game goes final)
  • Update rankings (60 Minutes after the last game goes final)
  • Seasonal stats validation (all day)
  • Injuries (all day)*
  • Transactions (all day)*

Monday

  • Final game times set for the day's games (10am CT)
  • Games stats validated and moved to closed status (60 Minutes after game goes final)
  • Update rankings (60 Minutes after the last game goes final)
  • Season stats validation (all day)
  • Injuries (all day)*
  • Transactions (all day)*

Tuesday

  • Final game times set for the day's games (10am CT)
  • Games stats validated and moved to closed status (60 Minutes after game goes final)
  • Update rankings (60 Minutes after the last game goes final)
  • Season stats validation (all day)
  • Injuries (all day)*
  • Transactions (all day)*

Wednesday

  • Final game times set for the day's games (10am CT)
  • Games stats validated and moved to closed status (60 Minutes after game goes final)
  • Update rankings (60 Minutes after the last game goes final)
  • Season stats validation (all day)
  • Injuries (all day)*
  • Transactions (all day)*

Thursday

  • Final game times set for the day's games (10am CT)
  • Games stats validated and moved to closed status (60 Minutes after game goes final)
  • Update rankings (60 Minutes after the last game goes final)
  • Season stats validation (all day)
  • Injuries (all day)*
  • Transactions (all day)*

Friday

  • Final game times set for the day's games (10am CT)
  • Games stats validated and moved to closed status (60 Minutes after game goes final)
  • Update rankings (60 Minutes after the last game goes final)
  • Injuries (all day)*
  • Transactions (all day)*

Saturday

  • Final game times set for the day's games (10am CT)
  • Games stats validated and moved to closed status (60 Minutes after game goes final)
  • Update rankings (60 Minutes after the last game goes final)
  • Seasonal stats validation (all day)
  • Injuries (all day)*
  • Transactions (all day)*

* We monitor and update injuries and transactions throughout the day, using a combination of official and reliable sources.

Important Dates

  • The NHL schedule typically becomes available in July. This release may differ year-to-year depending on seasonal demands.


All-Star Game FAQ

How do I locate the All-Star game(s)?

The games can be found in the Daily or League Schedule endpoint. For example: nhl/trial/v7/en/games/2022/02/05/schedule

Every game-centric feed (e.g. Game Play-by-Play, Game Summary, Push Events, etc) can be accessed during the games.

Click here for a Game Summary or Game Play-by-Play sample of the 2022 games.

What are the differences from a typical NHL game?

There are three total games played for the NHL All-Star break. Two semifinal games (teams for each of the 4 NHL divisions), with the winner of each game advancing to the final game. All three games appear in the Daily Schedule or League Schedule endpoint.

All three games are three-on-three, with two 10-minute periods.

Are the All-Star games covered in realtime?

Yes, all three games are covered in realtime, including the same level of team and player statistics as a regular season game.

When are the All-Star rosters set?

All-Star game rosters will be available shortly prior to each game beginning.

Please note that we only provide game rosters (not team rosters) for each game. Request the Game Summary endpoint prior to the game to receive rosters.

Do you cover the Skills competition?

No. We do not currently cover the All-Star Skills competition in the NHL API.



Simulations

Our NHL simulations give you the opportunity to test your code against a simulation of live data before the preseason starts or any time! Our simulation system replays select completed games allowing you to view our API feeds as if they were happening live.

Simulations run every day according to the below schedule. Data is reset for each day's simulations at 12:00pm UTC.

Quick Access
Start Time (UTC) Game Game ID
1:00pmCalgary at Ottawa823a317f-8bbe-4e26-8c75-2a05138f3d70
1:00pmEdmonton at Vancouver66a5f479-0011-4ead-a51d-33a93e0062f7
1:00pmMontreal at Winnipeg8d591315-f3c8-4925-a3f1-d5a23ac8ba55
5:00pmDallas at Tampa Bay90008b6a-3600-45e6-a3c3-21cca49e5d9d
5:00pmPittsburgh at New Yorke4ba2be3-6cdc-4434-9194-5694e82c7ef9
9:00pmSt. Louis at San Jose86bf6496-4a5d-456d-8e63-2cd41bd0373b​
9:00pmMinnesota at Vegasc7e64152-06e2-44cc-872f-678fb64714ca
9:00pmColorado at Arizonad364d4ec-892d-48d0-b44d-40a2e711b174​
9:00pmVegas at Anaheimdd1f6ad9-733a-4a28-b4a8-955f1fc04cc2

To retrieve the game IDs, team IDs, and other associated information for each game listed above, you can use the following URL with the syntax noted below. If you have an existing NHL API key, simply replace the access_level (trial or production) in the URL of a feed with simulation.

👍

Use SIM as the nhl_season and 2020 as the season_year for each applicable NHL simulation request.

Simulation Parameters

Game Schedule:
https://api.sportradar.com/nhl/simulation/{version}/{language_code}/games/2020/SIM/schedule.{format}?api_key={your_api_key}
ParameterDescription
versionVersion number of the API you are accessing (Current Version: v7).
language_code2 letter code for supported languages: en (English), es (Spanish), fr (French), ru (Russian), and zh (simplified Chinese).
nhl_seasonSIM
season_year2020
formatxml or json.
your_api_keyYour API key.

Feeds Available: Game Analytics, Game Boxscore, Game Faceoffs, Game Play-By-Play, Game Shot Zones, Game Summary, Game Time on Ice, League Leaders (Goaltending), League Leaders (Skaters), Schedule, Seasonal Analytics, Seasonal Faceoffs, Seasonal Shot Zones, Seasonal Statistics, Standings, Team Profile, Push Events, and Push Statistics.

For syntax structure on each feed, please reference the endpoint documentation.