/api/stock-detail/:underlying
GETAvailable

Stock underlying detail

Stock underlying detail (per-exchange contract quotes)

GET/api/stock-detail/:underlying

Request

Query parameters

NameTypeRequiredDefaultAllowed valuesDescription
underlying pathstringRequired——Underlying ticker (upper-cased); 404 when no data. Example: SOXL

Parameters marked “path” are part of the URL.

Example request

curl -s "https://www.coinboss.com/api/stock-detail/SOXL"

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.
sourcestring—Where the value comes from.
dataobject—Payload.
data.underlyingstring—Underlying equity / index / commodity symbol.
data.namestring—Name.
data.typestring—Type.
data.price_avgnumber—Average price across venues.
data.change_24hnumber—24h change.
data.high_24hnumber—24h high.
data.low_24hnumber—24h low.
data.volume_24hnumber—24h volume.
data.oi_usdnumberUSDOpen interest in USD notional.
data.funding_weightednumberfractionOpen-interest-weighted average of the exchanges' current funding rates, each per its own funding interval; null when no exchange reports open interest.
data.exchangesnumber—Exchanges.
data.marketsarray—Markets.
data.markets[]object—Markets.
data.markets[].exchangestring—Exchange id, lower case (for example `binance`).
data.markets[].symbolstring—Instrument symbol as normalised by CoinBoss (for example BTCUSDT).
data.markets[].pricenumber—Last price in the quote currency (USD or USDT unless stated).
data.markets[].change_pctnumber|null%Percentage change.
data.markets[].volume_24hnumber—24h volume.
data.markets[].fundingnumber—Funding rate block or value.
data.markets[].funding_interval_hnumberhFunding interval.
data.markets[].oi_usdnumber|nullUSDOpen interest in USD notional.
data.long_shortarray—Long/short block.
data.long_short[]object—Long/short block.
data.long_short[].exchangestring—Exchange id, lower case (for example `binance`).
data.long_short[].symbolstring—Instrument symbol as normalised by CoinBoss (for example BTCUSDT).
data.long_short[].ratio_typestring—What the ratio counts: `account` (all accounts), `topacc` (top-trader accounts), `position` (position size) or `taker` (taker buy vs sell volume).
data.long_short[].long_rationumber%Latest long share (taker buy share for `taker`) for this exchange and contract; `long_ratio` + `short_ratio` = 100.
data.long_short[].short_rationumber%Latest short share (taker sell share for `taker`) for this exchange and contract; `long_ratio` + `short_ratio` = 100.
data.liquidationsobject—Liquidations of this underlying (aliases included) across exchanges, by window `h1`, `h4`, `h12`, `h24`, plus `count_24h`.
data.liquidations.h1object—Notional value liquidated over the last 1 hour, in USD, split into `long`, `short` and `total`.
data.liquidations.h1.longnumber—Long side value.
data.liquidations.h1.shortnumber—Short side value.
data.liquidations.h1.totalnumber—Total.
data.liquidations.h4object—Notional value liquidated over the last 4 hours, in USD, split into `long`, `short` and `total`.
data.liquidations.h4.longnumber—Long side value.
data.liquidations.h4.shortnumber—Short side value.
data.liquidations.h4.totalnumber—Total.
data.liquidations.h12object—Notional value liquidated over the last 12 hours, in USD, split into `long`, `short` and `total`.
data.liquidations.h12.longnumber—Long side value.
data.liquidations.h12.shortnumber—Short side value.
data.liquidations.h12.totalnumber—Total.
data.liquidations.h24object—24-hour value.
data.liquidations.h24.longnumber—Long side value.
data.liquidations.h24.shortnumber—Short side value.
data.liquidations.h24.totalnumber—Total.
data.liquidations.count_24hnumber—Count over 24 hours.
data.klinesarray—Candles.
data.klines[]object—Candles.
data.klines[].tnumbermsTimestamp.
data.klines[].onumberUSDOpen price of the daily candle starting at `t` (UTC).
data.klines[].hnumberUSDHighest price of the daily candle starting at `t` (UTC).
data.klines[].lnumberUSDLowest price of the daily candle starting at `t` (UTC).
data.klines[].cnumberUSDClose price of the daily candle starting at `t` (UTC); latest price while the current day is still open.
data.klines[].vnumber—Value.

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

Example response

/api/stock-detail/SOXL · Real response captured 2026-11-13 03:58:45 UTC. Long arrays and maps are shortened for display: data.klines had 180 items; data.markets had 17 items; data.long_short had 16 items.

  • {
    • "success": true,
    • "now": 1794542325458,
    • "source": "in-house collection",
    • "data": {
      • "underlying": "SOXL",
      • "name": "Direxion Semiconductor Bull 3x",
      • "type": "etf",
      • "price_avg": 64.1974409886378,
      • "change_24h": 2.7419816659689613,
      • "high_24h": 69.02,
      • "low_24h": 58.4,
      • "volume_24h": 10975219799.62,
      • "oi_usd": 519894892.91999996,
      • "funding_weighted": 0.000008341482652906381,
      • "exchanges": 17,
      • "markets": [ … 2 ],
      • "long_short": [ … 2 ],
      • "liquidations": { … 5 },
      • "klines": [ … 2 ]
      }
    }

Details

Authentication
None. Public endpoint.
Rate limit
1200 requests per minute per IP
Server cache
60s
Edge micro-cache
10s
Update frequency
tickers every 1 min; OI/funding every 5 min; API cache 60 s
Window
liquidations 1h / 4h / 12h / 24h; up to 180 daily candles
Data sources
Detail of one tokenized-stock/TradFi underlying: per-exchange contracts, funding, OI, long/short, liquidations and daily candles, all from exchange data collected in-house.
Exchange coverage
Underlyings in the in-house tokenized-stock registry; 404 if none
Pagination
none
Units
USD; funding as decimal rate per interval
Method
funding_weighted = OI-weighted mean of raw rates (not normalized to 8h); quotes deviating more than 10% from the median with zero volume are dropped
Timestamps
Unix epoch milliseconds (UTC) unless the field description says otherwise
Response format
json
Stability
Stable

Live status

AvailableChecked 2026-11-13 03:58:45 UTCHTTP 20076 msSchema matchesNewest data point 4h old

Availability, last 30 days

100% of 409 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/stock-detail/:underlyingAvailable
Parameters

string — Underlying ticker (upper-cased); 404 when no data.

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