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
Documenting the publicly accessible portions of the NHL API
100 Commits 6 Branches 0 Tags 1.7 MiB
Python 100%
0eb90b00ec
Go to file
Drew Hynes 0eb90b00ec Merge branch 'master' into 'master' 
updates formatting of stats-api.md

See merge request dword4/nhlapi!39
2023-08-13 20:38:05 +00:00
swagger first attempt at swagger docs 2022-12-26 15:08:53 +00:00
.gitlab-ci.yml changed to non-deprecated build command 2022-12-26 15:10:53 +00:00
LICENSE Add LICENSE 2019-06-24 17:28:48 +00:00
made-with.md Adds Hockey Predictions to made-with.md 2023-06-05 12:58:36 -06:00
misc.md made-with cleanup, added misc and updated README 2021-06-18 22:29:04 -04:00
README.md made-with cleanup, added misc and updated README 2021-06-18 22:29:04 -04:00
records-api.md Added list of team logos as "infinite res" SVGs for all teams and franchises going back to 1917...Yes, it includes the Montreal Wanderers. 2019-09-29 12:06:54 +00:00
stats-api.md folds all json into collapsible bits 2023-08-12 22:37:33 -06:00

README.md

NHL API Documentation

About this Project

This effort is purely to make it easier for stats nerds and the like to make use of the wonderful trove of information the NHL provides to us but in a much more digestible form.

Roadmap

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 Collection of things made using the NHL API documentation, by no means exhaustive and zero affiliation with these projects.
misc.md Random things the NHL API uses or is somehow related to
records-api.md Documentation on the API for records.nhl.com
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 open up a MR/PR and I will get it merged. Generally speaking I get things done in a few days as time permits between work and other obligations.

Contact

Generally I am reached via Twitter @dw0rd4

Acknowledgements

Kevin Sidwar - First real source of documentation I found on the API and gave me a nice starting point for a project that eventually evolved into this repository

Jon Ursenbach - Built out an OpenAPI 3 spec for the NHL API