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

Coin-page options summary

Coin-page options summary (OI, volume, put/call, max pain)

GET/api/currency/options-summary
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
coinstringRequired——Base coin symbol (uppercase, e.g. BTC). Example: BTC

Example request

curl -s "https://www.coinboss.com/api/currency/options-summary?coin=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 }`.
coinstring—Coin symbol, upper case (for example BTC).
dataobject|null—Payload.
data.oi_usdnumberUSDOpen interest in USD notional.
data.change_pctnumber%Percentage change.
data.sourcestring—Where the value comes from.
data.tsnumbermsTimestamp.

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

Example response

/api/currency/options-summary?coin=BTC · Real response captured 2026-11-13 03:58:22 UTC.

  • {
    • "success": true,
    • "coin": "BTC",
    • "data": {
      • "oi_usd": 24978601771.99,
      • "change_pct": -4.71,
      • "source": "Deribit",
      • "ts": 1794541801732
      }
    }

Verified samples

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

ParametersHTTPLatencyResult
coin=ETH200494 msPass
coin=SOL2001 msPass
coin=ARKM2001 msPass

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

Details

Authentication
None. Public endpoint.
Rate limit
1200 requests per minute per IP
Server cache
5m
Edge micro-cache
10s
Update frequency
every 10 min (full snapshot replace); hourly archive for the 24h comparison
Window
latest snapshot; change versus the hourly snapshot about 24 hours earlier
Data sources
Options open interest aggregated from a single exchange's public API (Deribit).
Exchange coverage
BTC and ETH only (data is null for other coins); Deribit only.
Units
USD notional (oi_usd); percent (change_pct)
Method
oi_usd = sum over contracts of open interest (coins) x underlying price; change_pct compares with the archived snapshot closest to 23 hours ago.
Timestamps
Unix epoch milliseconds (UTC) unless the field description says otherwise
Response format
json
Stability
Stable

Live status

AvailableChecked 2026-11-13 03:58:22 UTCHTTP 200613 msSchema matchesNewest data point 8m old

Availability, last 30 days

100% of 410 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/currency/options-summaryAvailable
Parameters

string — Base coin symbol (uppercase, e.g. BTC).

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