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

Aggregate 24h volume — totals + per-strike breakdown.

Latest-snapshot 24h volume rolled up across expiries, plus a per-strike breakdown. Narrow to a single expiry with `?expiry`.

Path parameters

Segments of the URL path, validated server-side.

NameTypeRequiredDefaultDescription
underlyingenumrequired
BTC or ETH.
BTCETH

Query parameters

All query parameters are optional unless marked required.

NameTypeRequiredDefaultDescription
expirystringoptional
Restrict per-strike breakdown to one expiry.

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, expiry, totalVol, callVol, putVol, putCallVol, asOf, byStrike: StrikeVolumeRow[] }

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/volume"
Responsejson
{ "data": { "underlying": "BTC", "expiry": null, "totalVol": 89400, "callVol": 52000, "putVol": 37400, "putCallVol": 0.72, "asOf": 1744834800000, "byStrike": [] }, "meta": { "total": 0 } }

Next

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