Stock underlying detail
Stock underlying detail (per-exchange contract quotes)
/api/stock-detail/:underlyingRequest
Query parameters
| Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|
| underlying path | string | Required | — | — | 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.
| 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. |
| source | string | — | Where the value comes from. |
| data | object | — | Payload. |
| data.underlying | string | — | Underlying equity / index / commodity symbol. |
| data.name | string | — | Name. |
| data.type | string | — | Type. |
| data.price_avg | number | — | Average price across venues. |
| data.change_24h | number | — | 24h change. |
| data.high_24h | number | — | 24h high. |
| data.low_24h | number | — | 24h low. |
| data.volume_24h | number | — | 24h volume. |
| data.oi_usd | number | USD | Open interest in USD notional. |
| data.funding_weighted | number | fraction | Open-interest-weighted average of the exchanges' current funding rates, each per its own funding interval; null when no exchange reports open interest. |
| data.exchanges | number | — | Exchanges. |
| data.markets | array | — | Markets. |
| data.markets[] | object | — | Markets. |
| data.markets[].exchange | string | — | Exchange id, lower case (for example `binance`). |
| data.markets[].symbol | string | — | Instrument symbol as normalised by CoinBoss (for example BTCUSDT). |
| data.markets[].price | number | — | Last price in the quote currency (USD or USDT unless stated). |
| data.markets[].change_pct | number|null | % | Percentage change. |
| data.markets[].volume_24h | number | — | 24h volume. |
| data.markets[].funding | number | — | Funding rate block or value. |
| data.markets[].funding_interval_h | number | h | Funding interval. |
| data.markets[].oi_usd | number|null | USD | Open interest in USD notional. |
| data.long_short | array | — | Long/short block. |
| data.long_short[] | object | — | Long/short block. |
| data.long_short[].exchange | string | — | Exchange id, lower case (for example `binance`). |
| data.long_short[].symbol | string | — | Instrument symbol as normalised by CoinBoss (for example BTCUSDT). |
| data.long_short[].ratio_type | string | — | 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_ratio | number | % | Latest long share (taker buy share for `taker`) for this exchange and contract; `long_ratio` + `short_ratio` = 100. |
| data.long_short[].short_ratio | number | % | Latest short share (taker sell share for `taker`) for this exchange and contract; `long_ratio` + `short_ratio` = 100. |
| data.liquidations | object | — | Liquidations of this underlying (aliases included) across exchanges, by window `h1`, `h4`, `h12`, `h24`, plus `count_24h`. |
| data.liquidations.h1 | object | — | Notional value liquidated over the last 1 hour, in USD, split into `long`, `short` and `total`. |
| data.liquidations.h1.long | number | — | Long side value. |
| data.liquidations.h1.short | number | — | Short side value. |
| data.liquidations.h1.total | number | — | Total. |
| data.liquidations.h4 | object | — | Notional value liquidated over the last 4 hours, in USD, split into `long`, `short` and `total`. |
| data.liquidations.h4.long | number | — | Long side value. |
| data.liquidations.h4.short | number | — | Short side value. |
| data.liquidations.h4.total | number | — | Total. |
| data.liquidations.h12 | object | — | Notional value liquidated over the last 12 hours, in USD, split into `long`, `short` and `total`. |
| data.liquidations.h12.long | number | — | Long side value. |
| data.liquidations.h12.short | number | — | Short side value. |
| data.liquidations.h12.total | number | — | Total. |
| data.liquidations.h24 | object | — | 24-hour value. |
| data.liquidations.h24.long | number | — | Long side value. |
| data.liquidations.h24.short | number | — | Short side value. |
| data.liquidations.h24.total | number | — | Total. |
| data.liquidations.count_24h | number | — | Count over 24 hours. |
| data.klines | array | — | Candles. |
| data.klines[] | object | — | Candles. |
| data.klines[].t | number | ms | Timestamp. |
| data.klines[].o | number | USD | Open price of the daily candle starting at `t` (UTC). |
| data.klines[].h | number | USD | Highest price of the daily candle starting at `t` (UTC). |
| data.klines[].l | number | USD | Lowest price of the daily candle starting at `t` (UTC). |
| data.klines[].c | number | USD | Close price of the daily candle starting at `t` (UTC); latest price while the current day is still open. |
| data.klines[].v | number | — | 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"
- "long_short"
- "liquidations"
- "klines"
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
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 →
| 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/stock-detail/:underlyingAvailablestring — Underlying ticker (upper-cased); 404 when no data.
https://www.coinboss.com/api/stock-detail/SOXLMore in this category
- Liquidation overview for TradFi perpetuals /api/liquidations/tradfi
- List of TradFi symbols with liquidations in the window /api/liquidations/tradfi-asset-list
- Per-symbol liquidation ranking for TradFi perpetuals /api/liquidations/tradfi-assets
- Per-exchange liquidation split for TradFi perpetuals /api/liquidations/tradfi-exchanges
- Liquidation feed for TradFi perpetuals /api/liquidations/tradfi-feed
- Largest liquidation orders on TradFi perpetuals /api/liquidations/tradfi-largest
- Multi-window liquidation totals for TradFi perpetuals /api/liquidations/tradfi-overview
- Liquidation overview for one TradFi symbol /api/liquidations/tradfi-symbol
- Liquidation time series for one TradFi symbol /api/liquidations/tradfi-symbol-chart
- Per-exchange liquidation split for one TradFi symbol /api/liquidations/tradfi-symbol-exchanges
- Largest liquidations for one TradFi symbol /api/liquidations/tradfi-symbol-largest
- TradFi symbols with liquidation history /api/liquidations/tradfi-symbols
- TradFi liquidation table /api/liquidations/tradfi-table
- Total liquidation time series for TradFi perpetuals /api/liquidations/tradfi-total-chart
- Pre-IPO contract quotes /api/preipo/list
- Stock underlying list /api/stock-detail-list
- Stock underlying detail /api/stock-detail/:underlying
- Stock instrument list /api/stocks/list
- Stock perps / tokenized stocks listed on exchanges /api/tabs17/exchange-stocks
- Crypto-related equities quotes /api/tabs17/stocks