24h Volume—Open Interest—24h Liquidations$1.36B24h Long/Short—BTC Dominance—ETH Dominance—
App
Language ▾
$ USD ▾
/api/options/overview
GETAvailable

Options overview

Options overview (OI, volume, put/call, front expiry)

GET/api/options/overview
Single venue: computed from Deribit public option data only. `volume_usd`-type fields are premium-based where the venue reports premium turnover. For six venues with per-venue coverage use `/api/sd/options/overview`.

Request

Query parameters

NameTypeRequiredDefaultAllowed valuesDescription
currencystringOptionalBTCBTC, ETHUnderlying: `BTC` or `ETH`. Any other value returns 400 `INVALID_PARAM`. Alias: `coin`. Example: BTC

Example request

curl -s "https://www.coinboss.com/api/options/overview?currency=BTC"

Response fields

The field table is generated from real responses, so it lists exactly what the endpoint returns. Paths use a[] for array items and {*} for objects keyed by a dynamic name such as a coin or an exchange.

FieldTypeUnitDescription
successboolean—true when the request succeeded. On failure the body is `{ success: false, code, error, request_id }`.
currencystring—Currency / asset symbol.
snap_tsnumbermsTime of the snapshot.
index_pricenumber—Index price of the underlying.
dataobject—Payload.
data.total_oi_usdnumberUSDTotal open interest.
data.total_oi_coinsnumbercoinTotal open interest of all Deribit options on the currency, in units of the underlying coin.
data.volume_24h_usdnumberUSD24-hour options volume in USD as reported by Deribit; this is premium turnover, not notional, so it is far below `volume_24h_coins` × price.
data.volume_24h_coinsnumbercoin24-hour traded volume of all Deribit options on the currency, in units of the underlying coin.
data.pcr_oinumberratioPut/call ratio by open interest: put open interest ÷ call open interest, both in coin units; null when there is no call open interest.
data.pcr_volumenumberratioPut/call ratio by volume: 24-hour put volume ÷ 24-hour call volume, both in coin units; null when there is no call volume.
data.max_painobject—Strike at which option holders lose the most at expiry.
data.max_pain.expirystring—Expiry date of the option series.
data.max_pain.pricenumber—Last price in the quote currency (USD or USDT unless stated).
data.contractsnumber—Per-contract rows.
data.expiriesnumber—Option / futures expiries.

Generated 2026-11-11 23:00 UTC from 2 real responses.

Example response

/api/options/overview?currency=BTC · Real response captured 2026-11-13 03:52:56 UTC.

  • {
    • "success": true,
    • "currency": "BTC",
    • "snap_ts": 1794541801732,
    • "index_price": 69009.96,
    • "data": {
      • "total_oi_usd": 24978601771.99,
      • "total_oi_coins": 358629.9,
      • "volume_24h_usd": 46910595.32,
      • "volume_24h_coins": 36010,
      • "pcr_oi": 0.7462,
      • "pcr_volume": 1.6655,
      • "max_pain": { … 2 },
      • "contracts": 960,
      • "expiries": 12
      }
    }

Verified samples

Besides the example above, the probe calls this endpoint with these parameters and checks the schema each time.

ParametersHTTPLatencyResult
currency=ETH2001 msPass
currency=SOL4001 msPass returns the expected error

Checked 2026-11-13 03:28:22 UTC

Details

Authentication
None. Public endpoint.
Rate limit
1200 requests per minute per IP
Server cache
2m
Edge micro-cache
10s
Update frequency
every 10 min (full snapshot replace)
Window
latest snapshot (24h volume as reported by the exchange)
Data sources
Options market totals aggregated from a single exchange's public API (Deribit).
Exchange coverage
Deribit only, BTC and ETH options; other venues (Binance/OKX/Bybit options, CME) are not included.
Units
USD notional and coins (open interest, volume); ratios; USD strike (max pain)
Method
Sums over all contracts; pcr_oi = put OI / call OI (in coins); max pain = strike minimizing total option-holder payoff for the main expiry (nearest expiry holding >=5% of total OI, else the largest).
Timestamps
Unix epoch milliseconds (UTC) unless the field description says otherwise
Response format
json
Stability
Stable

Live status

AvailableChecked 2026-11-13 03:52:56 UTCHTTP 20075 msSchema matchesNewest data point 3m old

Availability, last 30 days

99.75% of 408 checks passed

Errors

Failed calls share one shape on every endpoint. The full list is on the errors page. Errors and rate limits →

CodeHTTPMeaningWhat to do
INVALID_PARAM400A required parameter is missing or a value is not accepted. `param` names the parameter when it is known.Do not retry unchanged; fix the request.
UNAUTHORIZED401The `CB-API-KEY` header was sent but the key is unknown or revoked. Public data needs no key — drop the header or use a valid key.Do not retry unchanged.
FORBIDDEN403The route is not part of the public API (internal or account-only).Do not retry.
NOT_FOUND404Unknown route, or the requested coin / exchange / fund does not exist.Do not retry; check the path and identifiers against the catalog.
RATE_LIMITED429More requests than the per-minute limit. `Retry-After` gives the seconds to wait.Wait for `Retry-After`, then retry with backoff.
INTERNAL500Unexpected server error. The message is generic by design; quote `request_id` when reporting it.Retry once after a few seconds; report it with the request id if it persists.
UPSTREAM_FAILED503The data source behind this endpoint did not answer in time. No stale or substitute numbers are returned in its place.Retry with backoff; check the status page.
UNAVAILABLE501 / 503The dataset is temporarily not ready (cache warming) or the endpoint has no lawful public source yet.Retry later; the catalog marks endpoints that are unavailable by design.
REQUEST_FAILED200Some older endpoints answer HTTP 200 with `success: false`. Always check `success`, not only the HTTP status.Depends on the message; treat as a failed request.

Try it

GET/api/options/overviewAvailable
Parameters

string · default BTC — Underlying: `BTC` or `ETH`. Any other value returns 400 `INVALID_PARAM`. Alias: `coin`.

Request URLhttps://www.coinboss.com/api/options/overview?currency=BTC
Choose an endpoint and press “Send request”. The response, headers and timing will appear here.