/api/sd/basis/rank
GETDegradedSTALE

Coins ranked by basis

Coins ranked by cross-exchange median basis, with mean, OI-weighted basis, open interest and the exchanges with the lowest and highest value.

GET/api/sd/basis/rank
Degraded. The endpoint reports data quality STALE

Request

Query parameters

NameTypeRequiredDefaultAllowed valuesDescription
kindstringOptionalperpperp, spot_perp`perp`: mark price against the index price of the same exchange. `spot_perp`: perpetual price against the spot price of the same exchange.
sortstringOptionalbasis_descbasis_desc, basis_asc, abs_descSort key: highest, lowest or largest absolute median basis first.
limitintegerOptional50≥ 1 · ≤ 200Number of rows.
min_exchangesintegerOptional3≥ 1 · ≤ 20Only coins with a basis on at least this many exchanges.

Example request

curl -s "https://www.coinboss.com/api/sd/basis/rank"

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 }`.
schemastring—Schema id of this response. It changes only when an existing field changes meaning or type.
nownumbermsServer time when the response was built.
kindstring—`perp` or `spot_perp`.
sortstring—Sort order applied.
limitnumber—Row limit applied.
min_exchangesnumber—Minimum number of exchanges applied.
totalnumber—Rows available before `limit` is applied.
countnumber—Rows returned.
dataarray—One row per coin.
data[]object—One row per coin.
data[].ranknumber—Position in the ranking; `null` when the row has no value to rank.
data[].coinstring—Coin symbol (upper case).
data[].basis_pctnumber%(mark − index) ÷ index × 100 for perpetuals and delivery; in rankings, the cross-exchange median.
data[].mean_pctnumber%Simple mean over the same set as the median.
data[].oi_weighted_pctnumber%Basis weighted by open interest; rows without an OI weight are left out.
data[].oi_usdnumberUSDOpen interest of the contract, single-sided; used as weight.
data[].n_exchangesnumber—Exchanges in the aggregate.
data[].n_contractsnumber—Contracts in the aggregate.
data[].minobject—Exchange and contract with the lowest basis.
data[].min.exchangestring—Exchange id (lower case).
data[].min.symbolstring—Contract symbol in CoinBoss storage form.
data[].min.basis_pctnumber%(mark − index) ÷ index × 100 for perpetuals and delivery; in rankings, the cross-exchange median.
data[].maxobject—Exchange and contract with the highest basis.
data[].max.exchangestring—Exchange id (lower case).
data[].max.symbolstring—Contract symbol in CoinBoss storage form.
data[].max.basis_pctnumber%(mark − index) ÷ index × 100 for perpetuals and delivery; in rankings, the cross-exchange median.
coverageobject—What is and is not included in the numbers. Compare this before comparing totals with another source.
coverage.included_exchangesarray—Sources whose fresh data is included.
coverage.included_exchanges[]string—Sources whose fresh data is included.
coverage.unavailablearray—Sources that could not be included, each with a reason. They are never counted as 0.
coverage.unavailable[]object—Sources that could not be included, each with a reason. They are never counted as 0.
coverage.unavailable[].exchangestring—Exchange id (lower case).
coverage.unavailable[].reasonstring—Machine-readable reason code.
coverage.unavailable[].detailstring—Human-readable explanation of the reason.
coverage.stale_excludedarray—Rows left out because their last update is outside the fresh window. empty in the samples used to generate this table
methodobject—Plain-text statement of the formulas used for this response, one entry per field.
method.basis_pctstring—Formula note for `basis_pct`, plain text.
method.oi_weighted_pctstring—Formula note for `oi_weighted_pct`, plain text.
method.inclusionstring—Formula note for `inclusion`, plain text.
method.coinstring—Formula note for `coin`, plain text.
metaobject—Lineage and freshness of this response.
meta.schemastring—Schema id of this response. It changes only when an existing field changes meaning or type.
meta.sourcearray—Upstream public endpoints the data was collected from.
meta.source[]object—Upstream public endpoints the data was collected from.
meta.source[].exchangestring—Exchange id (lower case).
meta.source[].endpointstring—Public endpoint of the source the collector reads (shown for lineage; clients never call it).
meta.observed_atnumbermsTimestamp given by the source for the data.
meta.received_atnumbermsTime the CoinBoss collector received the data.
meta.fetched_atnumbermsTime this response was assembled.
meta.windowstring—Time window the numbers cover.
meta.qualitystring—FRESH, PARTIAL, STALE, BROKEN or UNAVAILABLE, judged from data timestamps and coverage.
meta.is_staleboolean—True when the data is older than its fresh window.
meta.cache_ttl_snumbersCache lifetime of this response.
meta.fallbackstring—What the endpoint returns when the collector or a source fails.
meta.collector_heartbeat_age_snumbersSeconds since the collector last reported that it is running.

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

Example response

/api/sd/basis/rank · Real response captured 2026-11-13 03:58:08 UTC. Long arrays and maps are shortened for display: coverage.stale_excluded had 21 items.

  • {
    • "success": true,
    • "schema": "coinboss.sd.basis/1",
    • "now": 1794542288498,
    • "kind": "perp",
    • "sort": "basis_desc",
    • "limit": 50,
    • "min_exchanges": 3,
    • "total": null,
    • "count": null,
    • "data": null,
    • "coverage": {
      • "included_exchanges": [],
      • "unavailable": [],
      • "stale_excluded": [ … 2 ]
      },
    • "method": {
      • "basis_pct": "median over exchanges (one primary contract per exchange) of the perpetual mark-vs-index basis, percent; the ranking key",
      • "oi_weighted_pct": "OI-weighted mean over all included contracts of the coin (single-sided OI, <= 3 h old); null when no contract has a weight",
      • "inclusion": "fresh rows only (<= 180 s); same row filters as /api/sd/basis; catalogued stock/ETF perpetuals (stock_contracts) are removed; coins quoted on fewer than min_exc…",
      • "coin": "multiplier contracts are folded into the underlying coin (1000PEPE, kPEPE -> PEPE)"
      },
    • "meta": {
      • "schema": "coinboss.sd.basis/1",
      • "source": [],
      • "observed_at": null,
      • "received_at": null,
      • "fetched_at": 1794542288498,
      • "window": "latest",
      • "quality": "STALE",
      • "is_stale": true,
      • "cache_ttl_s": 30,
      • "fallback": "only rows refreshed within 180 s are ranked; when the collector is down the list is empty and quality is STALE",
      • "collector_heartbeat_age_s": 3091
      }
    }

Verified samples

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

ParametersHTTPLatencyResult
kind=spot_perp2002 msPass STALE
sort=basis_asc&limit=102002 msPass STALE
sort=zzz4002 msPass returns the expected error

Checked 2026-11-13 03:58:08 UTC

Details

Authentication
None. Public endpoint.
Rate limit
1200 requests per minute per IP
Server cache
30s
Edge micro-cache
10s
Update frequency
Collector round every 60 seconds; a row is fresh for 180 seconds. Hourly snapshots feed the history.
Window
Latest value per contract.
Data sources
Mark price, index price and last price published by 21 derivatives exchanges, plus the spot price of the same exchange, collected and stored by CoinBoss (sd_px_latest, sd_px_hourly).
Exchange coverage
21 exchanges. Exchanges that do not publish an index or mark price are listed under `coverage.unavailable`; rows whose two price legs are more than 60 seconds apart return `null`. Rows left out of the aggregate are listed under `coverage.excluded_from_aggregate` with the reason.
Pagination
No paging; `limit` caps the number of rows (max 200).
Sorting
Controlled by `sort`; the sort key is the cross-exchange median (`basis_pct`).
Units
All basis values in percent. Prices in the quote currency of the contract (USDT / USDC / USD). `oi_usd` single-sided.
Timestamps
Unix epoch milliseconds (UTC) unless the field description says otherwise
Response format
json
Stability
Stable
Available since
2026-11-11

Live status

DegradedChecked 2026-11-13 03:58:08 UTCHTTP 20023 msSchema matches

The endpoint reports data quality STALE

Availability, last 30 days

100% of 407 checks passed

Schema drift detected by the last probe
  • Returned but not documented: coverage.stale_excluded[], coverage.stale_excluded[].exchange, coverage.stale_excluded[].age_s

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/sd/basis/rankDegraded
Parameters

string · default perp — `perp`: mark price against the index price of the same exchange. `spot_perp`: perpetual price against the spot price of the same exchange.

string · default basis_desc — Sort key: highest, lowest or largest absolute median basis first.

integer · default 50 · min 1 · max 200 — Number of rows.

integer · default 3 · min 1 · max 20 — Only coins with a basis on at least this many exchanges.

Request URLhttps://www.coinboss.com/api/sd/basis/rank
Choose an endpoint and press “Send request”. The response, headers and timing will appear here.