Response format

Every response from the BackQuant API uses the same envelope structure, whether the request succeeds or fails. Always check the success field before reading data or error.

Success response

When a request succeeds, success is true and the result is in data. The meta block carries everything you need to know about the provenance and freshness of the data.

{
  "success": true,
  "data": {
    "all_expiry": {
      "hvl": 67000,
      "call_resistance": 70000,
      "put_support": 64000
    },
    "odte": {
      "hvl": 67500,
      "call_resistance": 68000,
      "put_support": 66500
    }
  },
  "meta": {
    "version": "2.7",
    "timestamp": "2026-04-30T12:00:00.123Z",
    "request_id": "req_a1b2c3d4...",
    "symbol": "BTCUSDT",
    "spot_price": 67213.5,
    "computed_at": "2026-04-30T11:59:48.000Z",
    "freshness_seconds": 12.0,
    "source": ["deribit", "bybit", "okx", "binance"]
  }
}

Error response

When a request fails, success is false and the reason is in error. The meta block keeps the same shape so logging code doesn’t have to special-case errors.

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Try again in 60 seconds.",
    "details": {
      "retry_after_seconds": 60,
      "limit": "120 per 1 minute"
    }
  },
  "meta": {
    "version": "2.7",
    "timestamp": "2026-04-30T12:00:00.123Z",
    "request_id": "req_a1b2c3d4..."
  }
}

See Errors for the full list of error codes.

Fields

boolean

required

true if the request succeeded, false if it failed. Always check this field first.

object

The response payload. Present when success is true. The shape varies by endpoint - see the API reference for each endpoint’s schema. The top 10 most-traffic endpoints have Pydantic-typed schemas in the OpenAPI spec; the rest are documented with examples.

object

Present when success is false.

Show properties

string

required

Machine-readable error code. See Errors.

string

required

Human-readable description.

object

Optional structured payload - e.g. RATE_LIMIT_EXCEEDED returns retry_after_seconds; VALIDATION_ERROR returns the failing field list.

object

required

Metadata included in every response - success or error.

Show properties

string

required

The v2 contract version that served the response - currently "2.7".This is major.minor, and it changes: the minor bumps whenever a public default or response contract changes (see the changelog). Treat it as informational, or compare the major. Do not assert equality on the full string, or a routine release will break your client.

string

required

ISO 8601 wall-clock when the response was built.

string

Per-request UUID, propagated from X-Request-ID header. Include this when reporting issues - we trace by it in our logs and Sentry.

string

Symbol the response is about, when applicable (e.g. BTCUSDT).

number

Current spot price for the symbol at the time of computation. Useful for normalising returns or sizing.

string

ISO 8601 of when the underlying cache value was last written by our worker.

number

now - computed_at in seconds. Useful for staleness alarms in your code.

array

Upstream venue list the data flowed through, e.g. ["deribit", "bybit", "okx", "binance"]. For provenance.

array

Echo of the ?exchanges= filter when one was applied. Confirms what your filter actually narrowed to.

object

{limit, remaining, reset} echo of the rate-limit headers. Echoed in body too so browser-based dashboards can read it without inspecting headers.

object

Open dict for endpoint-specific metadata (e.g. filter_hash on /options/chain, expiry_count on /options/opex).

Pydantic schemas

Twelve of the 62 v2 endpoints have full Pydantic response schemas in the OpenAPI spec. Use them with codegen tools (openapi-python-client, openapi-typescript-codegen, etc.) to get typed client SDKs:

GexLevelsResponse, GexStrikeProfileResponse, MaxPainResponse
ChainResponse, ExpirySummaryResponse, OpexResponse
IvTermStructureResponse, IvSkewResponse, ProbabilityDensityResponse
MultiGexLevelsResponse, TraceResponse
Plus ChangelogResponse

Every other endpoint is documented with examples and the same envelope shape.

Errors

Every error code with HTTP status mapping.

Rate limits

Rate-limit headers and tier-based throttling.

Data freshness

What computed_at and freshness_seconds mean per endpoint.

Get Started

Concepts

Code examples

API: Discovery & Meta

API: GEX

API: Options chain & OPEX

API: IV analytics

API: Probability density

API: Greeks

API: Open interest & flow

API: Futures & liquidation

API: Multi-symbol

API: Tape & WebSocket

API: Market data

API: ETF flows

Success response

Error response

Fields

Pydantic schemas

See also

Errors

Rate limits

Data freshness

​Success response

​Error response

​Fields

​Pydantic schemas

​See also

Errors

Rate limits

Data freshness

Success response

Error response

Fields

Pydantic schemas

See also