Errors

It's highly unlikely that you'll get any errors since this is a readonly API. However, you might get a 422 error if the optional parameters you provide are invalid. Look for the "errors" key in the JSON response for more information.

Error Responses

When an error occurs, the API will return an appropriate HTTP status code along with a JSON response containing error details.

Common Status Codes

Status Description
401 Unauthorized - Invalid or missing API key
404 Not Found - The requested resource doesn't exist
422 Unprocessable Entity - Invalid parameters
429 Too Many Requests - Rate limit exceeded
500 Internal Server Error - Something went wrong on our end

Error Response Format

{
    "message": "The given data was invalid.",
    "errors": {
        "field_name": [
            "The field_name must be a valid date."
        ]
    }
}