Site-wide section summary
Site-wide section summary (for content pages)
/api/content/summaryRequest
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.
| Field | Type | Unit | Description |
|---|---|---|---|
| success | boolean | — | true when the request succeeded. On failure the body is `{ success: false, code, error, request_id }`. |
| now | number | ms | Server time when the response was built. |
| exchanges | object | — | Exchanges. |
| exchanges.count | number | — | Number of items. |
| exchanges.total_vol | number | USD | 24h futures volume summed over all exchanges, stock-linked contracts excluded. |
| exchanges.total_oi | number | — | Total open interest. |
| exchanges.total_contracts | number | count | Number of futures contract tickers across all exchanges, stock-linked contracts excluded. |
| exchanges.top3 | array | — | Top three entries. |
| exchanges.top3[] | object | — | Top three entries. |
| exchanges.top3[].name | string | — | Name. |
| exchanges.top3[].vol | number | — | Volume. |
| exchanges.top3[].share_pct | number | % | Share of the total. |
| exchanges.dex_share_vol_pct | number | % | Share of `total_vol` traded on decentralized perpetual exchanges. |
| exchanges.dex_share_oi_pct | number | % | Share of `total_oi` held on decentralized perpetual exchanges. |
| exchanges.stock_vol_excluded | number | USD | 24h volume of stock-linked contracts that was left out of `total_vol`. |
| funding | object | — | Funding rate block or value. |
| funding.weighted_pct | number | % | 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_pos | array | — | 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[].base | string | — | Base asset symbol. |
| funding.top_pos[].ex | string | — | Exchange id, lower case. |
| funding.top_pos[].rate_pct | number | % | Current funding rate of the contract in percent, per its own funding interval. |
| funding.top_neg | array | — | 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[].base | string | — | Base asset symbol. |
| funding.top_neg[].ex | string | — | Exchange id, lower case. |
| funding.top_neg[].rate_pct | number | % | Current funding rate of the contract in percent, per its own funding interval. |
| funding.intervals | object | — | Intervals. |
| funding.intervals.h1_pct | number | % | Share of contracts that settled funding 16 or more times in the last 24 hours (classed as hourly). |
| funding.intervals.h4_pct | number | % | Share of contracts that settled funding 5 to 15 times in the last 24 hours (classed as 4-hourly). |
| funding.intervals.h8_pct | number | % | Share of contracts that settled funding fewer than 5 times in the last 24 hours (classed as 8-hourly). |
| oi | object | — | Open interest. |
| oi.total | number | — | Total. |
| oi.chg24_pct | number | % | Change of summed open interest against the hourly snapshot about 24 hours earlier, over contracts present in both; null when no snapshot exists. |
| oi.gainers | array | — | Largest gains. |
| oi.gainers[] | object | — | Largest gains. |
| oi.gainers[].base | string | — | Base asset symbol. |
| oi.gainers[].oi | number | — | Open interest. |
| oi.gainers[].chg_pct | number | % | Percentage change. |
| oi.losers | array | — | Largest losses. |
| oi.losers[] | object | — | Largest losses. |
| oi.losers[].base | string | — | Base asset symbol. |
| oi.losers[].oi | number | — | Open interest. |
| oi.losers[].chg_pct | number | % | Percentage change. |
| oi.top_ex | array | — | 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[].name | string | — | Name. |
| oi.top_ex[].oi | number | — | Open interest. |
| oi.top_ex[].share_pct | number | % | Share of the total. |
| market | object | — | Market. |
| market.total_oi | number | — | Total open interest. |
| market.liq_total | number | USD | Long plus short liquidations in the last 24 hours, stock-linked contracts excluded. |
| market.liq_long | number | — | Liquidated longs. |
| market.liq_short | number | — | Liquidated shorts. |
| market.up_cnt | number | count | Number of the top 500 coins by market cap whose 24h price change is positive. |
| market.down_cnt | number | count | Number of the top 500 coins by market cap whose 24h price change is negative. |
| market.btc_dom_pct | number | % | BTC market cap ÷ total market cap of the tracked coins × 100; null when the market-cap snapshot is unavailable. |
| stocks | object | — | 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.underlyings | number | — | Underlying symbols. |
| stocks.contracts | number | — | Per-contract rows. |
| stocks.vol | number | — | Volume. |
| stocks.exchanges | number | — | Exchanges. |
| stocks.top3 | array | — | Top three entries. |
| stocks.top3[] | object | — | Top three entries. |
| stocks.top3[].u | string | — | Ticker of the underlying stock or ETF. |
| stocks.top3[].vol | number | — | Volume. |
| preipo | object | — | Pre-IPO (synthetic) underlyings among the stock-linked contracts: count, 24h volume, highest price and widest price spread. |
| preipo.underlyings | number | — | Underlying symbols. |
| preipo.vol | number | — | Volume. |
| preipo.top_price | object | — | The pre-IPO underlying with the highest volume-weighted contract price (`u`, `price`); null when none trades. |
| preipo.top_price.u | string | — | Name of that underlying. |
| preipo.top_price.price | number | — | Last price in the quote currency (USD or USDT unless stated). |
| preipo.max_spread | object | — | 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.u | string | — | Name of that underlying. |
| preipo.max_spread.spread_pct | number | % | (`pmax` − `pmin`) ÷ `pmin` × 100. |
| preipo.max_spread.pmin | number | USD | Lowest current contract price of the underlying across exchanges. |
| preipo.max_spread.pmax | number | USD | Highest 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"
- "dex_share_vol_pct"8.3
- "dex_share_oi_pct"11.3
- "stock_vol_excluded"41399911752.17
- "funding"
- "weighted_pct"0.0045
- "top_pos"
- "top_neg"
- "intervals"
- "oi"
- "total"107132161363.71
- "chg24_pct"-3.93
- "gainers"
- "losers"
- "top_ex"
- "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"
- "preipo"
- "underlyings"3
- "vol"2217117745.7
- "top_price"
- "max_spread"
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
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 →
| Code | HTTP | Meaning | What to do |
|---|---|---|---|
| INVALID_PARAM | 400 | A 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. |
| UNAUTHORIZED | 401 | The `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. |
| FORBIDDEN | 403 | The route is not part of the public API (internal or account-only). | Do not retry. |
| NOT_FOUND | 404 | Unknown route, or the requested coin / exchange / fund does not exist. | Do not retry; check the path and identifiers against the catalog. |
| RATE_LIMITED | 429 | More requests than the per-minute limit. `Retry-After` gives the seconds to wait. | Wait for `Retry-After`, then retry with backoff. |
| INTERNAL | 500 | Unexpected 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_FAILED | 503 | The 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. |
| UNAVAILABLE | 501 / 503 | The 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_FAILED | 200 | Some 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
/api/content/summaryAvailableNo parameters.
https://www.coinboss.com/api/content/summaryMore in this category
- Data-quality matrix (collector view) /api/sd/quality
- API catalog /api/meta/catalog
- Changelog and versioning policy /api/meta/changelog
- Endpoint documentation /api/meta/endpoint
- OpenAPI document /api/meta/openapi
- Data-quality matrix /api/meta/quality
- Service status /api/meta/status
- Checks whether a coin symbol is known to the platform /api/coin-exists
- Map of coin symbol to locally hosted icon path /api/coin-icons
- Coin-page aggregated summary /api/content/coin
- Site-wide section summary /api/content/summary
- Fiat FX rate table /api/currency/fx
- Map of exchange id to locally hosted icon path /api/exchange-icons
- Liveness check /api/health
- Research-page statistics /api/research/stats