Error Handling

HTTP Status Codes

The API uses conventional HTTP status codes to indicate success or failure.
StatusMeaningWhat to do
200 OKThe request succeededParse the response body
400 Bad RequestInvalid request parametersCheck your query parameters for typos
404 Not FoundThe dataset or endpoint doesn't existVerify the slug and config name in the URL
429 Too Many RequestsRate limit exceededWait and retry with exponential backoff
500 Internal Server ErrorSomething went wrong on our endWait a moment and retry; report if it persists

Error Response Format

When an error occurs, the API returns a JSON body with details:

{
  "error": {
    "code": "not_found",
    "message": "Dataset 'tea' not found for source 'unknown'"
  }
}

Error fields

FieldTypeDescription
error.codestringMachine-readable error identifier
error.messagestringHuman-readable description of what went wrong

Error Codes

CodeMeaning
not_foundThe requested dataset or source doesn't exist
invalid_parameterA query parameter has an invalid value
rate_limitedToo many requests in a short period
internal_errorAn unexpected error occurred on the server