Github/nhlapi
1
0
Fork 0
mirror of https://gitlab.com/dword4/nhlapi synced 2024-11-23 19:14:55 +00:00
Code Issues Projects Releases Wiki Activity

folds all json into collapsible bits

Browse Source
This commit is contained in:
Michael Marchand 2023-08-12 22:37:33 -06:00
parent 1064d8ee6f
commit 6eed5c589b
1 changed files with 108 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

110
stats-api.md
View File

@ -4,7 +4,7 @@
Thanks to [erunion](https://github.com/erunion) Thanks to [erunion](https://github.com/erunion)
Base: Base:
`https://statsapi.web.nhl.com` `https://statsapi.web.nhl.com`
# Endpoint Tables # Endpoint Tables
@ -67,6 +67,9 @@ Base:
`GET https://statsapi.web.nhl.com/api/v1/awards/ID` Get an NHL Award. `GET https://statsapi.web.nhl.com/api/v1/awards/ID` Get an NHL Award.
<details>
<summary>click for example</summary>
```json ```json
{ {
"copyright": "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.", "copyright": "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.",
@ -84,6 +87,10 @@ Base:
] ]
} }
``` ```
<br /></details>
[back to top](#endpoint-tables) [back to top](#endpoint-tables)
## Conferences ## Conferences
@ -93,6 +100,9 @@ for all current NHL conferences.
`GET https://statsapi.web.nhl.com/api/v1/conferences/ID` Same as above but for `GET https://statsapi.web.nhl.com/api/v1/conferences/ID` Same as above but for
specific conference, also can look up id 7 for World Cup of Hockey. specific conference, also can look up id 7 for World Cup of Hockey.
<details>
<summary>click for example</summary>
```json ```json
{ {
"copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.", "copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.",
@ -114,6 +124,8 @@ specific conference, also can look up id 7 for World Cup of Hockey.
} }
``` ```
<br /></details>
[back to top](#endpoint-tables) [back to top](#endpoint-tables)
## Divisions ## Divisions
`GET https://statsapi.web.nhl.com/api/v1/divisions` Returns full list of divisions `GET https://statsapi.web.nhl.com/api/v1/divisions` Returns full list of divisions
@ -123,6 +135,9 @@ Does not show inactive divisions
`GET https://statsapi.web.nhl.com/api/v1/divisions/ID` Same as above but only for a `GET https://statsapi.web.nhl.com/api/v1/divisions/ID` Same as above but only for a
single division. This can show old inactive divisions such as 13 Patrick. single division. This can show old inactive divisions such as 13 Patrick.
<details>
<summary>click for example</summary>
```json ```json
{ {
"copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.", "copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.",
@ -141,6 +156,9 @@ single division. This can show old inactive divisions such as 13 Patrick.
] ]
} }
``` ```
<br /></details>
[back to top](#endpoint-tables) [back to top](#endpoint-tables)
## Franchises ## Franchises
@ -149,6 +167,7 @@ single division. This can show old inactive divisions such as 13 Patrick.
`GET https://statsapi.web.nhl.com/api/v1/franchises/ID` Gets information on a specific franchise `GET https://statsapi.web.nhl.com/api/v1/franchises/ID` Gets information on a specific franchise
[back to top](#endpoint-tables) [back to top](#endpoint-tables)
## Tournaments ## Tournaments
`GET https://statsapi.web.nhl.com/api/v1/tournamentTypes` `GET https://statsapi.web.nhl.com/api/v1/tournamentTypes`
@ -159,6 +178,9 @@ Gets the possible different tournament types.
This is used for tracking nested tournaments, specifically the Playoffs due to the nature of their structure. This is used for tracking nested tournaments, specifically the Playoffs due to the nature of their structure.
<details>
<summary>click for example</summary>
```json ```json
{ {
"copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2019. All Rights Reserved.", "copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2019. All Rights Reserved.",
@ -221,6 +243,7 @@ This is used for tracking nested tournaments, specifically the Playoffs due to t
} ] } ]
} }
``` ```
<br /></details>
In order to get additional information the expand modifer can be used such as this example In order to get additional information the expand modifer can be used such as this example
@ -233,6 +256,9 @@ In order to get additional information the expand modifer can be used such as th
`GET https://statsapi.web.nhl.com/api/v1/venues/ID` Get an NHL Venue. `GET https://statsapi.web.nhl.com/api/v1/venues/ID` Get an NHL Venue.
<details>
<summary>click for example</summary>
```json ```json
{ {
"copyright": "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2019. All Rights Reserved.", "copyright": "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2019. All Rights Reserved.",
@ -246,6 +272,7 @@ In order to get additional information the expand modifer can be used such as th
] ]
} }
``` ```
<br /></details>
[back to top](#endpoint-tables) [back to top](#endpoint-tables)
@ -310,6 +337,9 @@ This shows all the possible play types found within the liveData/plays portion o
`GET https://statsapi.web.nhl.com/api/v1/draft/YEAR` Takes a YYYY format year and returns draft data `GET https://statsapi.web.nhl.com/api/v1/draft/YEAR` Takes a YYYY format year and returns draft data
<details>
<summary>click for example</summary>
```json ```json
{ {
"copyright": "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.", "copyright": "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.",
@ -335,11 +365,15 @@ This shows all the possible play types found within the liveData/plays portion o
} }
}, },
``` ```
<br /></details>
[back to top](#endpoint-tables) [back to top](#endpoint-tables)
## Players ## Players
`GET https://statsapi.web.nhl.com/api/v1/people/ID` Gets details for a player, must `GET https://statsapi.web.nhl.com/api/v1/people/ID` Gets details for a player, must
specify the id value in order to return data. specify the id value in order to return data.
<details>
<summary>click for example</summary>
```json ```json
{ {
@ -379,6 +413,9 @@ specify the id value in order to return data.
} ] } ]
} }
``` ```
<br /></details>
<br />
`GET https://statsapi.web.nhl.com/api/v1/people/ID/stats` Complex endpoint with `GET https://statsapi.web.nhl.com/api/v1/people/ID/stats` Complex endpoint with
lots of append options to change what kind of stats you wish to obtain lots of append options to change what kind of stats you wish to obtain
@ -393,6 +430,8 @@ for a player
_note - stats have changed over the years, the below sample is for Wayne Gretzky _note - stats have changed over the years, the below sample is for Wayne Gretzky
and does not include things like evenTimeOnIce and other time related stats_ and does not include things like evenTimeOnIce and other time related stats_
<details>
<summary>click for example</summary>
```json ```json
{ {
@ -424,9 +463,13 @@ and does not include things like evenTimeOnIce and other time related stats_
} ] } ]
} }
``` ```
<br /></details>
_however here is Alex Ovechkin's 20162017 season stats which include time information_ _however here is Alex Ovechkin's 20162017 season stats which include time information_
<details>
<summary>click for example</summary>
```json ```json
{ {
"copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.", "copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.",
@ -470,9 +513,13 @@ _however here is Alex Ovechkin's 20162017 season stats which include time inform
} }
``` ```
<br /></details>
`?stats=yearByYear` Provides a list of every season for a player's career `?stats=yearByYear` Provides a list of every season for a player's career
<details>
<summary>click for example</summary>
```json ```json
{ {
"copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2019. All Rights Reserved.", "copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2019. All Rights Reserved.",
@ -780,9 +827,13 @@ _however here is Alex Ovechkin's 20162017 season stats which include time inform
} ] } ]
} }
``` ```
<br /></details>
`?stats=homeAndAway&season=20162017` Provides a split between home and away games. `?stats=homeAndAway&season=20162017` Provides a split between home and away games.
<details>
<summary>click for example</summary>
```json ```json
{ {
"copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.", "copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.",
@ -856,6 +907,7 @@ _however here is Alex Ovechkin's 20162017 season stats which include time inform
} ] } ]
} }
``` ```
<br /></details>
`?stats=winLoss&season=20162017` Very similar to the previous modifier except it provides the W/L/OT split instead of Home and Away `?stats=winLoss&season=20162017` Very similar to the previous modifier except it provides the W/L/OT split instead of Home and Away
@ -874,6 +926,9 @@ _however here is Alex Ovechkin's 20162017 season stats which include time inform
`?stats=regularSeasonStatRankings&season=20162017` Returns where someone stands vs `?stats=regularSeasonStatRankings&season=20162017` Returns where someone stands vs
the rest of the league for a specific regularSeasonStatRankings the rest of the league for a specific regularSeasonStatRankings
<details>
<summary>click for example</summary>
```json ```json
{ {
"copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.", "copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.",
@ -902,10 +957,14 @@ the rest of the league for a specific regularSeasonStatRankings
} ] } ]
} }
``` ```
<br /></details>
`?stats=goalsByGameSituation&season=20162017` Shows number on when goals for a `?stats=goalsByGameSituation&season=20162017` Shows number on when goals for a
player happened like how many in the shootout, how many in each period, etc. player happened like how many in the shootout, how many in each period, etc.
<details>
<summary>click for example</summary>
```json ```json
{ {
"copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.", "copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.",
@ -938,10 +997,14 @@ player happened like how many in the shootout, how many in each period, etc.
} ] } ]
} }
``` ```
<br /></details>
`?stats=onPaceRegularSeason&season=20172018` This only works with the current `?stats=onPaceRegularSeason&season=20172018` This only works with the current
in-progress season and shows **projected** totals based on current onPaceRegularSeason in-progress season and shows **projected** totals based on current onPaceRegularSeason
<details>
<summary>click for example</summary>
```json ```json
{ {
"copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.", "copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.",
@ -984,6 +1047,8 @@ in-progress season and shows **projected** totals based on current onPaceRegular
} }
``` ```
<br /></details>
[back to top](#endpoint-tables) [back to top](#endpoint-tables)
@ -994,6 +1059,8 @@ in-progress season and shows **projected** totals based on current onPaceRegular
`GET https://statsapi.web.nhl.com/api/v1/draft/prospects/ID` Get an NHL Entry Draft prospect. `GET https://statsapi.web.nhl.com/api/v1/draft/prospects/ID` Get an NHL Entry Draft prospect.
<br /></details>
```json ```json
{ {
"copyright": "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.", "copyright": "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.",
@ -1034,6 +1101,8 @@ in-progress season and shows **projected** totals based on current onPaceRegular
] ]
} }
``` ```
<br /></details>
[back to top](#endpoint-tables) [back to top](#endpoint-tables)
# Schedule endpoints # Schedule endpoints
@ -1068,6 +1137,9 @@ in-progress season and shows **projected** totals based on current onPaceRegular
`GET https://statsapi.web.nhl.com/api/v1/schedule?teamId=30` Returns Minnesota Wild games for the current day. `GET https://statsapi.web.nhl.com/api/v1/schedule?teamId=30` Returns Minnesota Wild games for the current day.
<details>
<summary>click for example</summary>
```json ```json
{ {
"copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.", "copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.",
@ -1138,9 +1210,13 @@ in-progress season and shows **projected** totals based on current onPaceRegular
} ] } ]
} }
``` ```
<br /></details>
<br />
`GET https://statsapi.web.nhl.com/api/v1/schedule?teamId=30&startDate=2018-01-02&endDate=2018-01-02` Returns Minnesota Wild games for January 2, 2018 with attached linescores and broadcasts. `GET https://statsapi.web.nhl.com/api/v1/schedule?teamId=30&startDate=2018-01-02&endDate=2018-01-02` Returns Minnesota Wild games for January 2, 2018 with attached linescores and broadcasts.
<details>
<summary>click for example</summary>
```json ```json
{ {
"copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.", "copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.",
@ -1327,12 +1403,17 @@ in-progress season and shows **projected** totals based on current onPaceRegular
} }
``` ```
<br /></details>
[back to top](#endpoint-tables) [back to top](#endpoint-tables)
## Seasons ## Seasons
`GET https://statsapi.web.nhl.com/api/v1/seasons` Returns data on each season such as if ties were used, divisions, wildcards or the Olympics were participated in `GET https://statsapi.web.nhl.com/api/v1/seasons` Returns data on each season such as if ties were used, divisions, wildcards or the Olympics were participated in
<details>
<summary>click for example</summary>
```json ```json
{ {
"copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2019. All Rights Reserved.", "copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2019. All Rights Reserved.",
@ -1350,6 +1431,7 @@ in-progress season and shows **projected** totals based on current onPaceRegular
} ] } ]
} }
``` ```
<br /></details>
`GET https://statsapi.web.nhl.com/api/v1/seasons/20172018` Gets just the data for a specific season `GET https://statsapi.web.nhl.com/api/v1/seasons/20172018` Gets just the data for a specific season
@ -1365,6 +1447,9 @@ in-progress season and shows **projected** totals based on current onPaceRegular
`GET https://statsapi.web.nhl.com/api/v1/standings` Returns ordered standings data `GET https://statsapi.web.nhl.com/api/v1/standings` Returns ordered standings data
for each team broken up by divisions for each team broken up by divisions
<details>
<summary>click for example</summary>
```json ```json
{ {
"team" : { "team" : {
@ -1394,6 +1479,7 @@ for each team broken up by divisions
}, },
} }
``` ```
<br /></details>
#### Modifiers #### Modifiers
@ -1401,6 +1487,9 @@ for each team broken up by divisions
`?expand=standings.record` Detailed information for each team including home and away records, record in shootouts, last ten games, and split head-to-head records against divisions and conferences `?expand=standings.record` Detailed information for each team including home and away records, record in shootouts, last ten games, and split head-to-head records against divisions and conferences
<details>
<summary>click for example</summary>
```json ```json
{ {
"records" : { "records" : {
@ -1459,6 +1548,7 @@ for each team broken up by divisions
} }
} }
``` ```
<br /></details>
[back to top](#endpoint-tables) [back to top](#endpoint-tables)
@ -1467,6 +1557,9 @@ for each team broken up by divisions
`GET https://statsapi.web.nhl.com/api/v1/standingsTypes` Returns all the standings types `GET https://statsapi.web.nhl.com/api/v1/standingsTypes` Returns all the standings types
to be used in order do get a specific standings to be used in order do get a specific standings
<details>
<summary>click for example</summary>
```json ```json
{ {
[ { [ {
@ -1498,6 +1591,7 @@ to be used in order do get a specific standings
"description" : "Standings by League" "description" : "Standings by League"
} ] } ]
``` ```
<br /></details>
[back to top](#endpoint-tables) [back to top](#endpoint-tables)
@ -1507,6 +1601,8 @@ to be used in order do get a specific standings
`GET https://statsapi.web.nhl.com/api/v1/teams/5/stats` Returns current season stats and the current season rankings for a specific team `GET https://statsapi.web.nhl.com/api/v1/teams/5/stats` Returns current season stats and the current season rankings for a specific team
Ex: Ex:
<details>
<summary>click for example</summary>
```json ```json
{ {
@ -1597,6 +1693,8 @@ Ex:
} }
``` ```
<br /></details>
[back to top](#endpoint-tables) [back to top](#endpoint-tables)
## Teams ## Teams
@ -1627,6 +1725,9 @@ Add these to the end of the url
`?stats=statsSingleSeasonPlayoffs` Specify which stats to get. Not fully sure all of the values `?stats=statsSingleSeasonPlayoffs` Specify which stats to get. Not fully sure all of the values
<details>
<summary>click for example</summary>
```json ```json
{ {
"copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.", "copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.",
@ -1669,10 +1770,14 @@ Add these to the end of the url
"active" : true "active" : true
}, { }, {
``` ```
<br /></details>
`GET https://statsapi.web.nhl.com/api/v1/teams/ID/roster` Returns entire roster for a team `GET https://statsapi.web.nhl.com/api/v1/teams/ID/roster` Returns entire roster for a team
including id value, name, jersey number and position details. including id value, name, jersey number and position details.
<details>
<summary>click for example</summary>
```json ```json
{ {
"copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.", "copyright" : "NHL and the NHL Shield are registered trademarks of the National Hockey League. NHL and NHL team marks are the property of the NHL and its teams. © NHL 2018. All Rights Reserved.",
@ -1692,6 +1797,7 @@ including id value, name, jersey number and position details.
},] },]
} }
``` ```
<br /></details>
[back to top](#endpoint-tables) [back to top](#endpoint-tables)