Aggregate open interest — totals + per-exchange breakdown.

Deribit is the only options source wired today — expect a single row in `byExchange`. Scaffolded for future OKX / Bybit / Binance options ingestion.

Path parameters

Segments of the URL path, validated server-side.

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.

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

{ underlying, totalOi, callOi, putOi, putCallOi, asOf, byExchange: OiByExchangeRow[] }

Example

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

curl -sS "http://localhost:3000/api/v1/options/BTC/oi"

{ "data": { "underlying": "BTC", "totalOi": 220000, "callOi": 120000, "putOi": 100000, "putCallOi": 0.83, "asOf": 1744834800000, "byExchange": [] }, "meta": { "total": 0 } }