Authentication

You will need an API key to use our API. If you don't have an hive.one account click here to sign up for one:

Once you've signed up (or if you already had an account) click here to get your API key

To use your API key you must set the Authorization HTTP header like so:

Authorization: Token <YOURAPIKEY>

Rate Limits

To ensure a consistent experience for all API users, our endpoints are rate limited.

When making requests with an API key you are allowed to make 2 requests per second

If you exceed your rate limit all requests will return with a 420 status code.

Tips to avoid being Rate Limited

Caching

We recommend to cache our data in your applications to ensure you are not requesting the same data unnecessarily

Our data updates every 24 hours.

ETags

Our endpoints will return with an ETag in the HTTP headers. We recommend using this ETag to check if your data needs a refresh when updating your cache.

Find out more here