/api/content/coin
GETAvailableBeta

Coin-page aggregated summary

Coin-page aggregated summary

GET/api/content/coin

Request

Query parameters

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

Example request

curl -s "https://www.coinboss.com/api/content/coin?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 }`.
nownumbermsServer time when the response was built.
coinstring—Coin symbol, upper case (for example BTC).
oi_totalnumberUSDThe coin's open interest summed over all exchanges with fresh data; null when there is none.
oi_toparray—The three exchanges with the largest open interest in the coin.
oi_top[]object—One exchange: `ex` (display name), `oi` (USD) and `share_pct` (% of `oi_total`).
oi_top[].exstring—Exchange id, lower case.
oi_top[].oinumber—Open interest.
oi_top[].share_pctnumber%Share of the total.
oi_exchangesnumbercountNumber of exchanges with fresh open interest for the coin; null when none.
listed_exchangesnumbercountNumber of exchanges whose futures ticker for the coin traded and was updated within the last hour; null when none.
vol24_perpnumberUSDThe coin's 24h futures volume summed over those exchanges; null when none.
funding_weighted_pctnumber%Current funding rate normalised to 8 hours and weighted by open interest across exchanges, in percent; a simple average when no weights exist.
funding_basisstring—Label of the method behind `funding_weighted_pct`; always `8h_normalized_oi_weighted`.
liq24object—The coin's liquidations in the last 24 hours: `total`, `long`, `short` in USD and `cnt` (orders); null when there were none.
liq24.totalnumber—Total.
liq24.longnumber—Long side value.
liq24.shortnumber—Short side value.
liq24.cntnumber—Count.
categoryobject—Category.
category.idstring—Identifier.
category.namestring—Name.
category.avg_chg_pctnumber%Average 24h price change of the coins in the category.
category.coin_cntnumbercountNumber of coins in the category that have a 24h price change.
category.coin_chg_pctnumber%This coin's 24h price change as recorded in the category data.

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

Example response

/api/content/coin?coin=BTC · Real response captured 2026-11-13 03:53:48 UTC. Long arrays and maps are shortened for display: oi_top had 3 items.

  • {
    • "success": true,
    • "now": 1794542028379,
    • "coin": "BTC",
    • "oi_total": 48984688222.06999,
    • "oi_top": [
      • { … 3 },
      • { … 3 }
      ],
    • "oi_exchanges": 22,
    • "listed_exchanges": 23,
    • "vol24_perp": 70805540560.31,
    • "funding_weighted_pct": 0.0056,
    • "funding_basis": "8h_normalized_oi_weighted",
    • "liq24": {
      • "total": 781913690.3299996,
      • "long": 770791028.0399991,
      • "short": 11122662.289999994,
      • "cnt": 29392
      },
    • "category": {
      • "id": "proof-of-work-pow",
      • "name": "Proof of Work (PoW)",
      • "avg_chg_pct": -0.99,
      • "coin_cnt": 125,
      • "coin_chg_pct": -0.45
      }
    }

Verified samples

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

ParametersHTTPLatencyResult
coin=ETH20034 msPass
coin=SOL20036 msPass
coin=ARKM20043 msPass

Checked 2026-11-13 03:29:29 UTC

Details

Authentication
None. Public endpoint.
Rate limit
1200 requests per minute per IP
Server cache
5m
Edge micro-cache
10s
Update frequency
tickers every 1 min; OI/funding every 5 min; API cache 300 s
Window
24h
Data sources
Per-coin summary figures (total OI and top venues, OI-weighted funding, 24h perpetual volume, 24h liquidations) aggregated in-house from exchange data, with a category comparison from a third-party market-data aggregator.
Exchange coverage
Any coin with listed derivative contracts
Pagination
none
Units
USD; funding_weighted_pct in percent per 8h
Method
funding_weighted_pct = OI-weighted mean of (rate * 8 / interval_hours) * 100; oi_total = SUM(oi_usd) over fresh contracts incl. multiplier contracts (3h; CME 120h)
Timestamps
Unix epoch milliseconds (UTC) unless the field description says otherwise
Response format
json
Stability
Beta

Live status

AvailableChecked 2026-11-13 03:53:48 UTCHTTP 20065 msSchema matches

Availability, last 30 days

100% of 407 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/coinAvailable
Parameters

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

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