Github/nhlapi
1
0
Fork 0
mirror of https://gitlab.com/dword4/nhlapi synced 2024-11-24 03:24:54 +00:00
Code Issues Projects Releases Wiki Activity

Merge branch 'rosetta-finds' into 'master'

Browse Source 
Rosetta finds

See merge request dword4/nhlapi!31
This commit is contained in:
Drew Hynes 2021-01-07 13:45:01 +00:00
commit 162437c609
1 changed files with 54 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
stats-api.md
View File

@ -3,6 +3,14 @@
[OpenAPI 3.0 specification file for the NHL API](https://github.com/erunion/sport-api-specifications/tree/master/nhl) thanks to @[erunion](https://github.com/erunion) [OpenAPI 3.0 specification file for the NHL API](https://github.com/erunion/sport-api-specifications/tree/master/nhl) thanks to @[erunion](https://github.com/erunion)
[Configurations](#configurations)
[Expands](#expands)
[Languages](#languages)
[Platforms](#platforms)
[Franchises](#franchises) [Franchises](#franchises)
[Teams](#teams) [Teams](#teams)
@ -41,6 +49,32 @@
[Event Types](#event-types) [Event Types](#event-types)
[Performer Types](#performer-types)
---
### <a name="configurations"></a>Configurations
`GET https://statsapi.web.nhl.com/api/v1/configurations` Returns a huge list of other endpoints, sort of the rosetta stone discovery tying many parts of the API together
---
### <a name="expands"></a>Expands
`GET https://statsapi.web.nhl.com/api/v1/expands` Shows all possible input for the expand field
---
### <a name="languages"></a>Languages
`GET https://statsapi.web.nhl.com/api/v1/languages`
Shows all possible languages for the API
---
### <a name="platforms"></a>Platforms
`GET https://statsapi.web.nhl.com/api/v1/platforms`
This seems to allow the API to be tailored to a specific platform, indicating platform specific behavior/apps.
--- ---
### <a name="franchises"></a>Franchises ### <a name="franchises"></a>Franchises
@ -851,30 +885,30 @@ multiple types of media relating to the game including videos of shots, goals an
Returns updates (like new play events, updated stats for boxscore, etc.) for the specified game ID Returns updates (like new play events, updated stats for boxscore, etc.) for the specified game ID
since the given startTimecode. If the startTimecode param is missing, returns an empty array. since the given startTimecode. If the startTimecode param is missing, returns an empty array.
#### <a name="game-ids">Game IDs #### <a name="game-ids"></a>Game IDs
The first 4 digits identify the season of the game (ie. 2017 for the 2017-2018 season). The next 2 digits give the type of game, where 01 = preseason, 02 = regular season, 03 = playoffs, 04 = all-star. The final 4 digits identify the specific game number. For regular season and preseason games, this ranges from 0001 to the number of games played. (1271 for seasons with 31 teams (2017 and onwards) and 1230 for seasons with 30 teams). For playoff games, the 2nd digit of the specific number gives the round of the playoffs, the 3rd digit specifies the matchup, and the 4th digit specifies the game (out of 7). The first 4 digits identify the season of the game (ie. 2017 for the 2017-2018 season). The next 2 digits give the type of game, where 01 = preseason, 02 = regular season, 03 = playoffs, 04 = all-star. The final 4 digits identify the specific game number. For regular season and preseason games, this ranges from 0001 to the number of games played. (1271 for seasons with 31 teams (2017 and onwards) and 1230 for seasons with 30 teams). For playoff games, the 2nd digit of the specific number gives the round of the playoffs, the 3rd digit specifies the matchup, and the 4th digit specifies the game (out of 7).
#### <a name="game-types">Game Types #### <a name="game-types"></a>Game Types
`GET https://statsapi.web.nhl.com/api/v1/gameTypes` `GET https://statsapi.web.nhl.com/api/v1/gameTypes`
Returns list of game types with description and post-season status Returns list of game types with description and post-season status
#### <a name="game-status">Game Status #### <a name="game-status"></a>Game Status
`GET https://statsapi.web.nhl.com/api/v1/gameStatus` `GET https://statsapi.web.nhl.com/api/v1/gameStatus`
Returns a list of game status values Returns a list of game status values
#### <a name="play-types">Play Types #### <a name="play-types"></a>Play Types
`GET https://statsapi.web.nhl.com/api/v1/playTypes` `GET https://statsapi.web.nhl.com/api/v1/playTypes`
This shows all the possible play types found within the liveData/plays portion of the game feed This shows all the possible play types found within the liveData/plays portion of the game feed
--- ---
### <a name="tournaments">Tournaments ### <a name="tournaments"></a>Tournaments
`GET https://statsapi.web.nhl.com/api/v1/tournamentTypes` `GET https://statsapi.web.nhl.com/api/v1/tournamentTypes`
@ -953,7 +987,7 @@ In order to get additional information the expand modifer can be used such as th
--- ---
### <a name="schedule">Schedule ### <a name="schedule"></a>Schedule
`GET https://statsapi.web.nhl.com/api/v1/schedule` Returns a list of data about the schedule for a specified date range. If no date range is specified, returns results from the current day. `GET https://statsapi.web.nhl.com/api/v1/schedule` Returns a list of data about the schedule for a specified date range. If no date range is specified, returns results from the current day.
@ -1242,7 +1276,7 @@ Without any flags or modifiers this endpoint will NOT return pre-season games th
``` ```
--- ---
### <a name="seasons">Seasons ### <a name="seasons"></a>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
``` ```
@ -1269,7 +1303,7 @@ Without any flags or modifiers this endpoint will NOT return pre-season games th
--- ---
### <a name="standings">Standings ### <a name="standings"></a>Standings
`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
@ -1369,7 +1403,7 @@ for each team broken up by divisions
``` ```
--- ---
### <a name="standings-types">Standings Types ### <a name="standings-types"></a>Standings Types
`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
@ -1409,14 +1443,14 @@ to be used in order do get a specific standings
--- ---
### <a name="stats-types">Stats Types ### <a name="stats-types"></a>Stats Types
`GET https://statsapi.web.nhl.com/api/v1/statTypes` Returns all the stats types `GET https://statsapi.web.nhl.com/api/v1/statTypes` Returns all the stats types
to be used in order do get a specific kind of player stats to be used in order do get a specific kind of player stats
--- ---
### <a name="team-stats">Team Stats ### <a name="team-stats"></a>Team Stats
`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
@ -1513,7 +1547,7 @@ Ex:
--- ---
### <a name="draft">Draft ### <a name="draft"></a>Draft
`GET https://statsapi.web.nhl.com/api/v1/draft` Get round-by-round data for current year's NHL Entry Draft. `GET https://statsapi.web.nhl.com/api/v1/draft` Get round-by-round data for current year's NHL Entry Draft.
@ -1545,7 +1579,7 @@ Ex:
}, },
``` ```
### <a name="prospects">Prospects ### <a name="prospects"></a>Prospects
`GET https://statsapi.web.nhl.com/api/v1/draft/prospects` Get all NHL Entry Draft prospects. `GET https://statsapi.web.nhl.com/api/v1/draft/prospects` Get all NHL Entry Draft prospects.
@ -1590,7 +1624,7 @@ Ex:
} }
``` ```
### <a name="awards">Awards ### <a name="awards"></a>Awards
`GET https://statsapi.web.nhl.com/api/v1/awards` Get all NHL Awards. `GET https://statsapi.web.nhl.com/api/v1/awards` Get all NHL Awards.
@ -1612,7 +1646,7 @@ Ex:
} }
``` ```
### <a name="venues">Venues ### <a name="venues"></a>Venues
`GET https://statsapi.web.nhl.com/api/v1/venues` Get all NHL Venues in API database. `GET https://statsapi.web.nhl.com/api/v1/venues` Get all NHL Venues in API database.
@ -1629,10 +1663,14 @@ Ex:
} ] } ]
} }
``` ```
---
### <a name="event-types">Event Types ### <a name="event-types"></a>Event Types
`GET https://statsapi.web.nhl.com/api/v1/eventTypes` `GET https://statsapi.web.nhl.com/api/v1/eventTypes`
Shows several event types beyond just hockey games, possibly an artifact left over from being reconfigured to be used by the NHL Shows several event types beyond just hockey games, possibly an artifact left over from being reconfigured to be used by the NHL
### <a name="performer-types"></a>Performer Types
`GET https://statsapi.web.nhl.com/api/v1/performerTypes` List of performer types likely tied to venue scheduling information