GET
/api/v1/options/{underlying}/by-strikeHobbyist tier+ · 30 req/minStrike-level aggregates: OI + volume + avg IV per strike.
One row per strike rolling up every listed expiry (or a single expiry when `?expiry` is supplied). Powers the /options/by-strike dashboard.
Path parameters
Segments of the URL path, validated server-side.
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| underlying | enum | required | — | BTC or ETH. BTCETH |
Query parameters
All query parameters are optional unless marked required.
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| expiry | string | optional | — | Narrow aggregation to a single 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, rows: StrikeAggregate[] }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-strike"Responsejson
{ "data": { "underlying": "BTC", "expiry": null, "rows": [] }, "meta": { "total": 0 } }Next
Check the error code reference, or get an API key to try the request against your own account.