Flobyt API

Flobyt is open. You can use our API for free within the daily limit set for your account.

If you would like to have an API account with us, click here to request for an API Key. Your API key would be sent to your email. You must have a valid use case for us to provide this API.


API Key Usage

A user may pass their API key in one of several ways. In order of precedence:

HTTP Header

Pass the API key into the X-Api-Key header:

curl -H 'X-Api-Key: YOUR_KEY' 'https://api.flobyt.com/v1/'

GET Query Param

Pass the API key into the api_key GET query string parameter:

curl 'https://api.flobyt.com/v1/?api_key=YOUR_KEY'

Note: The GET query parameter may be used for non-GET requests (such as POST and PUT).

HTTP Basic Auth Username

As an alternative, pass the API key as the username (with an empty password) using HTTP basic authentication:

$ curl 'https://[email protected]/v1/'

Rate Limits

Limits are placed on the number of API requests you may make using your API key. Rate limits may vary by service, but the defaults are:

  • Hourly Limit: 1,000 requests per hour

For each API key, these limits are applied across all API requests. Exceeding these limits will lead to your API key being temporarily blocked from making further requests. The block will automatically be lifted by waiting an hour.

How Do I See My Current Usage?

Your can check your current rate limit and usage details by inspecting the X-RateLimit-Limit and X-RateLimit-Remaining HTTP headers that are returned on every API response. For example, if an API has the default hourly limit of 1,000 request, after making 2 requests, you will receive these HTTP headers in the response of the second request:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 998


Understanding Rate Limit Time Periods

Hourly Limit

The hourly counters for your API key reset on a rolling basis.

Example: If you made 500 requests at 10:15AM and 500 requests at 10:25AM, your API key would become temporarily blocked. This temporary block of your API key would cease at 11:15AM, at which point you could make 500 requests. At 11:25AM, you could then make another 500 requests.

Rate Limit Error Response

If your API key exceeds the rate limits, you will receive a response with an HTTP status code of 429 (Too Many Requests).