Errors

Our APIs use conventional HTTP response codes to indicate the success or failure of a request. A 200 means that an API returned a matching record, and a 404 means that an API neither found nor returned a matching record. Any 4xx error besides a 404 indicates that there was an issue with the request, and 5xx errors indicate that an internal issue with the API occurred.

4xx Response Fields

Field Name	Type	Description
`error`	object	The object containing the error type and message.
`status`	integer	The HTTP status code.

Example 404 Response

{
    "status": 404,
    "error": {
        "type": "not_found",
        "message": "No records were found matching your request"
    }
}

Example 429 Response

{
    "status": 429,
    "error": {
        "type": "rate_limit_error",
        "message": "An error occurred due to requests hitting the API too quick"
    }
}

Error codes

Status	Error Name	Description
`400`	`invalid_request_error`	The request contained either missing or invalid parameters.
`401`	`authentication_error`	The request contained a missing or invalid key.
`402`	`payment_required`	You have reached your account maximum (all matches have been used).
`404`	`not_found`	There were no records found matching your request.
`405`	`invalid_request_error`	You cannot use the request method on the requested resource.
`429`	`rate_limit_error`	An error occurred due to requests hitting the API too quick.
`5xx`	`api_error`	The server encountered an unexpected condition that prevented it from fulfilling the request.