/api/content/summary
GETAvailableBeta

Site-wide section summary

Site-wide section summary (for content pages)

GET/api/content/summary

Request

This endpoint takes no parameters.

Example request

curl -s "https://www.coinboss.com/api/content/summary"

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 }`.
nownumbermsServer time when the response was built.
exchangesobject—Exchanges.
exchanges.countnumber—Number of items.
exchanges.total_volnumberUSD24h futures volume summed over all exchanges, stock-linked contracts excluded.
exchanges.total_oinumber—Total open interest.
exchanges.total_contractsnumbercountNumber of futures contract tickers across all exchanges, stock-linked contracts excluded.
exchanges.top3array—Top three entries.
exchanges.top3[]object—Top three entries.
exchanges.top3[].namestring—Name.
exchanges.top3[].volnumber—Volume.
exchanges.top3[].share_pctnumber%Share of the total.
exchanges.dex_share_vol_pctnumber%Share of `total_vol` traded on decentralized perpetual exchanges.
exchanges.dex_share_oi_pctnumber%Share of `total_oi` held on decentralized perpetual exchanges.
exchanges.stock_vol_excludednumberUSD24h volume of stock-linked contracts that was left out of `total_vol`.
fundingobject—Funding rate block or value.
funding.weighted_pctnumber%Current funding rate of crypto USDT perpetuals weighted by open interest, in percent per funding interval (rates are not normalised to 8 hours).
funding.top_posarray—The three highest current funding rates among USDT perpetuals with at least 300,000 USD of open interest.
funding.top_pos[]object—One contract: `base` (coin), `ex` (exchange display name) and `rate_pct`.
funding.top_pos[].basestring—Base asset symbol.
funding.top_pos[].exstring—Exchange id, lower case.
funding.top_pos[].rate_pctnumber%Current funding rate of the contract in percent, per its own funding interval.
funding.top_negarray—The three lowest (most negative) current funding rates among USDT perpetuals with at least 300,000 USD of open interest.
funding.top_neg[]object—One contract: `base` (coin), `ex` (exchange display name) and `rate_pct`.
funding.top_neg[].basestring—Base asset symbol.
funding.top_neg[].exstring—Exchange id, lower case.
funding.top_neg[].rate_pctnumber%Current funding rate of the contract in percent, per its own funding interval.
funding.intervalsobject—Intervals.
funding.intervals.h1_pctnumber%Share of contracts that settled funding 16 or more times in the last 24 hours (classed as hourly).
funding.intervals.h4_pctnumber%Share of contracts that settled funding 5 to 15 times in the last 24 hours (classed as 4-hourly).
funding.intervals.h8_pctnumber%Share of contracts that settled funding fewer than 5 times in the last 24 hours (classed as 8-hourly).
oiobject—Open interest.
oi.totalnumber—Total.
oi.chg24_pctnumber%Change of summed open interest against the hourly snapshot about 24 hours earlier, over contracts present in both; null when no snapshot exists.
oi.gainersarray—Largest gains.
oi.gainers[]object—Largest gains.
oi.gainers[].basestring—Base asset symbol.
oi.gainers[].oinumber—Open interest.
oi.gainers[].chg_pctnumber%Percentage change.
oi.losersarray—Largest losses.
oi.losers[]object—Largest losses.
oi.losers[].basestring—Base asset symbol.
oi.losers[].oinumber—Open interest.
oi.losers[].chg_pctnumber%Percentage change.
oi.top_exarray—The three exchanges with the largest open interest.
oi.top_ex[]object—One exchange: `name`, `oi` (USD) and `share_pct` (% of `oi.total`).
oi.top_ex[].namestring—Name.
oi.top_ex[].oinumber—Open interest.
oi.top_ex[].share_pctnumber%Share of the total.
marketobject—Market.
market.total_oinumber—Total open interest.
market.liq_totalnumberUSDLong plus short liquidations in the last 24 hours, stock-linked contracts excluded.
market.liq_longnumber—Liquidated longs.
market.liq_shortnumber—Liquidated shorts.
market.up_cntnumbercountNumber of the top 500 coins by market cap whose 24h price change is positive.
market.down_cntnumbercountNumber of the top 500 coins by market cap whose 24h price change is negative.
market.btc_dom_pctnumber%BTC market cap ÷ total market cap of the tracked coins × 100; null when the market-cap snapshot is unavailable.
stocksobject—Stock-linked perpetual contracts with a ticker from the last 12 hours: number of underlyings, contracts, exchanges, 24h volume and the top 3 underlyings.
stocks.underlyingsnumber—Underlying symbols.
stocks.contractsnumber—Per-contract rows.
stocks.volnumber—Volume.
stocks.exchangesnumber—Exchanges.
stocks.top3array—Top three entries.
stocks.top3[]object—Top three entries.
stocks.top3[].ustring—Ticker of the underlying stock or ETF.
stocks.top3[].volnumber—Volume.
preipoobject—Pre-IPO (synthetic) underlyings among the stock-linked contracts: count, 24h volume, highest price and widest price spread.
preipo.underlyingsnumber—Underlying symbols.
preipo.volnumber—Volume.
preipo.top_priceobject—The pre-IPO underlying with the highest volume-weighted contract price (`u`, `price`); null when none trades.
preipo.top_price.ustring—Name of that underlying.
preipo.top_price.pricenumber—Last price in the quote currency (USD or USDT unless stated).
preipo.max_spreadobject—The pre-IPO underlying with the widest price gap between its contracts (`u`, `spread_pct`, `pmin`, `pmax`); null when none has two contracts.
preipo.max_spread.ustring—Name of that underlying.
preipo.max_spread.spread_pctnumber%(`pmax` − `pmin`) ÷ `pmin` × 100.
preipo.max_spread.pminnumberUSDLowest current contract price of the underlying across exchanges.
preipo.max_spread.pmaxnumberUSDHighest current contract price of the underlying across exchanges.

Generated 2026-11-11 23:01 UTC from 1 real responses.

Example response

/api/content/summary · Real response captured 2026-11-13 03:59:32 UTC. Long arrays and maps are shortened for display: oi.losers had 3 items; oi.top_ex had 3 items; oi.gainers had 3 items; stocks.top3 had 3 items; exchanges.top3 had 3 items; funding.top_neg had 3 items.

  • {
    • "success": true,
    • "now": 1794542372009,
    • "exchanges": {
      • "count": 25,
      • "total_vol": 176285468302.16,
      • "total_oi": 107132161363.71,
      • "total_contracts": 10843,
      • "top3": [ … 2 ],
      • "dex_share_vol_pct": 8.3,
      • "dex_share_oi_pct": 11.3,
      • "stock_vol_excluded": 41399911752.17
      },
    • "funding": {
      • "weighted_pct": 0.0045,
      • "top_pos": [ … 2 ],
      • "top_neg": [ … 2 ],
      • "intervals": { … 3 }
      },
    • "oi": {
      • "total": 107132161363.71,
      • "chg24_pct": -3.93,
      • "gainers": [ … 2 ],
      • "losers": [ … 2 ],
      • "top_ex": [ … 2 ]
      },
    • "market": {
      • "total_oi": 107132161363.71,
      • "liq_total": 1363492414.84,
      • "liq_long": 1267532610.54,
      • "liq_short": 95959804.3,
      • "up_cnt": 150,
      • "down_cnt": 327,
      • "btc_dom_pct": 57.4
      },
    • "stocks": {
      • "underlyings": 648,
      • "contracts": 2338,
      • "vol": 41305485625.189865,
      • "exchanges": 18,
      • "top3": [ … 2 ]
      },
    • "preipo": {
      • "underlyings": 3,
      • "vol": 2217117745.7,
      • "top_price": { … 2 },
      • "max_spread": { … 4 }
      }
    }

Details

Authentication
None. Public endpoint.
Rate limit
1200 requests per minute per IP
Server cache
10m
Edge micro-cache
10s
Update frequency
tickers every 1 min; OI/funding every 5 min; API cache 600 s
Window
24h
Data sources
Site-wide summary figures (exchange volume and OI shares, funding extremes, OI movers, liquidations, tokenized-stock and pre-IPO contract stats) aggregated in-house from exchange data; BTC dominance and up/down counts from a third-party market-data aggregator.
Exchange coverage
All collected derivatives venues; tokenized-stock contracts excluded from crypto totals
Pagination
none
Units
USD; percentages
Method
funding.weighted_pct = SUM(rate * oi) / SUM(oi) * 100 over USDT perpetuals refreshed within 3h (not normalized to 8h); oi.chg24_pct compares contracts present both now and 24h ago
Timestamps
Unix epoch milliseconds (UTC) unless the field description says otherwise
Response format
json
Stability
Beta

Live status

AvailableChecked 2026-11-13 03:59:32 UTCHTTP 200342 msSchema matches

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

No parameters.

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