更新日誌

更新日誌與版本

API 的變更內容、目前版本與相容性規則。

v1目前版本
2026.11.12目錄修訂版

版本與相容性

版本規則

  • 公開 API 的版本為 v1。路徑前綴為 `/api`,不帶版本號。
  • 目錄有自己以日期為基礎的版本(`catalog_version`,例如 2026.11.11)。只要端點、參數或文件有變動,它就會更新。
  • 自研資料層端點的每個回應都帶有 `schema` ID(例如 `sd.oi.v1`)。只有在既有欄位的意義或型別改變時,才會發行新的 ID。

相容性

  • 新增端點、選填參數、回應欄位、列舉值或交易所屬於向下相容的變更,隨時可能發生。用戶端必須忽略不認得的欄位。
  • 移除或重新命名欄位、變更其型別或單位,或將選填參數改為必填,皆屬破壞性變更,會在上線前先於此處公告。
  • 修正屬於例外:針對錯誤數字、或過去被默默接受的無效輸入所做的修正會立即發布,並在上線當日列於此處;用戶端程式碼可能需要調整時,會標示為破壞性變更。
  • 數字可能因覆蓋範圍擴大(新增交易所或合約類型)而改變。回應中一律會回報覆蓋範圍,因此在比較合計之前,請先比對 `coverage`。
  • 缺少的資料會以 `null` 回傳,並列於 `coverage.unavailable`;絕不會以 0 或估計值取代。把 `null` 當成 0 處理的程式碼會得到錯誤的結果。

棄用

  • 標示為 `legacy` 的端點仍可正常使用,但新的開發應改用所列的替代端點。
  • 舊版端點最快會在其棄用項目列入本更新日誌滿 90 天後才移除。
  • 標示為 `beta` 的端點供網站頁面使用;其欄位組成可能在未提前 90 天通知的情況下變更,但每項變更仍會列在這裡。

變更

新增2026.11.12向下相容

`/api/currency/ex-table`: `market=perpetual`, `delivery` and `all`, plus one status vocabulary

  • New values of `market`: `perpetual` (perpetual contracts), `delivery` (dated futures) and `all` (spot, perpetual and delivery markets of the coin in one list). They return one row per market and number `rank` inside the requested view.
  • Every per-market row carries `market_status` (`ACTIVE`, `EXPIRING`, `EXPIRED`, `NO_QUOTE`, `STALE`), `reason_code` (`NO_QUOTE`, `EXPIRED`, `STALE`, `UNAVAILABLE` or null), `source_at`, `quality`, `is_stale`, `expires_in_s`, `symbol` and `base`. The state is derived from the contract specification of the exchange (expiry) and from the time the ticker was received. `status` and `status_reason` are unchanged.
  • `EXPIRING` marks a contract that still trades and expires within 24 hours (`meta.expiring_window_s`). Rows that are not `ACTIVE` or `EXPIRING` return `price: null`; no price is carried over from an earlier quote or from another contract.
  • `meta` adds `market_status_counts`, `type_counts` and `type_rankable`. The row order is the same for every caller: rankable rows by `volume_usd` descending, then rows without a quote, expired contracts last.
新增2026.11.12向下相容

`/api/liquidation-events` 新增事件數 / 帳戶數與 BTC 最高價、最低價、振幅

  • 每一列新增欄位:`btc_high`、`btc_low`、`btc_range`(美元,最高 − 最低)和 `btc_range_pct`((最高 − 最低) / 最低 × 100),以及 `btc_range_meta`。價格取 Binance(BTC/USDT)、Coinbase(BTC/USD)、Kraken(BTC/USD)現貨 UTC 日K最高價 / 最低價的中位數。三家的日K未全部定稿時這些欄位為 null。
  • `coinboss` 列新增欄位:`liquidation_count`(去重後的爆倉事件數,不是人數)和 `account_count`(在提供帳戶標識的交易所上去重後的被爆倉帳戶數,目前僅 Hyperliquid;`quality` 為 `PARTIAL`),各自帶一個 `_meta` 物件,給出來源、時間窗、品質與涵蓋範圍。基線列這兩個欄位均為 null。
  • CoinBoss 不發布爆倉人數;`coverage.metrics.people_count.quality` 為 `UNAVAILABLE`。`liquidated_traders` 與 `btc_amplitude` 沒有變化:仍是第三方資料記錄的文字,不會寫入新欄位。
變更2026.11.12向下相容

`/api/currency/ex-table`: per-contract rows carry their own quote and a `status`

  • With `group=pair`, every contract row now uses the ticker of that contract. Before, only the main contract of each exchange had a price and the other rows returned `price: null`.
  • New row fields with `group=pair` and `market=spot`: `status` (`active`, `no_quote`, `not_provided`, `expired`), `status_reason`, `market_type`, `expiry_ts`, `expiry_date`, `native_symbol`, `quote`, `margin_type`, `price_source`, `price_at` and `rank`; the response adds `meta` (freshness window, volume window and unit, sort rule, row counts per status).
  • Rows that are not `active` return `price: null` and are never filled from another contract. `volume_usd` on such rows is `0` only when the exchange reports zero 24h turnover, otherwise `null`.
  • Order with `group=pair`: `active` rows first by `volume_usd` descending (these carry `rank`), then rows without a live quote by `oi_usd` descending, expired contracts last. `contract_type` now follows the exchange contract specification, so dated contracts on Deribit, Bybit, Gate and KuCoin are reported as `delivery`; `expiry` is set for all of them.
  • Requests without `group` return the same rows and fields as before.
變更2026.11.12向下相容

`/api/liquidation-events` 回傳前 10 名並帶 `source` 欄位

  • 本條更正下方 2026-11-11 的條目。歷史基線列(第三方公開歷史資料)恢復輸出,按原樣保留、不重新計算。
  • CoinBoss 記錄的列是自有採集器的 UTC 單日彙總;只有當某日總額大於當時榜單第 10 名時才會入榜。每一列都帶有 `source`(`historical_baseline` 或 `coinboss`)和 `basis`。
  • 榜單按 `total_usd` 排序並回傳 10 列。新增欄位:`data[].total_usd`(與 `amount_usd` 相同)、`data[].source`、`data[].basis` 和 `threshold_usd`。`coverage` 拆分為 `coverage.baseline` 與 `coverage.coinboss`;2026-11-11 引入的 `coverage.source`、`coverage.from`、`coverage.note` 移到這兩個物件之下。
變更2026.11.12向下相容

上游故障時回應 HTTP 503,並保留 JSON 錯誤內容

  • 原本回應 HTTP 502 或 504 的失敗請求,現在改為回應 503,並帶有 `Retry-After` 標頭。API 前方的 CDN 會把 502 與 504 回應的內容換成它自己的文字,導致 `code` 與 `request_id` 遺失;503 則會原封不動地通過。`code` 的值與先前相同。
  • 單一端點背後的上游來源故障時,不再波及其他端點:閘道只有在發生連線錯誤與逾時的情況下,才會改用另一個執行個體重試。
  • `/api/sd/options/*` 與 `/api/sd/cme/overview` 接受以漢字書寫的幣種名稱。沒有對應市場的幣種會收到 HTTP 200,彙總值為 `null`,不再回傳 400。
  • 資金費率結算歷史:針對 Bybit、OKX、Gate 與 Bitget 上交易最活躍的 150 個幣種(HTX 為 40 個),會偵測並回補 30 天時間視窗內的缺口,因此有更多幣種的 `cum_7d` 與 `cum_30d` 是完整的。
修正2026.11.11向下相容

爆倉波動指數已修復;來源無法使用的端點回應 503

  • `/api/indicators/cdri`:先前每日序列為空,原因是依日分組時將毫秒時間戳記誤當成秒。現在最多回傳 90 個完整 UTC 日的爆倉總額;`current.days`(新增欄位)為所用的天數,不足兩天時 `current.cdri` / `current.liqCV` 為 `null`。
  • `/api/indicators/reddit-subs`:來源拒絕請求期間會回應 HTTP 503,錯誤碼為 `UNAVAILABLE`,不再回傳 HTTP 500。僅在來源回傳正數時才會儲存訂閱人數。
  • HTTP 5xx 回應的錯誤內容不再於舊版 `msg` 欄位中帶有上游錯誤文字;該欄位現在存放與 `error` 相同的通用訊息。
修正2026.11.11破壞性變更

停止更新的紀錄會被標示,並排除在總額之外

  • `/api/coins/all` 與 `/api/coins/search`:超過 48 小時未更新的幣種紀錄,其 `market_cap` 與 `mcap_rank` 會回傳 `null` 並附上 `is_stale: true`,且排在所有現行資料列之後。生效中的規則會以 `stale_rule` 原樣帶回。
  • `/api/derivatives/coins-full`:每個幣種恰好一列。過去若多筆幣種紀錄共用同一個代號,會每筆紀錄各產生一列;現在該列帶有 48 小時內有更新的最大一筆紀錄的名稱、市值與排名,沒有這類紀錄時為 `null`。`mcap_rank` 為新增欄位。
  • `/api/reserves/overview`:每一列都有 `updated_at` 與 `is_stale`。`total` 現在只加總 36 小時內有更新的交易所;原先的口徑保留為 `total_including_stale`,被排除的交易所則列在 `stale_exchanges` 中。
  • `/api/margin/rates` 與 `/api/margin-fee/matrix`:利率已停止更新的資產與儲存格會帶有 `is_stale: true`;門檻與計數於頂層回傳。
  • 2026-10-28 至 2026-11-11 的每日全球市值快照已重新計算,原因是在加總中發現兩筆市值不合理(大於 Bitcoin)的紀錄。採集器現在會將這類數值儲存為 `null`。
變更2026.11.11向下相容

來源中斷時會在回應中如實回報,不再直接失敗或看似仍為最新

  • `/api/indicators/mempool/pools`:礦池來源沒有回應時,會回傳最後儲存的結果,並附上 `stale: true`、`cached_at` 與 `stale_reason`,不再回傳 HTTP 500。
  • `/api/etf/funds`:新增 `frozen_fields` 物件,列出來源自 2026-10-08 起停止公布的基金層級欄位,以及各數值所對應的日期。
  • `/api/indicators/halving`:新增 `current_difficulty` 物件(`value`、`as_of`、`source`)。`difficulty`(難度調整進度)在其來源無法使用期間維持為 `null`。
  • `/api/browser/detect`:鏈上查詢失敗時,不再回報為沒有活動的地址。沒有任何鏈可供查詢時,`kind` 為 `lookup_failed`。
  • `/api/currency/flows`:文件現在列出該端點實際提供的 22 個時間視窗(5 分鐘至 1 年)。
變更2026.11.11破壞性變更

不支援的參數值會回傳 400,不再回傳預設資料

  • `/api/derivatives/kline`:`interval=4h` 會回傳真正的 4 小時 K 線,由 1h K 線依 UTC 邊界合成(過去回傳的是 1h K 線)。`1h`、`4h`、`1d` 以外的週期一律回傳 400。
  • `/api/options/` 之下的期權端點:不支援的 `currency` 會回傳 400,不再回傳 BTC 資料;全部七個端點皆接受以 `coin` 作為別名。
  • `/api/etf/flows`、`/api/etf/detail`、`/api/etf/funds` 與 `/api/etf/holdings`:不支援的 `asset` 會回傳 400,不再回傳 BTC 資料。
  • `/api/liquidations/coins`:不支援的 `range` 會回傳 400,不再回傳 24h 資料;生效中的時間視窗會以 `range` 原樣帶回。
  • 在 `/api/liquidations`、`/api/liquidations/largest` 與 `/api/derivatives/coins-full` 上,`limit` 的上限為 1000。非數字的 `limit` 會採用預設值,不再導致請求失敗。
修正2026.11.11破壞性變更

每日成交量與研究統計數據已修正

  • `/api/volume/coin`:`daily_30d` 過去會把一天內每一筆滾動 24h 快照全部加總,使每日成交量被高估約 24 倍。現在改取每個 UTC 日的最後一筆快照。
  • `/api/research/stats` 搭配 `topic=derivatives`:`volume_24h_usd` 有同樣的高估問題,現已修正。
  • 同一回應中的 `avg_funding_rate_pct` 現在為百分比,約為先前回傳的原始小數的 100 倍。若您的程式碼曾將其乘以 100,請加以調整。
修正2026.11.11向下相容

舊版行情端點會忽略已停止更新的資料列

  • 受影響的端點:`/api/market/tickers`、`/api/market/volume-rank`、`/api/market/open-interest`、`/api/market/funding`、`/api/market/funding-spread`、`/api/market/long-short`、`/api/market/long-short-v2`、`/api/market/overview`、`/api/p3/volume/overview`、`/api/p3/perp-spot-volume`、`/api/volume/btc-ex-share` 與 `/api/derivatives/coins-full`。
  • 資料列只在仍屬現行資料時才計入:行情為 1 小時內,持倉量為 3 小時內(CME:120 小時),資金費率為 4 小時內,多空比為 24 小時內。
  • 總額會略為降低,部分清單也會變短。已停止交易的合約,其價格會顯示為 `null`,而非最後一筆數值。
修正2026.11.11向下相容

乘數合約已對應至其基礎幣種

  • `/api/funding/coin`、`/api/funding/history`、`/api/funding/chart` 與 `/api/ls/coin` 現在會將以幣種倍數報價的合約(例如 `1000PEPE`)對應至基礎幣種,因此這些幣種會列出更多交易所。
新增2026.11.11向下相容

六家交易所的期權資料

  • 新增 `/api/sd/options/overview`、`/api/sd/options/expiries`、`/api/sd/options/strikes`、`/api/sd/options/chain` 與 `/api/sd/options/history`。
  • 持倉量、24h 名義成交額、看跌看漲比、最大痛點、ATM IV、25-delta 偏度與 IV 期限結構,皆由 CoinBoss 依 Deribit、Binance、Bybit、OKX、Gate 與 Coincall 的合約清單計算。
  • 名義成交額與權利金成交額是各自獨立的欄位,絕不相加。交易所未公布的欄位為 `null`,並列於 `coverage.field_gaps`。
  • 歷史資料為每小時一筆,自 2026-11-11 起;更早的時段不會回補。
新增2026.11.11向下相容

取自第一手公布資料的現貨 ETF、CME 與 CFTC 資料

  • 新增 `/api/sd/etf/overview`、`/api/sd/etf/funds` 與 `/api/sd/etf/history`,依發行商揭露資料建置。合計僅涵蓋 CoinBoss 能採集的基金;其餘基金一律列出並附上原因,且 `totals_scope` 一律為 `covered_funds_only`。
  • 基金資金流由 CoinBoss 依流通份額與 NAV(或淨資產與 NAV)計算。所採用的公式會依基金在 `flow_method` 中回傳。
  • 新增 `/api/sd/cme/overview`(八項 CME 產品的每日成交量與持倉量)與 `/api/sd/cme/cot`(依交易人類別分列的 CFTC 每週持倉)。
  • CME 結算價尚未採集。USD 數字採用附標示的參考價格(`price_src`),總覽也因此標記為 PARTIAL。
新增2026.11.11向下相容

訂單簿深度與滑點

  • 新增 `/api/sd/liquidity`、`/api/sd/liquidity/history` 與 `/api/sd/liquidity/rank`。
  • 中間價 ±0.5 %、±1 % 與 ±2 % 範圍內的深度,以及 10k / 100k / 1M USD 市價單的滑點,皆依 24 家交易所的真實訂單簿快照計算,永續合約與現貨市場分開計算。
  • 未能涵蓋某個價格區間的快照會標記為 `complete: false`,以下限值回報,且不計入彙總值。`n_included` 會指出合計包含多少個訂單簿。
  • `/api/indicators/large-orderbook` 是模型輸出,並非訂單簿;如需掛單流動性,請使用新端點。
新增2026.11.11向下相容

依交易所標記價格與指數價格計算的基差

  • 新增 `/api/sd/basis`、`/api/sd/basis/history` 與 `/api/sd/basis/rank`。
  • 永續合約基差 = 同一交易所的 (mark − index) ÷ index × 100;現貨對永續基差是將永續合約與同一交易所的現貨市場相比;交割合約另附年化值。
  • 彙總值提供 OI 加權、成交量加權與中位數三種。未通過納入規則的資料列仍會回傳,並附上 `excluded_reason`。
  • 小時歷史自 2026-11-11 起。
變更2026.11.11向下相容

圖示對應表改用公開網站的來源網域

  • `/api/coin-icons` 與 `/api/exchange-icons` 回傳的圖示 URL 位於 `https://www.coinboss.com`,與其他所有公開端點同源。路徑(`/api/coin-icon/{coin}`、`/api/exchange-icon/{exchange}`)維持不變。
棄用2026.11.11向下相容

`/api/basis/list` 與 `/api/cftc/cot` 標記為舊版

  • 請以 `/api/sd/basis/rank` 取代 `/api/basis/list`,以 `/api/sd/cme/cot` 取代 `/api/cftc/cot`。舊版端點仍可正常使用。
變更2026.11.11向下相容

`/api/liquidation-events` 現在僅提供 CoinBoss 自有紀錄

  • 此清單由 CoinBoss 從交易所資料流收到的爆倉單組成。歷史自 2026-08-19 起;更早的日期不會回傳任何資料列。
  • 欄位名稱與型別維持不變。
移除2026.11.11向下相容

維運端點已無法從網際網路存取

  • `/api/health/alerts`、`/api/health/server`、`/api/health/history` 與 `/api/health/ch-read` 對公開請求回應 404。這些端點從來不屬於公開 API。
  • 服務狀態請使用 `/api/meta/status`,資料新鮮度請使用 `/api/meta/quality`。
新增2026.11.11向下相容

開發者中心與機器可讀的 API 中繼資料

  • 新增 `/api/meta/catalog`、`/api/meta/endpoint`、`/api/meta/status`、`/api/meta/quality`、`/api/meta/changelog` 與 `/api/meta/openapi`。
  • 文件中的欄位表與回應範例由 API 探針依真實回應產生;探針每 5 分鐘呼叫每個公開端點一次。
  • 端點狀態(available / partial / degraded / down / unavailable)現在來自這些真實呼叫,而非行程狀態。
變更2026.11.11向下相容

統一的錯誤內容與請求 ID

  • 每個回應都帶有 `X-Request-Id` 標頭;錯誤內容會以 `request_id` 重複這個值。
  • 所有端點的錯誤內容現在一律為 `{ success: false, code, error, request_id }`。`error` 仍是字串,因此既有的用戶端可繼續運作。
  • 未知的 `/api/*` 路由會回應 JSON 404(`NOT_FOUND`),而非 HTML 頁面。
  • HTTP 429 回應會包含 `Retry-After`。
  • 5xx 錯誤的訊息一律為通用內容;不再回傳內部細節。
新增2026.11.11向下相容

每個回應都附帶覆蓋範圍與品質的自研資料層端點

  • 新增 `/api/sd/oi`、`/api/sd/funding`、`/api/sd/liquidations`、`/api/sd/volume`、`/api/sd/ls`、`/api/sd/coin` 與 `/api/sd/quality`。
  • 持倉量會將 USDT 本位/USDC 本位/幣本位/交割合約分開列報,並註明哪些交易所回報的是雙邊數字。
  • 資金費率會回傳原始值及其週期,另附歸一為 8h 的數值與年化值;合約未處於活躍狀態的交易所會被排除並列出。
棄用2026.11.11向下相容

`/api/market/long-short` 標記為舊版

  • 清單檢視請使用 `/api/market/long-short-v2`;各交易所的帳戶數/持倉量/主動買賣比請使用 `/api/sd/ls`。
變更2026.10.31向下相容

圖示欄位改為回傳同源路徑

  • `image_url` / `icon` 等欄位現在提供 CoinBoss 路徑(`/api/coin-icon/...`),而非第三方 URL。
  • 沒有經過驗證圖示的幣種會回傳 `null`;用戶端應自行顯示預留位置圖示。
修正2026.10.24向下相容

過期資料列不再計入彙總值

  • 持倉量、資金費率與多空比的合計,只採用在新鮮視窗內更新的資料列(CME 每日公布一次,視窗較長)。
  • 已下架的合約在最後一次更新超出視窗後,即不再計入合計。

舊版端點

為相容性而保留。這些端點仍可正常使用;新的整合請改用替代端點。

端點替代端點說明
/api/market/long-short/api/market/long-short-v2為既有整合而保留。請改用 `/api/market/long-short-v2`(新增交易所篩選)或 `/api/sd/ls`(依交易所分列,帳戶數/持倉量/主動買賣各自獨立)。
/api/basis/list/api/sd/basis/rank`apr_pct` 為 `basis_pct × 3 × 365`,是把當前永續合約基差視為每 8 小時支付一次所做的簡單外推;它並非資金費率或交割收益率。`/api/sd/basis` 會分別回報標記-指數、現貨-永續與交割合約基差。