/api/sd/liquidity
GET部分可用PARTIAL

订单簿深度与滑点

各交易所在中间价 ±0.5 / 1 / 2 % 范围内的订单簿深度、买卖价差,以及 10k / 100k / 1M USD 市价单的滑点,另按市场类型给出聚合值及其分母。

GET/api/sd/liquidity
部分覆盖. 对于流动性最好的币种,若干大型交易所的公开快照无法覆盖完整的价格带,因此这些交易所不计入聚合值,聚合值会低估总深度。`lower_bound_*` 字段补上了实际观测到的部分。读取深度值时请务必同时查看 `n_included`。

请求

查询参数

名称类型必填默认值可选值说明
coinstring必填——币种代码,不区分大小写(例如 `BTC`)。缺失或格式错误时返回 400。 示例: BTC
marketstring可选allperp, spot, all市场类型。永续合约订单簿与现货订单簿绝不相加。

请求示例

curl -s "https://www.coinboss.com/api/sd/liquidity?coin=BTC"

响应字段

字段表根据真实响应生成,因此所列内容与端点实际返回的完全一致。路径中 a[] 表示数组元素,{*} 表示以动态名称(如币种或交易所)为键的对象。

字段类型单位说明
successboolean—请求成功时为 true。失败时响应体为 `{ success: false, code, error, request_id }`。
schemastring—本响应的结构 ID。仅当已有字段的含义或类型发生变化时才会改变。
nownumberms响应生成时的服务器时间。
coinstring—币种代码(大写)。
marketstring—`perp` 或 `spot`。
venuesarray—每个交易所 × 市场 × 合约一行。
venues[]object—每个交易所 × 市场 × 合约一行。
venues[].exchangestring—交易所 ID(小写)。
venues[].marketstring—`perp` 或 `spot`。
venues[].symbolstring—CoinBoss 存储格式的合约代码。
venues[].quotestring—该市场的计价货币;USDT、USDC 和 USD 均按 1:1 计为 USD。
venues[].multipliernumber—每个报价单位所代表的币数(`1000PEPE` 这类合约为 1000)。价格已除以该值。
venues[].contract_valuenumber—一张合约的规模:线性合约以币计,反向合约以 USD 计。
venues[].inverseboolean—每张合约以 USD 计价的币本位合约为 true。
venues[].midnumberUSD(best bid + best ask) ÷ 2,即一个币的价格。
venues[].best_bidnumberUSD一个币的最优买价。
venues[].best_asknumberUSD一个币的最优卖价。
venues[].spread_bpsnumberbp(best ask − best bid) ÷ mid。
venues[].n_bidsnumber—快照中的买盘价格档位数。
venues[].n_asksnumber—快照中的卖盘价格档位数。
venues[].reach_bid_pctnumber%中间价到快照中最远买盘档位的距离。
venues[].reach_ask_pctnumber%中间价到快照中最远卖盘档位的距离。
venues[].book_complete_bidboolean—订单簿的整个买盘侧均已返回时为 true。
venues[].book_complete_askboolean—订单簿的整个卖盘侧均已返回时为 true。
venues[].bandsobject—各价格带的深度;键 `0.5`、`1` 和 `2` 为距中间价的百分比距离。
venues[].bands.1object—距中间价该百分比距离的价格带。
venues[].bands.1.bid_depth_usdnumberUSD中间价与价格带下沿之间的买盘挂单名义价值。`complete` 为 false 时为下限值。
venues[].bands.1.ask_depth_usdnumberUSD中间价与价格带上沿之间的卖盘挂单名义价值。`complete` 为 false 时为下限值。
venues[].bands.1.completeboolean—快照的买卖两侧均覆盖到价格带边沿时为 true。不完整的行不计入聚合值。
venues[].bands.2object—距中间价该百分比距离的价格带。
venues[].bands.2.bid_depth_usdnumberUSD中间价与价格带下沿之间的买盘挂单名义价值。`complete` 为 false 时为下限值。
venues[].bands.2.ask_depth_usdnumberUSD中间价与价格带上沿之间的卖盘挂单名义价值。`complete` 为 false 时为下限值。
venues[].bands.2.completeboolean—快照的买卖两侧均覆盖到价格带边沿时为 true。不完整的行不计入聚合值。
venues[].bands.0.5object—距中间价该百分比距离的价格带。
venues[].bands.0.5.bid_depth_usdnumberUSD中间价与价格带下沿之间的买盘挂单名义价值。`complete` 为 false 时为下限值。
venues[].bands.0.5.ask_depth_usdnumberUSD中间价与价格带上沿之间的卖盘挂单名义价值。`complete` 为 false 时为下限值。
venues[].bands.0.5.completeboolean—快照的买卖两侧均覆盖到价格带边沿时为 true。不完整的行不计入聚合值。
venues[].slippageobject—市价单的滑点;键 `10000`、`100000` 和 `1000000` 为以 USD 计的订单规模。
venues[].slippage.10000object—该 USD 规模的市价单。
venues[].slippage.10000.buy_bpsnumberbp市价买单的平均成交价相对中间价的偏离(含一半的买卖价差);快照无法完全成交该订单时为 `null`。
venues[].slippage.10000.sell_bpsnumber|nullbp市价卖单的平均成交价相对中间价的偏离(含一半的买卖价差);快照无法完全成交该订单时为 `null`。
venues[].slippage.10000.buy_flagnull—快照无法完全成交该订单时为 `insufficient_book`,使用了聚合价格桶时为 `upper_bound`,否则为 `null`。
venues[].slippage.10000.sell_flagstring|null—快照无法完全成交该订单时为 `insufficient_book`,使用了聚合价格桶时为 `upper_bound`,否则为 `null`。
venues[].slippage.100000object—该 USD 规模的市价单。
venues[].slippage.100000.buy_bpsnumber|nullbp市价买单的平均成交价相对中间价的偏离(含一半的买卖价差);快照无法完全成交该订单时为 `null`。
venues[].slippage.100000.sell_bpsnumber|nullbp市价卖单的平均成交价相对中间价的偏离(含一半的买卖价差);快照无法完全成交该订单时为 `null`。
venues[].slippage.100000.buy_flagstring|null—快照无法完全成交该订单时为 `insufficient_book`,使用了聚合价格桶时为 `upper_bound`,否则为 `null`。
venues[].slippage.100000.sell_flagstring|null—快照无法完全成交该订单时为 `insufficient_book`,使用了聚合价格桶时为 `upper_bound`,否则为 `null`。
venues[].slippage.1000000object—该 USD 规模的市价单。
venues[].slippage.1000000.buy_bpsnumber|nullbp市价买单的平均成交价相对中间价的偏离(含一半的买卖价差);快照无法完全成交该订单时为 `null`。
venues[].slippage.1000000.sell_bpsnumber|nullbp市价卖单的平均成交价相对中间价的偏离(含一半的买卖价差);快照无法完全成交该订单时为 `null`。
venues[].slippage.1000000.buy_flagstring|null—快照无法完全成交该订单时为 `insufficient_book`,使用了聚合价格桶时为 `upper_bound`,否则为 `null`。
venues[].slippage.1000000.sell_flagstring|null—快照无法完全成交该订单时为 `insufficient_book`,使用了聚合价格桶时为 `upper_bound`,否则为 `null`。
venues[].book_bid_usdnumberUSD快照所含全部买盘挂单的名义价值。
venues[].book_ask_usdnumberUSD快照所含全部卖盘挂单的名义价值。
venues[].agg_step_bpsnumber|nullbp±2 % 范围内所用最宽的聚合价格桶;仅使用原始价格档位时为 `null`。
venues[].layersnumber—为该行拼接在一起的快照数量。
venues[].observed_atnumber|nullms数据源为该数据给出的时间戳。
venues[].received_atnumbermsCoinBoss 采集器收到该数据的时间。
venues[].lag_msnumber|nullms接收时间减去交易所给出的订单簿时间戳;交易所未提供时间戳时为 `null`。
venues[].age_snumbers距收到该行的秒数。
venues[].fresh_window_snumbers存在时间超过此值的行即视为过期。
venues[].is_staleboolean—数据早于其新鲜窗口时为 true。
venues[].tierstring—采集层级:`A` 为交易最活跃的币种,`B` 为其余币种。
venues[].period_snumbers该行的采集周期。
aggregateobject—按市场类型的合计。永续合约与现货绝不相加。
aggregate.perpobject—永续合约订单簿的聚合值;没有数据行时为 `null`。 可能缺失
aggregate.perp.n_rowsnumber—找到的行数,包括过期的行。 可能缺失
aggregate.perp.n_freshnumber—新鲜的行数。 可能缺失
aggregate.perp.mid_mediannumberUSD新鲜行的中间价中位数。 可能缺失
aggregate.perp.spread_bps_minnumberbp新鲜行中最小的买卖价差。 可能缺失
aggregate.perp.bandsobject—各价格带的深度;键 `0.5`、`1` 和 `2` 为距中间价的百分比距离。 可能缺失
aggregate.perp.bands.1object—距中间价该百分比距离的价格带。 可能缺失
aggregate.perp.bands.1.bid_depth_usdnumberUSD中间价与价格带下沿之间的买盘挂单名义价值。`complete` 为 false 时为下限值。 可能缺失
aggregate.perp.bands.1.ask_depth_usdnumberUSD中间价与价格带上沿之间的卖盘挂单名义价值。`complete` 为 false 时为下限值。 可能缺失
aggregate.perp.bands.1.n_includednumber—计入深度合计的行数:新鲜且在该价格带内完整。请与深度值一并读取。 可能缺失
aggregate.perp.bands.1.n_freshnumber—新鲜的行数。 可能缺失
aggregate.perp.bands.1.included_exchangesarray—新鲜数据已计入的数据源。 可能缺失
aggregate.perp.bands.1.included_exchanges[]string—新鲜数据已计入的数据源。 可能缺失
aggregate.perp.bands.1.excluded_incompletearray—因快照未覆盖到价格带边沿而未计入该价格带的新鲜行。 可能缺失
aggregate.perp.bands.1.excluded_incomplete[]object—因快照未覆盖到价格带边沿而未计入该价格带的新鲜行。 可能缺失
aggregate.perp.bands.1.excluded_incomplete[].exchangestring—交易所 ID(小写)。 可能缺失
aggregate.perp.bands.1.excluded_incomplete[].symbolstring—CoinBoss 存储格式的合约代码。 可能缺失
aggregate.perp.bands.1.excluded_incomplete[].reach_bid_pctnumber%中间价到快照中最远买盘档位的距离。 可能缺失
aggregate.perp.bands.1.excluded_incomplete[].reach_ask_pctnumber%中间价到快照中最远卖盘档位的距离。 可能缺失
aggregate.perp.bands.1.lower_bound_bid_usdnumberUSD买盘深度,包含不完整行中已观测到的部分。这是下限,不是估算值。 可能缺失
aggregate.perp.bands.1.lower_bound_ask_usdnumberUSD卖盘深度,包含不完整行中已观测到的部分。这是下限,不是估算值。 可能缺失
aggregate.perp.bands.1.uses_aggregated_bucketsboolean—有已计入的行使用了按价格聚合的桶时为 true,此时合计为下限值。 可能缺失
aggregate.perp.bands.2object—距中间价该百分比距离的价格带。 可能缺失
aggregate.perp.bands.2.bid_depth_usdnumberUSD中间价与价格带下沿之间的买盘挂单名义价值。`complete` 为 false 时为下限值。 可能缺失
aggregate.perp.bands.2.ask_depth_usdnumberUSD中间价与价格带上沿之间的卖盘挂单名义价值。`complete` 为 false 时为下限值。 可能缺失
aggregate.perp.bands.2.n_includednumber—计入深度合计的行数:新鲜且在该价格带内完整。请与深度值一并读取。 可能缺失
aggregate.perp.bands.2.n_freshnumber—新鲜的行数。 可能缺失
aggregate.perp.bands.2.included_exchangesarray—新鲜数据已计入的数据源。 可能缺失
aggregate.perp.bands.2.included_exchanges[]string—新鲜数据已计入的数据源。 可能缺失
aggregate.perp.bands.2.excluded_incompletearray—因快照未覆盖到价格带边沿而未计入该价格带的新鲜行。 可能缺失
aggregate.perp.bands.2.excluded_incomplete[]object—因快照未覆盖到价格带边沿而未计入该价格带的新鲜行。 可能缺失
aggregate.perp.bands.2.excluded_incomplete[].exchangestring—交易所 ID(小写)。 可能缺失
aggregate.perp.bands.2.excluded_incomplete[].symbolstring—CoinBoss 存储格式的合约代码。 可能缺失
aggregate.perp.bands.2.excluded_incomplete[].reach_bid_pctnumber%中间价到快照中最远买盘档位的距离。 可能缺失
aggregate.perp.bands.2.excluded_incomplete[].reach_ask_pctnumber%中间价到快照中最远卖盘档位的距离。 可能缺失
aggregate.perp.bands.2.lower_bound_bid_usdnumberUSD买盘深度,包含不完整行中已观测到的部分。这是下限,不是估算值。 可能缺失
aggregate.perp.bands.2.lower_bound_ask_usdnumberUSD卖盘深度,包含不完整行中已观测到的部分。这是下限,不是估算值。 可能缺失
aggregate.perp.bands.2.uses_aggregated_bucketsboolean—有已计入的行使用了按价格聚合的桶时为 true,此时合计为下限值。 可能缺失
aggregate.perp.bands.0.5object—距中间价该百分比距离的价格带。 可能缺失
aggregate.perp.bands.0.5.bid_depth_usdnumberUSD中间价与价格带下沿之间的买盘挂单名义价值。`complete` 为 false 时为下限值。 可能缺失
aggregate.perp.bands.0.5.ask_depth_usdnumberUSD中间价与价格带上沿之间的卖盘挂单名义价值。`complete` 为 false 时为下限值。 可能缺失
aggregate.perp.bands.0.5.n_includednumber—计入深度合计的行数:新鲜且在该价格带内完整。请与深度值一并读取。 可能缺失
aggregate.perp.bands.0.5.n_freshnumber—新鲜的行数。 可能缺失
aggregate.perp.bands.0.5.included_exchangesarray—新鲜数据已计入的数据源。 可能缺失
aggregate.perp.bands.0.5.included_exchanges[]string—新鲜数据已计入的数据源。 可能缺失
aggregate.perp.bands.0.5.excluded_incompletearray—因快照未覆盖到价格带边沿而未计入该价格带的新鲜行。 可能缺失
aggregate.perp.bands.0.5.excluded_incomplete[]object—因快照未覆盖到价格带边沿而未计入该价格带的新鲜行。 可能缺失
aggregate.perp.bands.0.5.excluded_incomplete[].exchangestring—交易所 ID(小写)。 可能缺失
aggregate.perp.bands.0.5.excluded_incomplete[].symbolstring—CoinBoss 存储格式的合约代码。 可能缺失
aggregate.perp.bands.0.5.excluded_incomplete[].reach_bid_pctnumber%中间价到快照中最远买盘档位的距离。 可能缺失
aggregate.perp.bands.0.5.excluded_incomplete[].reach_ask_pctnumber%中间价到快照中最远卖盘档位的距离。 可能缺失
aggregate.perp.bands.0.5.lower_bound_bid_usdnumberUSD买盘深度,包含不完整行中已观测到的部分。这是下限,不是估算值。 可能缺失
aggregate.perp.bands.0.5.lower_bound_ask_usdnumberUSD卖盘深度,包含不完整行中已观测到的部分。这是下限,不是估算值。 可能缺失
aggregate.perp.bands.0.5.uses_aggregated_bucketsboolean—有已计入的行使用了按价格聚合的桶时为 true,此时合计为下限值。 可能缺失
aggregate.spotobject—现货订单簿的聚合值;没有数据行时为 `null`。 可能缺失
aggregate.spot.n_rowsnumber—找到的行数,包括过期的行。 可能缺失
aggregate.spot.n_freshnumber—新鲜的行数。 可能缺失
aggregate.spot.mid_mediannumberUSD新鲜行的中间价中位数。 可能缺失
aggregate.spot.spread_bps_minnumberbp新鲜行中最小的买卖价差。 可能缺失
aggregate.spot.bandsobject—各价格带的深度;键 `0.5`、`1` 和 `2` 为距中间价的百分比距离。 可能缺失
aggregate.spot.bands.1object—距中间价该百分比距离的价格带。 可能缺失
aggregate.spot.bands.1.bid_depth_usdnumberUSD中间价与价格带下沿之间的买盘挂单名义价值。`complete` 为 false 时为下限值。 可能缺失
aggregate.spot.bands.1.ask_depth_usdnumberUSD中间价与价格带上沿之间的卖盘挂单名义价值。`complete` 为 false 时为下限值。 可能缺失
aggregate.spot.bands.1.n_includednumber—计入深度合计的行数:新鲜且在该价格带内完整。请与深度值一并读取。 可能缺失
aggregate.spot.bands.1.n_freshnumber—新鲜的行数。 可能缺失
aggregate.spot.bands.1.included_exchangesarray—新鲜数据已计入的数据源。 可能缺失
aggregate.spot.bands.1.included_exchanges[]string—新鲜数据已计入的数据源。 可能缺失
aggregate.spot.bands.1.excluded_incompletearray—因快照未覆盖到价格带边沿而未计入该价格带的新鲜行。 可能缺失
aggregate.spot.bands.1.excluded_incomplete[]object—因快照未覆盖到价格带边沿而未计入该价格带的新鲜行。 可能缺失
aggregate.spot.bands.1.excluded_incomplete[].exchangestring—交易所 ID(小写)。 可能缺失
aggregate.spot.bands.1.excluded_incomplete[].symbolstring—CoinBoss 存储格式的合约代码。 可能缺失
aggregate.spot.bands.1.excluded_incomplete[].reach_bid_pctnumber%中间价到快照中最远买盘档位的距离。 可能缺失
aggregate.spot.bands.1.excluded_incomplete[].reach_ask_pctnumber%中间价到快照中最远卖盘档位的距离。 可能缺失
aggregate.spot.bands.1.lower_bound_bid_usdnumberUSD买盘深度,包含不完整行中已观测到的部分。这是下限,不是估算值。 可能缺失
aggregate.spot.bands.1.lower_bound_ask_usdnumberUSD卖盘深度,包含不完整行中已观测到的部分。这是下限,不是估算值。 可能缺失
aggregate.spot.bands.1.uses_aggregated_bucketsboolean—有已计入的行使用了按价格聚合的桶时为 true,此时合计为下限值。 可能缺失
aggregate.spot.bands.2object—距中间价该百分比距离的价格带。 可能缺失
aggregate.spot.bands.2.bid_depth_usdnumberUSD中间价与价格带下沿之间的买盘挂单名义价值。`complete` 为 false 时为下限值。 可能缺失
aggregate.spot.bands.2.ask_depth_usdnumberUSD中间价与价格带上沿之间的卖盘挂单名义价值。`complete` 为 false 时为下限值。 可能缺失
aggregate.spot.bands.2.n_includednumber—计入深度合计的行数:新鲜且在该价格带内完整。请与深度值一并读取。 可能缺失
aggregate.spot.bands.2.n_freshnumber—新鲜的行数。 可能缺失
aggregate.spot.bands.2.included_exchangesarray—新鲜数据已计入的数据源。 可能缺失
aggregate.spot.bands.2.included_exchanges[]string—新鲜数据已计入的数据源。 可能缺失
aggregate.spot.bands.2.excluded_incompletearray—因快照未覆盖到价格带边沿而未计入该价格带的新鲜行。 可能缺失
aggregate.spot.bands.2.excluded_incomplete[]object—因快照未覆盖到价格带边沿而未计入该价格带的新鲜行。 可能缺失
aggregate.spot.bands.2.excluded_incomplete[].exchangestring—交易所 ID(小写)。 可能缺失
aggregate.spot.bands.2.excluded_incomplete[].symbolstring—CoinBoss 存储格式的合约代码。 可能缺失
aggregate.spot.bands.2.excluded_incomplete[].reach_bid_pctnumber%中间价到快照中最远买盘档位的距离。 可能缺失
aggregate.spot.bands.2.excluded_incomplete[].reach_ask_pctnumber%中间价到快照中最远卖盘档位的距离。 可能缺失
aggregate.spot.bands.2.lower_bound_bid_usdnumberUSD买盘深度,包含不完整行中已观测到的部分。这是下限,不是估算值。 可能缺失
aggregate.spot.bands.2.lower_bound_ask_usdnumberUSD卖盘深度,包含不完整行中已观测到的部分。这是下限,不是估算值。 可能缺失
aggregate.spot.bands.2.uses_aggregated_bucketsboolean—有已计入的行使用了按价格聚合的桶时为 true,此时合计为下限值。 可能缺失
aggregate.spot.bands.0.5object—距中间价该百分比距离的价格带。 可能缺失
aggregate.spot.bands.0.5.bid_depth_usdnumberUSD中间价与价格带下沿之间的买盘挂单名义价值。`complete` 为 false 时为下限值。 可能缺失
aggregate.spot.bands.0.5.ask_depth_usdnumberUSD中间价与价格带上沿之间的卖盘挂单名义价值。`complete` 为 false 时为下限值。 可能缺失
aggregate.spot.bands.0.5.n_includednumber—计入深度合计的行数:新鲜且在该价格带内完整。请与深度值一并读取。 可能缺失
aggregate.spot.bands.0.5.n_freshnumber—新鲜的行数。 可能缺失
aggregate.spot.bands.0.5.included_exchangesarray—新鲜数据已计入的数据源。 可能缺失
aggregate.spot.bands.0.5.included_exchanges[]string—新鲜数据已计入的数据源。 可能缺失
aggregate.spot.bands.0.5.excluded_incompletearray—因快照未覆盖到价格带边沿而未计入该价格带的新鲜行。 可能缺失
aggregate.spot.bands.0.5.excluded_incomplete[]object—因快照未覆盖到价格带边沿而未计入该价格带的新鲜行。 可能缺失
aggregate.spot.bands.0.5.excluded_incomplete[].exchangestring—交易所 ID(小写)。 可能缺失
aggregate.spot.bands.0.5.excluded_incomplete[].symbolstring—CoinBoss 存储格式的合约代码。 可能缺失
aggregate.spot.bands.0.5.excluded_incomplete[].reach_bid_pctnumber%中间价到快照中最远买盘档位的距离。 可能缺失
aggregate.spot.bands.0.5.excluded_incomplete[].reach_ask_pctnumber%中间价到快照中最远卖盘档位的距离。 可能缺失
aggregate.spot.bands.0.5.lower_bound_bid_usdnumberUSD买盘深度,包含不完整行中已观测到的部分。这是下限,不是估算值。 可能缺失
aggregate.spot.bands.0.5.lower_bound_ask_usdnumberUSD卖盘深度,包含不完整行中已观测到的部分。这是下限,不是估算值。 可能缺失
aggregate.spot.bands.0.5.uses_aggregated_bucketsboolean—有已计入的行使用了按价格聚合的桶时为 true,此时合计为下限值。 可能缺失
coverageobject—这些数值包含什么、不包含什么。在与其他数据源比较合计之前,请先比对这一点。
coverage.included_exchangesarray—新鲜数据已计入的数据源。
coverage.included_exchanges[]string—新鲜数据已计入的数据源。
coverage.unavailablearray—无法计入的数据源,每项均附原因。它们绝不会按 0 计。 在生成此表所用的样本中为空
coverage.stale_excludedarray—因最近一次更新超出新鲜窗口而被排除的行。 在生成此表所用的样本中为空
coverage.no_marketarray—已采集但没有该币种数据行的交易所 × 市场组合。 在生成此表所用的样本中为空
methodobject—以纯文本说明本响应所用的公式,每个字段一条。
method.midstring—`mid` 的公式说明,纯文本。
method.spread_bpsstring—`spread_bps` 的公式说明,纯文本。
method.bid_depth_usdstring—`bid_depth_usd` 的公式说明,纯文本。
method.ask_depth_usdstring—`ask_depth_usd` 的公式说明,纯文本。
method.completestring—`complete` 的公式说明,纯文本。
method.reach_pctstring—`reach_pct` 的公式说明,纯文本。
method.slippage_bpsstring—`slippage_bps` 的公式说明,纯文本。
method.agg_step_bpsstring—`agg_step_bps` 的公式说明,纯文本。
method.aggregatestring—`aggregate` 的公式说明,纯文本。
method.freshstring—`fresh` 的公式说明,纯文本。
method.lag_msstring—`lag_ms` 的公式说明,纯文本。
method.no_marketstring—`no_market` 的公式说明,纯文本。
metaobject—本响应的数据来源与新鲜度。
meta.schemastring—本响应的结构 ID。仅当已有字段的含义或类型发生变化时才会改变。
meta.sourcearray—采集数据所用的上游公开端点。
meta.source[]object—采集数据所用的上游公开端点。
meta.source[].exchangestring—交易所 ID(小写)。
meta.source[].marketstring—`perp` 或 `spot`。
meta.source[].endpointstring—采集器读取的数据源公开端点(仅用于说明数据来源;客户端不会调用它)。
meta.observed_atnumberms数据源为该数据给出的时间戳。
meta.received_atnumbermsCoinBoss 采集器收到该数据的时间。
meta.fetched_atnumberms本响应的组装时间。
meta.windowstring—这些数值覆盖的时间窗口。
meta.qualitystring—FRESH、PARTIAL、STALE、BROKEN 或 UNAVAILABLE,根据数据时间戳和覆盖范围判定。
meta.is_staleboolean—数据早于其新鲜窗口时为 true。
meta.cache_ttl_snumbers本响应的缓存有效期。
meta.fallbackstring—采集器或数据源出现故障时端点返回的内容。
meta.collector_heartbeat_age_snumbers距采集器最近一次上报自身在运行的秒数。

生成于 2026-11-11 23:28 UTC,基于 4 个真实响应。

响应示例

/api/sd/liquidity?coin=BTC · 真实响应,采集于 2026-11-13 03:58:06 UTC。 为便于展示,较长的数组和映射已被截短:venues 原有 39 项; meta.source 原有 38 项; coverage.included_exchanges 原有 24 项; aggregate.perp.bands.1.included_exchanges 原有 19 项; aggregate.perp.bands.2.included_exchanges 原有 16 项; aggregate.spot.bands.1.included_exchanges 原有 14 项。

  • {
    • "success": true,
    • "schema": "coinboss.sd.liquidity/1",
    • "now": 1794542286066,
    • "coin": "BTC",
    • "market": "all",
    • "venues": [
      • { … 31 }
      ],
    • "aggregate": {
      • "perp": { … 5 },
      • "spot": { … 5 }
      },
    • "coverage": {
      • "included_exchanges": [ … 8 ],
      • "unavailable": [],
      • "stale_excluded": [],
      • "no_market": []
      },
    • "method": {
      • "mid": "(best_bid + best_ask) / 2 of the venue order book, normalised to the USD price of ONE coin (1000PEPE / kPEPE style contr…",
      • "spread_bps": "(best_ask - best_bid) / mid * 1e4",
      • "bid_depth_usd": "sum of resting bid notional with price >= mid * (1 - band%), in USD; notional = price * size * contract_value (inverse c…",
      • "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;…",
      • "reach_pct": "distance in % between mid and the farthest price level contained in the snapshot on that side",
      • "slippage_bps": "market order of N USD walked through the book: buy = (avg_fill / mid - 1) * 1e4, sell = (1 - avg_fill / mid) * 1e4, meas…",
      • "agg_step_bps": "widest price-aggregation bucket (in bps of mid) used inside +-2% for venues whose REST only exposes a shallow raw book (…",
      • "aggregate": "per market and band: sum over rows that are fresh AND complete for that band; n_included / n_fresh is the denominator; l…",
      • "fresh": "a row is fresh when now - received_at <= max(3 * period_s, 300s); stale rows are listed in coverage.stale_excluded; rows…",
      • "lag_ms": "received_at - venue timestamp of the book (null when the venue gives none); Gate spot books deeper than 100 levels are v…",
      • "no_market": "covered venue/market pairs that are being collected but hold no row for this coin: not listed there, or the contract was…"
      },
    • "meta": {
      • "schema": "coinboss.sd.liquidity/1",
      • "source": [ … 1 ],
      • "observed_at": 1794542285214,
      • "received_at": 1794542285776,
      • "fetched_at": 1794542286066,
      • "window": "latest",
      • "quality": "PARTIAL",
      • "is_stale": false,
      • "cache_ttl_s": 15,
      • "fallback": "on collector failure the last stored row is served with is_stale=true and left out of the aggregate; rows older than 24h…",
      • "collector_heartbeat_age_s": 9
      }
    }

已验证的样本

除上面的示例外,探针还会使用以下参数调用该端点,并在每次调用时校验结构。

参数HTTP延迟结果
coin=ETH&market=spot2003 ms通过 PARTIAL
coin=PEPE&market=perp2004 ms通过 FRESH
coin=SOL2004 ms通过 PARTIAL
—4001 ms通过 返回预期的错误

检查于 2026-11-13 03:58:06 UTC

详细信息

身份验证
无。公开端点。
速率限制
每个 IP 每分钟 1200 次请求
服务端缓存
15s
边缘微缓存
10s
更新频率
成交最活跃的币种每 120 秒快照一次,其余每 600 秒一次(少数交易所:300 / 1200 秒)。数据行在三个采集周期内视为新鲜,且至少为 300 秒。
时间窗口
每个合约的最新快照。
数据来源
24 家交易所(永续合约与现货市场)的公开 REST 订单簿快照,由 CoinBoss 采集并存储(sd_book_latest、sd_book_hist)。深度和滑点由 CoinBoss 根据原始价格档位计算。
交易所覆盖范围
24 家交易所,38 条交易所 × 市场通道。如果公开快照无法覆盖中间价 ±0.5 / 1 / 2 %(受交易所档位数量上限所限),该价格带会被标记为 `complete: false`,其数值为下限值,且不计入聚合值;`n_included` / `n_fresh` 给出分母,`excluded_incomplete` 列出被排除的项。
分页
不分页;每个交易所 × 市场 × 合约一行。
排序
永续合约行在前,现货行在后;各自内部按 ±1 % 深度(买盘 + 卖盘)降序。
单位
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.
计算方法
mid = (best bid + best ask) ÷ 2. Depth = Σ price × size of all levels between mid and mid ± x %. Slippage = (average fill price of a market order of N USD − mid) ÷ mid, in bp; `null` with flag `insufficient_book` when the snapshot cannot fill the order (no extrapolation), flag `upper_bound` when an aggregated price bucket was used.
时间戳
除非字段说明另有注明,均为 Unix 纪元毫秒(UTC)
响应格式
json
稳定性
稳定
上线时间
2026-11-11

实时状态

部分可用检查于 2026-11-13 03:58:06 UTCHTTP 2007 ms结构一致最新数据点距今 0s

该端点上报的数据质量为 PARTIAL — 对于流动性最好的币种,若干大型交易所的公开快照无法覆盖完整的价格带,因此这些交易所不计入聚合值,聚合值会低估总深度。`lower_bound_*` 字段补上了实际观测到的部分。读取深度值时请务必同时查看 `n_included`。

近 30 天可用性

407 次检查中 100% 通过

错误

所有端点的失败响应格式一致。完整列表见错误页面。 错误与速率限制 →

错误码HTTP含义处理方式
INVALID_PARAM400缺少必填参数,或某个取值不被接受。已知是哪个参数时,`param` 会给出其名称。请勿原样重试;请修正请求。
UNAUTHORIZED401已发送 `CB-API-KEY` 请求头,但该密钥未知或已被吊销。公开数据无需密钥,请去掉该请求头或使用有效密钥。请勿原样重试。
FORBIDDEN403该路由不属于公开 API(内部或仅限账户使用)。请勿重试。
NOT_FOUND404未知路由,或所请求的币种 / 交易所 / 基金不存在。请勿重试;请对照目录检查路径和标识符。
RATE_LIMITED429请求数超过每分钟限额。`Retry-After` 给出需要等待的秒数。等待 `Retry-After` 指定的时间后,再以退避方式重试。
INTERNAL500意外的服务器错误。错误信息有意保持通用;报告问题时请附上 `request_id`。几秒后重试一次;若问题持续,请附上请求 ID 报告。
UPSTREAM_FAILED503该端点背后的数据源未及时响应。不会返回过期数据或替代数值来顶替。以退避方式重试;并查看状态页。
UNAVAILABLE501 / 503数据集暂时未就绪(缓存预热中),或该端点尚无合法的公开数据源。请稍后重试;目录会标出因设计原因而不可用的端点。
REQUEST_FAILED200部分较旧的端点会以 HTTP 200 返回 `success: false`。请务必检查 `success`,而不只是 HTTP 状态码。取决于具体信息;按请求失败处理。

试一试

GET/api/sd/liquidity部分可用
参数

string — Coin symbol, case-insensitive (for example `BTC`). Missing or malformed values return 400.

string · 默认 all — Market type. Perpetual and spot books are never added together.

请求 URLhttps://www.coinboss.com/api/sd/liquidity?coin=BTC
选择一个端点,然后点击“发送请求”。响应、响应头和耗时将显示在这里。