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

Open-interest summary for one coin

Open-interest summary for one coin (per-exchange OI and changes)

GET/api/oi/summary

Request

Query parameters

NameTypeRequiredDefaultAllowed valuesDescription
coinstringOptionalBTC—Base coin symbol (uppercase, e.g. BTC). Example: BTC

Example request

curl -s "https://www.coinboss.com/api/oi/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).
pricenumber—Last price in the quote currency (USD or USDT unless stated).
total_usdnumberUSDTotal.
total_change_24h_pctnumber%24h change of total open interest: exchanges present now and in the hourly snapshot nearest to 24 hours ago, (Σ current − Σ previous) ÷ Σ previous.
total_change_24h_basisobject—Inputs of `total_change_24h_pct`: exchanges matched, baseline hour, contracts excluded for a frozen baseline and the rule name; null when no change is available.
total_change_24h_basis.n_matchednumber—Items present at both ends of the comparison.
total_change_24h_basis.prev_hour_tsnumbermsStart of the previous hour bucket.
total_change_24h_basis.frozen_excludedobject—Rows excluded because the source value did not move.
total_change_24h_basis.frozen_excluded.n_baselinenumber—Items in the baseline snapshot.
total_change_24h_basis.frozen_excluded.n_currentnumber—Items in the current snapshot.
total_change_24h_basis.frozen_excluded.cur_usdnumberUSDCurrent value.
total_change_24h_basis.frozen_excluded.prev_usdnumberUSDBaseline value.
total_change_24h_basis.rulestring—Name of the comparison rule; always `same_exchange_pairing_nearest_hour_excl_frozen_baseline`.
exchange_countnumber—Number of exchanges.
dataarray—Payload.
data[]object—Payload.
data[].exchangestring—Exchange id, lower case (for example `binance`).
data[].oi_usdnumberUSDOpen interest in USD notional.
data[].share_pctnumber%Share of the total.
data[].change_24h_pctnumber|null%24h percentage change.
data[].change_4h_pctnumber|null%Change of the exchange's open interest against its hourly snapshot nearest to 4 hours ago; always null for CME, which publishes daily.
data[].is_dailyboolean—Present and true only on the CME row, whose open interest is published once per trading day; absent on other rows. may be absent

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

Example response

/api/oi/summary?coin=BTC · Real response captured 2026-11-13 03:57:41 UTC. Long arrays and maps are shortened for display: data had 22 items.

  • {
    • "success": true,
    • "coin": "BTC",
    • "price": 68907.3,
    • "total_usd": 49032953661.26,
    • "total_change_24h_pct": -3.57,
    • "total_change_24h_basis": {
      • "n_matched": 22,
      • "prev_hour_ts": 1794456000000,
      • "frozen_excluded": { … 4 },
      • "rule": "same_exchange_pairing_nearest_hour_excl_frozen_baseline"
      },
    • "exchange_count": 22,
    • "data": [
      • { … 5 },
      • { … 5 }
      ]
    }

Verified samples

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

ParametersHTTPLatencyResult
coin=ETH20036 msPass
coin=SOL20022 msPass
coin=ARKM20022 msPass

Checked 2026-11-13 03:57:41 UTC

Details

Authentication
None. Public endpoint.
Rate limit
1200 requests per minute per IP
Server cache
60s
Edge micro-cache
10s
Update frequency
every 60 s for most venues (written together with tickers; binance top-50 and okx dedicated 60 s jobs); full binance / bingx / aster / gate / htx sweeps every 5 min; coin-margined / USDC / dated contracts every 120 s (promoted to the shared table every 5 min); cme once per trading day (04:10 UTC)
Window
latest snapshot; changes vs hourly buckets nearest to now - 24 h and now - 4 h (within +/- 1 h)
Data sources
Open interest polled by in-house collectors from the public REST APIs of 22 derivatives venues (e.g. binance, okx, bybit, gate, bitget, hyperliquid) plus CME's official daily volume/open-interest report.
Exchange coverage
23 sources with fresh rows (22 venues + cme); all contract types (USDT / USDC / USD linear, coin-margined inverse, perpetual and dated); bybit and gate report double-sided open interest as disclosed by the venue; rows older than 3 h (cme: 120 h) are excluded
Sorting
fixed exchange order (binance, cme, okx, bybit, bitget, gate, htx, ...), then alphabetical
Units
oi_usd in USD notional; share_pct / change_*_pct in percent; price in USD
Method
per exchange: oi_usd = SUM over fresh contracts of the coin; share_pct = oi_usd / total x 100; change = (cur - prev) / prev x 100 with same-contract pairing (frozen baselines excluded); total_change_24h_pct = same-exchange paired change across all exchanges; cme compared with its previous published value and has no 4 h change
Timestamps
Unix epoch milliseconds (UTC) unless the field description says otherwise
Response format
json
Stability
Stable

Live status

AvailableChecked 2026-11-13 03:57:41 UTCHTTP 20034 msSchema matches

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/oi/summaryAvailable
Parameters

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

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