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

Coin detail overview

Coin detail overview (price, market cap, supply, derivatives summary)

GET/api/currency/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/overview?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 }`.
dataobject—Payload.
data.coinstring—Coin symbol, upper case (for example BTC).
data.supplyobject—Supply in coins.
data.supply.price_usdstring(decimal)USDPrice.
data.supply.market_cap_usdstring(decimal)USDMarket capitalisation.
data.supply.mcap_ranknumber—Rank by market capitalisation.
data.supply.vol_24h_usdstring(decimal)USD24h volume.
data.supply.circulatingstring(decimal)—Circulating supply in coins.
data.supply.total_supplystring(decimal)—Total supply in coins.
data.supply.max_supplystring(decimal)|null—Maximum supply in coins; null when unlimited or unknown.
data.supply.change_24h_pctstring(decimal)%24h percentage change.
data.supply.image_urlstring—Same-origin icon path served by CoinBoss; null when no verified icon exists.
data.supply.website_urlstring—Official website of the project, from the coin metadata.
data.supply.reddit_urlstring|null—Subreddit of the project; null when none is listed.
data.supply.github_urlstring|null—Main source-code repository of the project; null when none is listed.
data.supply.whitepaper_urlstring—Link to the project's whitepaper.
data.supply.explorer_urlstring—Link to a block explorer for the coin.
data.supply.categorystring—Category.
data.supply.asofnumbermsTime of the newest data used.
data.supply.staleboolean—Rows or flag for data older than the freshness window.
data.supply.spot_vol_usdnumberUSDSum of the coin's 24h spot volume over the spot exchanges CoinBoss collects itself (latest snapshot); null when not collected.
data.supply.futures_vol_usdnumberUSDSum of 24h futures volume across all exchanges with a ticker fresher than 1 hour, same value as `futures_vol.total_usd`; null without own data.
data.supply.oi_total_usdnumberUSDAggregated open interest of the coin across all exchanges and contract types, same value as `oi.total_usd`; null without own data.
data.supply.high_24hstring(decimal)—24h high.
data.supply.low_24hstring(decimal)—24h low.
data.futures_vol_chg_pctnumber%24h change of futures volume: exchanges present now and in the hourly snapshot about 24 hours ago, (Σ current − Σ previous) ÷ Σ previous.
data.oi_chg_pctnumber%24h change of open interest computed on contracts present both now and in the hourly snapshot nearest to 24 hours ago.
data.oiobject—Open interest.
data.oi.total_usdnumberUSDTotal.
data.oi.local_usdnumberUSDOpen interest summed from CoinBoss's own per-exchange collection; identical to `oi.total_usd`.
data.oi.by_exchangearray—Per-exchange breakdown.
data.oi.by_exchange[]object—Per-exchange breakdown.
data.oi.by_exchange[].exchangestring—Exchange id, lower case (for example `binance`).
data.oi.by_exchange[].oi_usdnumberUSDOpen interest in USD notional.
data.oi.n_exchangesnumber—Number of exchanges contributing.
data.oi.asofnumbermsTime of the newest data used.
data.oi.chg_basisobject—Inputs of `oi_chg_pct`: paired current and previous sums (`cur`, `prev`), number of exchanges matched, baseline hour and excluded frozen contracts.
data.oi.chg_basis.curnumber—Current value.
data.oi.chg_basis.prevnumber—Previous value (baseline).
data.oi.chg_basis.n_matchednumber—Items present at both ends of the comparison.
data.oi.chg_basis.prev_hour_tsnumbermsStart of the previous hour bucket.
data.oi.chg_basis.frozen_excludedobject—Rows excluded because the source value did not move.
data.oi.chg_basis.frozen_excluded.n_baselinenumber—Items in the baseline snapshot.
data.oi.chg_basis.frozen_excluded.n_currentnumber—Items in the current snapshot.
data.oi.chg_basis.frozen_excluded.cur_usdnumberUSDCurrent value.
data.oi.chg_basis.frozen_excluded.prev_usdnumberUSDBaseline value.
data.futures_volobject—Futures volume.
data.futures_vol.total_usdnumberUSDTotal.
data.futures_vol.n_exchangesnumber—Number of exchanges contributing.
data.futures_vol.chg_basisobject—Inputs of `futures_vol_chg_pct`: paired current and previous volume sums (`cur`, `prev`), number of exchanges matched and the baseline hour.
data.futures_vol.chg_basis.curnumber—Current value.
data.futures_vol.chg_basis.prevnumber—Previous value (baseline).
data.futures_vol.chg_basis.n_matchednumber—Items present at both ends of the comparison.
data.futures_vol.chg_basis.prev_hour_tsnumbermsStart of the previous hour bucket.
data.fundingnumber—Funding rate block or value.
data.funding_detailobject—Breakdown behind `funding`: simple and open-interest-weighted 8h-normalised rates, annualised rate, exchange counts and one entry per exchange.
data.funding_detail.basisstring—Futures price minus spot price, or the basis block.
data.funding_detail.avg_8hnumber—Mean of 8h-normalised rates.
data.funding_detail.oi_weighted_8hnumber—Open-interest-weighted mean of 8h-normalised rates.
data.funding_detail.apr_pctnumber% per yearAnnualised percentage.
data.funding_detail.n_exchangesnumber—Number of exchanges contributing.
data.funding_detail.n_normalizednumber—Exchanges normalised to 8h.
data.funding_detail.n_unknown_intervalnumber—Exchanges with unknown funding interval.
data.funding_detail.by_exchangearray—Per-exchange breakdown.
data.funding_detail.by_exchange[]object—Per-exchange breakdown.
data.funding_detail.by_exchange[].exchangestring—Exchange id, lower case (for example `binance`).
data.funding_detail.by_exchange[].symbolstring—Instrument symbol as normalised by CoinBoss (for example BTCUSDT).
data.funding_detail.by_exchange[].ratenumber—Rate.
data.funding_detail.by_exchange[].interval_hnumberhInterval.
data.funding_detail.by_exchange[].rate_8hnumber—Rate normalised to an 8-hour period.
data.funding_detail.by_exchange[].next_funding_timenumber|nullmsTimestamp.
data.long_shortobject—Long/short block.
data.long_short.longnumber—Long side value.
data.long_short.shortnumber—Short side value.
data.long_short.rationumber—Ratio.
data.long_short.typestring—Type.
data.long_short.n_exchangesnumber—Number of exchanges contributing.
data.derivedobject—Periodically recomputed indicators for the coin (RSI, basis, aggregated open interest, average funding, long/short shares, 24h liquidations); null when not computed.
data.derived.rsi_1hstring(decimal)—RSI(14) on 1h candles.
data.derived.rsi_4hstring(decimal)—RSI(14) on 4h candles.
data.derived.rsi_1dstring(decimal)—RSI(14) on daily candles.
data.derived.basis_pctstring(decimal)|null%(futures − spot) / spot × 100.
data.derived.basis_annual_pctnull% per yearBasis annualised by days to expiry.
data.derived.oi_usd_aggstring(decimal)USDAggregated open interest across all exchanges and contract types at the last indicator refresh; can lag `oi.total_usd` slightly.
data.derived.funding_avgstring(decimal)—Average funding rate across exchanges.
data.derived.ls_accountstring(decimal)—Long/short ratio by accounts.
data.derived.ls_takerstring(decimal)|null—Taker buy/sell ratio.
data.derived.liq_24h_usdstring(decimal)USD24h liquidations.
data.liquidationobject—Liquidation block. dynamic keys: 1h,4h,12h,24h
data.liquidation.{*}object—Liquidation block.
data.liquidation.{*}.winstring—Window label of the entry, repeating its key (`1h`, `4h`, `12h` or `24h`).
data.liquidation.{*}.long_usdnumberUSDLong side.
data.liquidation.{*}.short_usdnumberUSDShort side.
data.liquidation.{*}.total_usdnumberUSDTotal.
data.liquidation.{*}.cntnumber—Count.

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

Example response

/api/currency/overview?coin=BTC · Real response captured 2026-11-13 03:57:31 UTC. Long arrays and maps are shortened for display: data.liquidation had 4 items; data.oi.by_exchange had 22 items; data.funding_detail.by_exchange had 23 items.

  • {
    • "success": true,
    • "data": {
      • "coin": "BTC",
      • "supply": { … 22 },
      • "futures_vol_chg_pct": 67.76,
      • "oi_chg_pct": -3.65,
      • "oi": { … 6 },
      • "futures_vol": { … 3 },
      • "funding": 0.000057831612725940206,
      • "funding_detail": { … 8 },
      • "long_short": { … 5 },
      • "derived": { … 10 },
      • "liquidation": { … 2 }
      }
    }

Verified samples

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

ParametersHTTPLatencyResult
coin=ETH20086 msPass
coin=SOL20081 msPass
coin=ARKM20079 msPass

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

Details

Authentication
None. Public endpoint.
Rate limit
1200 requests per minute per IP
Server cache
30s
Edge micro-cache
10s
Update frequency
third-party market-data aggregator every 10 min; tickers every 1 min; OI/funding/long-short every 5 min (core coins every 1 min); spot volume every 10 min; in-memory cache 30 s
Window
24h rolling for volume/liquidations; latest snapshot for OI/funding/long-short
Data sources
Supply, market cap and rank come from a third-party market-data aggregator; price, open interest, funding, long/short, futures and spot volume are aggregated in-house from exchange public APIs; liquidations from exchange liquidation streams.
Exchange coverage
Any coin in the third-party market-data aggregator-backed table or with a listed derivative contract
Pagination
none
Units
USD; rates as decimals; changes in percent
Method
OI = SUM(oi_usd) over fresh contracts incl. multiplier contracts (3h; CME 120h); funding = OI-weighted mean of rate normalized to 8h (rate * 8 / interval_hours)
Timestamps
Unix epoch milliseconds (UTC) unless the field description says otherwise
Response format
json
Stability
Stable

Live status

AvailableChecked 2026-11-13 03:57:31 UTCHTTP 20095 msSchema matchesNewest data point 20s old

Availability, last 30 days

99.76% of 411 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/overviewAvailable
Parameters

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

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