Guide

Errors & rate limits

Stable error envelopes, docs_url links, and backoff.

Error envelope

Failed responses use ok: false with a structured error object and meta.request_id. Include the request_id in support tickets. Each error also includes docs_url pointing at the public catalog.

{
  "ok": false,
  "error": {
    "code": "missing_scope",
    "message": "The API key does not include the required scope.",
    "docs_url": "https://docs.statxe.com/api/errors/missing_scope"
  },
  "meta": {
    "request_id": "req_123"
  }
}

Rate limits

When limited, the API returns rate_limited (typically HTTP 429). Honor Retry-After and use exponential backoff with jitter for bursts.