Skip to content

Features -> skate distance endpoints #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
johnsondillond wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Features -> skate distance endpoints #80

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c42ff6f
Add shot location endpoint keys
johnsondillond Nov 25, 2025
0b506cc
Refine NHL API documentation in READMEFixed to only change the releva…
johnsondillond Nov 25, 2025
daee942
Refactor API documentation for shot locations
johnsondillond Nov 25, 2025
290d9d9
Revert "Refactor API documentation for shot locations"
johnsondillond Nov 26, 2025
e72499d
Revert "Refine NHL API documentation in READMEFixed to only change th…
johnsondillond Nov 26, 2025
8f7caf7
Revert "Add shot location endpoint keys"
johnsondillond Nov 26, 2025
9676190
Added skate distance endpoints to both team and skater stats
johnsondillond Nov 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1152,30 +1152,30 @@ 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

###### 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
Expand Down Expand Up @@ -1426,28 +1426,28 @@ 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

###### 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
Expand Down