Skip to content

Zmalski/NHL-API-Reference

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
LICENSE
LICENSE
 
 
README.md
README.md
 
 

Repository files navigation

NHL API Documentation

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.

Table of Contents

api-web.nhle.com

  1. Base URL
  2. Player Information
    1. Players
      1. Get Game Log
      2. Get Specific Player Info
      3. Get Game Log As of Now
    2. Skaters
      1. Get Current Skater Stats Leaders
      2. Get Skater Stats Leaders for a Specific Season and Game Type
    3. Goalies
      1. Get Current Goalie Stats Leaders
      2. Get Goalie Stats Leaders by Season
    4. Player Spotlight
      1. Get Players
  3. Team Information
    1. Standings
      1. Get Standings
      2. Get Standings by Date
      3. Get Standings information for each Season
    2. Stats
      1. Get Club Stats Now
      2. Get Club Stats for the Season for a Team
      3. Get Club Stats by Season and Game Type
      4. Get Team Scoreboard
    3. Roster
      1. Get Team Roster As of Now
      2. Get Team Roster by Season
      3. Get Roster Season for Team
      4. Get Team Prospects
    4. Schedule
      1. Get Team Season Schedule As of Now
      2. Get Team Season Schedule
      3. Get Month Schedule As of Now
      4. Get Month Schedule
      5. Get Week Schedule
      6. Get Week Schedule As of Now
  4. League Schedule Information
    1. Schedule
      1. Get Current Schedule
      2. Get Schedule by Date
    2. Schedule Calendar
      1. Get Schedule Calendar As of Now
      2. Get Schedule Calendar for a Specific Date
  5. Game Information
    1. Daily Scores
      1. Get Daily Scores As of Now
      2. Get Daily Scores by Date
      3. Get Scoreboard
    2. Where to Watch
      1. Get Streams
    3. Game Events
      1. Get Play By Play
      2. Get Landing
      3. Get Boxscore
      4. Get Game Story
    4. Network
      1. Get TV Schedule for a Specific Date
      2. Get Current TV Schedule
    5. Odds
      1. Get Partner Game Odds
  6. Playoff Information
    1. Overview
      1. Playoff Series Carousel
    2. Schedule
      1. Get Playoff Series Schedule
    3. Bracket
      1. Get Playoff Bracket
  7. Season
    1. Get Seasons
  8. Draft
    1. Get Draft Rankings
    2. Get Draft Rankings by Date
    3. Get Draft Tracker Now
    4. Get Draft Picks Now
    5. Get Draft Picks
  9. Miscellaneous
    1. Meta
      1. Get Meta Information
      2. Get Game Information
      3. Get Location
      4. Get Playoff Series Metadata
    2. Postal Lookup
      1. Get Postal Code Information
    3. Game Replays
      1. Get Goal Replay
      2. Get Play Replay
    4. Additional Game Content
      1. Get Game Right Rail Content
      2. Get WSC Play By Play
    5. OpenAPI Specification
      1. Get OpenAPI Specification
  10. [NHL Edge Data](#NHL Edge Data)
    1. [Team Data](#Team Data)
      1. [Team Details](#Team Details)
      2. [Team Landing](#Team Landing)
      3. [Team Comparison](#Team Comparison)
      4. [Team Skating Distance - Top 10](#Team Skating Distance - Top 10)
      5. [Team Skating Distance - Detail](#Team Skating Distance - Detail)
      6. [Team Skating Speed - Top 10](#Team Skating Speed - Top 10)
      7. [Team Skating Speed - Detail](#Team Skating Speed - Detail)
      8. [Team Zone Time - Top 10](#Team Zone Time - Top 10)
      9. [Team Zone Time - Details](#Team Zone Time - Details)
      10. [Team Shot Speed - Top 10](#Team Shot Speed - Top 10)
      11. [Team Shot Speed - Detail](#Team Shot Speed - Detail)
      12. [Team Shot Location - Top 10](#Team Shot Location - Top 10)
      13. [Team Shot Location - Detail](#Team Shot Location - Detail)
    2. [Skater Data](#Skater Data)
      1. [Skater Detail](#Skater Detail)
      2. [Skater Landing](#Skater Landing)
      3. [Skater Comparison](#Skater Comparison)
      4. [Skater Distance - Top 10](#Skater Distance - Top 10)
      5. [Skater Distance - Detail](#Skater Distance - Detail)
      6. [Skater Speed - Top 10](#Skater Speed - Top 10)
      7. [Skater Speed - Detail](#Skater Speed - Detail)
      8. [Skater Zone Time - Top 10](#Skater Zone Time - Top 10)
      9. [Skater Zone Time - Detail](#Skater Zone Time - Detail)
      10. [Skater Shot Speed - Top 10](#Skater Shot Speed - Top 10)
      11. [Skater Shot Speed - Detail](#Skater Shot Speed - Detail)
      12. [Skater Shot Location - Top 10](#Skater Shot Location - Top 10)
      13. [Skater Shot Location - Detail](#Skater Shot Location - Detail)
      14. [CAT - Skater Detail](#CAT - Skater Detail)
    3. [Goalie Data](#Goalie Data)
      1. [Goalie Detail](#Goalie Detail)
      2. [Goalie Landing](#Goalie Landing)
      3. [Goalie Comparison](#Goalie Comparison)
      4. [Goalie 5v5 - Top 10](#Goalie 5v5 - Top 10)
      5. [Goalie 5v5 - Detail](#Goalie 5v5 - Detail)
      6. [Goalie Shot Location - Top 10](#Goalie Shot Location - Top 10)
      7. [Goalie Shot Location - Detail](#Goalie Shot Location - Detail)
      8. [Goalie Save Percentage - Top 10](#Goalie Save Percentage - Top 10)
      9. [Goalie Save Percentage - Detail](#Goalie Save Percentage - Detail)
      10. [CAT - Goalie Detail](#CAT - Goalie Detail)

api.nhle.com/stats/rest

  1. Base URL
  2. Players
    1. Players
      1. Get Player Information
    2. Skaters
      1. Get Skater Leaders
      2. Get Skater Milestones
      3. Get Skater Information
      4. Get Skater Stats
    3. Goalies
      1. Get Goalie Leaders
      2. Get Goalie Stats
      3. Get Goalie Milestones
    4. Draft
      1. Get Draft Information
  3. Teams
    1. Get Team Information
    2. Get Team By ID
    3. Get Team Stats
    4. Get Franchise Information
  4. Season
    1. Get Component Season
    2. Get Season
  5. Game
    1. Get Game Information
    2. Get Game Metadata
  6. Miscellaneous
    1. Configuration
      1. Get Configuration
    2. Ping the Server
    3. Get Country Information
    4. Get Shift Charts
    5. Glossary
      1. Get Glossary
    6. Content Module
      1. Get Content Module

NHL Web API Documentation

This section provides documentation for the NHL Web API (https://api-web.nhle.com/).

Base URL

All endpoints described in this section are relative to the following base URL:

https://api-web.nhle.com/

Player Information

Players

Get Game Log

  • Endpoint: /v1/player/{player}/game-log/{season}/{game-type}
  • Method: GET
  • Description: Retrieve the game log for a specific player, season, and game type.
  • Parameters:
    • player (int) - Player ID
    • 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)
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/player/8478402/game-log/20232024/2"

Get Specific Player Info

  • Endpoint: /v1/player/{player}/landing
  • Method: GET
  • Description: Retrieve information for a specific player.
  • Parameters:
    • player (int) - Player ID
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/player/8478402/landing"

Get Game Log As of Now

  • Endpoint: /v1/player/{player}/game-log/now
  • Method: GET
  • Description: Retrieve the game log for a specific player as of the current moment.
  • Parameters:
    • player (int) - Player ID
  • Response: JSON format
Example using cURL:
curl -L -X GET "https://api-web.nhle.com/v1/player/8478402/game-log/now"

Skaters

Get Current Skater Stats Leaders

  • Endpoint: /v1/skater-stats-leaders/current
  • Method: GET
  • Description: Retrieve current skater stats leaders.
  • Parameters:
    • categories (query, string) - Optional
    • limit (query, int) - Optional (Note: a limit of -1 will return all results)
  • Response: JSON format
Example using cURL:
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

  • Endpoint: /v1/skater-stats-leaders/{season}/{game-type}
  • Method: GET
  • Description: Retrieve skater stats leaders for a specific season and game type.
  • Parameters:
    • 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)
  • Parameters:
    • categories (query, string) - Optional
    • limit (query, int) - Optional (Note: a limit of -1 will return all results)
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/skater-stats-leaders/20222023/2?categories=assists&limit=3"

Goalies

Get Current Goalie Stats Leaders

  • Endpoint: /v1/goalie-stats-leaders/current
  • Method: GET
  • Description: Retrieve current goalie stats leaders.
  • Request Parameters:
    • categories (query, string) - Optional
    • limit (query, int) - Optional (Note: a limit of -1 will return all results)
  • Response: JSON format
Example using cURL:
curl -L -X GET "https://api-web.nhle.com/v1/goalie-stats-leaders/current?categories=wins&limit=5"

Get Goalie Stats Leaders by Season

  • Endpoint: /v1/goalie-stats-leaders/{season}/{game-type}
  • Method: GET
  • Description: Retrieve goalie stats leaders for a specific season and game type.
  • Parameters:
    • 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)
  • Request Parameters:
    • categories (query, string) - Optional
    • limit (query, int) - Optional (Note: a limit of -1 will return all results)
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/goalie-stats-leaders/20232024/2?categories=wins&limit=3"

Player Spotlight

Get Players

  • Endpoint: /v1/player-spotlight
  • Method: GET
  • Description: Retrieve information about players in the "spotlight".
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/player-spotlight"

Team Information

Standings

Get Standings

  • Endpoint: /v1/standings/now
  • Method: GET
  • Description: Retrieve the standings as of the current moment.
  • Response: JSON format
Example using cURL:
curl -L -X GET "https://api-web.nhle.com/v1/standings/now"

Get Standings by Date

  • Endpoint: /v1/standings/{date}
  • Method: GET
  • Description: Retrieve the standings for a specific date.
  • Parameters:
    • date (string) - Date in YYYY-MM-DD format
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/standings/2023-11-10"

Get Standings information for each Season

  • Endpoint: /v1/standings-season
  • Method: GET
  • Description: Retrieves information for each season's standings
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/standings-season"

Stats

Get Club Stats Now

  • Endpoint: /v1/club-stats/{team}/now
  • Method: GET
  • Description: Retrieve current statistics for a specific club.
  • Parameters:
    • team (string) - Three-letter team code
  • Response: JSON format
Example using cURL:
curl -L -X GET "https://api-web.nhle.com/v1/club-stats/TOR/now"

Get Club Stats for the Season for a Team

  • Endpoint: /v1/club-stats-season/{team}
  • Method: GET
  • Description: Returns an overview of the stats for each season for a specific club. Seems to only indicate the gametypes played in each season.
  • Parameters:
    • team (string) - Three-letter team code
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/club-stats-season/TOR"

Get Club Stats by Season and Game Type

  • Endpoint: /v1/club-stats/{team}/{season}/{game-type}
  • Method: GET
  • Description: Retrieve the stats for a specific team, season, and game type.
  • Parameters:
    • team (string) - Three-letter team code
    • 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)
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/club-stats/TOR/20232024/2"

Get Team Scoreboard

  • Endpoint: /v1/scoreboard/{team}/now
  • Method: GET
  • Description: Retrieve the scoreboard for a specific team as of the current moment.
  • Parameters:
    • team (string) - Three-letter team code
  • Response: JSON format
Example using cURL:
curl -L -X GET "https://api-web.nhle.com/v1/scoreboard/TOR/now"

Roster

Get Team Roster As of Now

  • Endpoint: /v1/roster/{team}/current
  • Method: GET
  • Description: Retrieve the roster for a specific team as of the current moment.
  • Parameters:
    • team (string) - Three-letter team code
  • Response: JSON format
Example using cURL:
curl -L -X GET "https://api-web.nhle.com/v1/roster/TOR/current"

Get Team Roster by Season

  • Endpoint: /v1/roster/{team}/{season}
  • Method: GET
  • Description: Retrieve the roster for a specific team and season.
  • Parameters:
    • team (string) - Three-letter team code
    • 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.
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/roster/TOR/20232024"

Get Roster Season for Team

  • Endpoint: /v1/roster-season/{team}
  • Method: GET
  • Description: Seems to just return a list of all of the seasons that the team played.
  • Parameters:
    • team (string) - Three-letter team code
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/roster-season/TOR"

Get Team Prospects

  • Endpoint: /v1/prospects/{team}
  • Method: GET
  • Description: Retrieve prospects for a specific team.
  • Parameters:
    • team (string) - Three-letter team code
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/prospects/TOR"

Schedule

Get Team Season Schedule As of Now

  • Endpoint: /v1/club-schedule-season/{team}/now
  • Method: GET
  • Description: Retrieve the season schedule for a specific team as of the current moment.
  • Parameters:
    • team (string) - Three-letter team code
  • Response: JSON format
Example using cURL:
curl -L -X GET "https://api-web.nhle.com/v1/club-schedule-season/TOR/now"

Get Team Season Schedule

  • Endpoint: /v1/club-schedule-season/{team}/{season}
  • Method: GET
  • Description: Retrieve the season schedule for a specific team and season.
  • Parameters:
    • team (string) - Three-letter team code
    • 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.
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/club-schedule-season/TOR/20232024"

Get Month Schedule As of Now

  • Endpoint: /v1/club-schedule/{team}/month/now
  • Method: GET
  • Description: Retrieve the monthly schedule for a specific team as of the current moment.
  • Parameters:
    • team (string) - Three-letter team code
  • Response: JSON format
Example using cURL:
curl -L -X GET "https://api-web.nhle.com/v1/club-schedule/TOR/month/now"

Get Month Schedule

  • Endpoint: /v1/club-schedule/{team}/month/{month}
  • Method: GET
  • Description: Retrieve the monthly schedule for a specific team and month.
  • Parameters:
    • team (string) - Three-letter team code
    • month (string) - Month in YYYY-MM format
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/club-schedule/TOR/month/2023-11"

Get Week Schedule

  • Endpoint: /v1/club-schedule/{team}/week/{date}
  • Method: GET
  • Description: Retrieve the weekly schedule for a specific team and date.
  • Parameters:
    • team (string) - Three-letter team code
    • date (string) - Date in YYYY-MM-DD format
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/club-schedule/TOR/week/2023-11-10"

Get Week Schedule As of Now

  • Endpoint: /v1/club-schedule/{team}/week/now
  • Method: GET
  • Description: Retrieve the weekly schedule for a specific team as of the current moment.
  • Parameters:
    • team (string) - Three-letter team code
  • Response: JSON format
Example using cURL:
curl -L -X GET "https://api-web.nhle.com/v1/club-schedule/TOR/week/now"

League Schedule Information

Schedule

Get Current Schedule

  • Endpoint: /v1/schedule/now
  • Method: GET
  • Description: Retrieve the current schedule.
  • Response: JSON format
Example using cURL:
curl -L -X GET "https://api-web.nhle.com/v1/schedule/now"

Get Schedule by Date

  • Endpoint: /v1/schedule/{date}
  • Method: GET
  • Description: Retrieve the schedule for a specific date.
  • Parameters:
    • date (string) - Date format: YYYY-MM-DD
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/schedule/2023-11-10"

Schedule Calendar

Get Schedule Calendar As of Now

  • Endpoint: /v1/schedule-calendar/now
  • Method: GET
  • Description: Retrieve the schedule calendar as of the current moment.
  • Response: JSON format
Example using cURL:
curl -L -X GET "https://api-web.nhle.com/v1/schedule-calendar/now"

Get Schedule Calendar for a Specific Date

  • Endpoint: /v1/schedule-calendar/{date}
  • Method: GET
  • Description: Retrieve the schedule calendar for a specific date.
  • Parameters:
    • date (string) - Date in YYYY-MM-DD format
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/schedule-calendar/2023-11-10"

Game Information

Daily Scores

Get Daily Scores As of Now

  • Endpoint: /v1/score/now
  • Method: GET
  • Description: Retrieve daily scores as of the current moment.
  • Response: JSON format
Example using cURL:
curl -L -X GET "https://api-web.nhle.com/v1/score/now"

Get Daily Scores by Date

  • Endpoint: /v1/score/{date}
  • Method: GET
  • Description: Retrieve daily scores for a specific date.
  • Parameters:
    • date (string) - Date format: YYYY-MM-DD
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/score/2023-11-10"

Get Scoreboard

  • Endpoint: /v1/scoreboard/now
  • Method: GET
  • Description: Retrieve the overall scoreboard as of the current moment.
  • Response: JSON format
Example using cURL:
curl -L -X GET "https://api-web.nhle.com/v1/scoreboard/now"

Where to Watch

Get Streams

  • Endpoint: /v1/where-to-watch
  • Method: GET
  • Description: Retrieve information about streaming options.
  • Parameters:
    • include (query, string) - Optional
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/where-to-watch"

Game Events

Get Play By Play

  • Endpoint: /v1/gamecenter/{game-id}/play-by-play
  • Method: GET
  • Description: Retrieve play-by-play information for a specific game.
  • Parameters:
    • game-id (int) - Game ID
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/gamecenter/2023020204/play-by-play"

Get Landing

  • Endpoint: /v1/gamecenter/{game-id}/landing
  • Method: GET
  • Description: Retrieve landing information for a specific game.
  • Parameters:
    • game-id (int) - Game ID
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/gamecenter/2023020204/landing"

Get Boxscore

  • Endpoint: /v1/gamecenter/{game-id}/boxscore
  • Method: GET
  • Description: Retrieve boxscore information for a specific game.
  • Parameters:
    • game-id (int) - Game ID
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/gamecenter/2023020204/boxscore"

Get Game Story

  • Endpoint: /v1/wsc/game-story/{game-id}
  • Method: GET
  • Description: Retrieve game story information for a specific game.
  • Parameters:
    • game-id (int) - Game ID
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/wsc/game-story/2023020204"

Network

Get TV Schedule for a Specific Date

  • Endpoint: /v1/network/tv-schedule/{date}
  • Method: GET
  • Description: Retrieve the TV schedule for a specific date.
  • Parameters:
    • date (string) - Date in YYYY-MM-DD format
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/network/tv-schedule/2023-11-10"

Get Current TV Schedule

  • Endpoint: /v1/network/tv-schedule/now
  • Method: GET
  • Description: Retrieve the current TV schedule.
  • Response: JSON format
Example using cURL:
curl -L -X GET "https://api-web.nhle.com/v1/network/tv-schedule/now"

Odds

Get Partner Game Odds

  • Endpoint: /v1/partner-game/{country-code}/now
  • Method: GET
  • Description: Retrieve odds for games in a specific country as of the current moment.
  • Parameters:
    • country-code (string) - Country code
  • Response: JSON format
Example using cURL:
curl -L -X GET "https://api-web.nhle.com/v1/partner-game/US/now"

Playoff Information

Overview

Playoff Series Carousel

  • Endpoint: /v1/playoff-series/carousel/{season}/
  • Method: GET
  • Description: Retrieve an overview of each playoff series.
  • Parameters:
    • 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.
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/playoff-series/carousel/20232024/"

Schedule

Get Playoff Series Schedule

  • Endpoint: /v1/schedule/playoff-series/{season}/{series_letter}/
  • Method: GET
  • Description: Retrieve the schedule for a specific playoff series.
  • Parameters:
    • 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.
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/schedule/playoff-series/20232024/a"

Bracket

Get Playoff Bracket

  • Endpoint: /v1/playoff-bracket/{year}
  • Method: GET
  • Description: Retrieve the current bracket for a specific year's playoffs.
  • Parameters:
    • year (int) - Year in YYYY format
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/playoff-bracket/2022"

Season

Get Seasons

  • Endpoint: /v1/season
  • Method: GET
  • Description: Retrieve a list of all season IDs past & present in the NHL.
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/season"

Draft

Get Draft Rankings

  • Endpoint /v1/draft/rankings/now
  • Method: GET
  • Description: Retrieve a list of all draft prospects by category of prospect as of the current moment.
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/draft/rankings/now"

Get Draft Rankings by Date

  • Endpoint /v1/draft/rankings/{season}/{prospect_category}
  • Method: GET
  • Description: Retrieve a list of all draft prospects by category of prospect for a specific season.
  • Parameters:
    • season (int) - Season in YYYY format
    • prospect_category (int) - Prospect Category (1 - North American Skater, 2 - International Skater, 3 - North American Goalie, 4 - International Goalie)
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/draft/rankings/2023/1"

Get Draft Tracker Now

  • Endpoint: /v1/draft-tracker/picks/now
  • Method: GET
  • Description: Retrieve current draft tracker information with the most recent draft picks.
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/draft-tracker/picks/now"

Get Draft Picks Now

  • Endpoint: /v1/draft/picks/now
  • Method: GET
  • Description: Retrieve the most recent draft picks information.
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/draft/picks/now"

Get Draft Picks

  • Endpoint https://api-web.nhle.com/v1/draft/picks/{season}/{round}
  • Method: GET
  • Description: Retrieve a list of draft picks for a specific season.
  • Parameters:
    • season (int) - Season in YYYY format
    • round (string) - Selectable round (1-7, 1 for round 1 etc.) or all for all selectable rounds
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/draft/picks/2023/all"

Miscellaneous

Meta

Get Meta Information

  • Endpoint: /v1/meta
  • Method: GET
  • Description: Retrieve meta information.
  • Request Parameters:
    • players (query, string) - Optional
    • teams (query, string) - Optional
    • seasonStates (query, string) - Optional (Unsure what the options might be here)
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/meta?players=8478402&teams=EDM,TOR"

Get Game Information

  • Endpoint: /v1/meta/game/{game-id}
  • Method: GET
  • Description: Retrieve information for a specific game.
  • Parameters:
    • game-id (int) - Game ID
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/meta/game/2023020204"

Get Location

  • Endpoint: /v1/location
  • Method: GET
  • Description: Returns country code that the webserver thinks the user is in.
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/location"

Get Playoff Series Metadata

  • Endpoint: /v1/meta/playoff-series/{year}/{series_letter}
  • Method: GET
  • Description: Retrieve metadata for a specific playoff series.
  • Parameters:
    • year (int) - Year in YYYY format
    • series_letter (string) - Single letter identifying the playoff series
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/meta/playoff-series/2023/a"

Postal Lookup

Get Postal Code Information

  • Endpoint: /v1/postal-lookup/{postalCode}
  • Method: GET
  • Description: Retrieves information based on a postal code.
  • Parameters:
    • postalCode (string) - Postal (or zip) code to look up
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/postal-lookup/90210"

Game Replays

Get Goal Replay

  • Endpoint: /v1/ppt-replay/goal/{game-id}/{event-number}
  • Method: GET
  • Description: Retrieves goal replay information for a specific game and event.
  • Parameters:
    • game-id (int) - Game ID
    • event-number (int) - Event number within the game
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/ppt-replay/goal/2023020204/12"

Get Play Replay

  • Endpoint: /v1/ppt-replay/{game-id}/{event-number}
  • Method: GET
  • Description: Retrieves replay information for a specific game and event.
  • Parameters:
    • game-id (int) - Game ID
    • event-number (int) - Event number within the game
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/ppt-replay/2023020204/12"

Additional Game Content

Get Game Right Rail Content

  • Endpoint: /v1/gamecenter/{game-id}/right-rail
  • Method: GET
  • Description: Retrieves sidebar content for the game center view.
  • Parameters:
    • game-id (int) - Game ID
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/gamecenter/2023020204/right-rail"

Get WSC Play By Play

  • Endpoint: /v1/wsc/play-by-play/{game-id}
  • Method: GET
  • Description: Retrieves WSC (World Showcase) play-by-play information for a specific game.
  • Parameters:
    • game-id (int) - Game ID
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/wsc/play-by-play/2023020204"

OpenAPI Specification

Get OpenAPI Specification

  • Endpoint: /model/v1/openapi.json
  • Method: GET
  • Description: Retrieve the OpenAPI specification. (Seems to return 404 currently)
  • Response: JSON or YAML format
Example using cURL:
curl -X GET "https://api-web.nhle.com/model/v1/openapi.json"

For the full WADL with extended resources: WADL Link

NHL Edge Data

Team Data

Team Details

  • Endpoint: /v1/edge/team-detail/{team-id}/{season}/{game-type}; /v1/edge/team-detail/{team-id}/now
  • Method: GET
  • Description: Retrieve team-based ranking for NHL Edge data
  • Parameters:
    • team-id (int) - Team ID
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/team-detail/9/20242025/2"

Team Landing

  • Endpoint: /v1/edge/team-detail/{season}/{game-type}; /v1/edge/team-detail/now
  • Method: GET
  • Description: Retrieve the leading team for each NHL Edge data point (shot attempts over 90, bursts over 22, distance per 60, high danger SOG, offensive, neutral and defensive zone time)
  • Parameters:
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/team-landing/20242025/2"

Team Comparison

  • Endpoint: /v1/edge/team-comparison/{team-id}/{season}/{game-type}; /v1/edge/team-comparison/{team-id}/now
  • Method: GET
  • Description: General information and comparison to league average for NHL Edge datapoints. Includes shots by location and shooting percentage by location.
  • Parameters:
    • team-id (int) - Team ID
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/team-comparison/9/20242025/2"

Team Skating Distance - Top 10

  • Endpoint: /v1/edge/team-skating-distance-top-10/{positions}/{strength}/{sort-by}/{season}{game-type}; /v1/edge/team-skating-distance-top-10/{positions}/{strength}/{sort-by}/now
  • Method: GET
  • Description: Retrieve team-based ranking for NHL Edge data - TODO
  • Parameters:
    • position (str) -
      • 'all' - Forwards and Defense
      • 'F' - Forwards
      • 'D' - Defense
    • strength (str) -
      • 'all' - All situations
      • 'pp' - Power-play
      • 'pk' - Penalty kill
      • 'es' - Even-strength
    • sort-by (str) - String - TODO
      • 'total' - Total distance skated
      • 'unknown' - Average distance skated per 60 - TODO
      • 'unknown' - Top distance skated in a game - TODO
      • 'unknown' - Top distance skated in a period - TODO
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/team-skating-distance-top-10/F/pp/{sort-by}/20242025/2"

Team Skating Distance - Detail

  • Endpoint: /v1/edge/team-skating-distance-detail/{team-id}/{season}/{game-type}; /v1/edge/team-skating-distance-detail/{team-id}/now
  • Method: GET
  • Description: Skating distance details for all situations and positions, both in last 10 games and in the season.
  • Parameters:
    • team-id (int) - Team ID
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/team-skating-distance-detail/9/20242025/2"

Team Skating Speed - Top 10

  • Endpoint: /v1/edge/team-skating-speed-top-10/{position}/{sort-by}/{season}/{game-type}; v1/edge/team-skating-speed-top-10/{positions}/{sort-by}/now
  • Method: GET
  • Description: Retrieve team-based ranking for NHL Edge data - TODO
  • Parameters:
    • position (str) -
      • 'all' - Forwards and Defense
      • 'F' - Forwards
      • 'D' - Defense
    • sort-by (str) - String - TODO
      • 'max' - Max skating speed
      • 'unknown' - 22 mph+ bursts
      • 'unknown' - 20 mph+ bursts
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/team-skating-speed-top-10/F/max/20242025/2"

Team Skating Speed - Detail

  • Endpoint: /v1/edge/team-skating-speed-detail/{team-id}/{season}/{game-type}; /v1/edge/team-skating-speed-detail/{team-id}/now
  • Method: GET
  • Description: Zone time details by situation (All Situations/Even Strength/Power Play/Penalty Kill)
  • Parameters:
    • team-id (int) - Team ID
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/team-skating-speed-detail/9/20242025/2"

Team Zone Time - Top 10

  • Endpoint: /v1/edge/team-zone-time-top-10/{strength}/{sort-by}/{season}/{game-type}; /v1/edge/team-zone-time-top-10/{strength}/{sort-by}/now
  • Method: GET
  • Description: Top 10 teams by specified zone time
  • Parameters:
    • strength (str) -
      • 'all' - All situations
      • 'pp' - Power-play
      • 'pk' - Penalty kill
      • 'es' - Even-strength
    • sort-by (str) -
      • 'offensive' - Offensive Zone
      • 'neutral' - Neutral Zone
      • 'defensive' - Defensive Zone
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/team-zone-time-top-10/es/offensive/20242025/2"

Team Zone Time - Details

  • Endpoint: /v1/edge/team-zone-time-details/{team-id}/{season}/{game-type}; /v1/edge/team-zone-time-details/{team-id}/now
  • Method: GET
  • Description: Zone time details by situation (All Situations/Even Strength/Power Play/Penalty Kill)
  • Parameters:
    • team-id (int) - Team ID
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/team-zone-time-details/9/20242025/2"

Team Shot Speed - Top 10

  • Endpoint: /v1/edge/team-shot-speed-top-10/{positions}/{sort-by}/{season}/{game-type}; /v1/edge/team-shot-speed-top-10/{positions}/{sort-by}/now
  • Method: GET
  • Description: Retrieve team-based ranking for NHL Edge data - TODO
  • Parameters:
    • position (str) -
      • 'all' - Forwards and Defense
      • 'F' - Forwards
      • 'D' - Defense
    • sort-by (str) - String - TODO
      • 'max' - Maximum shot speed
      • 'unknown' - 100+ mph - TODO
      • 'unknown' - 90+ mph - TODO
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-speed-top-10/F/{sort-by}/20242025/2"

Team Shot Speed - Detail

  • Endpoint: /v1/edge/team-shot-speed-detail/{team-id}/{season}/{game-type}; /v1/edge/team-shot-speed-detail/{team-id}/now
  • Method: GET
  • Description: Top 10 Shots by speed, shot speed details by position
  • Parameters:
    • team-id (int) - Team ID
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-speed-detail/9/20242025/2"

Team Shot Location - Top 10

  • Endpoint: /v1/edge/team-shot-location-top-10/{position}/{category}/{sort-by}/{season}/{game-type}; /v1/edge/team-shot-location-top-10/{position}/{category}/{sort-by}/now
  • Method: GET
  • Description: Retrieve team-based ranking for NHL Edge data - TODO
  • Parameters:
    • position (str) -
      • 'all' - Forwards and Defense
      • 'F' - Forwards
      • 'D' - Defense
    • category (str) - TODO
      • 'unknown' - All Locations
      • 'unknown' - High-Danger
      • 'unknown' - Mid-Range
      • 'unknown' - Long-Range
    • sort-by (str) - String - TODO
      • 'unknown' - Shots on Goal
      • 'unknown' - Goals
      • 'unknown' - Shooting Percentage
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-location-top-10/F/{category}/{sort-by}/20242025/2"

Team Shot Location - Detail

  • Endpoint: /v1/edge/team-shot-location-detail/{team-id}/{season}/{game-type}; /v1/edge/team-shot-location-detail/{team-id}/now
  • Method: GET
  • Description: Shot count by all locations and positions
  • Parameters:
    • team-id (int) - Team ID
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-location-detail/9/20242025/2"

Skater Data

Skater Detail

  • Endpoint: /v1/edge/skater-detail/{player-id}/{season}/{game-type}; /v1/edge/skater-detail/{player-id}/now
  • Method: GET
  • Description: Retrieve player rankings for NHL Edge data, Includes top shot speed, skating speed, distance skated, shot on goal summary/details, zone time percentages.
  • Parameters:
    • player-id (int) - Player ID
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/skater-detail/8482116/20242025/2"

Skater Landing

  • Endpoint: /v1/edge/skater-landing/{season}/{game-type}; /v1/edge/skater-landing/now
  • Method: GET
  • Description: Retrieve leading player for NHL Edge data, Includes top shot speed, skating speed, distance skated, high danger SOG, zone time percentages.
  • Parameters:
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/skater-landing/20242025/2"

Skater Comparison

  • Endpoint: /v1/edge/skater-comparison/{player-id}/{season}/{game-type}; /v1/edge/skater-comparison/{player-id}/now

  • Method: GET

  • Description: Retrieve NHL Edge data for the specified player, Includes skating distance and speed data, shot location and speed data, zone time details and zone starts.

  • Parameters:

    • player-id (int) - Player ID
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason

  • Response: JSON format

Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/skater-comparison/8482116/20242025/2"

Skater Distance - Top 10

  • Endpoint: /v1/edge/skater-distance-top-10/{positions}/{strength}/{sort-by}/{season}/{game-type}; /v1/edge/skater-distance-top-10/{positions}/{strength}/{sort-by}/now
  • Method: GET
  • Description: Retrieve top 10 skaters in skating distance based on the provided filters
  • Parameters:
    • position (str) -
      • 'all' - Forwards and Defense
      • 'F' - Forwards
      • 'D' - Defense
    • strength (str) -
      • 'all' - All situations
      • 'pp' - Power-play
      • 'pk' - Penalty kill
      • 'es' - Even-strength
    • sort-by (str) - String - TODO
      • 'total' - Total distance skated
      • 'unknown' - Average distance skated per 60 min
      • 'unknown' - Top distance skated in a game
      • 'unknown' - Top distance skated in a period
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/skater-distance-top-10/D/all/total/20242025/2"

Skater Skating Distance - Detail

  • Endpoint: /v1/edge/skater-skating-distance-detail/{player-id}/{season}/{game-type}; /v1/edge/skater-skating-distance-detail/{player-id}/now
  • Method: GET
  • Description: Shot count by all locations and positions
  • Parameters:
    • player-id (int) - Player ID
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/skater-skating-distance-detail/8482116/20242025/2"

Skater Speed - Top 10

  • Endpoint: /v1/edge/skater-speed-top-10/{positions}/{sort-by}/{season}/{game-type}; /v1/edge/skater-speed-top-10/{positions}/{sort-by}/now
  • Method: GET
  • Description: Retrieve 10 fastest skaters based on the provided filters.
  • Parameters:
    • position (str) -
      • 'all' - Forwards and Defense
      • 'F' - Forwards
      • 'D' - Defense
    • sort-by (str) - String - TODO
      • 'max' - Max skating speed
      • 'unknown' - 22 mph+ bursts
      • 'unknown' - 20 mph+ bursts
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/skater-speed-top-10/F/max/20242025/2"

Skater Skating Speed - Detail

  • Endpoint: /v1/edge/skater-skating-speed-detail/{player-id}/{season}/{game-type}; /v1/edge/skater-skating-speed-detail/{player-id}/now
  • Method: GET
  • Description: Retrieve top 10 skating speeds for the provided player. Also provides max skating speed, bursts over 22mph, bursts from 20 to 22mph and bursts from 18 to 20mph.
  • Parameters:
    • player-id (int) - Player ID
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/skater-skating-speed-detail/8482116/20242025/2"

Skater Zone Time - Top 10

  • Endpoint: /v1/edge/skater-zone-time-top-10/{positions}/{strength}/{sort-by}/{season}/{game-type}; /v1/edge/skater-zone-time-top-10/{positions}/{strength}/{sort-by}/now
  • Method: GET
  • Description: Retrieve 10 fastest skaters based on the provided filters.
  • Parameters:
    • position (str) -
      • 'all' - Forwards and Defense
      • 'F' - Forwards
      • 'D' - Defense
    • strength (str) -
      • 'all' - All situations
      • 'pp' - Power-play
      • 'pk' - Penalty kill
      • 'es' - Even-strength
    • sort-by (str) -
      • 'offensive' - Offensive Zone
      • 'neutral' - Neutral Zone
      • 'defensive' - Defensive Zone
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/skater-zone-time-top-10/F/all/offensive/20242025/2"

Skater Zone Time - Detail

  • Endpoint: /v1/edge/skater-zone-time/{player-id}/{season}/{game-type}; /v1/edge/skater-zone-time/{player-id}/now
  • Method: GET
  • Description: Zone time details by situation (All Situations/Even Strength/Power Play/Penalty Kill). Includes zone starts.
  • Parameters:
    • player-id (int) - Player ID
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/skater-zone-time/8482116/20242025/2"

Skater Shot Speed - Top 10

  • Endpoint: /v1/edge/skater-shot-speed-top-10/{positions}/{sort-by}/{season}/{game-type}; /v1/edge/skater-shot-speed-top-10/{positions}/{sort-by}/now
  • Method: GET
  • Description: Retrieve 10 players with the fastest shot based on the provided filters.
  • Parameters:
    • position (str) -
      • 'all' - Forwards and Defense
      • 'F' - Forwards
      • 'D' - Defense
    • sort-by (str) - String - TODO
      • 'max' - Max skating speed
      • 'unknown' - 100+ mph
      • 'unknown' - 90+ mph
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/skater-shot-speed-top-10/F/max/20242025/2"

Skater Shot Speed - Detail

  • Endpoint: /v1/edge/skater-shot-speed-detail/{player-id}/{season}/{game-type}; /v1/edge/skater-shot-speed-detail/{player-id}/now
  • Method: GET
  • Description: Provides the 10 hardest shots for a specified player. Includes top shot speed, average shot speed, shot attempts in the following groups: 100+, 90-100, 80-90, 70-80.
  • Parameters:
    • player-id (int) - Player ID
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/skater-shot-speed-detail/8482116/20242025/2"

Skater Shot Location - Top 10

  • Endpoint: /v1/edge/skater-shot-location-top-10/{position}/{category}/{sort-by}/{season}/{game-type}; /v1/edge/skater-shot-location-top-10/{position}/{category}/{sort-by}/now
  • Method: GET
  • Description: Presumably top 10 skaters based on the specified filters. -TODO
  • Parameters:
    • position (str) -
      • 'all' - Forwards and Defense
      • 'F' - Forwards
      • 'D' - Defense
    • category (str) - TODO
      • 'unknown' - All Locations
      • 'unknown' - High-Danger
      • 'unknown' - Mid-Range
      • 'unknown' - Long-Range
    • sort-by (str) - String - TODO
      • 'unknown' - Shots on Goal
      • 'unknown' - Goals
      • 'unknown' - Shooting Percentage
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/skater-shot-location-top-10/F/{category}/{sort-by}/20242025/2"

Skater Shot Location - Detail

  • Endpoint: /v1/edge/skater-shot-location-detail/{player-id}/{season}/{game-type}; /v1/edge/skater-shot-location-detail/{player-id}/now
  • Method: GET
  • Description: Provides information on shot location
  • Parameters:
    • player-id (int) - Player ID
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/skater-shot-location-detail/8482116/20242025/2"

CAT - Skater Detail

  • Endpoint: /v1/cat/edge/skater-detail/{player-id}/{season}/{game-type}; /v1/cat/edge/skater-detail/{player-id}/now
  • Method: GET
  • Description: Provides information on top shot speed, skating speed/distance, shots on goal summary/details and zone time details.
  • Parameters:
    • player-id (int) - Player ID
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/cat/edge/skater-detail/8482116/20242025/2"

Goalie Data

Goalie Detail

  • Endpoint: /v1/edge/goalie-detail/{player-id}/{season}/{game-type}; /v1/edge/goalie-detail/{player-id}/now
  • Method: GET
  • Description: Retrieve goalie rankings for NHL Edge data, Includes GAA, games above .900, goal differential per 60, average goal support, point percentage, shot location summary/details.
  • Parameters:
    • player-id (int) - Player ID
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/goalie-detail/8476999/20242025/2"

Goalie Landing

  • Endpoint: /v1/edge/goalie-landing/{season}/{game-type}; /v1/edge/goalie-landing/now
  • Method: GET
  • Description: Retrieve leading goalie for NHL Edge data, Includes high-danger save percentage/saves/goals against, save percentage at 5v5, games above .900.
  • Parameters:
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/goalie-landing/20242025/2"

Goalie Comparison

  • Endpoint: /v1/edge/goalie-comparison/{player-id}/{season}/{game-type}; /v1/edge/goalie-comparison/{player-id}/now
  • Method: GET
  • Description: Retrieve NHL Edge data for the specified player, Includes shot location summary/details, 5v5 save percentage in the last 10 games/details, overall save percentage in the last 10 games, and overall save percentage details.
  • Parameters:
    • player-id (int) - Player ID
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/goalie-comparison/8476999/20242025/2"

Goalie 5v5 - Top 10

  • Endpoint: /v1/edge/goalie-5v5-top-10/{sort-by}/{season}/{game-type}; /v1/edge/goalie-5v5-top-10/{sort-by}/now
  • Method: GET
  • Description: Top 10 goalies based on the specified filters.
  • Parameters:
    • sort-by (str) - String - TODO
      • 'shots' - Shots on Goal
      • Likely more parameters available
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/goalie-5v5-top-10/shots/20242025/2"

Goalie 5v5 - Detail

  • Endpoint: /v1/edge/goalie-5v5-detail/{player-id}/{season}/{game-type}; /v1/edge/goalie-5v5-detail/{player-id}/now
  • Method: GET
  • Description: 5v5 save percentage details for the specified player.
  • Parameters:
    • player-id (int) - Player ID
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/goalie-5v5-detail/8476999/20242025/2"

Goalie Shot Location - Top 10

  • Endpoint: /v1/edge/goalie-shot-location-top-10/{category}/{sort-by}/{season}/{game-type}; /v1/edge/goalie-shot-location-top-10/{category}/{sort-by}/now
  • Method: GET
  • Description: Presumably top 10 goalies based on the specified filters. -TODO
  • Parameters:
    • category (str) - TODO
      • 'unknown' - All Locations
      • 'unknown' - High-Danger
      • 'unknown' - Mid-Range
      • 'unknown' - Long-Range
    • sort-by (str) - String - TODO
      • 'unknown' - Shots Against
      • 'unknown' - Saves
      • 'unknown' - Goals Against
      • 'unknown' - Save %
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/goalie-shot-location-top-10/{category}/{sort-by}/20242025/2"

Goalie Shot Location - Detail

  • Endpoint: /v1/edge/goalie-shot-location-detail/{player-id}/{season}/{game-type}; /v1/edge/goalie-shot-location-detail/{player-id}/now
  • Method: GET
  • Description: Goalie shot location details for the specified player.
  • Parameters:
    • player-id (int) - Player ID
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/goalie-shot-location-detail/8476999/20242025/2"

Goalie Save Percentage - Top 10

  • Endpoint: /v1/edge/goalie-edge-save-pctg-top-10/{sort-by}/{season}/{game-type}; /v1/edge/goalie-edge-save-pctg-top-10/{sort-by}/now
  • Method: GET
  • Description: Unknown. -TODO
  • Parameters:
    • sort-by (str) - String - TODO
      • Unknown parameters
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/goalie-edge-save-pctg-top-10/{sort-by}/20242025/2"

Goalie Save Percentage - Detail

  • Endpoint: /v1/edge/goalie-save-percentage-detail/{player-id}/{season}/{game-type}; /v1/edge/goalie-save-percentage-detail/{player-id}/now
  • Method: GET
  • Description: Goalie save percentage details for the specified player. Contains save percentage in last 10 games, games above .900 and percentage of games above .900.
  • Parameters:
    • player-id (int) - Player ID
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/edge/goalie-save-percentage-detail/8476999/20242025/2"

CAT - Goalie Detail

  • Endpoint: /v1/cat/edge/goalie-detail/{player-id}/{season}/{game-type}; /v1/cat/edge/goalie-detail/{player-id}/now
  • Method: GET
  • Description: Provides information on GAA, games above .900, goal differential per 60, goal support average, point percentage, shot location summary/details.
  • Parameters:
    • player-id (int) - Player ID
    • season (int) - Season in YYYYYYYY format
    • game-type (int) - 2 for regular season, 3 for postseason
  • Response: JSON format
Example using cURL:
curl -X GET "https://api-web.nhle.com/v1/cat/edge/skater-detail/8482116/20242025/2"

Miscellaneous Data

https://api-web.nhle.com/v1/edge/by-the-numbers - Unknown

NHL Stats API Documentation

This section provides documentation for the NHL Stats API (https://api.nhle.com/stats/rest).

Base URL

All endpoints described in this section are relative to the following base URL:

https://api.nhle.com/stats/rest

Players

Players

Get Player Information

  • Endpoint: /{lang}/players
  • Method: GET
  • Description: Retrieve basic player information. (Responses limited to 5 results)
  • Parameters:
    • lang (string) - Language code
  • Request Parameters:
    • include (query, string) - Optional
    • exclude (query, string) - Optional
    • cayenneExp (query, string) - Optional
    • sort (query, string) - Optional
    • dir (query, string) - Optional
    • start (query, int) - Optional
    • limit (query, int) - Optional (Note: a limit of -1 will return all results)
  • Response: JSON format
Example using cURL:
curl -X GET "https://api.nhle.com/stats/rest/en/players?limit=3&sort=lastName&dir=asc&cayenneExp=currentTeamId=7"

Skaters

Get Skater Leaders

  • Endpoint: /{lang}/leaders/skaters/{attribute}
  • Method: GET
  • Description: Retrieve skater leaders for a specific attribute.
  • Parameters:
    • attribute (string) - Skater attribute
    • lang (string) - Language code
  • Response: JSON format
Example using cURL:
curl -X GET "https://api.nhle.com/stats/rest/en/leaders/skaters/points"

Get Skater Milestones

  • Endpoint: /{lang}/milestones/skaters
  • Method: GET
  • Description: Retrieve skater milestones.
  • Parameters:
    • lang (string) - Language code
  • Response: JSON format
Example using cURL:
curl -X GET "https://api.nhle.com/stats/rest/en/milestones/skaters"

Get Skater Information

  • Endpoint: /{lang}/skater
  • Method: GET
  • Description: Retrieve skater information.
  • Parameters:
    • lang (string) - Language code
  • Response: JSON format
Example using cURL:
curl -X GET "https://api.nhle.com/stats/rest/en/skater"

Get Skater Stats

  • Endpoint: /{lang}/skater/{report}
  • Method: GET
  • Description: Retrieve skater stats for a specific report.
  • Parameters:
    • report (string) - Skater report
    • lang (string) - Language code
  • Request Parameters:
    • isAggregate (query, boolean) - Optional
    • isGame (query, boolean) - Optional
    • factCayenneExp (query, string) - Optional
    • include (query, string) - Optional
    • exclude (query, string) - Optional
    • cayenneExp (query, string) - Required
    • sort (query, string) - Optional
    • dir (query, string) - Optional
    • start (query, int) - Optional
    • limit (query, int) - Optional (Note: a limit of -1 will return all results)
  • Response: JSON format
Example using cURL:
curl -X GET "https://api.nhle.com/stats/rest/en/skater/summary?limit=72&start=17&sort=points&cayenneExp=seasonId=20232024"

Goalies

Get Goalie Leaders

  • Endpoint: /{lang}/leaders/goalies/{attribute}
  • Method: GET
  • Description: Retrieve goalie leaders for a specific attribute.
  • Parameters:
    • attribute (string) - Goalie attribute
    • lang (string) - Language code
  • Response: JSON format
Example using cURL:
curl -X GET "https://api.nhle.com/stats/rest/en/leaders/goalies/gaa"

Get Goalie Stats

  • Endpoint: /{lang}/goalie/{report}
  • Method: GET
  • Description: Retrieve goalie stats for a specific report.
  • Parameters:
    • report (string) - Goalie report
    • lang (string) - Language code
  • Request Parameters:
    • isAggregate (query, boolean) - Optional
    • isGame (query, boolean) - Optional
    • factCayenneExp (query, string) - Optional
    • include (query, string) - Optional
    • exclude (query, string) - Optional
    • cayenneExp (query, string) - Required
    • sort (query, string) - Optional
    • dir (query, string) - Optional
    • start (query, int) - Optional
    • limit (query, int) - Optional (Note: a limit of -1 will return all results)
  • Response: JSON format
Example using cURL:
curl -X GET "https://api.nhle.com/stats/rest/en/goalie/summary?limit=72&start=15&sort=wins&cayenneExp=seasonId=20232024"

Get Goalie Milestones

  • Endpoint: /{lang}/milestones/goalies
  • Method: GET
  • Description: Retrieve goalie milestones.
  • Parameters:
    • lang (string) - Language code
  • Response: JSON format
Example using cURL:
curl -X GET "https://api.nhle.com/stats/rest/en/milestones/goalies"

Draft

Get Draft Information

  • Endpoint: /{lang}/draft
  • Method: GET
  • Description: Retrieve draft information.
  • Response: JSON format
Example using cURL:
curl -X GET "https://api.nhle.com/stats/rest/en/draft"

Teams

Get Team Information

  • Endpoint: /{lang}/team
  • Method: GET
  • Description: Retrieve list of all teams.
  • Parameters:
    • lang (string) - Language code
  • Response: JSON format
Example using cURL:
curl -X GET "https://api.nhle.com/stats/rest/en/team"

Get Team By ID

  • Endpoint: /{lang}/team/id/{id}
  • Method: GET
  • Description: Retrieve information for a specific team by ID.
  • Parameters:
    • lang (string) - Language code
    • id (string) - Team ID
  • Response: JSON format
Example using cURL:
curl -X GET "https://api.nhle.com/stats/rest/en/team/id/10"

Get Team Stats

  • Endpoint: /{lang}/team/{report}
  • Method: GET
  • Description: Retrieve team stats for a specific report.
  • Parameters:
    • report (string) - Team report
    • lang (string) - Language code
  • Request Parameters:
    • isAggregate (query, boolean) - Optional
    • isGame (query, boolean) - Optional
    • factCayenneExp (query, string) - Optional
    • include (query, string) - Optional
    • exclude (query, string) - Optional
    • cayenneExp (query, string) - Optional
    • sort (query, string) - Optional
    • dir (query, string) - Optional
    • start (query, int) - Optional
    • limit (query, int) - Optional (Note: a limit of -1 will return all results)
  • Response: JSON format
Example using cURL:
curl -X GET "https://api.nhle.com/stats/rest/en/team/summary?sort=shotsForPerGame&cayenneExp=seasonId=20232024%20and%20gameTypeId=2"

Get Franchise Information

  • Endpoint: /{lang}/franchise
  • Method: GET
  • Description: Retrieve list of all franchises.
  • Parameters:
    • lang (string) - Language code
  • Response: JSON format
Example using cURL:
curl -X GET "https://api.nhle.com/stats/rest/en/franchise"

Season

Get Component Season

  • Endpoint: /{lang}/componentSeason
  • Method: GET
  • Description: Retrieve component season information.
  • Response: JSON format
Example using cURL:
curl -X GET "https://api.nhle.com/stats/rest/en/componentSeason"

Get Season

  • Endpoint: /{lang}/season
  • Method: GET
  • Description: Retrieve season information.
  • Response: JSON format
Example using cURL:
curl -X GET "https://api.nhle.com/stats/rest/en/season"

Game

Get Game Information

  • Endpoint: /{lang}/game
  • Method: GET
  • Description: Retrieve game information.
  • Response: JSON format
Example using cURL:
curl -X GET "https://api.nhle.com/stats/rest/en/game"

Get Game Metadata

  • Endpoint: /{lang}/game/meta
  • Method: GET
  • Description: Retrieve metadata for game.
  • Parameters:
    • lang (string) - Language code
  • Response: JSON format
Example using cURL:
curl -X GET "https://api.nhle.com/stats/rest/en/game/meta"

Miscellaneous

Configuration

Get Configuration

  • Endpoint: /{lang}/config
  • Method: GET
  • Description: Retrieve configuration information.
  • Parameters:
    • lang (string) - Language code
  • Response: JSON format
Example using cURL:
curl -X GET "https://api.nhle.com/stats/rest/en/config"

Ping the Server

  • Endpoint: /ping
  • Method: GET
  • Description: Ping the server to check connectivity.
  • Response: JSON format
Example using cURL:
curl -X GET "https://api.nhle.com/stats/rest/ping"

Get Country Information

  • Endpoint: /{lang}/country
  • Method: GET
  • Description: Retrieve country information. Returns list of all countries with a hockey presence(?)
  • Parameters:
    • lang (string) - Language code
  • Response: JSON format
Example using cURL:
curl -X GET "https://api.nhle.com/stats/rest/en/country"

Get Shift Charts

  • Endpoint: /{lang}/shiftcharts?cayenneExp=gameId={game_id}
  • Method: GET
  • Description: Retrieve shift charts for a specific game.
  • Parameters:
    • lang (string) - Language code
    • game-id (int) - Game ID
  • Response: JSON format
Example using cURL:
curl -X GET "https://api.nhle.com/stats/rest/en/shiftcharts?cayenneExp=gameId=2021020001"

Glossary

Get Glossary

  • Endpoint: /{lang}/glossary
  • Method: GET
  • Description: Retrieve the glossary for a specific language.
  • Parameters:
    • lang (string) - Language code
  • Response: JSON format
Example using cURL:
curl -X GET "https://api.nhle.com/stats/rest/en/glossary"

Content Module

Get Content Module

  • Endpoint: /{lang}/content/module/{templateKey}
  • Method: GET
  • Description: Retrieve content module information for a specific template.
  • Parameters:
    • lang (string) - Language code
    • templateKey (string) - Template key/name
  • Response: JSON format
Example using cURL:
curl -X GET "https://api.nhle.com/stats/rest/en/content/module/overview"

For the full WADL with extended resources: WADL Link

About

Unofficial reference for the NHL API endpoints.

Resources

Readme

License

MIT license
Activity

Stars

458 stars

Watchers

34 watching

Forks

49 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 4