All responses are returned in JSON format. We specify this by sending the Content-Type header.

Response example:

HTTP/1.1 200 OK
Content-Type: application/json
    "success": "true",

Status Codes

Status Code Description
200 Success
400 Bad request
401 Requires authentication
404 Not Found
429 Too Many Requests
500 Internal server error

All failed responses will contain a JSON response with "error" set to true and an error message. 

Example response of a failed request:

HTTP/1.1 400 Bad request
Content-Type: application/json
    "error": "true",
    "message": "Some error message", 

Rate Limits

All calls within the Web API are allotted a specific number of requests per refresh period.

Depending on the endpoint you are trying to reach, it will have a specific number of allowed requests per refresh period. Once this threshold has been reached, we will return a status code 429 response.

Each API response contains X-RateLimit Headers that inform you about your current rate limit.

Example response:

HTTP/1.1 200 OK
Content-Type: application/json
X-RateLimit-Limit: 180
X-RateLimit-Remaining: 179
X-RateLimit-Reset: 60
  "foo": "bar"

When the limit is reached you will no longer be able to make requests against that endpoint for the duration of that refresh period. 

Per default you can make a minimum of 120 request per minute. This equals 2 requests per second.