From c42ff6f5f83a574fed4e09c61201e174370d6c28 Mon Sep 17 00:00:00 2001 From: Dillon Johnson <158092981+johnsondillond@users.noreply.github.com> Date: Tue, 25 Nov 2025 11:49:35 -0700 Subject: [PATCH 1/7] Add shot location endpoint keys Added endpoint values for both top 10 skaters and team shot location endpoints --- README.md | 488 ++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 325 insertions(+), 163 deletions(-) diff --git a/README.md b/README.md index b056c44..b4814fd 100644 --- a/README.md +++ b/README.md @@ -6,138 +6,301 @@ Please note that there appears to be *two* primary sources for official NHL APIs ## Table of Contents ### [api-web.nhle.com](#nhl-web-api-documentation) -1. [Base URL](#base-url) -2. [Player Information](#player-information) - 1. [Players](#players) - 1. [Get Game Log](#get-game-log) - 2. [Get Specific Player Info](#get-specific-player-info) - 3. [Get Game Log As of Now](#get-game-log-as-of-now) - 2. [Skaters](#skaters) - 1. [Get Current Skater Stats Leaders](#get-current-skater-stats-leaders) - 2. [Get Skater Stats Leaders for a Specific Season and Game Type](#get-skater-stats-leaders-for-a-specific-season-and-game-type) - 3. [Goalies](#goalies) - 1. [Get Current Goalie Stats Leaders](#get-current-goalie-stats-leaders) - 2. [Get Goalie Stats Leaders by Season](#get-goalie-stats-leaders-by-season) - 4. [Player Spotlight](#player-spotlight) - 1. [Get Players](#get-players) -3. [Team Information](#team-information) - 1. [Standings](#standings) - 1. [Get Standings](#get-standings) - 2. [Get Standings by Date](#get-standings-by-date) - 3. [Get Standings information for each Season](#get-standings-information-for-each-season) - 2. [Stats](#stats) - 1. [Get Club Stats Now](#get-club-stats-now) - 2. [Get Club Stats for the Season for a Team](#get-club-stats-for-the-season-for-a-team) - 3. [Get Club Stats by Season and Game Type](#get-club-stats-by-season-and-game-type) - 4. [Get Team Scoreboard](#get-team-scoreboard) - 3. [Roster](#roster) - 1. [Get Team Roster As of Now](#get-team-roster-as-of-now) - 2. [Get Team Roster by Season](#get-team-roster-by-season) - 3. [Get Roster Season for Team](#get-roster-season-for-team) - 4. [Get Team Prospects](#get-team-prospects) - 4. [Schedule](#schedule) - 1. [Get Team Season Schedule As of Now](#get-team-season-schedule-as-of-now) - 2. [Get Team Season Schedule](#get-team-season-schedule) - 3. [Get Month Schedule As of Now](#get-month-schedule-as-of-now) - 4. [Get Month Schedule](#get-month-schedule) - 5. [Get Week Schedule](#get-week-schedule) - 6. [Get Week Schedule As of Now](#get-week-schedule-as-of-now) -4. [League Schedule Information](#league-schedule-information) - 1. [Schedule](#schedule-1) - 1. [Get Current Schedule](#get-current-schedule) - 2. [Get Schedule by Date](#get-schedule-by-date) - 2. [Schedule Calendar](#schedule-calendar) - 1. [Get Schedule Calendar As of Now](#get-schedule-calendar-as-of-now) - 2. [Get Schedule Calendar for a Specific Date](#get-schedule-calendar-for-a-specific-date) -5. [Game Information](#game-information) - 1. [Daily Scores](#daily-scores) - 1. [Get Daily Scores As of Now](#get-daily-scores-as-of-now) - 2. [Get Daily Scores by Date](#get-daily-scores-by-date) - 3. [Get Scoreboard](#get-scoreboard) - 2. [Where to Watch](#where-to-watch) - 1. [Get Streams](#get-streams) - 3. [Game Events](#game-events) - 1. [Get Play By Play](#get-play-by-play) - 2. [Get Landing](#get-landing) - 3. [Get Boxscore](#get-boxscore) - 4. [Get Game Story](#get-game-story) - 4. [Network](#network) - 1. [Get TV Schedule for a Specific Date](#get-tv-schedule-for-a-specific-date) - 2. [Get Current TV Schedule](#get-current-tv-schedule) - 5. [Odds](#odds) - 1. [Get Partner Game Odds](#get-partner-game-odds) -6. [Playoff Information](#playoff-information) - 1. [Overview](#overview) - 1. [Playoff Series Carousel](#playoff-series-carousel) - 2. [Schedule](#schedule-2) - 1. [Get Playoff Series Schedule](#get-playoff-series-schedule) - 3. [Bracket](#bracket) - 1. [Get Playoff Bracket](#get-playoff-bracket) -7. [Season](#season) - 1. [Get Seasons](#get-seasons) -8. [Draft](#draft) - 1. [Get Draft Rankings](#get-draft-rankings) - 2. [Get Draft Rankings by Date](#get-draft-rankings-by-date) - 3. [Get Draft Tracker Now](#get-draft-tracker-now) - 4. [Get Draft Picks Now](#get-draft-picks-now) - 5. [Get Draft Picks](#get-draft-picks) -9. [Miscellaneous](#miscellaneous) - 1. [Meta](#meta) - 1. [Get Meta Information](#get-meta-information) - 2. [Get Game Information](#get-game-information) - 3. [Get Location](#get-location) - 4. [Get Playoff Series Metadata](#get-playoff-series-metadata) - 2. [Postal Lookup](#postal-lookup) - 1. [Get Postal Code Information](#get-postal-code-information) - 3. [Game Replays](#game-replays) - 1. [Get Goal Replay](#get-goal-replay) - 2. [Get Play Replay](#get-play-replay) - 4. [Additional Game Content](#additional-game-content) - 1. [Get Game Right Rail Content](#get-game-right-rail-content) - 2. [Get WSC Play By Play](#get-wsc-play-by-play) - 5. [OpenAPI Specification](#openapi-specification) - 1. [Get OpenAPI Specification](#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) +- [NHL API Documentation](#nhl-api-documentation) + - [Table of Contents](#table-of-contents) + - [api-web.nhle.com](#api-webnhlecom) + - [api.nhle.com/stats/rest](#apinhlecomstatsrest) +- [NHL Web API Documentation](#nhl-web-api-documentation) + - [Base URL](#base-url) + - [Player Information](#player-information) + - [Players](#players) + - [Get Game Log](#get-game-log) + - [Example using cURL:](#example-using-curl) + - [Get Specific Player Info](#get-specific-player-info) + - [Example using cURL:](#example-using-curl-1) + - [Get Game Log As of Now](#get-game-log-as-of-now) + - [Example using cURL:](#example-using-curl-2) + - [Skaters](#skaters) + - [Get Current Skater Stats Leaders](#get-current-skater-stats-leaders) + - [Example using cURL:](#example-using-curl-3) + - [Get Skater Stats Leaders for a Specific Season and Game Type](#get-skater-stats-leaders-for-a-specific-season-and-game-type) + - [Example using cURL:](#example-using-curl-4) + - [Goalies](#goalies) + - [Get Current Goalie Stats Leaders](#get-current-goalie-stats-leaders) + - [Example using cURL:](#example-using-curl-5) + - [Get Goalie Stats Leaders by Season](#get-goalie-stats-leaders-by-season) + - [Example using cURL:](#example-using-curl-6) + - [Player Spotlight](#player-spotlight) + - [Get Players](#get-players) + - [Example using cURL:](#example-using-curl-7) + - [Team Information](#team-information) + - [Standings](#standings) + - [Get Standings](#get-standings) + - [Example using cURL:](#example-using-curl-8) + - [Get Standings by Date](#get-standings-by-date) + - [Example using cURL:](#example-using-curl-9) + - [Get Standings information for each Season](#get-standings-information-for-each-season) + - [Example using cURL:](#example-using-curl-10) + - [Stats](#stats) + - [Get Club Stats Now](#get-club-stats-now) + - [Example using cURL:](#example-using-curl-11) + - [Get Club Stats for the Season for a Team](#get-club-stats-for-the-season-for-a-team) + - [Example using cURL:](#example-using-curl-12) + - [Get Club Stats by Season and Game Type](#get-club-stats-by-season-and-game-type) + - [Example using cURL:](#example-using-curl-13) + - [Get Team Scoreboard](#get-team-scoreboard) + - [Example using cURL:](#example-using-curl-14) + - [Roster](#roster) + - [Get Team Roster As of Now](#get-team-roster-as-of-now) + - [Example using cURL:](#example-using-curl-15) + - [Get Team Roster by Season](#get-team-roster-by-season) + - [Example using cURL:](#example-using-curl-16) + - [Get Roster Season for Team](#get-roster-season-for-team) + - [Example using cURL:](#example-using-curl-17) + - [Get Team Prospects](#get-team-prospects) + - [Example using cURL:](#example-using-curl-18) + - [Schedule](#schedule) + - [Get Team Season Schedule As of Now](#get-team-season-schedule-as-of-now) + - [Example using cURL:](#example-using-curl-19) + - [Get Team Season Schedule](#get-team-season-schedule) + - [Example using cURL:](#example-using-curl-20) + - [Get Month Schedule As of Now](#get-month-schedule-as-of-now) + - [Example using cURL:](#example-using-curl-21) + - [Get Month Schedule](#get-month-schedule) + - [Example using cURL:](#example-using-curl-22) + - [Get Week Schedule](#get-week-schedule) + - [Example using cURL:](#example-using-curl-23) + - [Get Week Schedule As of Now](#get-week-schedule-as-of-now) + - [Example using cURL:](#example-using-curl-24) + - [League Schedule Information](#league-schedule-information) + - [Schedule](#schedule-1) + - [Get Current Schedule](#get-current-schedule) + - [Example using cURL:](#example-using-curl-25) + - [Get Schedule by Date](#get-schedule-by-date) + - [Example using cURL:](#example-using-curl-26) + - [Schedule Calendar](#schedule-calendar) + - [Get Schedule Calendar As of Now](#get-schedule-calendar-as-of-now) + - [Example using cURL:](#example-using-curl-27) + - [Get Schedule Calendar for a Specific Date](#get-schedule-calendar-for-a-specific-date) + - [Example using cURL:](#example-using-curl-28) + - [Game Information](#game-information) + - [Daily Scores](#daily-scores) + - [Get Daily Scores As of Now](#get-daily-scores-as-of-now) + - [Example using cURL:](#example-using-curl-29) + - [Get Daily Scores by Date](#get-daily-scores-by-date) + - [Example using cURL:](#example-using-curl-30) + - [Get Scoreboard](#get-scoreboard) + - [Example using cURL:](#example-using-curl-31) + - [Where to Watch](#where-to-watch) + - [Get Streams](#get-streams) + - [Example using cURL:](#example-using-curl-32) + - [Game Events](#game-events) + - [Get Play By Play](#get-play-by-play) + - [Example using cURL:](#example-using-curl-33) + - [Get Landing](#get-landing) + - [Example using cURL:](#example-using-curl-34) + - [Get Boxscore](#get-boxscore) + - [Example using cURL:](#example-using-curl-35) + - [Get Game Story](#get-game-story) + - [Example using cURL:](#example-using-curl-36) + - [Network](#network) + - [Get TV Schedule for a Specific Date](#get-tv-schedule-for-a-specific-date) + - [Example using cURL:](#example-using-curl-37) + - [Get Current TV Schedule](#get-current-tv-schedule) + - [Example using cURL:](#example-using-curl-38) + - [Odds](#odds) + - [Get Partner Game Odds](#get-partner-game-odds) + - [Example using cURL:](#example-using-curl-39) + - [Playoff Information](#playoff-information) + - [Overview](#overview) + - [Playoff Series Carousel](#playoff-series-carousel) + - [Example using cURL:](#example-using-curl-40) + - [Schedule](#schedule-2) + - [Get Playoff Series Schedule](#get-playoff-series-schedule) + - [Example using cURL:](#example-using-curl-41) + - [Bracket](#bracket) + - [Get Playoff Bracket](#get-playoff-bracket) + - [Example using cURL:](#example-using-curl-42) + - [Season](#season) + - [Get Seasons](#get-seasons) + - [Example using cURL:](#example-using-curl-43) + - [Draft](#draft) + - [Get Draft Rankings](#get-draft-rankings) + - [Example using cURL:](#example-using-curl-44) + - [Get Draft Rankings by Date](#get-draft-rankings-by-date) + - [Example using cURL:](#example-using-curl-45) + - [Get Draft Tracker Now](#get-draft-tracker-now) + - [Example using cURL:](#example-using-curl-46) + - [Get Draft Picks Now](#get-draft-picks-now) + - [Example using cURL:](#example-using-curl-47) + - [Get Draft Picks](#get-draft-picks) + - [Example using cURL:](#example-using-curl-48) + - [Miscellaneous](#miscellaneous) + - [Meta](#meta) + - [Get Meta Information](#get-meta-information) + - [Example using cURL:](#example-using-curl-49) + - [Get Game Information](#get-game-information) + - [Example using cURL:](#example-using-curl-50) + - [Get Location](#get-location) + - [Example using cURL:](#example-using-curl-51) + - [Get Playoff Series Metadata](#get-playoff-series-metadata) + - [Example using cURL:](#example-using-curl-52) + - [Postal Lookup](#postal-lookup) + - [Get Postal Code Information](#get-postal-code-information) + - [Example using cURL:](#example-using-curl-53) + - [Game Replays](#game-replays) + - [Get Goal Replay](#get-goal-replay) + - [Example using cURL:](#example-using-curl-54) + - [Get Play Replay](#get-play-replay) + - [Example using cURL:](#example-using-curl-55) + - [Additional Game Content](#additional-game-content) + - [Get Game Right Rail Content](#get-game-right-rail-content) + - [Example using cURL:](#example-using-curl-56) + - [Get WSC Play By Play](#get-wsc-play-by-play) + - [Example using cURL:](#example-using-curl-57) + - [OpenAPI Specification](#openapi-specification) + - [Get OpenAPI Specification](#get-openapi-specification) + - [Example using cURL:](#example-using-curl-58) + - [NHL Edge Data](#nhl-edge-data) + - [Team Data](#team-data) + - [Team Details](#team-details) + - [Example using cURL:](#example-using-curl-59) + - [Team Landing](#team-landing) + - [Example using cURL:](#example-using-curl-60) + - [Team Comparison](#team-comparison) + - [Example using cURL:](#example-using-curl-61) + - [Team Skating Distance - Top 10](#team-skating-distance---top-10) + - [Example using cURL:](#example-using-curl-62) + - [Team Skating Distance - Detail](#team-skating-distance---detail) + - [Example using cURL:](#example-using-curl-63) + - [Team Skating Speed - Top 10](#team-skating-speed---top-10) + - [Example using cURL:](#example-using-curl-64) + - [Team Skating Speed - Detail](#team-skating-speed---detail) + - [Example using cURL:](#example-using-curl-65) + - [Team Zone Time - Top 10](#team-zone-time---top-10) + - [Example using cURL:](#example-using-curl-66) + - [Team Zone Time - Details](#team-zone-time---details) + - [Example using cURL:](#example-using-curl-67) + - [Team Shot Speed - Top 10](#team-shot-speed---top-10) + - [Example using cURL:](#example-using-curl-68) + - [Team Shot Speed - Detail](#team-shot-speed---detail) + - [Example using cURL:](#example-using-curl-69) + - [Team Shot Location - Top 10](#team-shot-location---top-10) + - [Example using cURL:](#example-using-curl-70) + - [Team Shot Location - Detail](#team-shot-location---detail) + - [Example using cURL:](#example-using-curl-71) + - [](#) + - [Skater Data](#skater-data) + - [Skater Detail](#skater-detail) + - [Example using cURL:](#example-using-curl-72) + - [Skater Landing](#skater-landing) + - [Example using cURL:](#example-using-curl-73) + - [Skater Comparison](#skater-comparison) + - [Example using cURL:](#example-using-curl-74) + - [Skater Distance - Top 10](#skater-distance---top-10) + - [Example using cURL:](#example-using-curl-75) + - [Skater Skating Distance - Detail](#skater-skating-distance---detail) + - [Example using cURL:](#example-using-curl-76) + - [Skater Speed - Top 10](#skater-speed---top-10) + - [Example using cURL:](#example-using-curl-77) + - [Skater Skating Speed - Detail](#skater-skating-speed---detail) + - [Example using cURL:](#example-using-curl-78) + - [Skater Zone Time - Top 10](#skater-zone-time---top-10) + - [Example using cURL:](#example-using-curl-79) + - [Skater Zone Time - Detail](#skater-zone-time---detail) + - [Example using cURL:](#example-using-curl-80) + - [Skater Shot Speed - Top 10](#skater-shot-speed---top-10) + - [Example using cURL:](#example-using-curl-81) + - [Skater Shot Speed - Detail](#skater-shot-speed---detail) + - [Example using cURL:](#example-using-curl-82) + - [Skater Shot Location - Top 10](#skater-shot-location---top-10) + - [Example using cURL:](#example-using-curl-83) + - [Skater Shot Location - Detail](#skater-shot-location---detail) + - [Example using cURL:](#example-using-curl-84) + - [CAT - Skater Detail](#cat---skater-detail) + - [Example using cURL:](#example-using-curl-85) + - [Goalie Data](#goalie-data) + - [Goalie Detail](#goalie-detail) + - [Example using cURL:](#example-using-curl-86) + - [Goalie Landing](#goalie-landing) + - [Example using cURL:](#example-using-curl-87) + - [Goalie Comparison](#goalie-comparison) + - [Example using cURL:](#example-using-curl-88) + - [Goalie 5v5 - Top 10](#goalie-5v5---top-10) + - [Example using cURL:](#example-using-curl-89) + - [Goalie 5v5 - Detail](#goalie-5v5---detail) + - [Example using cURL:](#example-using-curl-90) + - [Goalie Shot Location - Top 10](#goalie-shot-location---top-10) + - [Example using cURL:](#example-using-curl-91) + - [Goalie Shot Location - Detail](#goalie-shot-location---detail) + - [Example using cURL:](#example-using-curl-92) + - [Goalie Save Percentage - Top 10](#goalie-save-percentage---top-10) + - [Example using cURL:](#example-using-curl-93) + - [Goalie Save Percentage - Detail](#goalie-save-percentage---detail) + - [Example using cURL:](#example-using-curl-94) + - [CAT - Goalie Detail](#cat---goalie-detail) + - [Example using cURL:](#example-using-curl-95) + - [Miscellaneous Data](#miscellaneous-data) +- [NHL Stats API Documentation](#nhl-stats-api-documentation) + - [Base URL](#base-url-1) + - [Players](#players-1) + - [Players](#players-2) + - [Get Player Information](#get-player-information) + - [Example using cURL:](#example-using-curl-96) + - [Skaters](#skaters-1) + - [Get Skater Leaders](#get-skater-leaders) + - [Example using cURL:](#example-using-curl-97) + - [Get Skater Milestones](#get-skater-milestones) + - [Example using cURL:](#example-using-curl-98) + - [Get Skater Information](#get-skater-information) + - [Example using cURL:](#example-using-curl-99) + - [Get Skater Stats](#get-skater-stats) + - [Example using cURL:](#example-using-curl-100) + - [Goalies](#goalies-1) + - [Get Goalie Leaders](#get-goalie-leaders) + - [Example using cURL:](#example-using-curl-101) + - [Get Goalie Stats](#get-goalie-stats) + - [Example using cURL:](#example-using-curl-102) + - [Get Goalie Milestones](#get-goalie-milestones) + - [Example using cURL:](#example-using-curl-103) + - [Draft](#draft-1) + - [Get Draft Information](#get-draft-information) + - [Example using cURL:](#example-using-curl-104) + - [Teams](#teams) + - [Get Team Information](#get-team-information) + - [Example using cURL:](#example-using-curl-105) + - [Get Team By ID](#get-team-by-id) + - [Example using cURL:](#example-using-curl-106) + - [Get Team Stats](#get-team-stats) + - [Example using cURL:](#example-using-curl-107) + - [Get Franchise Information](#get-franchise-information) + - [Example using cURL:](#example-using-curl-108) + - [Season](#season-1) + - [Get Component Season](#get-component-season) + - [Example using cURL:](#example-using-curl-109) + - [Get Season](#get-season) + - [Example using cURL:](#example-using-curl-110) + - [Game](#game) + - [Get Game Information](#get-game-information-1) + - [Example using cURL:](#example-using-curl-111) + - [Get Game Metadata](#get-game-metadata) + - [Example using cURL:](#example-using-curl-112) + - [Miscellaneous](#miscellaneous-1) + - [Configuration](#configuration) + - [Get Configuration](#get-configuration) + - [Example using cURL:](#example-using-curl-113) + - [Ping the Server](#ping-the-server) + - [Example using cURL:](#example-using-curl-114) + - [Get Country Information](#get-country-information) + - [Example using cURL:](#example-using-curl-115) + - [Get Shift Charts](#get-shift-charts) + - [Example using cURL:](#example-using-curl-116) + - [Glossary](#glossary) + - [Get Glossary](#get-glossary) + - [Example using cURL:](#example-using-curl-117) + - [Content Module](#content-module) + - [Get Content Module](#get-content-module) + - [Example using cURL:](#example-using-curl-118) --- ### [api.nhle.com/stats/rest](#nhl-stats-api-documentation) 1. [Base URL](#base-url-1) @@ -1321,23 +1484,23 @@ curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-speed-detail/9/20242025/ #### 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` +- **Endpoint**: `/v1/edge/team-shot-location-top-10/{position}/{sort-by}/{category}/{season}/{game-type}`; `/v1/edge/team-shot-location-top-10/{position}/{sort-by}/{category}/now` - **Method**: GET -- **Description**: Retrieve team-based ranking for NHL Edge data - **TODO** +- **Description**: Retrieve team-based ranking for NHL Edge data - **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 + - 'all' - Forwards and Defensemen + - 'forwards' - Forwards + - 'defense' - Defensemen + - `sort-by` (str) - String + - 'sog' - Shots on Goal + - 'goals' - Goals + - 'shooting-pctg' - Shooting Percentage + - `category` (str) + - 'all' - All Locations + - 'high' - High-Danger + - 'mid' - Mid-Range + - 'long' - Long-Range - `season` (int) - Season in YYYYYYYY format - `game-type` (int) - 2 for regular season, 3 for postseason - **Response**: JSON format @@ -1345,7 +1508,7 @@ curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-speed-detail/9/20242025/ ###### Example using cURL: ```bash -curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-location-top-10/F/{category}/{sort-by}/20242025/2" +curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-location-top-10/forwards/goals/all/20252026/2" ``` #### Team Shot Location - Detail @@ -1597,31 +1760,30 @@ curl -X GET "https://api-web.nhle.com/v1/edge/skater-shot-speed-detail/8482116/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` +- **Endpoint**: `/v1/edge/skater-shot-location-top-10/{position}/{sort-by}/{category}/{season}/{game-type}`; `/v1/edge/skater-shot-location-top-10/{position}/{sort-by}/{category}/now` - **Method**: GET -- **Description**: Presumably top 10 skaters based on the specified filters. -**TODO** +- **Description**: Presumably top 10 skaters based on the specified filters. - **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 + - 'all' - Forwards and Defensemen + - 'forwards' - Forwards + - 'defense' - Defensemen + - `sort-by` (str) - String + - 'sog' - Shots on Goal + - 'goals' - Goals + - 'shooting-pctg' - Shooting Percentage + - `category` (str) + - 'all' - All Locations + - 'high' - High-Danger + - 'mid' - Mid-Range + - 'long' - Long-Range - `season` (int) - Season in YYYYYYYY format - `game-type` (int) - 2 for regular season, 3 for postseason -- **Response**: JSON format ###### Example using cURL: ```bash -curl -X GET "https://api-web.nhle.com/v1/edge/skater-shot-location-top-10/F/{category}/{sort-by}/20242025/2" +curl -X GET "https://api-web.nhle.com/v1/edge/skater-shot-location-top-10/forwards/goals/high/now" ``` #### Skater Shot Location - Detail From 0b506cc683ecd00f5199f88abf7878f2eb26108c Mon Sep 17 00:00:00 2001 From: Dillon Johnson <158092981+johnsondillond@users.noreply.github.com> Date: Tue, 25 Nov 2025 11:55:15 -0700 Subject: [PATCH 2/7] Refine NHL API documentation in READMEFixed to only change the relevant sections Updated the README to refine the NHL API documentation structure and clarify endpoints. --- README.md | 472 ++++++++++++++++++------------------------------------ 1 file changed, 160 insertions(+), 312 deletions(-) diff --git a/README.md b/README.md index b4814fd..d870d3d 100644 --- a/README.md +++ b/README.md @@ -6,301 +6,138 @@ Please note that there appears to be *two* primary sources for official NHL APIs ## Table of Contents ### [api-web.nhle.com](#nhl-web-api-documentation) -- [NHL API Documentation](#nhl-api-documentation) - - [Table of Contents](#table-of-contents) - - [api-web.nhle.com](#api-webnhlecom) - - [api.nhle.com/stats/rest](#apinhlecomstatsrest) -- [NHL Web API Documentation](#nhl-web-api-documentation) - - [Base URL](#base-url) - - [Player Information](#player-information) - - [Players](#players) - - [Get Game Log](#get-game-log) - - [Example using cURL:](#example-using-curl) - - [Get Specific Player Info](#get-specific-player-info) - - [Example using cURL:](#example-using-curl-1) - - [Get Game Log As of Now](#get-game-log-as-of-now) - - [Example using cURL:](#example-using-curl-2) - - [Skaters](#skaters) - - [Get Current Skater Stats Leaders](#get-current-skater-stats-leaders) - - [Example using cURL:](#example-using-curl-3) - - [Get Skater Stats Leaders for a Specific Season and Game Type](#get-skater-stats-leaders-for-a-specific-season-and-game-type) - - [Example using cURL:](#example-using-curl-4) - - [Goalies](#goalies) - - [Get Current Goalie Stats Leaders](#get-current-goalie-stats-leaders) - - [Example using cURL:](#example-using-curl-5) - - [Get Goalie Stats Leaders by Season](#get-goalie-stats-leaders-by-season) - - [Example using cURL:](#example-using-curl-6) - - [Player Spotlight](#player-spotlight) - - [Get Players](#get-players) - - [Example using cURL:](#example-using-curl-7) - - [Team Information](#team-information) - - [Standings](#standings) - - [Get Standings](#get-standings) - - [Example using cURL:](#example-using-curl-8) - - [Get Standings by Date](#get-standings-by-date) - - [Example using cURL:](#example-using-curl-9) - - [Get Standings information for each Season](#get-standings-information-for-each-season) - - [Example using cURL:](#example-using-curl-10) - - [Stats](#stats) - - [Get Club Stats Now](#get-club-stats-now) - - [Example using cURL:](#example-using-curl-11) - - [Get Club Stats for the Season for a Team](#get-club-stats-for-the-season-for-a-team) - - [Example using cURL:](#example-using-curl-12) - - [Get Club Stats by Season and Game Type](#get-club-stats-by-season-and-game-type) - - [Example using cURL:](#example-using-curl-13) - - [Get Team Scoreboard](#get-team-scoreboard) - - [Example using cURL:](#example-using-curl-14) - - [Roster](#roster) - - [Get Team Roster As of Now](#get-team-roster-as-of-now) - - [Example using cURL:](#example-using-curl-15) - - [Get Team Roster by Season](#get-team-roster-by-season) - - [Example using cURL:](#example-using-curl-16) - - [Get Roster Season for Team](#get-roster-season-for-team) - - [Example using cURL:](#example-using-curl-17) - - [Get Team Prospects](#get-team-prospects) - - [Example using cURL:](#example-using-curl-18) - - [Schedule](#schedule) - - [Get Team Season Schedule As of Now](#get-team-season-schedule-as-of-now) - - [Example using cURL:](#example-using-curl-19) - - [Get Team Season Schedule](#get-team-season-schedule) - - [Example using cURL:](#example-using-curl-20) - - [Get Month Schedule As of Now](#get-month-schedule-as-of-now) - - [Example using cURL:](#example-using-curl-21) - - [Get Month Schedule](#get-month-schedule) - - [Example using cURL:](#example-using-curl-22) - - [Get Week Schedule](#get-week-schedule) - - [Example using cURL:](#example-using-curl-23) - - [Get Week Schedule As of Now](#get-week-schedule-as-of-now) - - [Example using cURL:](#example-using-curl-24) - - [League Schedule Information](#league-schedule-information) - - [Schedule](#schedule-1) - - [Get Current Schedule](#get-current-schedule) - - [Example using cURL:](#example-using-curl-25) - - [Get Schedule by Date](#get-schedule-by-date) - - [Example using cURL:](#example-using-curl-26) - - [Schedule Calendar](#schedule-calendar) - - [Get Schedule Calendar As of Now](#get-schedule-calendar-as-of-now) - - [Example using cURL:](#example-using-curl-27) - - [Get Schedule Calendar for a Specific Date](#get-schedule-calendar-for-a-specific-date) - - [Example using cURL:](#example-using-curl-28) - - [Game Information](#game-information) - - [Daily Scores](#daily-scores) - - [Get Daily Scores As of Now](#get-daily-scores-as-of-now) - - [Example using cURL:](#example-using-curl-29) - - [Get Daily Scores by Date](#get-daily-scores-by-date) - - [Example using cURL:](#example-using-curl-30) - - [Get Scoreboard](#get-scoreboard) - - [Example using cURL:](#example-using-curl-31) - - [Where to Watch](#where-to-watch) - - [Get Streams](#get-streams) - - [Example using cURL:](#example-using-curl-32) - - [Game Events](#game-events) - - [Get Play By Play](#get-play-by-play) - - [Example using cURL:](#example-using-curl-33) - - [Get Landing](#get-landing) - - [Example using cURL:](#example-using-curl-34) - - [Get Boxscore](#get-boxscore) - - [Example using cURL:](#example-using-curl-35) - - [Get Game Story](#get-game-story) - - [Example using cURL:](#example-using-curl-36) - - [Network](#network) - - [Get TV Schedule for a Specific Date](#get-tv-schedule-for-a-specific-date) - - [Example using cURL:](#example-using-curl-37) - - [Get Current TV Schedule](#get-current-tv-schedule) - - [Example using cURL:](#example-using-curl-38) - - [Odds](#odds) - - [Get Partner Game Odds](#get-partner-game-odds) - - [Example using cURL:](#example-using-curl-39) - - [Playoff Information](#playoff-information) - - [Overview](#overview) - - [Playoff Series Carousel](#playoff-series-carousel) - - [Example using cURL:](#example-using-curl-40) - - [Schedule](#schedule-2) - - [Get Playoff Series Schedule](#get-playoff-series-schedule) - - [Example using cURL:](#example-using-curl-41) - - [Bracket](#bracket) - - [Get Playoff Bracket](#get-playoff-bracket) - - [Example using cURL:](#example-using-curl-42) - - [Season](#season) - - [Get Seasons](#get-seasons) - - [Example using cURL:](#example-using-curl-43) - - [Draft](#draft) - - [Get Draft Rankings](#get-draft-rankings) - - [Example using cURL:](#example-using-curl-44) - - [Get Draft Rankings by Date](#get-draft-rankings-by-date) - - [Example using cURL:](#example-using-curl-45) - - [Get Draft Tracker Now](#get-draft-tracker-now) - - [Example using cURL:](#example-using-curl-46) - - [Get Draft Picks Now](#get-draft-picks-now) - - [Example using cURL:](#example-using-curl-47) - - [Get Draft Picks](#get-draft-picks) - - [Example using cURL:](#example-using-curl-48) - - [Miscellaneous](#miscellaneous) - - [Meta](#meta) - - [Get Meta Information](#get-meta-information) - - [Example using cURL:](#example-using-curl-49) - - [Get Game Information](#get-game-information) - - [Example using cURL:](#example-using-curl-50) - - [Get Location](#get-location) - - [Example using cURL:](#example-using-curl-51) - - [Get Playoff Series Metadata](#get-playoff-series-metadata) - - [Example using cURL:](#example-using-curl-52) - - [Postal Lookup](#postal-lookup) - - [Get Postal Code Information](#get-postal-code-information) - - [Example using cURL:](#example-using-curl-53) - - [Game Replays](#game-replays) - - [Get Goal Replay](#get-goal-replay) - - [Example using cURL:](#example-using-curl-54) - - [Get Play Replay](#get-play-replay) - - [Example using cURL:](#example-using-curl-55) - - [Additional Game Content](#additional-game-content) - - [Get Game Right Rail Content](#get-game-right-rail-content) - - [Example using cURL:](#example-using-curl-56) - - [Get WSC Play By Play](#get-wsc-play-by-play) - - [Example using cURL:](#example-using-curl-57) - - [OpenAPI Specification](#openapi-specification) - - [Get OpenAPI Specification](#get-openapi-specification) - - [Example using cURL:](#example-using-curl-58) - - [NHL Edge Data](#nhl-edge-data) - - [Team Data](#team-data) - - [Team Details](#team-details) - - [Example using cURL:](#example-using-curl-59) - - [Team Landing](#team-landing) - - [Example using cURL:](#example-using-curl-60) - - [Team Comparison](#team-comparison) - - [Example using cURL:](#example-using-curl-61) - - [Team Skating Distance - Top 10](#team-skating-distance---top-10) - - [Example using cURL:](#example-using-curl-62) - - [Team Skating Distance - Detail](#team-skating-distance---detail) - - [Example using cURL:](#example-using-curl-63) - - [Team Skating Speed - Top 10](#team-skating-speed---top-10) - - [Example using cURL:](#example-using-curl-64) - - [Team Skating Speed - Detail](#team-skating-speed---detail) - - [Example using cURL:](#example-using-curl-65) - - [Team Zone Time - Top 10](#team-zone-time---top-10) - - [Example using cURL:](#example-using-curl-66) - - [Team Zone Time - Details](#team-zone-time---details) - - [Example using cURL:](#example-using-curl-67) - - [Team Shot Speed - Top 10](#team-shot-speed---top-10) - - [Example using cURL:](#example-using-curl-68) - - [Team Shot Speed - Detail](#team-shot-speed---detail) - - [Example using cURL:](#example-using-curl-69) - - [Team Shot Location - Top 10](#team-shot-location---top-10) - - [Example using cURL:](#example-using-curl-70) - - [Team Shot Location - Detail](#team-shot-location---detail) - - [Example using cURL:](#example-using-curl-71) - - [](#) - - [Skater Data](#skater-data) - - [Skater Detail](#skater-detail) - - [Example using cURL:](#example-using-curl-72) - - [Skater Landing](#skater-landing) - - [Example using cURL:](#example-using-curl-73) - - [Skater Comparison](#skater-comparison) - - [Example using cURL:](#example-using-curl-74) - - [Skater Distance - Top 10](#skater-distance---top-10) - - [Example using cURL:](#example-using-curl-75) - - [Skater Skating Distance - Detail](#skater-skating-distance---detail) - - [Example using cURL:](#example-using-curl-76) - - [Skater Speed - Top 10](#skater-speed---top-10) - - [Example using cURL:](#example-using-curl-77) - - [Skater Skating Speed - Detail](#skater-skating-speed---detail) - - [Example using cURL:](#example-using-curl-78) - - [Skater Zone Time - Top 10](#skater-zone-time---top-10) - - [Example using cURL:](#example-using-curl-79) - - [Skater Zone Time - Detail](#skater-zone-time---detail) - - [Example using cURL:](#example-using-curl-80) - - [Skater Shot Speed - Top 10](#skater-shot-speed---top-10) - - [Example using cURL:](#example-using-curl-81) - - [Skater Shot Speed - Detail](#skater-shot-speed---detail) - - [Example using cURL:](#example-using-curl-82) - - [Skater Shot Location - Top 10](#skater-shot-location---top-10) - - [Example using cURL:](#example-using-curl-83) - - [Skater Shot Location - Detail](#skater-shot-location---detail) - - [Example using cURL:](#example-using-curl-84) - - [CAT - Skater Detail](#cat---skater-detail) - - [Example using cURL:](#example-using-curl-85) - - [Goalie Data](#goalie-data) - - [Goalie Detail](#goalie-detail) - - [Example using cURL:](#example-using-curl-86) - - [Goalie Landing](#goalie-landing) - - [Example using cURL:](#example-using-curl-87) - - [Goalie Comparison](#goalie-comparison) - - [Example using cURL:](#example-using-curl-88) - - [Goalie 5v5 - Top 10](#goalie-5v5---top-10) - - [Example using cURL:](#example-using-curl-89) - - [Goalie 5v5 - Detail](#goalie-5v5---detail) - - [Example using cURL:](#example-using-curl-90) - - [Goalie Shot Location - Top 10](#goalie-shot-location---top-10) - - [Example using cURL:](#example-using-curl-91) - - [Goalie Shot Location - Detail](#goalie-shot-location---detail) - - [Example using cURL:](#example-using-curl-92) - - [Goalie Save Percentage - Top 10](#goalie-save-percentage---top-10) - - [Example using cURL:](#example-using-curl-93) - - [Goalie Save Percentage - Detail](#goalie-save-percentage---detail) - - [Example using cURL:](#example-using-curl-94) - - [CAT - Goalie Detail](#cat---goalie-detail) - - [Example using cURL:](#example-using-curl-95) - - [Miscellaneous Data](#miscellaneous-data) -- [NHL Stats API Documentation](#nhl-stats-api-documentation) - - [Base URL](#base-url-1) - - [Players](#players-1) - - [Players](#players-2) - - [Get Player Information](#get-player-information) - - [Example using cURL:](#example-using-curl-96) - - [Skaters](#skaters-1) - - [Get Skater Leaders](#get-skater-leaders) - - [Example using cURL:](#example-using-curl-97) - - [Get Skater Milestones](#get-skater-milestones) - - [Example using cURL:](#example-using-curl-98) - - [Get Skater Information](#get-skater-information) - - [Example using cURL:](#example-using-curl-99) - - [Get Skater Stats](#get-skater-stats) - - [Example using cURL:](#example-using-curl-100) - - [Goalies](#goalies-1) - - [Get Goalie Leaders](#get-goalie-leaders) - - [Example using cURL:](#example-using-curl-101) - - [Get Goalie Stats](#get-goalie-stats) - - [Example using cURL:](#example-using-curl-102) - - [Get Goalie Milestones](#get-goalie-milestones) - - [Example using cURL:](#example-using-curl-103) - - [Draft](#draft-1) - - [Get Draft Information](#get-draft-information) - - [Example using cURL:](#example-using-curl-104) - - [Teams](#teams) - - [Get Team Information](#get-team-information) - - [Example using cURL:](#example-using-curl-105) - - [Get Team By ID](#get-team-by-id) - - [Example using cURL:](#example-using-curl-106) - - [Get Team Stats](#get-team-stats) - - [Example using cURL:](#example-using-curl-107) - - [Get Franchise Information](#get-franchise-information) - - [Example using cURL:](#example-using-curl-108) - - [Season](#season-1) - - [Get Component Season](#get-component-season) - - [Example using cURL:](#example-using-curl-109) - - [Get Season](#get-season) - - [Example using cURL:](#example-using-curl-110) - - [Game](#game) - - [Get Game Information](#get-game-information-1) - - [Example using cURL:](#example-using-curl-111) - - [Get Game Metadata](#get-game-metadata) - - [Example using cURL:](#example-using-curl-112) - - [Miscellaneous](#miscellaneous-1) - - [Configuration](#configuration) - - [Get Configuration](#get-configuration) - - [Example using cURL:](#example-using-curl-113) - - [Ping the Server](#ping-the-server) - - [Example using cURL:](#example-using-curl-114) - - [Get Country Information](#get-country-information) - - [Example using cURL:](#example-using-curl-115) - - [Get Shift Charts](#get-shift-charts) - - [Example using cURL:](#example-using-curl-116) - - [Glossary](#glossary) - - [Get Glossary](#get-glossary) - - [Example using cURL:](#example-using-curl-117) - - [Content Module](#content-module) - - [Get Content Module](#get-content-module) - - [Example using cURL:](#example-using-curl-118) +1. [Base URL](#base-url) +2. [Player Information](#player-information) + 1. [Players](#players) + 1. [Get Game Log](#get-game-log) + 2. [Get Specific Player Info](#get-specific-player-info) + 3. [Get Game Log As of Now](#get-game-log-as-of-now) + 2. [Skaters](#skaters) + 1. [Get Current Skater Stats Leaders](#get-current-skater-stats-leaders) + 2. [Get Skater Stats Leaders for a Specific Season and Game Type](#get-skater-stats-leaders-for-a-specific-season-and-game-type) + 3. [Goalies](#goalies) + 1. [Get Current Goalie Stats Leaders](#get-current-goalie-stats-leaders) + 2. [Get Goalie Stats Leaders by Season](#get-goalie-stats-leaders-by-season) + 4. [Player Spotlight](#player-spotlight) + 1. [Get Players](#get-players) +3. [Team Information](#team-information) + 1. [Standings](#standings) + 1. [Get Standings](#get-standings) + 2. [Get Standings by Date](#get-standings-by-date) + 3. [Get Standings information for each Season](#get-standings-information-for-each-season) + 2. [Stats](#stats) + 1. [Get Club Stats Now](#get-club-stats-now) + 2. [Get Club Stats for the Season for a Team](#get-club-stats-for-the-season-for-a-team) + 3. [Get Club Stats by Season and Game Type](#get-club-stats-by-season-and-game-type) + 4. [Get Team Scoreboard](#get-team-scoreboard) + 3. [Roster](#roster) + 1. [Get Team Roster As of Now](#get-team-roster-as-of-now) + 2. [Get Team Roster by Season](#get-team-roster-by-season) + 3. [Get Roster Season for Team](#get-roster-season-for-team) + 4. [Get Team Prospects](#get-team-prospects) + 4. [Schedule](#schedule) + 1. [Get Team Season Schedule As of Now](#get-team-season-schedule-as-of-now) + 2. [Get Team Season Schedule](#get-team-season-schedule) + 3. [Get Month Schedule As of Now](#get-month-schedule-as-of-now) + 4. [Get Month Schedule](#get-month-schedule) + 5. [Get Week Schedule](#get-week-schedule) + 6. [Get Week Schedule As of Now](#get-week-schedule-as-of-now) +4. [League Schedule Information](#league-schedule-information) + 1. [Schedule](#schedule-1) + 1. [Get Current Schedule](#get-current-schedule) + 2. [Get Schedule by Date](#get-schedule-by-date) + 2. [Schedule Calendar](#schedule-calendar) + 1. [Get Schedule Calendar As of Now](#get-schedule-calendar-as-of-now) + 2. [Get Schedule Calendar for a Specific Date](#get-schedule-calendar-for-a-specific-date) +5. [Game Information](#game-information) + 1. [Daily Scores](#daily-scores) + 1. [Get Daily Scores As of Now](#get-daily-scores-as-of-now) + 2. [Get Daily Scores by Date](#get-daily-scores-by-date) + 3. [Get Scoreboard](#get-scoreboard) + 2. [Where to Watch](#where-to-watch) + 1. [Get Streams](#get-streams) + 3. [Game Events](#game-events) + 1. [Get Play By Play](#get-play-by-play) + 2. [Get Landing](#get-landing) + 3. [Get Boxscore](#get-boxscore) + 4. [Get Game Story](#get-game-story) + 4. [Network](#network) + 1. [Get TV Schedule for a Specific Date](#get-tv-schedule-for-a-specific-date) + 2. [Get Current TV Schedule](#get-current-tv-schedule) + 5. [Odds](#odds) + 1. [Get Partner Game Odds](#get-partner-game-odds) +6. [Playoff Information](#playoff-information) + 1. [Overview](#overview) + 1. [Playoff Series Carousel](#playoff-series-carousel) + 2. [Schedule](#schedule-2) + 1. [Get Playoff Series Schedule](#get-playoff-series-schedule) + 3. [Bracket](#bracket) + 1. [Get Playoff Bracket](#get-playoff-bracket) +7. [Season](#season) + 1. [Get Seasons](#get-seasons) +8. [Draft](#draft) + 1. [Get Draft Rankings](#get-draft-rankings) + 2. [Get Draft Rankings by Date](#get-draft-rankings-by-date) + 3. [Get Draft Tracker Now](#get-draft-tracker-now) + 4. [Get Draft Picks Now](#get-draft-picks-now) + 5. [Get Draft Picks](#get-draft-picks) +9. [Miscellaneous](#miscellaneous) + 1. [Meta](#meta) + 1. [Get Meta Information](#get-meta-information) + 2. [Get Game Information](#get-game-information) + 3. [Get Location](#get-location) + 4. [Get Playoff Series Metadata](#get-playoff-series-metadata) + 2. [Postal Lookup](#postal-lookup) + 1. [Get Postal Code Information](#get-postal-code-information) + 3. [Game Replays](#game-replays) + 1. [Get Goal Replay](#get-goal-replay) + 2. [Get Play Replay](#get-play-replay) + 4. [Additional Game Content](#additional-game-content) + 1. [Get Game Right Rail Content](#get-game-right-rail-content) + 2. [Get WSC Play By Play](#get-wsc-play-by-play) + 5. [OpenAPI Specification](#openapi-specification) + 1. [Get OpenAPI Specification](#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](#nhl-stats-api-documentation) 1. [Base URL](#base-url-1) @@ -1484,6 +1321,34 @@ curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-speed-detail/9/20242025/ #### 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: + +```bash +curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-location-top-10/F/{category}/{sort-by}/20242025/2" +``` +#### Team Shot Location - Top 10 + - **Endpoint**: `/v1/edge/team-shot-location-top-10/{position}/{sort-by}/{category}/{season}/{game-type}`; `/v1/edge/team-shot-location-top-10/{position}/{sort-by}/{category}/now` - **Method**: GET - **Description**: Retrieve team-based ranking for NHL Edge data @@ -1511,23 +1376,6 @@ curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-speed-detail/9/20242025/ curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-location-top-10/forwards/goals/all/20252026/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: - -```bash -curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-location-detail/9/20242025/2" -``` - #### ### Skater Data From daee942d7e84cc8ba906cd609175725af5d03fb5 Mon Sep 17 00:00:00 2001 From: Dillon Johnson <158092981+johnsondillond@users.noreply.github.com> Date: Tue, 25 Nov 2025 12:05:44 -0700 Subject: [PATCH 3/7] Refactor API documentation for shot locations Updated API endpoints and parameters for team and goalie shot locations in correct spot of document --- README.md | 73 +++++++++++++++++++++++-------------------------------- 1 file changed, 31 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index d870d3d..34d6dcd 100644 --- a/README.md +++ b/README.md @@ -1321,34 +1321,6 @@ curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-speed-detail/9/20242025/ #### 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: - -```bash -curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-location-top-10/F/{category}/{sort-by}/20242025/2" -``` -#### Team Shot Location - Top 10 - - **Endpoint**: `/v1/edge/team-shot-location-top-10/{position}/{sort-by}/{category}/{season}/{game-type}`; `/v1/edge/team-shot-location-top-10/{position}/{sort-by}/{category}/now` - **Method**: GET - **Description**: Retrieve team-based ranking for NHL Edge data @@ -1373,7 +1345,24 @@ curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-location-top-10/F/{categ ###### Example using cURL: ```bash -curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-location-top-10/forwards/goals/all/20252026/2" +curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-location-top-10/forwards/goals/all/now" +``` + +#### 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: + +```bash +curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-location-detail/9/20242025/2" ``` #### @@ -1758,20 +1747,20 @@ curl -X GET "https://api-web.nhle.com/v1/edge/goalie-5v5-detail/8476999/20242025 #### 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` +- **Endpoint**: `/v1/edge/goalie-shot-location-top-10/{sort-by}/{category}/{season}/{game-type}`; `/v1/edge/goalie-shot-location-top-10/{sort-by}/{category}/now` - **Method**: GET -- **Description**: Presumably top 10 goalies based on the specified filters. -**TODO** +- **Description**: Presumably top 10 goalies based on the specified filters. - **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 % + - `category` (str) + - 'all' - All Locations + - 'high' - High-Danger + - 'mid' - Mid-Range + - 'long' - Long-Range + - `sort-by` (str) - String + - 'save-pctg' - Save % + - 'saves' - Saves + - 'shots-against' - Shots Against + - 'goals-against' - Goals Against - `season` (int) - Season in YYYYYYYY format - `game-type` (int) - 2 for regular season, 3 for postseason - **Response**: JSON format @@ -1779,7 +1768,7 @@ curl -X GET "https://api-web.nhle.com/v1/edge/goalie-5v5-detail/8476999/20242025 ###### Example using cURL: ```bash -curl -X GET "https://api-web.nhle.com/v1/edge/goalie-shot-location-top-10/{category}/{sort-by}/20242025/2" +curl -X GET "https://api-web.nhle.com/v1/edge/goalie-shot-location-top-10/save-pctg/all/now" ``` #### Goalie Shot Location - Detail From 290d9d9108e5f8f5262fca3e59ca1d5fab21eab6 Mon Sep 17 00:00:00 2001 From: djtopshot13 Date: Wed, 26 Nov 2025 14:09:03 -0700 Subject: [PATCH 4/7] Revert "Refactor API documentation for shot locations" This reverts commit daee942d7e84cc8ba906cd609175725af5d03fb5. --- README.md | 73 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 42 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 34d6dcd..d870d3d 100644 --- a/README.md +++ b/README.md @@ -1321,6 +1321,34 @@ curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-speed-detail/9/20242025/ #### 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: + +```bash +curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-location-top-10/F/{category}/{sort-by}/20242025/2" +``` +#### Team Shot Location - Top 10 + - **Endpoint**: `/v1/edge/team-shot-location-top-10/{position}/{sort-by}/{category}/{season}/{game-type}`; `/v1/edge/team-shot-location-top-10/{position}/{sort-by}/{category}/now` - **Method**: GET - **Description**: Retrieve team-based ranking for NHL Edge data @@ -1345,24 +1373,7 @@ curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-speed-detail/9/20242025/ ###### Example using cURL: ```bash -curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-location-top-10/forwards/goals/all/now" -``` - -#### 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: - -```bash -curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-location-detail/9/20242025/2" +curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-location-top-10/forwards/goals/all/20252026/2" ``` #### @@ -1747,20 +1758,20 @@ curl -X GET "https://api-web.nhle.com/v1/edge/goalie-5v5-detail/8476999/20242025 #### Goalie Shot Location - Top 10 -- **Endpoint**: `/v1/edge/goalie-shot-location-top-10/{sort-by}/{category}/{season}/{game-type}`; `/v1/edge/goalie-shot-location-top-10/{sort-by}/{category}/now` +- **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. +- **Description**: Presumably top 10 goalies based on the specified filters. -**TODO** - **Parameters**: - - `category` (str) - - 'all' - All Locations - - 'high' - High-Danger - - 'mid' - Mid-Range - - 'long' - Long-Range - - `sort-by` (str) - String - - 'save-pctg' - Save % - - 'saves' - Saves - - 'shots-against' - Shots Against - - 'goals-against' - Goals Against + - `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 @@ -1768,7 +1779,7 @@ curl -X GET "https://api-web.nhle.com/v1/edge/goalie-5v5-detail/8476999/20242025 ###### Example using cURL: ```bash -curl -X GET "https://api-web.nhle.com/v1/edge/goalie-shot-location-top-10/save-pctg/all/now" +curl -X GET "https://api-web.nhle.com/v1/edge/goalie-shot-location-top-10/{category}/{sort-by}/20242025/2" ``` #### Goalie Shot Location - Detail From e72499de208595cc48b0b751d5ade0670a89e6d4 Mon Sep 17 00:00:00 2001 From: djtopshot13 Date: Wed, 26 Nov 2025 14:09:16 -0700 Subject: [PATCH 5/7] Revert "Refine NHL API documentation in READMEFixed to only change the relevant sections" This reverts commit 0b506cc683ecd00f5199f88abf7878f2eb26108c. --- README.md | 472 ++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 312 insertions(+), 160 deletions(-) diff --git a/README.md b/README.md index d870d3d..b4814fd 100644 --- a/README.md +++ b/README.md @@ -6,138 +6,301 @@ Please note that there appears to be *two* primary sources for official NHL APIs ## Table of Contents ### [api-web.nhle.com](#nhl-web-api-documentation) -1. [Base URL](#base-url) -2. [Player Information](#player-information) - 1. [Players](#players) - 1. [Get Game Log](#get-game-log) - 2. [Get Specific Player Info](#get-specific-player-info) - 3. [Get Game Log As of Now](#get-game-log-as-of-now) - 2. [Skaters](#skaters) - 1. [Get Current Skater Stats Leaders](#get-current-skater-stats-leaders) - 2. [Get Skater Stats Leaders for a Specific Season and Game Type](#get-skater-stats-leaders-for-a-specific-season-and-game-type) - 3. [Goalies](#goalies) - 1. [Get Current Goalie Stats Leaders](#get-current-goalie-stats-leaders) - 2. [Get Goalie Stats Leaders by Season](#get-goalie-stats-leaders-by-season) - 4. [Player Spotlight](#player-spotlight) - 1. [Get Players](#get-players) -3. [Team Information](#team-information) - 1. [Standings](#standings) - 1. [Get Standings](#get-standings) - 2. [Get Standings by Date](#get-standings-by-date) - 3. [Get Standings information for each Season](#get-standings-information-for-each-season) - 2. [Stats](#stats) - 1. [Get Club Stats Now](#get-club-stats-now) - 2. [Get Club Stats for the Season for a Team](#get-club-stats-for-the-season-for-a-team) - 3. [Get Club Stats by Season and Game Type](#get-club-stats-by-season-and-game-type) - 4. [Get Team Scoreboard](#get-team-scoreboard) - 3. [Roster](#roster) - 1. [Get Team Roster As of Now](#get-team-roster-as-of-now) - 2. [Get Team Roster by Season](#get-team-roster-by-season) - 3. [Get Roster Season for Team](#get-roster-season-for-team) - 4. [Get Team Prospects](#get-team-prospects) - 4. [Schedule](#schedule) - 1. [Get Team Season Schedule As of Now](#get-team-season-schedule-as-of-now) - 2. [Get Team Season Schedule](#get-team-season-schedule) - 3. [Get Month Schedule As of Now](#get-month-schedule-as-of-now) - 4. [Get Month Schedule](#get-month-schedule) - 5. [Get Week Schedule](#get-week-schedule) - 6. [Get Week Schedule As of Now](#get-week-schedule-as-of-now) -4. [League Schedule Information](#league-schedule-information) - 1. [Schedule](#schedule-1) - 1. [Get Current Schedule](#get-current-schedule) - 2. [Get Schedule by Date](#get-schedule-by-date) - 2. [Schedule Calendar](#schedule-calendar) - 1. [Get Schedule Calendar As of Now](#get-schedule-calendar-as-of-now) - 2. [Get Schedule Calendar for a Specific Date](#get-schedule-calendar-for-a-specific-date) -5. [Game Information](#game-information) - 1. [Daily Scores](#daily-scores) - 1. [Get Daily Scores As of Now](#get-daily-scores-as-of-now) - 2. [Get Daily Scores by Date](#get-daily-scores-by-date) - 3. [Get Scoreboard](#get-scoreboard) - 2. [Where to Watch](#where-to-watch) - 1. [Get Streams](#get-streams) - 3. [Game Events](#game-events) - 1. [Get Play By Play](#get-play-by-play) - 2. [Get Landing](#get-landing) - 3. [Get Boxscore](#get-boxscore) - 4. [Get Game Story](#get-game-story) - 4. [Network](#network) - 1. [Get TV Schedule for a Specific Date](#get-tv-schedule-for-a-specific-date) - 2. [Get Current TV Schedule](#get-current-tv-schedule) - 5. [Odds](#odds) - 1. [Get Partner Game Odds](#get-partner-game-odds) -6. [Playoff Information](#playoff-information) - 1. [Overview](#overview) - 1. [Playoff Series Carousel](#playoff-series-carousel) - 2. [Schedule](#schedule-2) - 1. [Get Playoff Series Schedule](#get-playoff-series-schedule) - 3. [Bracket](#bracket) - 1. [Get Playoff Bracket](#get-playoff-bracket) -7. [Season](#season) - 1. [Get Seasons](#get-seasons) -8. [Draft](#draft) - 1. [Get Draft Rankings](#get-draft-rankings) - 2. [Get Draft Rankings by Date](#get-draft-rankings-by-date) - 3. [Get Draft Tracker Now](#get-draft-tracker-now) - 4. [Get Draft Picks Now](#get-draft-picks-now) - 5. [Get Draft Picks](#get-draft-picks) -9. [Miscellaneous](#miscellaneous) - 1. [Meta](#meta) - 1. [Get Meta Information](#get-meta-information) - 2. [Get Game Information](#get-game-information) - 3. [Get Location](#get-location) - 4. [Get Playoff Series Metadata](#get-playoff-series-metadata) - 2. [Postal Lookup](#postal-lookup) - 1. [Get Postal Code Information](#get-postal-code-information) - 3. [Game Replays](#game-replays) - 1. [Get Goal Replay](#get-goal-replay) - 2. [Get Play Replay](#get-play-replay) - 4. [Additional Game Content](#additional-game-content) - 1. [Get Game Right Rail Content](#get-game-right-rail-content) - 2. [Get WSC Play By Play](#get-wsc-play-by-play) - 5. [OpenAPI Specification](#openapi-specification) - 1. [Get OpenAPI Specification](#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) +- [NHL API Documentation](#nhl-api-documentation) + - [Table of Contents](#table-of-contents) + - [api-web.nhle.com](#api-webnhlecom) + - [api.nhle.com/stats/rest](#apinhlecomstatsrest) +- [NHL Web API Documentation](#nhl-web-api-documentation) + - [Base URL](#base-url) + - [Player Information](#player-information) + - [Players](#players) + - [Get Game Log](#get-game-log) + - [Example using cURL:](#example-using-curl) + - [Get Specific Player Info](#get-specific-player-info) + - [Example using cURL:](#example-using-curl-1) + - [Get Game Log As of Now](#get-game-log-as-of-now) + - [Example using cURL:](#example-using-curl-2) + - [Skaters](#skaters) + - [Get Current Skater Stats Leaders](#get-current-skater-stats-leaders) + - [Example using cURL:](#example-using-curl-3) + - [Get Skater Stats Leaders for a Specific Season and Game Type](#get-skater-stats-leaders-for-a-specific-season-and-game-type) + - [Example using cURL:](#example-using-curl-4) + - [Goalies](#goalies) + - [Get Current Goalie Stats Leaders](#get-current-goalie-stats-leaders) + - [Example using cURL:](#example-using-curl-5) + - [Get Goalie Stats Leaders by Season](#get-goalie-stats-leaders-by-season) + - [Example using cURL:](#example-using-curl-6) + - [Player Spotlight](#player-spotlight) + - [Get Players](#get-players) + - [Example using cURL:](#example-using-curl-7) + - [Team Information](#team-information) + - [Standings](#standings) + - [Get Standings](#get-standings) + - [Example using cURL:](#example-using-curl-8) + - [Get Standings by Date](#get-standings-by-date) + - [Example using cURL:](#example-using-curl-9) + - [Get Standings information for each Season](#get-standings-information-for-each-season) + - [Example using cURL:](#example-using-curl-10) + - [Stats](#stats) + - [Get Club Stats Now](#get-club-stats-now) + - [Example using cURL:](#example-using-curl-11) + - [Get Club Stats for the Season for a Team](#get-club-stats-for-the-season-for-a-team) + - [Example using cURL:](#example-using-curl-12) + - [Get Club Stats by Season and Game Type](#get-club-stats-by-season-and-game-type) + - [Example using cURL:](#example-using-curl-13) + - [Get Team Scoreboard](#get-team-scoreboard) + - [Example using cURL:](#example-using-curl-14) + - [Roster](#roster) + - [Get Team Roster As of Now](#get-team-roster-as-of-now) + - [Example using cURL:](#example-using-curl-15) + - [Get Team Roster by Season](#get-team-roster-by-season) + - [Example using cURL:](#example-using-curl-16) + - [Get Roster Season for Team](#get-roster-season-for-team) + - [Example using cURL:](#example-using-curl-17) + - [Get Team Prospects](#get-team-prospects) + - [Example using cURL:](#example-using-curl-18) + - [Schedule](#schedule) + - [Get Team Season Schedule As of Now](#get-team-season-schedule-as-of-now) + - [Example using cURL:](#example-using-curl-19) + - [Get Team Season Schedule](#get-team-season-schedule) + - [Example using cURL:](#example-using-curl-20) + - [Get Month Schedule As of Now](#get-month-schedule-as-of-now) + - [Example using cURL:](#example-using-curl-21) + - [Get Month Schedule](#get-month-schedule) + - [Example using cURL:](#example-using-curl-22) + - [Get Week Schedule](#get-week-schedule) + - [Example using cURL:](#example-using-curl-23) + - [Get Week Schedule As of Now](#get-week-schedule-as-of-now) + - [Example using cURL:](#example-using-curl-24) + - [League Schedule Information](#league-schedule-information) + - [Schedule](#schedule-1) + - [Get Current Schedule](#get-current-schedule) + - [Example using cURL:](#example-using-curl-25) + - [Get Schedule by Date](#get-schedule-by-date) + - [Example using cURL:](#example-using-curl-26) + - [Schedule Calendar](#schedule-calendar) + - [Get Schedule Calendar As of Now](#get-schedule-calendar-as-of-now) + - [Example using cURL:](#example-using-curl-27) + - [Get Schedule Calendar for a Specific Date](#get-schedule-calendar-for-a-specific-date) + - [Example using cURL:](#example-using-curl-28) + - [Game Information](#game-information) + - [Daily Scores](#daily-scores) + - [Get Daily Scores As of Now](#get-daily-scores-as-of-now) + - [Example using cURL:](#example-using-curl-29) + - [Get Daily Scores by Date](#get-daily-scores-by-date) + - [Example using cURL:](#example-using-curl-30) + - [Get Scoreboard](#get-scoreboard) + - [Example using cURL:](#example-using-curl-31) + - [Where to Watch](#where-to-watch) + - [Get Streams](#get-streams) + - [Example using cURL:](#example-using-curl-32) + - [Game Events](#game-events) + - [Get Play By Play](#get-play-by-play) + - [Example using cURL:](#example-using-curl-33) + - [Get Landing](#get-landing) + - [Example using cURL:](#example-using-curl-34) + - [Get Boxscore](#get-boxscore) + - [Example using cURL:](#example-using-curl-35) + - [Get Game Story](#get-game-story) + - [Example using cURL:](#example-using-curl-36) + - [Network](#network) + - [Get TV Schedule for a Specific Date](#get-tv-schedule-for-a-specific-date) + - [Example using cURL:](#example-using-curl-37) + - [Get Current TV Schedule](#get-current-tv-schedule) + - [Example using cURL:](#example-using-curl-38) + - [Odds](#odds) + - [Get Partner Game Odds](#get-partner-game-odds) + - [Example using cURL:](#example-using-curl-39) + - [Playoff Information](#playoff-information) + - [Overview](#overview) + - [Playoff Series Carousel](#playoff-series-carousel) + - [Example using cURL:](#example-using-curl-40) + - [Schedule](#schedule-2) + - [Get Playoff Series Schedule](#get-playoff-series-schedule) + - [Example using cURL:](#example-using-curl-41) + - [Bracket](#bracket) + - [Get Playoff Bracket](#get-playoff-bracket) + - [Example using cURL:](#example-using-curl-42) + - [Season](#season) + - [Get Seasons](#get-seasons) + - [Example using cURL:](#example-using-curl-43) + - [Draft](#draft) + - [Get Draft Rankings](#get-draft-rankings) + - [Example using cURL:](#example-using-curl-44) + - [Get Draft Rankings by Date](#get-draft-rankings-by-date) + - [Example using cURL:](#example-using-curl-45) + - [Get Draft Tracker Now](#get-draft-tracker-now) + - [Example using cURL:](#example-using-curl-46) + - [Get Draft Picks Now](#get-draft-picks-now) + - [Example using cURL:](#example-using-curl-47) + - [Get Draft Picks](#get-draft-picks) + - [Example using cURL:](#example-using-curl-48) + - [Miscellaneous](#miscellaneous) + - [Meta](#meta) + - [Get Meta Information](#get-meta-information) + - [Example using cURL:](#example-using-curl-49) + - [Get Game Information](#get-game-information) + - [Example using cURL:](#example-using-curl-50) + - [Get Location](#get-location) + - [Example using cURL:](#example-using-curl-51) + - [Get Playoff Series Metadata](#get-playoff-series-metadata) + - [Example using cURL:](#example-using-curl-52) + - [Postal Lookup](#postal-lookup) + - [Get Postal Code Information](#get-postal-code-information) + - [Example using cURL:](#example-using-curl-53) + - [Game Replays](#game-replays) + - [Get Goal Replay](#get-goal-replay) + - [Example using cURL:](#example-using-curl-54) + - [Get Play Replay](#get-play-replay) + - [Example using cURL:](#example-using-curl-55) + - [Additional Game Content](#additional-game-content) + - [Get Game Right Rail Content](#get-game-right-rail-content) + - [Example using cURL:](#example-using-curl-56) + - [Get WSC Play By Play](#get-wsc-play-by-play) + - [Example using cURL:](#example-using-curl-57) + - [OpenAPI Specification](#openapi-specification) + - [Get OpenAPI Specification](#get-openapi-specification) + - [Example using cURL:](#example-using-curl-58) + - [NHL Edge Data](#nhl-edge-data) + - [Team Data](#team-data) + - [Team Details](#team-details) + - [Example using cURL:](#example-using-curl-59) + - [Team Landing](#team-landing) + - [Example using cURL:](#example-using-curl-60) + - [Team Comparison](#team-comparison) + - [Example using cURL:](#example-using-curl-61) + - [Team Skating Distance - Top 10](#team-skating-distance---top-10) + - [Example using cURL:](#example-using-curl-62) + - [Team Skating Distance - Detail](#team-skating-distance---detail) + - [Example using cURL:](#example-using-curl-63) + - [Team Skating Speed - Top 10](#team-skating-speed---top-10) + - [Example using cURL:](#example-using-curl-64) + - [Team Skating Speed - Detail](#team-skating-speed---detail) + - [Example using cURL:](#example-using-curl-65) + - [Team Zone Time - Top 10](#team-zone-time---top-10) + - [Example using cURL:](#example-using-curl-66) + - [Team Zone Time - Details](#team-zone-time---details) + - [Example using cURL:](#example-using-curl-67) + - [Team Shot Speed - Top 10](#team-shot-speed---top-10) + - [Example using cURL:](#example-using-curl-68) + - [Team Shot Speed - Detail](#team-shot-speed---detail) + - [Example using cURL:](#example-using-curl-69) + - [Team Shot Location - Top 10](#team-shot-location---top-10) + - [Example using cURL:](#example-using-curl-70) + - [Team Shot Location - Detail](#team-shot-location---detail) + - [Example using cURL:](#example-using-curl-71) + - [](#) + - [Skater Data](#skater-data) + - [Skater Detail](#skater-detail) + - [Example using cURL:](#example-using-curl-72) + - [Skater Landing](#skater-landing) + - [Example using cURL:](#example-using-curl-73) + - [Skater Comparison](#skater-comparison) + - [Example using cURL:](#example-using-curl-74) + - [Skater Distance - Top 10](#skater-distance---top-10) + - [Example using cURL:](#example-using-curl-75) + - [Skater Skating Distance - Detail](#skater-skating-distance---detail) + - [Example using cURL:](#example-using-curl-76) + - [Skater Speed - Top 10](#skater-speed---top-10) + - [Example using cURL:](#example-using-curl-77) + - [Skater Skating Speed - Detail](#skater-skating-speed---detail) + - [Example using cURL:](#example-using-curl-78) + - [Skater Zone Time - Top 10](#skater-zone-time---top-10) + - [Example using cURL:](#example-using-curl-79) + - [Skater Zone Time - Detail](#skater-zone-time---detail) + - [Example using cURL:](#example-using-curl-80) + - [Skater Shot Speed - Top 10](#skater-shot-speed---top-10) + - [Example using cURL:](#example-using-curl-81) + - [Skater Shot Speed - Detail](#skater-shot-speed---detail) + - [Example using cURL:](#example-using-curl-82) + - [Skater Shot Location - Top 10](#skater-shot-location---top-10) + - [Example using cURL:](#example-using-curl-83) + - [Skater Shot Location - Detail](#skater-shot-location---detail) + - [Example using cURL:](#example-using-curl-84) + - [CAT - Skater Detail](#cat---skater-detail) + - [Example using cURL:](#example-using-curl-85) + - [Goalie Data](#goalie-data) + - [Goalie Detail](#goalie-detail) + - [Example using cURL:](#example-using-curl-86) + - [Goalie Landing](#goalie-landing) + - [Example using cURL:](#example-using-curl-87) + - [Goalie Comparison](#goalie-comparison) + - [Example using cURL:](#example-using-curl-88) + - [Goalie 5v5 - Top 10](#goalie-5v5---top-10) + - [Example using cURL:](#example-using-curl-89) + - [Goalie 5v5 - Detail](#goalie-5v5---detail) + - [Example using cURL:](#example-using-curl-90) + - [Goalie Shot Location - Top 10](#goalie-shot-location---top-10) + - [Example using cURL:](#example-using-curl-91) + - [Goalie Shot Location - Detail](#goalie-shot-location---detail) + - [Example using cURL:](#example-using-curl-92) + - [Goalie Save Percentage - Top 10](#goalie-save-percentage---top-10) + - [Example using cURL:](#example-using-curl-93) + - [Goalie Save Percentage - Detail](#goalie-save-percentage---detail) + - [Example using cURL:](#example-using-curl-94) + - [CAT - Goalie Detail](#cat---goalie-detail) + - [Example using cURL:](#example-using-curl-95) + - [Miscellaneous Data](#miscellaneous-data) +- [NHL Stats API Documentation](#nhl-stats-api-documentation) + - [Base URL](#base-url-1) + - [Players](#players-1) + - [Players](#players-2) + - [Get Player Information](#get-player-information) + - [Example using cURL:](#example-using-curl-96) + - [Skaters](#skaters-1) + - [Get Skater Leaders](#get-skater-leaders) + - [Example using cURL:](#example-using-curl-97) + - [Get Skater Milestones](#get-skater-milestones) + - [Example using cURL:](#example-using-curl-98) + - [Get Skater Information](#get-skater-information) + - [Example using cURL:](#example-using-curl-99) + - [Get Skater Stats](#get-skater-stats) + - [Example using cURL:](#example-using-curl-100) + - [Goalies](#goalies-1) + - [Get Goalie Leaders](#get-goalie-leaders) + - [Example using cURL:](#example-using-curl-101) + - [Get Goalie Stats](#get-goalie-stats) + - [Example using cURL:](#example-using-curl-102) + - [Get Goalie Milestones](#get-goalie-milestones) + - [Example using cURL:](#example-using-curl-103) + - [Draft](#draft-1) + - [Get Draft Information](#get-draft-information) + - [Example using cURL:](#example-using-curl-104) + - [Teams](#teams) + - [Get Team Information](#get-team-information) + - [Example using cURL:](#example-using-curl-105) + - [Get Team By ID](#get-team-by-id) + - [Example using cURL:](#example-using-curl-106) + - [Get Team Stats](#get-team-stats) + - [Example using cURL:](#example-using-curl-107) + - [Get Franchise Information](#get-franchise-information) + - [Example using cURL:](#example-using-curl-108) + - [Season](#season-1) + - [Get Component Season](#get-component-season) + - [Example using cURL:](#example-using-curl-109) + - [Get Season](#get-season) + - [Example using cURL:](#example-using-curl-110) + - [Game](#game) + - [Get Game Information](#get-game-information-1) + - [Example using cURL:](#example-using-curl-111) + - [Get Game Metadata](#get-game-metadata) + - [Example using cURL:](#example-using-curl-112) + - [Miscellaneous](#miscellaneous-1) + - [Configuration](#configuration) + - [Get Configuration](#get-configuration) + - [Example using cURL:](#example-using-curl-113) + - [Ping the Server](#ping-the-server) + - [Example using cURL:](#example-using-curl-114) + - [Get Country Information](#get-country-information) + - [Example using cURL:](#example-using-curl-115) + - [Get Shift Charts](#get-shift-charts) + - [Example using cURL:](#example-using-curl-116) + - [Glossary](#glossary) + - [Get Glossary](#get-glossary) + - [Example using cURL:](#example-using-curl-117) + - [Content Module](#content-module) + - [Get Content Module](#get-content-module) + - [Example using cURL:](#example-using-curl-118) --- ### [api.nhle.com/stats/rest](#nhl-stats-api-documentation) 1. [Base URL](#base-url-1) @@ -1321,34 +1484,6 @@ curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-speed-detail/9/20242025/ #### 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: - -```bash -curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-location-top-10/F/{category}/{sort-by}/20242025/2" -``` -#### Team Shot Location - Top 10 - - **Endpoint**: `/v1/edge/team-shot-location-top-10/{position}/{sort-by}/{category}/{season}/{game-type}`; `/v1/edge/team-shot-location-top-10/{position}/{sort-by}/{category}/now` - **Method**: GET - **Description**: Retrieve team-based ranking for NHL Edge data @@ -1376,6 +1511,23 @@ curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-location-top-10/F/{categ curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-location-top-10/forwards/goals/all/20252026/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: + +```bash +curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-location-detail/9/20242025/2" +``` + #### ### Skater Data From 8f7caf71e1ff99a0d4d137ff5c3c64fea014d8f3 Mon Sep 17 00:00:00 2001 From: djtopshot13 Date: Wed, 26 Nov 2025 14:09:28 -0700 Subject: [PATCH 6/7] Revert "Add shot location endpoint keys" This reverts commit c42ff6f5f83a574fed4e09c61201e174370d6c28. --- README.md | 488 ++++++++++++++++++------------------------------------ 1 file changed, 163 insertions(+), 325 deletions(-) diff --git a/README.md b/README.md index b4814fd..b056c44 100644 --- a/README.md +++ b/README.md @@ -6,301 +6,138 @@ Please note that there appears to be *two* primary sources for official NHL APIs ## Table of Contents ### [api-web.nhle.com](#nhl-web-api-documentation) -- [NHL API Documentation](#nhl-api-documentation) - - [Table of Contents](#table-of-contents) - - [api-web.nhle.com](#api-webnhlecom) - - [api.nhle.com/stats/rest](#apinhlecomstatsrest) -- [NHL Web API Documentation](#nhl-web-api-documentation) - - [Base URL](#base-url) - - [Player Information](#player-information) - - [Players](#players) - - [Get Game Log](#get-game-log) - - [Example using cURL:](#example-using-curl) - - [Get Specific Player Info](#get-specific-player-info) - - [Example using cURL:](#example-using-curl-1) - - [Get Game Log As of Now](#get-game-log-as-of-now) - - [Example using cURL:](#example-using-curl-2) - - [Skaters](#skaters) - - [Get Current Skater Stats Leaders](#get-current-skater-stats-leaders) - - [Example using cURL:](#example-using-curl-3) - - [Get Skater Stats Leaders for a Specific Season and Game Type](#get-skater-stats-leaders-for-a-specific-season-and-game-type) - - [Example using cURL:](#example-using-curl-4) - - [Goalies](#goalies) - - [Get Current Goalie Stats Leaders](#get-current-goalie-stats-leaders) - - [Example using cURL:](#example-using-curl-5) - - [Get Goalie Stats Leaders by Season](#get-goalie-stats-leaders-by-season) - - [Example using cURL:](#example-using-curl-6) - - [Player Spotlight](#player-spotlight) - - [Get Players](#get-players) - - [Example using cURL:](#example-using-curl-7) - - [Team Information](#team-information) - - [Standings](#standings) - - [Get Standings](#get-standings) - - [Example using cURL:](#example-using-curl-8) - - [Get Standings by Date](#get-standings-by-date) - - [Example using cURL:](#example-using-curl-9) - - [Get Standings information for each Season](#get-standings-information-for-each-season) - - [Example using cURL:](#example-using-curl-10) - - [Stats](#stats) - - [Get Club Stats Now](#get-club-stats-now) - - [Example using cURL:](#example-using-curl-11) - - [Get Club Stats for the Season for a Team](#get-club-stats-for-the-season-for-a-team) - - [Example using cURL:](#example-using-curl-12) - - [Get Club Stats by Season and Game Type](#get-club-stats-by-season-and-game-type) - - [Example using cURL:](#example-using-curl-13) - - [Get Team Scoreboard](#get-team-scoreboard) - - [Example using cURL:](#example-using-curl-14) - - [Roster](#roster) - - [Get Team Roster As of Now](#get-team-roster-as-of-now) - - [Example using cURL:](#example-using-curl-15) - - [Get Team Roster by Season](#get-team-roster-by-season) - - [Example using cURL:](#example-using-curl-16) - - [Get Roster Season for Team](#get-roster-season-for-team) - - [Example using cURL:](#example-using-curl-17) - - [Get Team Prospects](#get-team-prospects) - - [Example using cURL:](#example-using-curl-18) - - [Schedule](#schedule) - - [Get Team Season Schedule As of Now](#get-team-season-schedule-as-of-now) - - [Example using cURL:](#example-using-curl-19) - - [Get Team Season Schedule](#get-team-season-schedule) - - [Example using cURL:](#example-using-curl-20) - - [Get Month Schedule As of Now](#get-month-schedule-as-of-now) - - [Example using cURL:](#example-using-curl-21) - - [Get Month Schedule](#get-month-schedule) - - [Example using cURL:](#example-using-curl-22) - - [Get Week Schedule](#get-week-schedule) - - [Example using cURL:](#example-using-curl-23) - - [Get Week Schedule As of Now](#get-week-schedule-as-of-now) - - [Example using cURL:](#example-using-curl-24) - - [League Schedule Information](#league-schedule-information) - - [Schedule](#schedule-1) - - [Get Current Schedule](#get-current-schedule) - - [Example using cURL:](#example-using-curl-25) - - [Get Schedule by Date](#get-schedule-by-date) - - [Example using cURL:](#example-using-curl-26) - - [Schedule Calendar](#schedule-calendar) - - [Get Schedule Calendar As of Now](#get-schedule-calendar-as-of-now) - - [Example using cURL:](#example-using-curl-27) - - [Get Schedule Calendar for a Specific Date](#get-schedule-calendar-for-a-specific-date) - - [Example using cURL:](#example-using-curl-28) - - [Game Information](#game-information) - - [Daily Scores](#daily-scores) - - [Get Daily Scores As of Now](#get-daily-scores-as-of-now) - - [Example using cURL:](#example-using-curl-29) - - [Get Daily Scores by Date](#get-daily-scores-by-date) - - [Example using cURL:](#example-using-curl-30) - - [Get Scoreboard](#get-scoreboard) - - [Example using cURL:](#example-using-curl-31) - - [Where to Watch](#where-to-watch) - - [Get Streams](#get-streams) - - [Example using cURL:](#example-using-curl-32) - - [Game Events](#game-events) - - [Get Play By Play](#get-play-by-play) - - [Example using cURL:](#example-using-curl-33) - - [Get Landing](#get-landing) - - [Example using cURL:](#example-using-curl-34) - - [Get Boxscore](#get-boxscore) - - [Example using cURL:](#example-using-curl-35) - - [Get Game Story](#get-game-story) - - [Example using cURL:](#example-using-curl-36) - - [Network](#network) - - [Get TV Schedule for a Specific Date](#get-tv-schedule-for-a-specific-date) - - [Example using cURL:](#example-using-curl-37) - - [Get Current TV Schedule](#get-current-tv-schedule) - - [Example using cURL:](#example-using-curl-38) - - [Odds](#odds) - - [Get Partner Game Odds](#get-partner-game-odds) - - [Example using cURL:](#example-using-curl-39) - - [Playoff Information](#playoff-information) - - [Overview](#overview) - - [Playoff Series Carousel](#playoff-series-carousel) - - [Example using cURL:](#example-using-curl-40) - - [Schedule](#schedule-2) - - [Get Playoff Series Schedule](#get-playoff-series-schedule) - - [Example using cURL:](#example-using-curl-41) - - [Bracket](#bracket) - - [Get Playoff Bracket](#get-playoff-bracket) - - [Example using cURL:](#example-using-curl-42) - - [Season](#season) - - [Get Seasons](#get-seasons) - - [Example using cURL:](#example-using-curl-43) - - [Draft](#draft) - - [Get Draft Rankings](#get-draft-rankings) - - [Example using cURL:](#example-using-curl-44) - - [Get Draft Rankings by Date](#get-draft-rankings-by-date) - - [Example using cURL:](#example-using-curl-45) - - [Get Draft Tracker Now](#get-draft-tracker-now) - - [Example using cURL:](#example-using-curl-46) - - [Get Draft Picks Now](#get-draft-picks-now) - - [Example using cURL:](#example-using-curl-47) - - [Get Draft Picks](#get-draft-picks) - - [Example using cURL:](#example-using-curl-48) - - [Miscellaneous](#miscellaneous) - - [Meta](#meta) - - [Get Meta Information](#get-meta-information) - - [Example using cURL:](#example-using-curl-49) - - [Get Game Information](#get-game-information) - - [Example using cURL:](#example-using-curl-50) - - [Get Location](#get-location) - - [Example using cURL:](#example-using-curl-51) - - [Get Playoff Series Metadata](#get-playoff-series-metadata) - - [Example using cURL:](#example-using-curl-52) - - [Postal Lookup](#postal-lookup) - - [Get Postal Code Information](#get-postal-code-information) - - [Example using cURL:](#example-using-curl-53) - - [Game Replays](#game-replays) - - [Get Goal Replay](#get-goal-replay) - - [Example using cURL:](#example-using-curl-54) - - [Get Play Replay](#get-play-replay) - - [Example using cURL:](#example-using-curl-55) - - [Additional Game Content](#additional-game-content) - - [Get Game Right Rail Content](#get-game-right-rail-content) - - [Example using cURL:](#example-using-curl-56) - - [Get WSC Play By Play](#get-wsc-play-by-play) - - [Example using cURL:](#example-using-curl-57) - - [OpenAPI Specification](#openapi-specification) - - [Get OpenAPI Specification](#get-openapi-specification) - - [Example using cURL:](#example-using-curl-58) - - [NHL Edge Data](#nhl-edge-data) - - [Team Data](#team-data) - - [Team Details](#team-details) - - [Example using cURL:](#example-using-curl-59) - - [Team Landing](#team-landing) - - [Example using cURL:](#example-using-curl-60) - - [Team Comparison](#team-comparison) - - [Example using cURL:](#example-using-curl-61) - - [Team Skating Distance - Top 10](#team-skating-distance---top-10) - - [Example using cURL:](#example-using-curl-62) - - [Team Skating Distance - Detail](#team-skating-distance---detail) - - [Example using cURL:](#example-using-curl-63) - - [Team Skating Speed - Top 10](#team-skating-speed---top-10) - - [Example using cURL:](#example-using-curl-64) - - [Team Skating Speed - Detail](#team-skating-speed---detail) - - [Example using cURL:](#example-using-curl-65) - - [Team Zone Time - Top 10](#team-zone-time---top-10) - - [Example using cURL:](#example-using-curl-66) - - [Team Zone Time - Details](#team-zone-time---details) - - [Example using cURL:](#example-using-curl-67) - - [Team Shot Speed - Top 10](#team-shot-speed---top-10) - - [Example using cURL:](#example-using-curl-68) - - [Team Shot Speed - Detail](#team-shot-speed---detail) - - [Example using cURL:](#example-using-curl-69) - - [Team Shot Location - Top 10](#team-shot-location---top-10) - - [Example using cURL:](#example-using-curl-70) - - [Team Shot Location - Detail](#team-shot-location---detail) - - [Example using cURL:](#example-using-curl-71) - - [](#) - - [Skater Data](#skater-data) - - [Skater Detail](#skater-detail) - - [Example using cURL:](#example-using-curl-72) - - [Skater Landing](#skater-landing) - - [Example using cURL:](#example-using-curl-73) - - [Skater Comparison](#skater-comparison) - - [Example using cURL:](#example-using-curl-74) - - [Skater Distance - Top 10](#skater-distance---top-10) - - [Example using cURL:](#example-using-curl-75) - - [Skater Skating Distance - Detail](#skater-skating-distance---detail) - - [Example using cURL:](#example-using-curl-76) - - [Skater Speed - Top 10](#skater-speed---top-10) - - [Example using cURL:](#example-using-curl-77) - - [Skater Skating Speed - Detail](#skater-skating-speed---detail) - - [Example using cURL:](#example-using-curl-78) - - [Skater Zone Time - Top 10](#skater-zone-time---top-10) - - [Example using cURL:](#example-using-curl-79) - - [Skater Zone Time - Detail](#skater-zone-time---detail) - - [Example using cURL:](#example-using-curl-80) - - [Skater Shot Speed - Top 10](#skater-shot-speed---top-10) - - [Example using cURL:](#example-using-curl-81) - - [Skater Shot Speed - Detail](#skater-shot-speed---detail) - - [Example using cURL:](#example-using-curl-82) - - [Skater Shot Location - Top 10](#skater-shot-location---top-10) - - [Example using cURL:](#example-using-curl-83) - - [Skater Shot Location - Detail](#skater-shot-location---detail) - - [Example using cURL:](#example-using-curl-84) - - [CAT - Skater Detail](#cat---skater-detail) - - [Example using cURL:](#example-using-curl-85) - - [Goalie Data](#goalie-data) - - [Goalie Detail](#goalie-detail) - - [Example using cURL:](#example-using-curl-86) - - [Goalie Landing](#goalie-landing) - - [Example using cURL:](#example-using-curl-87) - - [Goalie Comparison](#goalie-comparison) - - [Example using cURL:](#example-using-curl-88) - - [Goalie 5v5 - Top 10](#goalie-5v5---top-10) - - [Example using cURL:](#example-using-curl-89) - - [Goalie 5v5 - Detail](#goalie-5v5---detail) - - [Example using cURL:](#example-using-curl-90) - - [Goalie Shot Location - Top 10](#goalie-shot-location---top-10) - - [Example using cURL:](#example-using-curl-91) - - [Goalie Shot Location - Detail](#goalie-shot-location---detail) - - [Example using cURL:](#example-using-curl-92) - - [Goalie Save Percentage - Top 10](#goalie-save-percentage---top-10) - - [Example using cURL:](#example-using-curl-93) - - [Goalie Save Percentage - Detail](#goalie-save-percentage---detail) - - [Example using cURL:](#example-using-curl-94) - - [CAT - Goalie Detail](#cat---goalie-detail) - - [Example using cURL:](#example-using-curl-95) - - [Miscellaneous Data](#miscellaneous-data) -- [NHL Stats API Documentation](#nhl-stats-api-documentation) - - [Base URL](#base-url-1) - - [Players](#players-1) - - [Players](#players-2) - - [Get Player Information](#get-player-information) - - [Example using cURL:](#example-using-curl-96) - - [Skaters](#skaters-1) - - [Get Skater Leaders](#get-skater-leaders) - - [Example using cURL:](#example-using-curl-97) - - [Get Skater Milestones](#get-skater-milestones) - - [Example using cURL:](#example-using-curl-98) - - [Get Skater Information](#get-skater-information) - - [Example using cURL:](#example-using-curl-99) - - [Get Skater Stats](#get-skater-stats) - - [Example using cURL:](#example-using-curl-100) - - [Goalies](#goalies-1) - - [Get Goalie Leaders](#get-goalie-leaders) - - [Example using cURL:](#example-using-curl-101) - - [Get Goalie Stats](#get-goalie-stats) - - [Example using cURL:](#example-using-curl-102) - - [Get Goalie Milestones](#get-goalie-milestones) - - [Example using cURL:](#example-using-curl-103) - - [Draft](#draft-1) - - [Get Draft Information](#get-draft-information) - - [Example using cURL:](#example-using-curl-104) - - [Teams](#teams) - - [Get Team Information](#get-team-information) - - [Example using cURL:](#example-using-curl-105) - - [Get Team By ID](#get-team-by-id) - - [Example using cURL:](#example-using-curl-106) - - [Get Team Stats](#get-team-stats) - - [Example using cURL:](#example-using-curl-107) - - [Get Franchise Information](#get-franchise-information) - - [Example using cURL:](#example-using-curl-108) - - [Season](#season-1) - - [Get Component Season](#get-component-season) - - [Example using cURL:](#example-using-curl-109) - - [Get Season](#get-season) - - [Example using cURL:](#example-using-curl-110) - - [Game](#game) - - [Get Game Information](#get-game-information-1) - - [Example using cURL:](#example-using-curl-111) - - [Get Game Metadata](#get-game-metadata) - - [Example using cURL:](#example-using-curl-112) - - [Miscellaneous](#miscellaneous-1) - - [Configuration](#configuration) - - [Get Configuration](#get-configuration) - - [Example using cURL:](#example-using-curl-113) - - [Ping the Server](#ping-the-server) - - [Example using cURL:](#example-using-curl-114) - - [Get Country Information](#get-country-information) - - [Example using cURL:](#example-using-curl-115) - - [Get Shift Charts](#get-shift-charts) - - [Example using cURL:](#example-using-curl-116) - - [Glossary](#glossary) - - [Get Glossary](#get-glossary) - - [Example using cURL:](#example-using-curl-117) - - [Content Module](#content-module) - - [Get Content Module](#get-content-module) - - [Example using cURL:](#example-using-curl-118) +1. [Base URL](#base-url) +2. [Player Information](#player-information) + 1. [Players](#players) + 1. [Get Game Log](#get-game-log) + 2. [Get Specific Player Info](#get-specific-player-info) + 3. [Get Game Log As of Now](#get-game-log-as-of-now) + 2. [Skaters](#skaters) + 1. [Get Current Skater Stats Leaders](#get-current-skater-stats-leaders) + 2. [Get Skater Stats Leaders for a Specific Season and Game Type](#get-skater-stats-leaders-for-a-specific-season-and-game-type) + 3. [Goalies](#goalies) + 1. [Get Current Goalie Stats Leaders](#get-current-goalie-stats-leaders) + 2. [Get Goalie Stats Leaders by Season](#get-goalie-stats-leaders-by-season) + 4. [Player Spotlight](#player-spotlight) + 1. [Get Players](#get-players) +3. [Team Information](#team-information) + 1. [Standings](#standings) + 1. [Get Standings](#get-standings) + 2. [Get Standings by Date](#get-standings-by-date) + 3. [Get Standings information for each Season](#get-standings-information-for-each-season) + 2. [Stats](#stats) + 1. [Get Club Stats Now](#get-club-stats-now) + 2. [Get Club Stats for the Season for a Team](#get-club-stats-for-the-season-for-a-team) + 3. [Get Club Stats by Season and Game Type](#get-club-stats-by-season-and-game-type) + 4. [Get Team Scoreboard](#get-team-scoreboard) + 3. [Roster](#roster) + 1. [Get Team Roster As of Now](#get-team-roster-as-of-now) + 2. [Get Team Roster by Season](#get-team-roster-by-season) + 3. [Get Roster Season for Team](#get-roster-season-for-team) + 4. [Get Team Prospects](#get-team-prospects) + 4. [Schedule](#schedule) + 1. [Get Team Season Schedule As of Now](#get-team-season-schedule-as-of-now) + 2. [Get Team Season Schedule](#get-team-season-schedule) + 3. [Get Month Schedule As of Now](#get-month-schedule-as-of-now) + 4. [Get Month Schedule](#get-month-schedule) + 5. [Get Week Schedule](#get-week-schedule) + 6. [Get Week Schedule As of Now](#get-week-schedule-as-of-now) +4. [League Schedule Information](#league-schedule-information) + 1. [Schedule](#schedule-1) + 1. [Get Current Schedule](#get-current-schedule) + 2. [Get Schedule by Date](#get-schedule-by-date) + 2. [Schedule Calendar](#schedule-calendar) + 1. [Get Schedule Calendar As of Now](#get-schedule-calendar-as-of-now) + 2. [Get Schedule Calendar for a Specific Date](#get-schedule-calendar-for-a-specific-date) +5. [Game Information](#game-information) + 1. [Daily Scores](#daily-scores) + 1. [Get Daily Scores As of Now](#get-daily-scores-as-of-now) + 2. [Get Daily Scores by Date](#get-daily-scores-by-date) + 3. [Get Scoreboard](#get-scoreboard) + 2. [Where to Watch](#where-to-watch) + 1. [Get Streams](#get-streams) + 3. [Game Events](#game-events) + 1. [Get Play By Play](#get-play-by-play) + 2. [Get Landing](#get-landing) + 3. [Get Boxscore](#get-boxscore) + 4. [Get Game Story](#get-game-story) + 4. [Network](#network) + 1. [Get TV Schedule for a Specific Date](#get-tv-schedule-for-a-specific-date) + 2. [Get Current TV Schedule](#get-current-tv-schedule) + 5. [Odds](#odds) + 1. [Get Partner Game Odds](#get-partner-game-odds) +6. [Playoff Information](#playoff-information) + 1. [Overview](#overview) + 1. [Playoff Series Carousel](#playoff-series-carousel) + 2. [Schedule](#schedule-2) + 1. [Get Playoff Series Schedule](#get-playoff-series-schedule) + 3. [Bracket](#bracket) + 1. [Get Playoff Bracket](#get-playoff-bracket) +7. [Season](#season) + 1. [Get Seasons](#get-seasons) +8. [Draft](#draft) + 1. [Get Draft Rankings](#get-draft-rankings) + 2. [Get Draft Rankings by Date](#get-draft-rankings-by-date) + 3. [Get Draft Tracker Now](#get-draft-tracker-now) + 4. [Get Draft Picks Now](#get-draft-picks-now) + 5. [Get Draft Picks](#get-draft-picks) +9. [Miscellaneous](#miscellaneous) + 1. [Meta](#meta) + 1. [Get Meta Information](#get-meta-information) + 2. [Get Game Information](#get-game-information) + 3. [Get Location](#get-location) + 4. [Get Playoff Series Metadata](#get-playoff-series-metadata) + 2. [Postal Lookup](#postal-lookup) + 1. [Get Postal Code Information](#get-postal-code-information) + 3. [Game Replays](#game-replays) + 1. [Get Goal Replay](#get-goal-replay) + 2. [Get Play Replay](#get-play-replay) + 4. [Additional Game Content](#additional-game-content) + 1. [Get Game Right Rail Content](#get-game-right-rail-content) + 2. [Get WSC Play By Play](#get-wsc-play-by-play) + 5. [OpenAPI Specification](#openapi-specification) + 1. [Get OpenAPI Specification](#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](#nhl-stats-api-documentation) 1. [Base URL](#base-url-1) @@ -1484,23 +1321,23 @@ curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-speed-detail/9/20242025/ #### Team Shot Location - Top 10 -- **Endpoint**: `/v1/edge/team-shot-location-top-10/{position}/{sort-by}/{category}/{season}/{game-type}`; `/v1/edge/team-shot-location-top-10/{position}/{sort-by}/{category}/now` +- **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 +- **Description**: Retrieve team-based ranking for NHL Edge data - **TODO** - **Parameters**: - `position` (str) - - - 'all' - Forwards and Defensemen - - 'forwards' - Forwards - - 'defense' - Defensemen - - `sort-by` (str) - String - - 'sog' - Shots on Goal - - 'goals' - Goals - - 'shooting-pctg' - Shooting Percentage - - `category` (str) - - 'all' - All Locations - - 'high' - High-Danger - - 'mid' - Mid-Range - - 'long' - Long-Range + - '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 @@ -1508,7 +1345,7 @@ curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-speed-detail/9/20242025/ ###### Example using cURL: ```bash -curl -X GET "https://api-web.nhle.com/v1/edge/team-shot-location-top-10/forwards/goals/all/20252026/2" +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 @@ -1760,30 +1597,31 @@ curl -X GET "https://api-web.nhle.com/v1/edge/skater-shot-speed-detail/8482116/2 #### Skater Shot Location - Top 10 -- **Endpoint**: `/v1/edge/skater-shot-location-top-10/{position}/{sort-by}/{category}/{season}/{game-type}`; `/v1/edge/skater-shot-location-top-10/{position}/{sort-by}/{category}/now` +- **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. +- **Description**: Presumably top 10 skaters based on the specified filters. -**TODO** - **Parameters**: - `position` (str) - - - 'all' - Forwards and Defensemen - - 'forwards' - Forwards - - 'defense' - Defensemen - - `sort-by` (str) - String - - 'sog' - Shots on Goal - - 'goals' - Goals - - 'shooting-pctg' - Shooting Percentage - - `category` (str) - - 'all' - All Locations - - 'high' - High-Danger - - 'mid' - Mid-Range - - 'long' - Long-Range + - '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: ```bash -curl -X GET "https://api-web.nhle.com/v1/edge/skater-shot-location-top-10/forwards/goals/high/now" +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 From 9676190824044b17e7475dc01ecfa7d67a5a52c2 Mon Sep 17 00:00:00 2001 From: djtopshot13 Date: Thu, 27 Nov 2025 09:55:58 -0700 Subject: [PATCH 7/7] Added skate distance endpoints to both team and skater stats --- README.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index b056c44..20db261 100644 --- a/README.md +++ b/README.md @@ -1152,22 +1152,22 @@ curl -X GET "https://api-web.nhle.com/v1/edge/team-comparison/9/20242025/2" - **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** +- **Description**: Retrieve team-based ranking for NHL Edge data - **Parameters**: - - `position` (str) - + - `position` (str) - - 'all' - Forwards and Defense - 'F' - Forwards - 'D' - Defense - - `strength` (str) - + - `strength` (str) - - 'all' - All situations + - 'es' - Even-strength - 'pp' - Power-play - 'pk' - Penalty kill - - 'es' - Even-strength - - `sort-by` (str) - String - **TODO** + - `sort-by` (str) - String - '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** + - 'per-60' - Average distance skated per 60 + - 'max-game' - Top distance skated in a game + - 'max-period' - 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 @@ -1175,7 +1175,7 @@ curl -X GET "https://api-web.nhle.com/v1/edge/team-comparison/9/20242025/2" ###### Example using cURL: ```bash -curl -X GET "https://api-web.nhle.com/v1/edge/team-skating-distance-top-10/F/pp/{sort-by}/20242025/2" +curl -X GET "https://api-web.nhle.com/v1/edge/team-skating-distance-top-10/F/pp/max-game/now" ``` #### Team Skating Distance - Detail @@ -1426,20 +1426,20 @@ curl -X GET "https://api-web.nhle.com/v1/edge/skater-comparison/8482116/20242025 - **Method**: GET - **Description**: Retrieve top 10 skaters in skating distance based on the provided filters - **Parameters**: - - `position` (str) - + - `position` (str) - - 'all' - Forwards and Defense - 'F' - Forwards - 'D' - Defense - - `strength` (str) - + - `strength` (str) - - 'all' - All situations + - 'es' - Even-strength - 'pp' - Power-play - 'pk' - Penalty kill - - 'es' - Even-strength - - `sort-by` (str) - String - **TODO** + - `sort-by` (str) - String - '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 + - 'per-60' - Average distance skated per 60 min + - 'max-game' - Top distance skated in a game + - 'max-period' - 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 @@ -1447,7 +1447,7 @@ curl -X GET "https://api-web.nhle.com/v1/edge/skater-comparison/8482116/20242025 ###### Example using cURL: ```bash -curl -X GET "https://api-web.nhle.com/v1/edge/skater-distance-top-10/D/all/total/20242025/2" +curl -X GET "https://api-web.nhle.com/v1/edge/skater-distance-top-10/D/pp/total/now" ``` #### Skater Skating Distance - Detail