Overview

❗️

Alert

Please note that the current, stable version of our NHL API is v7. We suggest integrating with this version.

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.

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.

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. Please note that this collection is specific to the current version (v7).

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 v5 Schema

Data Entry Workflow

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.

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

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.