Options chain

GET

options

chain

Filtered options chain

curl --request GET \
  --url https://api.example.com/options/chain \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.example.com/options/chain', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/options/chain",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/options/chain"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/options/chain")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "contracts": [
      {
        "strike": 123,
        "expiry": "<string>",
        "dte": 123,
        "type": "call",
        "oi": 123,
        "iv": 123,
        "mark": 123,
        "bid": 123,
        "ask": 123,
        "volume": 123,
        "notional_volume": 123,
        "trade_count": 123,
        "delta": 123,
        "gamma": 123,
        "theta": 123,
        "vega": 123,
        "vanna": 123,
        "charm": 123,
        "gex": 123
      }
    ],
    "aggregates": {
      "net_gex": 123,
      "call_gex": 123,
      "put_gex": 123,
      "total_oi": 123,
      "call_oi": 123,
      "put_oi": 123,
      "contract_count": 123,
      "pcr": 123,
      "atm_iv": 123
    },
    "available_expiries": [
      "<string>"
    ],
    "truncated": true,
    "total_matching_count": 123,
    "max_contracts": 123
  },
  "meta": {
    "version": "2.0",
    "timestamp": "<string>",
    "request_id": "<string>",
    "symbol": "<string>",
    "spot_price": 123,
    "computed_at": "<string>",
    "freshness_seconds": 123,
    "source": [
      "<string>"
    ],
    "exchanges_filtered": [
      "<string>"
    ],
    "rate_limit": {},
    "extra": {}
  },
  "success": true
}

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API key"
  },
  "meta": {
    "version": "2.0",
    "timestamp": "2026-04-29T12:00:00Z"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "version": "2.0",
    "timestamp": "<string>",
    "request_id": "<string>",
    "symbol": "<string>",
    "spot_price": 123,
    "computed_at": "<string>",
    "freshness_seconds": 123,
    "source": [
      "<string>"
    ],
    "exchanges_filtered": [
      "<string>"
    ],
    "rate_limit": {},
    "extra": {}
  },
  "success": false
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters",
    "details": {
      "errors": []
    }
  },
  "meta": {
    "version": "2.0",
    "timestamp": "2026-04-29T12:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Try again later."
  },
  "meta": {
    "version": "2.0",
    "timestamp": "2026-04-29T12:00:00Z"
  }
}

Filtered chain with two-layer projection (?fields= top-level, ?include= per-contract) and a payload cap (?max_contracts). Cached 30s per filter combination.

Where each number comes from

A chain row mixes cross-venue and single-venue fields on purpose. Reading a single-venue field as a market-wide total is the most common way to misread this endpoint.

Field	Scope
`oi`	All eight venues, summed
`bid`, `ask`, `mark`	Deribit only. Use venue-book for consolidated best bid and offer
`volume`, `notional_volume`, `trade_count`	All eight venues on BTC and ETH; Deribit only on SOL, Derive only on HYPE

The activity fields cover a rolling 24 hours and arrive under ?include=volume. volume is contracts, notional_volume is premium paid in USD, and trade_count is prints. All three mean the same thing on every symbol; only the venue scope differs. Under ?as_of=, these three are recomputed from the tape for the window ending at that snapshot (meta.extra.activity_rebuilt confirms it). bid and ask are not recoverable that way and stay 0 on chains persisted before 2026-09-01 - meta.extra.quotes_note says so.

On the activity fields, null is not 0. A 0 means measured and nothing traded; a null means not measured. SOL reports trade_count: null, because no venue publishes a per-contract trade count for it, and BTC/ETH read null in the brief window where the cross-venue measurement is unavailable.

Full reasoning, including why SOL and HYPE are not blended, is in Venues.

Which fields are cross-venue

Consolidated best bid/offer

Greeks beyond delta

Refresh cadences

Authorizations

X-API-Key

string

header

required

Your BackQuant API key (same key as v1)

Headers

X-API-Key

string | null

Query Parameters

symbol

enum<string>

default:BTCUSDT

Trading symbol: BTCUSDT, ETHUSDT, SOLUSDT, or HYPEUSDT.

Available options:

BTCUSDT,

ETHUSDT,

SOLUSDT,

HYPEUSDT

expiries

string | null

CSV of expiry tokens (e.g. 28MAR25,25APR25)

dte_min

integer | null

Inclusive lower bound on days-to-expiry.

Required range: 0 <= x <= 720

dte_max

integer | null

Inclusive upper bound on days-to-expiry.

Required range: 0 <= x <= 720

oi_min

number | null

Minimum open interest per contract.

Required range: x >= 0

oi_max

number | null

Maximum open interest per contract.

Required range: x >= 0

delta_min

number | null

Minimum |delta| (0..1).

Required range: 0 <= x <= 1

delta_max

number | null

Maximum |delta| (0..1).

Required range: 0 <= x <= 1

strike_min

number | null

Minimum strike price (absolute).

Required range: x >= 0

strike_max

number | null

Maximum strike price (absolute).

Required range: x >= 0

moneyness_min

number | null

Strike/spot lower bound (e.g. 0.9 for ATM-10%).

Required range: 0 <= x <= 10

moneyness_max

number | null

Strike/spot upper bound (e.g. 1.1 for ATM+10%).

Required range: 0 <= x <= 10

option_type

enum<string>

default:both

Filter to call, put, or both contract types.

Available options:

call,

put,

both

max_contracts

integer

default:2000

Cap on the number of contracts returned (default 2000, hard ceiling 5000). When more contracts match the filters, the response is truncated to the closest-to-spot subset and truncated=true is set with total_matching_count so the client knows to narrow the filter.

Required range: 1 <= x <= 5000

fields

string | null

Top-level projection: aggregates,available_expiries,contracts

include

string | null

Per-contract projection: bid_ask,gex,greeks,iv,oi,volume. Default is all sections.

as_of

string | null

ISO-8601 instant to answer as of, e.g. 2026-08-20T14:30:00Z. Omit for the current value. Resolves to the nearest chain snapshot AT OR BEFORE the requested time (never after, which would be look-ahead bias); the snapshot actually used and the lag are reported in meta.extra.as_of. Under positioning=flow the dealer flow map is rebuilt from the tape as it stood at that instant, so a given timestamp always returns the same numbers. Bounded by your plan's history window.

Response

Successful Response

data

ChainData · object

required

Show child attributes

meta

V2Meta · object

required

The meta block returned alongside every v2 response.

Every field after version/timestamp is optional because endpoints attach different combinations - e.g. /v2/status skips symbol, the chain endpoint sets extra.filter_hash, etc. Listing them here means SDKs get a typed accessor for each instead of a generic meta: dict.

Show child attributes

success

boolean

default:true

Filtered options chain

curl --request GET \
  --url https://api.example.com/options/chain \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.example.com/options/chain', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/options/chain",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/options/chain"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/options/chain")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "contracts": [
      {
        "strike": 123,
        "expiry": "<string>",
        "dte": 123,
        "type": "call",
        "oi": 123,
        "iv": 123,
        "mark": 123,
        "bid": 123,
        "ask": 123,
        "volume": 123,
        "notional_volume": 123,
        "trade_count": 123,
        "delta": 123,
        "gamma": 123,
        "theta": 123,
        "vega": 123,
        "vanna": 123,
        "charm": 123,
        "gex": 123
      }
    ],
    "aggregates": {
      "net_gex": 123,
      "call_gex": 123,
      "put_gex": 123,
      "total_oi": 123,
      "call_oi": 123,
      "put_oi": 123,
      "contract_count": 123,
      "pcr": 123,
      "atm_iv": 123
    },
    "available_expiries": [
      "<string>"
    ],
    "truncated": true,
    "total_matching_count": 123,
    "max_contracts": 123
  },
  "meta": {
    "version": "2.0",
    "timestamp": "<string>",
    "request_id": "<string>",
    "symbol": "<string>",
    "spot_price": 123,
    "computed_at": "<string>",
    "freshness_seconds": 123,
    "source": [
      "<string>"
    ],
    "exchanges_filtered": [
      "<string>"
    ],
    "rate_limit": {},
    "extra": {}
  },
  "success": true
}

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API key"
  },
  "meta": {
    "version": "2.0",
    "timestamp": "2026-04-29T12:00:00Z"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "version": "2.0",
    "timestamp": "<string>",
    "request_id": "<string>",
    "symbol": "<string>",
    "spot_price": 123,
    "computed_at": "<string>",
    "freshness_seconds": 123,
    "source": [
      "<string>"
    ],
    "exchanges_filtered": [
      "<string>"
    ],
    "rate_limit": {},
    "extra": {}
  },
  "success": false
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters",
    "details": {
      "errors": []
    }
  },
  "meta": {
    "version": "2.0",
    "timestamp": "2026-04-29T12:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Try again later."
  },
  "meta": {
    "version": "2.0",
    "timestamp": "2026-04-29T12:00:00Z"
  }
}

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

Where each number comes from

See also

Which fields are cross-venue

Consolidated best bid/offer

Greeks beyond delta

Refresh cadences

Authorizations

Headers

Query Parameters

Response

​Where each number comes from

​See also

Which fields are cross-venue

Consolidated best bid/offer

Greeks beyond delta

Refresh cadences

Authorizations

Headers

Query Parameters

Response

Where each number comes from

See also