2018-01-05 20:02:58 +00:00
# NHL API Documentation
2020-02-20 16:30:02 +00:00
2018-02-16 12:50:16 +00:00
---
2020-02-20 16:30:02 +00:00
## About this Project
2018-02-16 12:50:16 +00:00
2018-09-18 00:33:01 +00:00
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
2020-02-20 16:30:02 +00:00
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)
2021-06-19 02:29:04 +00:00
## 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!|
2020-02-20 16:30:02 +00:00
## 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 ](https://twitter.com/dw0rd4 )
## Acknowledgements
[Kevin Sidwar ](https://www.kevinsidwar.com/ ) - 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 ](https://github.com/erunion ) - Built out an [OpenAPI 3 spec ](https://github.com/erunion/sport-api-specifications ) for the NHL API
