In case of an error, the API response will include a JSON object providing more details about the error. See the example at the right.
The API uses standard HTTP status codes to indicate the success or failure of a request. In the event of an error, the API will return an appropriate HTTP status code along with a detailed error message in the response body.
Below are the HTTP status codes you may encounter:
200 OK — The request was successful, and the response contains the expected data.
400 Bad Request — The request was invalid or missing required parameters. Check the request format and ensure all required fields are included.
401 Unauthorized — The API key is missing or invalid. Ensure you've included a valid x-api-key in the headers of your request.
403 Forbidden — You do not have permission to access the requested resource. Verify your access rights or contact support.
404 Not Found — The requested resource does not exist. Check the endpoint URL and resource identifiers.
500 Internal Server Error — An error occurred on the server. This is likely a temporary issue, and retrying the request may resolve it. If the problem persists, contact support.
|
Example of an error
{
"error": {
"code": 400,
"message": "Invalid request. Missing 'date_from' parameter." } }
|