Skip to content

[:warning:WIP] A JavaScript implementation of the Parkrun API gathered from reverse-engineering the official app.

License

Notifications You must be signed in to change notification settings

jcxldn/parkrun.js

Repository files navigation

parkrun.js

ci build status (master) docs build status (master) Codecov node-current Dist Size (Brotli) npm latest version

A JavaScript implementation of the Parkrun API gathered from reverse-engineering the official app.

Installation

npm i parkrun.js

Or, for usage in a browser:

<script src="https://cdn.jsdelivr.net/npm/parkrun.js"></script>


Bleeding edge releases

Please note that these releases will have bugs, and are not meant for production use.

  • via npm: npm i prouser123/parkrun.js

  • or for use within a browser: <script src="https://parkrun.js.org/parkrun.browser.min.js"></script>

FAQ

Upstream API Limitations

These are limitations with all services using the official parkrun API.

  • Freedom Runs can only be accessed for the current user

    • 401: Attempt to access details for AthleteId which does not match user AthleteId

Acknowledgments

About

[:warning:WIP] A JavaScript implementation of the Parkrun API gathered from reverse-engineering the official app.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •