To get your API Key, see Request an API Key. Once obtained, you can pass it in your requests with the
X-API-KEY-TOKEN header. It has a perpetual validity.
Note that upon successful login in this page, API key is automatically added to your requests
Want to integrate Foobot API in your application? We also implemented OAuth2 so you can retrieve and manage user authentication tokens. Let us know about your plans!
Foobot API supports GET and POST methods.
Although the API is available in plain HTTP, we strongly recommend using HTTPS. And that, for both accessing this page (where you can try the endpoints) and calling the API with your preferred HTTP client.
Your API key is strictly personal and should be kept in a safe place, as you would do with a password.
The main output format is JSON. Some endpoints are able to return data in CSV (see Data point API).
In that case you can add a
'Accept:text/csv' header to your request.
Responses are encoded in UTF-8, and so must be your requests.
For performance purposes, we also support gzip encoding of the response: add
to your request to get a compressed response body.
API keys are usually issued with a 200 requests/day quota.
We can apply throttling in case of excessive requests number. We generally do not allow more than 1 request per second.
A Foobot sends data every 5 minutes. It is therefore useless to request datapoints more often.
Request only few datapoints per request. If you provide a wide time range, the response will be slower. A valid example would be to issue a call every hour, with start time being current time minus 1 hour.
2018-01-25: Added filtering based on sensor type, A list of sensors can be specified in the request to the API.
2016-09-05: simplify authentication, API key is now the only authentication token required in the requests.