The API returns HTTP responses on each request to indicate the success or otherwise of API requests. The codes listed below are often used, and the API may use others. Note that 4xx and 5xx responses may be returned for any request and clients should cater for them.
Response Code | Description |
|---|---|
200 | Ok -- The request was successful. |
201 | Created -- The request was successful. |
400 | Bad Request -- General client error, possibly malformed data. |
401 | Unauthorized -- The API Key was not authorised (or no API Key was found). |
403 | Forbidden -- The request is not allowed. |
404 | Not Found -- The resource was not found. |
422 | Unprocessable Entity -- The data was well-formed but invalid. |
429 | Too Many Requests -- The client has reached or exceeded a rate limit, or the server is overloaded. |
500 | Server Error - Something went wrong on our end. This response is most likely a momentary operational error (e.g. temporary unavailability), and, as a result, requests should be retried once. |