After frequently putting you off with statements such as “In progress” and “Coming soon”, the time has finally come. Runalyze has a new API! The API for third-party apps (Third Party API) and for personal use (Personal API) has been completely renewed.
In order for us to be able to offer an app in the future and for third-party apps to also be able to use the API for reading, it was necessary to completely refactor our API.
FAQ
What has changed in the Personal API?
There are numerous new endpoints for the personal API, including some for reading data. The permitted scopes are therefore defined for each token of the personal API.
Older, existing tokens only have access to the endpoints to which they previously had access.
Where can I find the documentation?
- Free users: https://runalyze.com/doc/api/free
- Supporter users: https://runalyze.com/doc/api/supporter
- Premium users: https://runalyze.com/doc/api/premium (almost the same as “Supporter”)
- Third party apps have access to these endpoints (depends on the allowed scopes): https://runalyze.com/doc/api/api
Which third-party apps get read access?
At the moment, no third-party app has read access. This will remain the case for a while. On the one hand, we want to provide a stable API, while at the same time making sensible use of the resources we can provide.
If read access is granted, the apps would also have to have the connection renewed by the user. Third-party apps will not suddenly have read access to the data.
Why does the endpoint XY not exist?
Because we had to set priorities and have a long to-do list. We are aware that there are still some missing endpoints, especially for activities. We will work on this.
If you have specific requests, you can leave a feature request at ideas.runalyze.com at any time.
What new endpoints are there?
Beside the “Read” endpoints there is a new endpoint to get your current statistics (mainly the ones you see in the calculations panel).
What has changed in the Third Party API?
Existing scope names can be kept. With the new API we’re introducing a very detailed scope system, which really allows to limit clients to write/read/delete/patch data on Runalyze. The scope names are currently not visible in the API documentation. We will extend the documentation as soon as we found a good automatic solution.
- “activity_push” stays the same and has access to the same endpoints
- “health_metrics_write” is now an alias which contains all needed scopes for writing health metrics
