NHL API Documentation

https://github.com/zmalski/nhl-api-reference
Admin
This document aims to serve as an unofficial reference for the NHL APIs, detailing two primary API...
Tokens:22,116
Snippets:235
Trust Score:6.5
License:MIT
Update:3 months ago
Show doc for...
Tokens:
Raw
### Get Configuration

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves configuration information.

```bash
curl -X GET "https://api.nhle.com/stats/rest/en/config"
```

--------------------------------

### Get Glossary

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves the glossary for a specific language.

```bash
curl -X GET "https://api.nhle.com/stats/rest/en/glossary"
```

--------------------------------

### Get Game Information

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves game information.

```bash
curl -X GET "https://api.nhle.com/stats/rest/en/game"
```

--------------------------------

### Get Game Metadata

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves metadata for a game.

```bash
curl -X GET "https://api.nhle.com/stats/rest/en/game/meta"
```

--------------------------------

### Get Season

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves season information.

```bash
curl -X GET "https://api.nhle.com/stats/rest/en/season"
```

--------------------------------

### GET /{lang}/config

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve configuration information.

```APIDOC
## GET /{lang}/config

### Description
Retrieve configuration information.

### Method
GET

### Endpoint
/{lang}/config

### Parameters
#### Path Parameters
- **lang** (string) - Required - Language code
```

--------------------------------

### Get Component Season

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves component season information.

```bash
curl -X GET "https://api.nhle.com/stats/rest/en/componentSeason"
```

--------------------------------

### GET /{lang}/game

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve game information.

```APIDOC
## GET /{lang}/game

### Description
Retrieve game information.

### Method
GET

### Endpoint
/{lang}/game
```

--------------------------------

### GET /ping

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Ping the server to check connectivity.

```APIDOC
## GET /ping

### Description
Ping the server to check connectivity.

### Method
GET

### Endpoint
/ping
```

--------------------------------

### Get Streams

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves information about available streaming options.

```bash
curl -X GET "https://api-web.nhle.com/v1/where-to-watch"
```

--------------------------------

### GET /{lang}/componentSeason

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve component season information.

```APIDOC
## GET /{lang}/componentSeason

### Description
Retrieve component season information.

### Method
GET

### Endpoint
/{lang}/componentSeason
```

--------------------------------

### GET /{lang}/game/meta

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve metadata for game.

```APIDOC
## GET /{lang}/game/meta

### Description
Retrieve metadata for game.

### Method
GET

### Endpoint
/{lang}/game/meta

### Parameters
#### Path Parameters
- **lang** (string) - Required - Language code
```

--------------------------------

### GET /v1/where-to-watch

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve information about streaming options.

```APIDOC
## GET /v1/where-to-watch

### Description
Retrieve information about streaming options.

### Method
GET

### Endpoint
/v1/where-to-watch

### Parameters
#### Query Parameters
- **include** (string) - Optional
```

--------------------------------

### Get Content Module

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves content module information for a specific template.

```bash
curl -X GET "https://api.nhle.com/stats/rest/en/content/module/overview"
```

--------------------------------

### GET /model/v1/openapi.json

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve the OpenAPI specification.

```APIDOC
## GET /model/v1/openapi.json

### Description
Retrieve the OpenAPI specification.

### Method
GET

### Endpoint
/model/v1/openapi.json

### Response
#### Success Response (200)
- **JSON/YAML** - OpenAPI specification
```

--------------------------------

### Get Landing

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves landing page information for a specific game ID.

```bash
curl -X GET "https://api-web.nhle.com/v1/gamecenter/2023020204/landing"
```

--------------------------------

### GET /v1/meta/game/{game-id}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve information for a specific game.

```APIDOC
## GET /v1/meta/game/{game-id}

### Description
Retrieve information for a specific game.

### Method
GET

### Endpoint
/v1/meta/game/{game-id}

### Parameters
#### Path Parameters
- **game-id** (int) - Required - Game ID

### Response
#### Success Response (200)
- **JSON** - Game information object
```

--------------------------------

### Get Play By Play

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves play-by-play details for a specific game ID.

```bash
curl -X GET "https://api-web.nhle.com/v1/gamecenter/2023020204/play-by-play"
```

--------------------------------

### GET /v1/edge/skater-zone-time/{player-id}/{season}/{game-type}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Zone time details by situation (All Situations/Even Strength/Power Play/Penalty Kill). Includes zone starts.

```APIDOC
## GET /v1/edge/skater-zone-time/{player-id}/{season}/{game-type}

### Description
Zone time details by situation (All Situations/Even Strength/Power Play/Penalty Kill). Includes zone starts.

### Method
GET

### Endpoint
/v1/edge/skater-zone-time/{player-id}/{season}/{game-type}

### Parameters
#### Path Parameters
- **player-id** (int) - Required - Player ID
- **season** (int) - Required - Season in YYYYYYYY format
- **game-type** (int) - Required - 2 for regular season, 3 for postseason

### Response
#### Success Response (200)
- **JSON** - Zone time details
```

--------------------------------

### GET /v1/standings/now

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve the standings as of the current moment.

```APIDOC
## GET /v1/standings/now

### Description
Retrieve the standings as of the current moment.

### Method
GET

### Endpoint
/v1/standings/now

### Response
- JSON format
```

--------------------------------

### GET /v1/network/tv-schedule/now

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve the current TV schedule.

```APIDOC
## GET /v1/network/tv-schedule/now

### Description
Retrieve the current TV schedule.

### Method
GET

### Endpoint
/v1/network/tv-schedule/now
```

--------------------------------

### GET /v1/wsc/play-by-play/{game-id}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves WSC play-by-play information for a specific game.

```APIDOC
## GET /v1/wsc/play-by-play/{game-id}

### Description
Retrieves WSC (World Showcase) play-by-play information for a specific game.

### Method
GET

### Endpoint
/v1/wsc/play-by-play/{game-id}

### Parameters
#### Path Parameters
- **game-id** (int) - Required - Game ID

### Response
#### Success Response (200)
- **JSON** - Play-by-play information
```

--------------------------------

### Get Scoreboard

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves the overall scoreboard for the current moment.

```bash
curl -L -X GET "https://api-web.nhle.com/v1/scoreboard/now"
```

--------------------------------

### Get Draft Information via cURL

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve draft information.

```bash
curl -X GET "https://api.nhle.com/stats/rest/en/draft"
```

--------------------------------

### GET /v1/gamecenter/{game-id}/play-by-play

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve play-by-play information for a specific game.

```APIDOC
## GET /v1/gamecenter/{game-id}/play-by-play

### Description
Retrieve play-by-play information for a specific game.

### Method
GET

### Endpoint
/v1/gamecenter/{game-id}/play-by-play

### Parameters
#### Path Parameters
- **game-id** (int) - Required - Game ID
```

--------------------------------

### GET /v1/scoreboard/now

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve the overall scoreboard as of the current moment.

```APIDOC
## GET /v1/scoreboard/now

### Description
Retrieve the overall scoreboard as of the current moment.

### Method
GET

### Endpoint
/v1/scoreboard/now
```

--------------------------------

### Get Daily Scores Now

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves the current daily scores.

```bash
curl -L -X GET "https://api-web.nhle.com/v1/score/now"
```

--------------------------------

### Get Club Season Stats Overview

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Returns an overview of stats for each season for a specific club, indicating gametypes played.

```bash
curl -X GET "https://api-web.nhle.com/v1/club-stats-season/TOR"
```

--------------------------------

### Get Month Schedule As of Now

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves the current monthly schedule for a specified team.

```bash
curl -L -X GET "https://api-web.nhle.com/v1/club-schedule/TOR/month/now"
```

--------------------------------

### GET /v1/schedule/now

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve the current NHL schedule.

```APIDOC
## GET /v1/schedule/now

### Description
Retrieve the current schedule.

### Method
GET

### Endpoint
/v1/schedule/now

### Response
- JSON format
```

--------------------------------

### Get Game Story

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves the game story for a specific game ID.

```bash
curl -X GET "https://api-web.nhle.com/v1/wsc/game-story/2023020204"
```

--------------------------------

### GET /v1/player-spotlight

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve information about players in the "spotlight".

```APIDOC
## GET /v1/player-spotlight

### Description
Retrieve information about players in the "spotlight".

### Method
GET

### Endpoint
/v1/player-spotlight

### Response
- JSON format
```

--------------------------------

### Get Current TV Schedule

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves the current TV schedule.

```bash
curl -L -X GET "https://api-web.nhle.com/v1/network/tv-schedule/now"
```

--------------------------------

### GET /{lang}/players

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve basic player information.

```APIDOC
## GET /{lang}/players

### Description
Retrieve basic player information. Responses are limited to 5 results.

### Method
GET

### Endpoint
/{lang}/players

### Parameters
#### Path Parameters
- **lang** (string) - Required - Language code

#### Query Parameters
- **include** (string) - Optional - Include fields
- **exclude** (string) - Optional - Exclude fields
- **cayenneExp** (string) - Optional - Cayenne expression filter
- **sort** (string) - Optional - Sort field
- **dir** (string) - Optional - Sort direction
- **start** (int) - Optional - Start index
- **limit** (int) - Optional - Limit results (use -1 for all)

### Response
#### Success Response (200)
- **JSON** - Player information data
```

--------------------------------

### Get Season Standings Information

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves information regarding standings for each season.

```bash
curl -X GET "https://api-web.nhle.com/v1/standings-season"
```

--------------------------------

### Get Team Prospects

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves the list of prospects for a specific team.

```bash
curl -X GET "https://api-web.nhle.com/v1/prospects/TOR"
```

--------------------------------

### Get Goalie Milestones via cURL

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve goalie milestones.

```bash
curl -X GET "https://api.nhle.com/stats/rest/en/milestones/goalies"
```

--------------------------------

### GET /v1/meta

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve meta information such as players, teams, and season states.

```APIDOC
## GET /v1/meta

### Description
Retrieve meta information.

### Method
GET

### Endpoint
/v1/meta

### Parameters
#### Query Parameters
- **players** (string) - Optional - List of player IDs
- **teams** (string) - Optional - List of team abbreviations
- **seasonStates** (string) - Optional - Season state information

### Response
#### Success Response (200)
- **JSON** - Meta information object
```

--------------------------------

### GET /{lang}/glossary

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve the glossary for a specific language.

```APIDOC
## GET /{lang}/glossary

### Description
Retrieve the glossary for a specific language.

### Method
GET

### Endpoint
/{lang}/glossary

### Parameters
#### Path Parameters
- **lang** (string) - Required - Language code
```

--------------------------------

### GET /v1/prospects/{team}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve prospects for a specific team.

```APIDOC
## GET /v1/prospects/{team}

### Description
Retrieve prospects for a specific team.

### Method
GET

### Endpoint
/v1/prospects/{team}

### Parameters
#### Path Parameters
- **team** (string) - Required - Three-letter team code

### Response
- JSON format
```

--------------------------------

### GET /v1/network/tv-schedule/{date}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve the TV schedule for a specific date.

```APIDOC
## GET /v1/network/tv-schedule/{date}

### Description
Retrieve the TV schedule for a specific date.

### Method
GET

### Endpoint
/v1/network/tv-schedule/{date}

### Parameters
#### Path Parameters
- **date** (string) - Required - Date in YYYY-MM-DD format
```

--------------------------------

### GET /v1/standings/{date}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve the standings for a specific date.

```APIDOC
## GET /v1/standings/{date}

### Description
Retrieve the standings for a specific date.

### Method
GET

### Endpoint
/v1/standings/{date}

### Parameters
#### Path Parameters
- **date** (string) - Required - Date in YYYY-MM-DD format

### Response
- JSON format
```

--------------------------------

### GET /v1/wsc/game-story/{game-id}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve game story information for a specific game.

```APIDOC
## GET /v1/wsc/game-story/{game-id}

### Description
Retrieve game story information for a specific game.

### Method
GET

### Endpoint
/v1/wsc/game-story/{game-id}

### Parameters
#### Path Parameters
- **game-id** (int) - Required - Game ID
```

--------------------------------

### GET /v1/draft/picks/now

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve the most recent draft picks information.

```APIDOC
## GET /v1/draft/picks/now

### Description
Retrieve the most recent draft picks information.

### Method
GET

### Endpoint
/v1/draft/picks/now
```

--------------------------------

### GET /v1/schedule-calendar/now

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve the schedule calendar as of the current moment.

```APIDOC
## GET /v1/schedule-calendar/now

### Description
Retrieve the schedule calendar as of the current moment.

### Method
GET

### Endpoint
/v1/schedule-calendar/now

### Response
- JSON format
```

--------------------------------

### GET /v1/goalie-stats-leaders/current

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve current goalie stats leaders.

```APIDOC
## GET /v1/goalie-stats-leaders/current

### Description
Retrieve current goalie stats leaders.

### Method
GET

### Endpoint
/v1/goalie-stats-leaders/current

### Parameters
#### Query Parameters
- **categories** (string) - Optional - Stats category
- **limit** (int) - Optional - Number of results to return (-1 for all)

### Response
- JSON format
```

--------------------------------

### GET /v1/edge/skater-comparison/{player-id}/{season}/{game-type}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

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

```APIDOC
## GET /v1/edge/skater-comparison/{player-id}/{season}/{game-type}

### 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.

### Method
GET

### Endpoint
/v1/edge/skater-comparison/{player-id}/{season}/{game-type}

### Parameters
#### Path Parameters
- **player-id** (int) - Required - Player ID
- **season** (int) - Required - Season in YYYYYYYY format
- **game-type** (int) - Required - 2 for regular season, 3 for postseason

### Response
#### Success Response (200)
- **JSON** (object) - JSON format
```

--------------------------------

### GET /v1/ppt-replay/{game-id}/{event-number}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves replay information for a specific game and event.

```APIDOC
## GET /v1/ppt-replay/{game-id}/{event-number}

### Description
Retrieves replay information for a specific game and event.

### Method
GET

### Endpoint
/v1/ppt-replay/{game-id}/{event-number}

### Parameters
#### Path Parameters
- **game-id** (int) - Required - Game ID
- **event-number** (int) - Required - Event number within the game

### Response
#### Success Response (200)
- **JSON** - Replay information
```

--------------------------------

### GET /v1/standings-season

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves information for each season's standings.

```APIDOC
## GET /v1/standings-season

### Description
Retrieves information for each season's standings.

### Method
GET

### Endpoint
/v1/standings-season

### Response
- JSON format
```

--------------------------------

### GET /v1/skater-stats-leaders/current

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve current skater stats leaders.

```APIDOC
## GET /v1/skater-stats-leaders/current

### Description
Retrieve current skater stats leaders.

### Method
GET

### Endpoint
/v1/skater-stats-leaders/current

### Parameters
#### Query Parameters
- **categories** (string) - Optional - Stats category
- **limit** (int) - Optional - Number of results to return (-1 for all)

### Response
- JSON format
```

--------------------------------

### Get Country Information

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves a list of countries with a hockey presence.

```bash
curl -X GET "https://api.nhle.com/stats/rest/en/country"
```

--------------------------------

### GET /v1/player/{player}/landing

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve information for a specific player.

```APIDOC
## GET /v1/player/{player}/landing

### Description
Retrieve information for a specific player.

### Method
GET

### Endpoint
/v1/player/{player}/landing

### Parameters
#### Path Parameters
- **player** (int) - Required - Player ID

### Response
- JSON format
```

--------------------------------

### Get Team Roster by Season

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves the roster for a specific team and season in YYYYYYYY format.

```bash
curl -X GET "https://api-web.nhle.com/v1/roster/TOR/20232024"
```

--------------------------------

### Retrieve Specific Player Info

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Fetches landing page information for a specific player.

```bash
curl -X GET "https://api-web.nhle.com/v1/player/8478402/landing"
```

--------------------------------

### GET /{lang}/shiftcharts

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve shift charts for a specific game.

```APIDOC
## GET /{lang}/shiftcharts

### Description
Retrieve shift charts for a specific game.

### Method
GET

### Endpoint
/{lang}/shiftcharts?cayenneExp=gameId={game_id}

### Parameters
#### Path Parameters
- **lang** (string) - Required - Language code

#### Query Parameters
- **game-id** (int) - Required - Game ID
```

--------------------------------

### Get Current Standings

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves the league standings as of the current moment.

```bash
curl -L -X GET "https://api-web.nhle.com/v1/standings/now"
```

--------------------------------

### GET /v1/player/{player}/game-log/now

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve the game log for a specific player as of the current moment.

```APIDOC
## GET /v1/player/{player}/game-log/now

### Description
Retrieve the game log for a specific player as of the current moment.

### Method
GET

### Endpoint
/v1/player/{player}/game-log/now

### Parameters
#### Path Parameters
- **player** (int) - Required - Player ID

### Response
- JSON format
```

--------------------------------

### GET /{lang}/content/module/{templateKey}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve content module information for a specific template.

```APIDOC
## GET /{lang}/content/module/{templateKey}

### Description
Retrieve content module information for a specific template.

### Method
GET

### Endpoint
/{lang}/content/module/{templateKey}

### Parameters
#### Path Parameters
- **lang** (string) - Required - Language code
- **templateKey** (string) - Required - Template key/name
```

--------------------------------

### GET /v1/roster-season/{team}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Returns a list of all of the seasons that the team played.

```APIDOC
## GET /v1/roster-season/{team}

### Description
Seems to just return a list of all of the seasons that the team played.

### Method
GET

### Endpoint
/v1/roster-season/{team}

### Parameters
#### Path Parameters
- **team** (string) - Required - Three-letter team code

### Response
- JSON format
```

--------------------------------

### GET /{lang}/country

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve country information.

```APIDOC
## GET /{lang}/country

### Description
Retrieve country information. Returns list of all countries with a hockey presence.

### Method
GET

### Endpoint
/{lang}/country

### Parameters
#### Path Parameters
- **lang** (string) - Required - Language code
```

--------------------------------

### Get Skater Information via cURL

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve skater information.

```bash
curl -X GET "https://api.nhle.com/stats/rest/en/skater"
```

--------------------------------

### GET /v1/club-schedule/{team}/month/{month}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve the monthly schedule for a specific team and month.

```APIDOC
## GET /v1/club-schedule/{team}/month/{month}

### Description
Retrieve the monthly schedule for a specific team and month.

### Method
GET

### Endpoint
/v1/club-schedule/{team}/month/{month}

### Parameters
#### Path Parameters
- **team** (string) - Required - Three-letter team code
- **month** (string) - Required - Month in YYYY-MM format

### Response
#### Success Response (200)
- **JSON** - Monthly schedule data
```

--------------------------------

### GET /v1/draft/rankings/now

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve a list of all draft prospects by category of prospect as of the current moment.

```APIDOC
## GET /v1/draft/rankings/now

### Description
Retrieve a list of all draft prospects by category of prospect as of the current moment.

### Method
GET

### Endpoint
/v1/draft/rankings/now
```

--------------------------------

### GET /v1/roster/{team}/{season}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve the roster for a specific team and season.

```APIDOC
## GET /v1/roster/{team}/{season}

### Description
Retrieve the roster for a specific team and season.

### Method
GET

### Endpoint
/v1/roster/{team}/{season}

### Parameters
#### Path Parameters
- **team** (string) - Required - Three-letter team code
- **season** (int) - Required - Season in YYYYYYYY format

### Response
- JSON format
```

--------------------------------

### Get Skater Milestones via cURL

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve skater milestones.

```bash
curl -X GET "https://api.nhle.com/stats/rest/en/milestones/skaters"
```

--------------------------------

### GET /v1/playoff-series/carousel/{season}/

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve an overview of each playoff series for a given season.

```APIDOC
## GET /v1/playoff-series/carousel/{season}/

### Description
Retrieve an overview of each playoff series.

### Method
GET

### Endpoint
/v1/playoff-series/carousel/{season}/

### Parameters
#### Path Parameters
- **season** (int) - Required - 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
```

--------------------------------

### Get TV Schedule by Date

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves the TV schedule for a specific date in YYYY-MM-DD format.

```bash
curl -X GET "https://api-web.nhle.com/v1/network/tv-schedule/2023-11-10"
```

--------------------------------

### Get Team Roster Seasons

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Returns a list of all seasons a specific team has played.

```bash
curl -X GET "https://api-web.nhle.com/v1/roster-season/TOR"
```

--------------------------------

### GET /v1/gamecenter/{game-id}/landing

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve landing information for a specific game.

```APIDOC
## GET /v1/gamecenter/{game-id}/landing

### Description
Retrieve landing information for a specific game.

### Method
GET

### Endpoint
/v1/gamecenter/{game-id}/landing

### Parameters
#### Path Parameters
- **game-id** (int) - Required - Game ID
```

--------------------------------

### Retrieve WSC Play By Play

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Fetches World Showcase play-by-play information for a specific game.

```bash
curl -X GET "https://api-web.nhle.com/v1/wsc/play-by-play/2023020204"
```

--------------------------------

### Retrieve Skater Zone Time Detail

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Fetches zone time statistics and zone starts for a specific player.

```bash
curl -X GET "https://api-web.nhle.com/v1/edge/skater-zone-time/8482116/20242025/2"
```

--------------------------------

### Get Week Schedule As of Now

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves the current weekly schedule for a specified team.

```bash
curl -L -X GET "https://api-web.nhle.com/v1/club-schedule/TOR/week/now"
```

--------------------------------

### Get Standings by Date

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves the league standings for a specific date in YYYY-MM-DD format.

```bash
curl -X GET "https://api-web.nhle.com/v1/standings/2023-11-10"
```

--------------------------------

### GET /v1/edge/team-skating-speed-detail/{team-id}/{season}/{game-type}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Zone time details by situation.

```APIDOC
## GET /v1/edge/team-skating-speed-detail/{team-id}/{season}/{game-type}

### Description
Zone time details by situation (All Situations/Even Strength/Power Play/Penalty Kill).

### Method
GET

### Endpoint
/v1/edge/team-skating-speed-detail/{team-id}/{season}/{game-type}

### Parameters
#### Path Parameters
- **team-id** (int) - Required - Team ID
- **season** (int) - Required - Season in YYYYYYYY format
- **game-type** (int) - Required - 2 for regular season, 3 for postseason

### Response
- JSON format
```

--------------------------------

### GET /{lang}/season

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve season information.

```APIDOC
## GET /{lang}/season

### Description
Retrieve season information.

### Method
GET

### Endpoint
/{lang}/season
```

--------------------------------

### GET /v1/player/{player}/game-log/{season}/{game-type}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve the game log for a specific player, season, and game type.

```APIDOC
## GET /v1/player/{player}/game-log/{season}/{game-type}

### Description
Retrieve the game log for a specific player, season, and game type.

### Method
GET

### Endpoint
/v1/player/{player}/game-log/{season}/{game-type}

### Parameters
#### Path Parameters
- **player** (int) - Required - Player ID
- **season** (int) - Required - Season in YYYYYYYY format
- **game-type** (int) - Required - Game type (e.g., 2 for regular season, 3 for playoffs)

### Response
- JSON format
```

--------------------------------

### GET /v1/schedule/{date}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve the NHL schedule for a specific date.

```APIDOC
## GET /v1/schedule/{date}

### Description
Retrieve the schedule for a specific date.

### Method
GET

### Endpoint
/v1/schedule/{date}

### Parameters
#### Path Parameters
- **date** (string) - Required - Date format: YYYY-MM-DD

### Response
- JSON format
```

--------------------------------

### GET /v1/club-stats-season/{team}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Returns an overview of the stats for each season for a specific club.

```APIDOC
## GET /v1/club-stats-season/{team}

### Description
Returns an overview of the stats for each season for a specific club. Seems to only indicate the gametypes played in each season.

### Method
GET

### Endpoint
/v1/club-stats-season/{team}

### Parameters
#### Path Parameters
- **team** (string) - Required - Three-letter team code

### Response
- JSON format
```

--------------------------------

### GET /v1/schedule-calendar/{date}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve the schedule calendar for a specific date.

```APIDOC
## GET /v1/schedule-calendar/{date}

### Description
Retrieve the schedule calendar for a specific date.

### Method
GET

### Endpoint
/v1/schedule-calendar/{date}

### Parameters
#### Path Parameters
- **date** (string) - Required - Date in YYYY-MM-DD format

### Response
- JSON format
```

--------------------------------

### Get Shift Charts

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves shift charts for a specific game ID.

```bash
curl -X GET "https://api.nhle.com/stats/rest/en/shiftcharts?cayenneExp=gameId=2021020001"
```

--------------------------------

### Retrieve OpenAPI Specification

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Fetches the OpenAPI specification file for the API.

```bash
curl -X GET "https://api-web.nhle.com/model/v1/openapi.json"
```

--------------------------------

### GET /v1/edge/team-comparison/{team-id}/{season}/{game-type}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

General information and comparison to league average for NHL Edge datapoints.

```APIDOC
## GET /v1/edge/team-comparison/{team-id}/{season}/{game-type}

### Description
General information and comparison to league average for NHL Edge datapoints. Includes shots by location and shooting percentage by location.

### Method
GET

### Endpoint
/v1/edge/team-comparison/{team-id}/{season}/{game-type}

### Parameters
#### Path Parameters
- **team-id** (int) - Required - Team ID
- **season** (int) - Required - Season in YYYYYYYY format
- **game-type** (int) - Required - 2 for regular season, 3 for postseason

### Response
- JSON format
```

--------------------------------

### Retrieve Skater Landing Data

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Fetches leading player data for NHL Edge metrics.

```bash
curl -X GET "https://api-web.nhle.com/v1/edge/skater-landing/20242025/2"
```

--------------------------------

### Retrieve Goalie Detail

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Fetches comprehensive goalie rankings and performance statistics.

```bash
curl -X GET "https://api-web.nhle.com/v1/edge/goalie-detail/8476999/20242025/2"
```

--------------------------------

### GET /v1/edge/goalie-5v5-detail/{player-id}/{season}/{game-type}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve 5v5 save percentage details for the specified goalie.

```APIDOC
## GET /v1/edge/goalie-5v5-detail/{player-id}/{season}/{game-type}

### Description
5v5 save percentage details for the specified player.

### Method
GET

### Endpoint
/v1/edge/goalie-5v5-detail/{player-id}/{season}/{game-type}

### Parameters
#### Path Parameters
- **player-id** (int) - Required - Player ID
- **season** (int) - Required - Season in YYYYYYYY format
- **game-type** (int) - Required - 2 for regular season, 3 for postseason

### Response
- JSON format
```

--------------------------------

### GET /v1/club-schedule-season/{team}/{season}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve the season schedule for a specific team and season.

```APIDOC
## GET /v1/club-schedule-season/{team}/{season}

### Description
Retrieve the season schedule for a specific team and season.

### Method
GET

### Endpoint
/v1/club-schedule-season/{team}/{season}

### Parameters
#### Path Parameters
- **team** (string) - Required - Three-letter team code
- **season** (int) - Required - Season in YYYYYYYY format

### Response
#### Success Response (200)
- **JSON** - Season schedule data
```

--------------------------------

### GET /v1/club-schedule/{team}/month/now

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve the monthly schedule for a specific team as of the current moment.

```APIDOC
## GET /v1/club-schedule/{team}/month/now

### Description
Retrieve the monthly schedule for a specific team as of the current moment.

### Method
GET

### Endpoint
/v1/club-schedule/{team}/month/now

### Parameters
#### Path Parameters
- **team** (string) - Required - Three-letter team code

### Response
#### Success Response (200)
- **JSON** - Monthly schedule data
```

--------------------------------

### GET /v1/club-schedule/{team}/week/{date}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve the weekly schedule for a specific team and date.

```APIDOC
## GET /v1/club-schedule/{team}/week/{date}

### Description
Retrieve the weekly schedule for a specific team and date.

### Method
GET

### Endpoint
/v1/club-schedule/{team}/week/{date}

### Parameters
#### Path Parameters
- **team** (string) - Required - Three-letter team code
- **date** (string) - Required - Date in YYYY-MM-DD format

### Response
#### Success Response (200)
- **JSON** - Weekly schedule data
```

--------------------------------

### GET /v1/ppt-replay/goal/{game-id}/{event-number}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves goal replay information for a specific game and event.

```APIDOC
## GET /v1/ppt-replay/goal/{game-id}/{event-number}

### Description
Retrieves goal replay information for a specific game and event.

### Method
GET

### Endpoint
/v1/ppt-replay/goal/{game-id}/{event-number}

### Parameters
#### Path Parameters
- **game-id** (int) - Required - Game ID
- **event-number** (int) - Required - Event number within the game

### Response
#### Success Response (200)
- **JSON** - Goal replay information
```

--------------------------------

### Get Player Information via cURL

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve player data with filtering and sorting parameters.

```bash
curl -X GET "https://api.nhle.com/stats/rest/en/players?limit=3&sort=lastName&dir=asc&cayenneExp=currentTeamId=7"
```

--------------------------------

### GET /v1/schedule/playoff-series/{season}/{series_letter}/

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve the schedule for a specific playoff series.

```APIDOC
## GET /v1/schedule/playoff-series/{season}/{series_letter}/

### Description
Retrieve the schedule for a specific playoff series.

### Method
GET

### Endpoint
/v1/schedule/playoff-series/{season}/{series_letter}/

### Parameters
#### Path Parameters
- **season** (int) - Required - 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) - Required - Single letter indicating which series to retrieve. Is sequential in alphabetical order.

### Response
- JSON format
```

--------------------------------

### Retrieve Player Game Log As of Now

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Fetches the current game log for a specific player.

```bash
curl -L -X GET "https://api-web.nhle.com/v1/player/8478402/game-log/now"
```

--------------------------------

### GET /v1/edge/team-skating-distance-detail/{team-id}/{season}/{game-type}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Skating distance details for all situations and positions.

```APIDOC
## GET /v1/edge/team-skating-distance-detail/{team-id}/{season}/{game-type}

### Description
Skating distance details for all situations and positions, both in last 10 games and in the season.

### Method
GET

### Endpoint
/v1/edge/team-skating-distance-detail/{team-id}/{season}/{game-type}

### Parameters
#### Path Parameters
- **team-id** (int) - Required - Team ID
- **season** (int) - Required - Season in YYYYYYYY format
- **game-type** (int) - Required - 2 for regular season, 3 for postseason

### Response
- JSON format
```

--------------------------------

### GET /v1/draft-tracker/picks/now

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve current draft tracker information with the most recent draft picks.

```APIDOC
## GET /v1/draft-tracker/picks/now

### Description
Retrieve current draft tracker information with the most recent draft picks.

### Method
GET

### Endpoint
/v1/draft-tracker/picks/now
```

--------------------------------

### GET /{lang}/franchise

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve a list of all NHL franchises.

```APIDOC
## GET /{lang}/franchise

### Description
Retrieve list of all franchises.

### Method
GET

### Endpoint
/{lang}/franchise

### Parameters
#### Path Parameters
- **lang** (string) - Required - Language code
```

--------------------------------

### Retrieve draft rankings by season and category

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Fetches draft prospects for a specific season and category.

```bash
curl -X GET "https://api-web.nhle.com/v1/draft/rankings/2023/1"
```

--------------------------------

### GET /v1/draft/rankings/{season}/{prospect_category}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve a list of all draft prospects by category of prospect for a specific season.

```APIDOC
## GET /v1/draft/rankings/{season}/{prospect_category}

### Description
Retrieve a list of all draft prospects by category of prospect for a specific season.

### Method
GET

### Endpoint
/v1/draft/rankings/{season}/{prospect_category}

### Parameters
#### Path Parameters
- **season** (int) - Required - Season in YYYY format
- **prospect_category** (int) - Required - Prospect Category (1 - North American Skater, 2 - International Skater, 3 - North American Goalie, 4 - International Goalie)
```

--------------------------------

### Retrieve Goalie Comparison

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Fetches comparative performance data for a specific goalie.

```bash
curl -X GET "https://api-web.nhle.com/v1/edge/goalie-comparison/8476999/20242025/2"
```

--------------------------------

### GET /{lang}/team

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve a list of all NHL teams.

```APIDOC
## GET /{lang}/team

### Description
Retrieve list of all teams.

### Method
GET

### Endpoint
/{lang}/team

### Parameters
#### Path Parameters
- **lang** (string) - Required - Language code
```

--------------------------------

### GET /v1/club-schedule-season/{team}/now

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve the season schedule for a specific team as of the current moment.

```APIDOC
## GET /v1/club-schedule-season/{team}/now

### Description
Retrieve the season schedule for a specific team as of the current moment.

### Method
GET

### Endpoint
/v1/club-schedule-season/{team}/now

### Parameters
#### Path Parameters
- **team** (string) - Required - Three-letter team code

### Response
#### Success Response (200)
- **JSON** - Season schedule data
```

--------------------------------

### Get Team Season Schedule As of Now

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves the current season schedule for a specified team using a three-letter team code.

```bash
curl -L -X GET "https://api-web.nhle.com/v1/club-schedule-season/TOR/now"
```

--------------------------------

### Retrieve Spotlight Players

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Fetches information about players currently in the spotlight.

```bash
curl -X GET "https://api-web.nhle.com/v1/player-spotlight"
```

--------------------------------

### Get Month Schedule

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves the schedule for a specific team and month, where the month is formatted as YYYY-MM.

```bash
curl -X GET "https://api-web.nhle.com/v1/club-schedule/TOR/month/2023-11"
```

--------------------------------

### GET /v1/draft/picks/{season}/{round}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve a list of draft picks for a specific season.

```APIDOC
## GET /v1/draft/picks/{season}/{round}

### Description
Retrieve a list of draft picks for a specific season.

### Method
GET

### Endpoint
/v1/draft/picks/{season}/{round}

### Parameters
#### Path Parameters
- **season** (int) - Required - Season in YYYY format
- **round** (string) - Required - Selectable round (1-7, 1 for round 1 etc.) or all for all selectable rounds
```

--------------------------------

### GET /v1/club-stats/{team}/now

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve current statistics for a specific club.

```APIDOC
## GET /v1/club-stats/{team}/now

### Description
Retrieve current statistics for a specific club.

### Method
GET

### Endpoint
/v1/club-stats/{team}/now

### Parameters
#### Path Parameters
- **team** (string) - Required - Three-letter team code

### Response
- JSON format
```

--------------------------------

### Retrieve Goalie 5v5 Detail

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Fetches 5v5 save percentage details for a specific goalie.

```bash
curl -X GET "https://api-web.nhle.com/v1/edge/goalie-5v5-detail/8476999/20242025/2"
```

--------------------------------

### Get Current Team Roster

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieves the roster for a specific team as of the current moment.

```bash
curl -L -X GET "https://api-web.nhle.com/v1/roster/TOR/current"
```

--------------------------------

### GET /v1/roster/{team}/current

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve the roster for a specific team as of the current moment.

```APIDOC
## GET /v1/roster/{team}/current

### Description
Retrieve the roster for a specific team as of the current moment.

### Method
GET

### Endpoint
/v1/roster/{team}/current

### Parameters
#### Path Parameters
- **team** (string) - Required - Three-letter team code

### Response
- JSON format
```

--------------------------------

### GET /v1/club-schedule/{team}/week/now

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve the weekly schedule for a specific team as of the current moment.

```APIDOC
## GET /v1/club-schedule/{team}/week/now

### Description
Retrieve the weekly schedule for a specific team as of the current moment.

### Method
GET

### Endpoint
/v1/club-schedule/{team}/week/now

### Parameters
#### Path Parameters
- **team** (string) - Required - Three-letter team code

### Response
#### Success Response (200)
- **JSON** - Weekly schedule data
```

--------------------------------

### GET /v1/score/now

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve daily scores as of the current moment.

```APIDOC
## GET /v1/score/now

### Description
Retrieve daily scores as of the current moment.

### Method
GET

### Endpoint
/v1/score/now
```

--------------------------------

### Retrieve Team Comparison

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Fetches general team information and comparisons to league averages for NHL Edge metrics.

```bash
curl -X GET "https://api-web.nhle.com/v1/edge/team-comparison/9/20242025/2"
```

--------------------------------

### GET /v1/edge/skater-zone-time-top-10/{positions}/{strength}/{sort-by}/{season}/{game-type}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve 10 fastest skaters based on the provided filters.

```APIDOC
## GET /v1/edge/skater-zone-time-top-10/{positions}/{strength}/{sort-by}/{season}/{game-type}

### Description
Retrieve 10 fastest skaters based on the provided filters.

### Method
GET

### Endpoint
/v1/edge/skater-zone-time-top-10/{positions}/{strength}/{sort-by}/{season}/{game-type}

### Parameters
#### Path Parameters
- **positions** (str) - Required - 'all', 'F', or 'D'
- **strength** (str) - Required - 'all', 'pp', 'pk', or 'es'
- **sort-by** (str) - Required - 'offensive', 'neutral', or 'defensive'
- **season** (int) - Required - Season in YYYYYYYY format
- **game-type** (int) - Required - 2 for regular season, 3 for postseason

### Response
#### Success Response (200)
- **JSON** - List of top 10 skaters
```

--------------------------------

### GET /v1/scoreboard/{team}/now

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve the scoreboard for a specific team as of the current moment.

```APIDOC
## GET /v1/scoreboard/{team}/now

### Description
Retrieve the scoreboard for a specific team as of the current moment.

### Method
GET

### Endpoint
/v1/scoreboard/{team}/now

### Parameters
#### Path Parameters
- **team** (string) - Required - Three-letter team code

### Response
- JSON format
```

--------------------------------

### GET /v1/goalie-stats-leaders/{season}/{game-type}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve goalie stats leaders for a specific season and game type.

```APIDOC
## GET /v1/goalie-stats-leaders/{season}/{game-type}

### Description
Retrieve goalie stats leaders for a specific season and game type.

### Method
GET

### Endpoint
/v1/goalie-stats-leaders/{season}/{game-type}

### Parameters
#### Path Parameters
- **season** (int) - Required - Season in YYYYYYYY format
- **game-type** (int) - Required - Game type
#### Query Parameters
- **categories** (string) - Optional - Stats category
- **limit** (int) - Optional - Number of results to return (-1 for all)

### Response
- JSON format
```

--------------------------------

### Retrieve Game Information

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Fetches details for a specific game using its unique game ID.

```bash
curl -X GET "https://api-web.nhle.com/v1/meta/game/2023020204"
```

--------------------------------

### GET /v1/edge/skater-speed-top-10/{positions}/{sort-by}/{season}/{game-type}

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Retrieve 10 fastest skaters based on the provided filters.

```APIDOC
## GET /v1/edge/skater-speed-top-10/{positions}/{sort-by}/{season}/{game-type}

### Description
Retrieve 10 fastest skaters based on the provided filters.

### Method
GET

### Endpoint
/v1/edge/skater-speed-top-10/{positions}/{sort-by}/{season}/{game-type}

### Parameters
#### Path Parameters
- **positions** (str) - Required - 'all', 'F', or 'D'
- **sort-by** (str) - Required - 'max'
- **season** (int) - Required - Season in YYYYYYYY format
- **game-type** (int) - Required - 2 for regular season, 3 for postseason

### Response
#### Success Response (200)
- **JSON** (object) - JSON format
```

--------------------------------

### Retrieve Skater Comparison

Source: https://github.com/zmalski/nhl-api-reference/blob/main/README.md

Fetches comparative NHL Edge data for a specific player.

```bash
curl -X GET "https://api-web.nhle.com/v1/edge/skater-comparison/8482116/20242025/2"
```
Tokens:
Raw