Skip to main content
Loading market data…
GET/api/v1/options/{underlying}/by-expiryHobbyist tier+ · 30 req/min

Expiry-level aggregates — term structure of OI, volume, max pain.

One row per listed expiry with OI / volume / put-call OI / max-pain strike / strike count. Chronological. Powers the /options/by-expiry dashboard.

Path parameters

Segments of the URL path, validated server-side.

NameTypeRequiredDefaultDescription
underlyingenumrequired
BTC or ETH.
BTCETH

Query parameters

This endpoint takes no query parameters.

Response shape

Always wrapped in the standard envelope. Nullable fields are explicitly marked — treat missing numeric data as a real data-source gap, not as an error.

data payloadtypescript
// Wrapped in the standard envelope:
// {
//   data: /* shape below */,
//   meta?: { total?: number; limit?: number; offset?: number; ... }
// }

{ underlying, rows: ExpiryAggregate[] }

Example

Copy the curl, replace YOUR_KEY with a real key from your dashboard, and run.

Requestbash
curl -sS "http://localhost:3000/api/v1/options/BTC/by-expiry"
Responsejson
{ "data": { "underlying": "BTC", "rows": [] }, "meta": { "total": 0 } }

Next

Check the error code reference, or get an API key to try the request against your own account.