Github
/
nhlapi
mirror of https://gitlab.com/dword4/nhlapi
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

made-with cleanup, added misc and updated README

This commit is contained in:
Drew Hynes 2021-06-18 22:29:04 -04:00
parent d733ecd532
commit f4ea97e0af
3 changed files with 31 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -13,6 +13,17 @@ Eventually build documentation on features such as cayenneExp which allows for
retrieval of very complex documentation and perhaps even a more thorough set of
documentation including examples in multiple common langages (such as using Swagger)
## Files
| file | description |
| --- | --- |
|[made-with.md](made-with.md)|Collection of things made using the NHL API documentation, by no means exhaustive and zero affiliation with these projects.|
|[misc.md](misc.md)|Random things the NHL API uses or is somehow related to|
|[records-api.md](records-api.md)|Documentation on the API for records.nhl.com|
|[stats-api.md](stats-api.md)|The one, the only NHL API (stats) documentation!|
## Contributing
I am only one person so if you see something I have missed please feel free to

6
made-with.md
View File

@ -7,13 +7,17 @@ This document exists to collect things that people make using this documentation
## nhl-api-explorer
Description: nuxtjs client with nodejs server (to bypass CORS headers).
Live: https://nhl-api-explorer.herokuapp.com/
Code: https://gitlab.com/sebastienblanchet/nhl-api-explorer
Author: [Sebastien Blanchet](https://gitlab.com/sebastienblanchet)
## hockey-info.online
Description: web app showing hockey information in a mobile friendly format
Live: https://www.hockey-info.online
Code: https://gitlab.com/dword4/hockey-info
Author: [Me](https://gitlab.com/dword4)

15
misc.md Normal file
View File

@ -0,0 +1,15 @@
# Miscellaneous
This area documents things not directly part of the NHL API but related to it, utilized by it or otherwise related to it somehow.
## Player Name Suggestion
This service appears to be a search of players based on name
`GET https://suggest.svc.nhl.com/svc/suggest/v1/minplayers/NAME/NUMBER`
Takes the NAME value which can be any part of a player's name and a NUMBER of results to return, this endpoint searches for all players with this name fragment
`GET https://suggest.svc.nhl.com/svc/suggest/v1/minactiveplayers/NAME/NUMBER`
Same as the minplayers endpoint however this only looks at active players.