订单簿深度历史
某币种在单一价格带内的聚合买盘与卖盘深度时间序列,可取全部已覆盖交易所或单个交易所。每个数据点都注明所含合约数量。
/api/sd/liquidity/history请求
查询参数
| 名称 | 类型 | 必填 | 默认值 | 可选值 | 说明 |
|---|---|---|---|---|---|
| coin | string | 必填 | — | — | 币种代码,不区分大小写(例如 `BTC`)。缺失或格式错误时返回 400。 示例: BTC |
| market | string | 可选 | perp | perp, spot | 市场类型。永续合约订单簿与现货订单簿绝不相加。 |
| band | string | 可选 | 1 | 0.5, 1, 2 | 距中间价的百分比距离。 |
| range | string | 可选 | 24h | 24h, 7d, 30d | 回溯范围:24h(30 分钟一个点)、7d(2 小时一个点)或 30d(6 小时一个点)。 |
| exchange | string | 可选 | — | — | 该市场已覆盖的某个交易所 ID(例如 `gate`)。默认:全部交易所。未覆盖的交易所返回 400。 |
请求示例
curl -s "https://www.coinboss.com/api/sd/liquidity/history?coin=BTC"响应字段
字段表根据真实响应生成,因此所列内容与端点实际返回的完全一致。路径中 a[] 表示数组元素,{*} 表示以动态名称(如币种或交易所)为键的对象。
| 字段 | 类型 | 单位 | 说明 |
|---|---|---|---|
| success | boolean | — | 请求成功时为 true。失败时响应体为 `{ success: false, code, error, request_id }`。 |
| schema | string | — | 本响应的结构 ID。仅当已有字段的含义或类型发生变化时才会改变。 |
| now | number | ms | 响应生成时的服务器时间。 |
| coin | string | — | 币种代码(大写)。 |
| market | string | — | `perp` 或 `spot`。 |
| band_pct | number | % | 所选价格带:距中间价的距离。 |
| range | string | — | 实际采用的回溯范围。 |
| exchange | string|null | — | 交易所 ID(小写)。 |
| interval_s | number | s | 数据点的间隔。 |
| points | array | — | 序列数据点,按时间从早到晚排列。 |
| points[] | object | — | 序列数据点,按时间从早到晚排列。 |
| points[].t | number | ms | 时间桶的起始时间。 |
| points[].bid_depth_usd | number | USD | 中间价与价格带下沿之间的买盘挂单名义价值。`complete` 为 false 时为下限值。 |
| points[].ask_depth_usd | number | USD | 中间价与价格带上沿之间的卖盘挂单名义价值。`complete` 为 false 时为下限值。 |
| points[].n_included | number | — | 计入深度合计的行数:新鲜且在该价格带内完整。请与深度值一并读取。 |
| points[].n_rows | number | — | 找到的行数,包括过期的行。 |
| points[].mid | number | USD | (best bid + best ask) ÷ 2,即一个币的价格。 |
| points[].uses_aggregated_buckets | boolean | — | 有已计入的行使用了按价格聚合的桶时为 true,此时合计为下限值。 |
| points_expected | number | — | 该范围完整时应有的数据点数量。 |
| first_t | number | ms | 返回的第一个数据点的时间。 |
| last_t | number | ms | 返回的最后一个数据点的时间。 |
| exchange_points | object | — | 每个交易所出现在多少个数据点中(键为交易所 ID)。 动态键: deribit,aster,backpack,bitfinex,bitget,bitunix |
| exchange_points.{*} | number | — | 每个交易所出现在多少个数据点中(键为交易所 ID)。 |
| coverage | object | — | 这些数值包含什么、不包含什么。在与其他数据源比较合计之前,请先比对这一点。 |
| coverage.included_exchanges | array | — | 新鲜数据已计入的数据源。 |
| coverage.included_exchanges[] | string | — | 新鲜数据已计入的数据源。 |
| coverage.unavailable | array | — | 无法计入的数据源,每项均附原因。它们绝不会按 0 计。 在生成此表所用的样本中为空 |
| coverage.stale_excluded | array | — | 因最近一次更新超出新鲜窗口而被排除的行。 在生成此表所用的样本中为空 |
| method | object | — | 以纯文本说明本响应所用的公式,每个字段一条。 |
| method.bid_depth_usd | string | — | `bid_depth_usd` 的公式说明,纯文本。 |
| method.ask_depth_usd | string | — | `ask_depth_usd` 的公式说明,纯文本。 |
| method.complete | string | — | `complete` 的公式说明,纯文本。 |
| method.history | string | — | `history` 的公式说明,纯文本。 |
| method.exchange_points | string | — | `exchange_points` 的公式说明,纯文本。 |
| meta | object | — | 本响应的数据来源与新鲜度。 |
| meta.schema | string | — | 本响应的结构 ID。仅当已有字段的含义或类型发生变化时才会改变。 |
| meta.source | array | — | 采集数据所用的上游公开端点。 |
| meta.source[] | object | — | 采集数据所用的上游公开端点。 |
| meta.source[].exchange | string | — | 交易所 ID(小写)。 |
| meta.source[].market | string | — | `perp` 或 `spot`。 |
| meta.source[].endpoint | string | — | 采集器读取的数据源公开端点(仅用于说明数据来源;客户端不会调用它)。 |
| meta.observed_at | null | — | 数据源为该数据给出的时间戳。 |
| meta.received_at | number | ms | CoinBoss 采集器收到该数据的时间。 |
| meta.fetched_at | number | ms | 本响应的组装时间。 |
| meta.window | string | — | 这些数值覆盖的时间窗口。 |
| meta.quality | string | — | FRESH、PARTIAL、STALE、BROKEN 或 UNAVAILABLE,根据数据时间戳和覆盖范围判定。 |
| meta.is_stale | boolean | — | 数据早于其新鲜窗口时为 true。 |
| meta.cache_ttl_s | number | s | 本响应的缓存有效期。 |
| meta.fallback | string | — | 采集器或数据源出现故障时端点返回的内容。 |
| meta.collector_heartbeat_age_s | number | s | 距采集器最近一次上报自身在运行的秒数。 |
生成于 2026-11-11 23:00 UTC,基于 3 个真实响应。
响应示例
/api/sd/liquidity/history?coin=BTC · 真实响应,采集于 2026-11-13 04:02:45 UTC。 为便于展示,较长的数组和映射已被截短:points 原有 48 项; meta.source 原有 19 项; exchange_points 原有 19 项; coverage.included_exchanges 原有 19 项。
- "success"true
- "schema""coinboss.sd.liquidity/1"
- "now"1794542565889
- "coin""BTC"
- "market""perp"
- "band_pct"1
- "range""24h"
- "exchange"null
- "interval_s"1800
- "points"
- "points_expected"48
- "first_t"1794457800000
- "last_t"1794542400000
- "exchange_points"
- "deribit"96
- "aster"48
- "coverage"
- "included_exchanges"
- "unavailable"
- "stale_excluded"
- "method"
- "bid_depth_usd""sum of resting bid notional with price >= mid * (1 - band%), in USD; notional = price * size * contract_value (inverse contracts: size * contract_value); USDT /…"
- "ask_depth_usd""sum of resting ask notional with price <= mid * (1 + band%), in USD; same notional rule as bid_depth_usd"
- "complete""true when BOTH sides of the snapshot reach the band edge (reach_pct >= band) or the whole side of the book was returned; when false the depth values are lower b…"
- "history""sd_book_hist keeps the first snapshot of every 15-minute bucket per contract; each returned point takes, per contract, the first stored snapshot inside the poin…"
- "exchange_points""number of returned points in which each exchange had a row that was complete for the band; a changing venue set moves the aggregate, so compare n_included acros…"
- "meta"
- "schema""coinboss.sd.liquidity/1"
- "source"
- "observed_at"null
- "received_at"1794542400000
- "fetched_at"1794542565889
- "window""24h"
- "quality""FRESH"
- "is_stale"false
- "cache_ttl_s"120
- "fallback""history is append-only (first snapshot of each 15-minute bucket per contract, 30-day retention); buckets the collector missed are simply absent, never interpola…"
- "collector_heartbeat_age_s"3
已验证的样本
除上面的示例外,探针还会使用以下参数调用该端点,并在每次调用时校验结构。
| 参数 | HTTP | 延迟 | 结果 |
|---|---|---|---|
| band=2&coin=ETH&market=spot | 200 | 6 ms | 通过 FRESH |
| coin=SOL&exchange=gate | 200 | 2 ms | 通过 FRESH |
| band=3&coin=BTC | 400 | 1 ms | 通过 返回预期的错误 |
检查于 2026-11-13 03:58:06 UTC
详细信息
- 身份验证
- 无。公开端点。
- 速率限制
- 每个 IP 每分钟 1200 次请求
- 服务端缓存
- 2m
- 边缘微缓存
- 10s
- 更新频率
- 每个合约每 15 分钟存储一次快照;每个数据点取其时间桶内最早的快照(时点值,不是平均值)。
- 时间窗口
- 24h / 7d / 30d.
- 数据来源
- 24 家交易所(永续合约与现货市场)的公开 REST 订单簿快照,由 CoinBoss 采集并存储(sd_book_latest、sd_book_hist)。深度和滑点由 CoinBoss 根据原始价格档位计算。
- 交易所覆盖范围
- 24 家交易所,38 条交易所 × 市场通道。如果公开快照无法覆盖中间价 ±0.5 / 1 / 2 %(受交易所档位数量上限所限),该价格带会被标记为 `complete: false`,其数值为下限值,且不计入聚合值;`n_included` / `n_fresh` 给出分母,`excluded_incomplete` 列出被排除的项。
- 分页
- 不分页;`range` 决定数据点数量的上限(48 / 84 / 120)。
- 排序
- 按时间升序。
- 单位
- Depth in USD notional, bid and ask side reported separately and never added. Spread and slippage in basis points (1 bp = 0.01 %). USDT / USDC / USD quotes are counted 1:1 as USD.
- 时间戳
- 除非字段说明另有注明,均为 Unix 纪元毫秒(UTC)
- 响应格式
- json
- 稳定性
- 稳定
- 上线时间
- 2026-11-11
实时状态
采集始于 2026-11-11,因此较长的时间范围会逐步填满。缺失的时间桶不会出现,也不做插值;两个数据点之间 `n_included` 发生变化,表示参与计算的合约集合有变。
近 30 天可用性
408 次检查中 100% 通过
错误
所有端点的失败响应格式一致。完整列表见错误页面。 错误与速率限制 →
| 错误码 | HTTP | 含义 | 处理方式 |
|---|---|---|---|
| INVALID_PARAM | 400 | 缺少必填参数,或某个取值不被接受。已知是哪个参数时,`param` 会给出其名称。 | 请勿原样重试;请修正请求。 |
| UNAUTHORIZED | 401 | 已发送 `CB-API-KEY` 请求头,但该密钥未知或已被吊销。公开数据无需密钥,请去掉该请求头或使用有效密钥。 | 请勿原样重试。 |
| FORBIDDEN | 403 | 该路由不属于公开 API(内部或仅限账户使用)。 | 请勿重试。 |
| NOT_FOUND | 404 | 未知路由,或所请求的币种 / 交易所 / 基金不存在。 | 请勿重试;请对照目录检查路径和标识符。 |
| RATE_LIMITED | 429 | 请求数超过每分钟限额。`Retry-After` 给出需要等待的秒数。 | 等待 `Retry-After` 指定的时间后,再以退避方式重试。 |
| INTERNAL | 500 | 意外的服务器错误。错误信息有意保持通用;报告问题时请附上 `request_id`。 | 几秒后重试一次;若问题持续,请附上请求 ID 报告。 |
| UPSTREAM_FAILED | 503 | 该端点背后的数据源未及时响应。不会返回过期数据或替代数值来顶替。 | 以退避方式重试;并查看状态页。 |
| UNAVAILABLE | 501 / 503 | 数据集暂时未就绪(缓存预热中),或该端点尚无合法的公开数据源。 | 请稍后重试;目录会标出因设计原因而不可用的端点。 |
| REQUEST_FAILED | 200 | 部分较旧的端点会以 HTTP 200 返回 `success: false`。请务必检查 `success`,而不只是 HTTP 状态码。 | 取决于具体信息;按请求失败处理。 |
试一试
/api/sd/liquidity/history部分可用string — Coin symbol, case-insensitive (for example `BTC`). Missing or malformed values return 400.
string · 默认 perp — Market type. Perpetual and spot books are never added together.
string · 默认 1 — Distance from mid price in percent.
string · 默认 24h — Look-back range: 24h (30-minute points), 7d (2-hour points) or 30d (6-hour points).
string — One exchange id covered for this market (for example `gate`). Default: all exchanges. An exchange that is not covered returns 400.
https://www.coinboss.com/api/sd/liquidity/history?coin=BTC同分类的其他端点
- 订单簿深度与滑点 /api/sd/liquidity
- 订单簿深度历史 /api/sd/liquidity/history
- 按订单簿深度排名的币种 /api/sd/liquidity/rank
- 大额挂单监控 /api/indicators/large-orderbook