General information

The API base URL is

All API calls are implemented as HTTP POST. Unless the request irrecoverably crashes, the HTTP response code is always 200 and the error, if any, is specified via the result field in the response (which can be either ok or error).


Each request to the API must contain an API key for authentication, in an apiKey parameter. API keys can be generated in your dashboard.

Request data

All request data posted to the API must be in JSON objects. The documentation for each API route describes the request data parameters in detail.

Return data

Return data from the API is in JSON objects.


Set the Content-Type header to application/json on all requests.