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

Fixed import errors in markdown

Browse Source
This commit is contained in:
Drew Hynes 2018-06-05 13:27:43 +00:00
parent a85a69a3a1
commit c20e1d874a
1 changed files with 32 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
README.md
View File

@ -55,9 +55,10 @@ for a single team instead of the entire league.
`?teamId=4,5,29` Can string team id together to get multiple teams `?teamId=4,5,29` Can string team id together to get multiple teams
`?stats=statsSingleSeasonPlayoffs` Speciy 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
```{ ```
{
"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.",
"teams" : [ { "teams" : [ {
"id" : 1, "id" : 1,
@ -97,12 +98,13 @@ for a single team instead of the entire league.
"franchiseId" : 23, "franchiseId" : 23,
"active" : true "active" : true
}, { }, {
``` ```
`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.
```{ ```
{
"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.",
"roster" : [ { "roster" : [ {
"person" : { "person" : {
@ -127,7 +129,8 @@ 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.
```{ ```
{
"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.",
"divisions" : [ { "divisions" : [ {
"id" : 17, "id" : 17,
@ -149,7 +152,8 @@ 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.
```{ ```
{
"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.",
"conferences" : [ { "conferences" : [ {
"id" : 6, "id" : 6,
@ -172,7 +176,8 @@ specific conference, also can look up id 7 for World Cup of Hockey.
### <a name="people"></a>People ### <a name="people"></a>People
`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.
```{ ```
{
"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.",
"people" : [ { "people" : [ {
"id" : 8477474, "id" : 8477474,
@ -217,7 +222,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*
```{ ```
{
"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.",
"stats" : [ { "stats" : [ {
"type" : { "type" : {
@ -249,7 +255,8 @@ and does not include things like evenTimeOnIce and other time related stats*
*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*
```{ ```
{
"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.",
"stats" : [ { "stats" : [ {
"type" : { "type" : {
@ -291,7 +298,8 @@ and does not include things like evenTimeOnIce and other time related stats*
} }
``` ```
`?stats=homeAndAway&season=20162017` Provides a split between home and away games. `?stats=homeAndAway&season=20162017` Provides a split between home and away games.
```{ ```
{
"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.",
"stats" : [ { "stats" : [ {
"type" : { "type" : {
@ -380,7 +388,8 @@ and does not include things like evenTimeOnIce and other time related stats*
`?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
```{ ```
{
"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.",
"stats" : [ { "stats" : [ {
"type" : { "type" : {
@ -411,7 +420,8 @@ the rest of the league for a specific regularSeasonStatRankings
`?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.
```{ ```
{
"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.",
"stats" : [ { "stats" : [ {
"type" : { "type" : {
@ -445,7 +455,8 @@ player happened like how many in the shootout, how many in each period, etc.
`?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
```{ ```
{
"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.",
"stats" : [ { "stats" : [ {
"type" : { "type" : {
@ -603,7 +614,8 @@ The first 4 digits identify the season of the game (ie. 2017 for the 2017-2018 s
`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.
```{ ```
{
"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.",
"totalItems" : 1, "totalItems" : 1,
"totalEvents" : 0, "totalEvents" : 0,
@ -896,7 +908,8 @@ 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
```{ ```
{
[ { [ {
"name" : "regularSeason", "name" : "regularSeason",
"description" : "Regular Season Standings" "description" : "Regular Season Standings"
@ -945,7 +958,8 @@ to be used in order do get a specific kind of player stats
Ex: Ex:
```{ ```
{
"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.",
"stats" : [ { "stats" : [ {
"type" : { "type" : {
@ -1041,7 +1055,8 @@ Ex:
`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
```{ ```
{
"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.",
"drafts": [{ "drafts": [{
"draftYear": 2017, "draftYear": 2017,