GET一部PARTIAL
板の厚みとスリッページ
取引所別に、仲値の±0.5 / 1 / 2 %以内の板の厚み、スプレッド、10k / 100k / 1M USDの成行注文に対するスリッページを返します。市場タイプ別の集計値とその分母も含まれます。
GET
/api/sd/liquidity部分的なカバレッジ. 流動性が特に高い銘柄では、複数の大手取引所の公開スナップショットが価格帯の全体に届かないため、それらの取引所は集計値から除外され、集計値は板の厚みの合計を過小に表します。`lower_bound_*`フィールドは、観測できた部分を加えた値です。板の厚みの値は、必ず`n_included`と併せて読んでください。
リクエスト
クエリパラメータ
| 名前 | 型 | 必須 | デフォルト | 指定可能な値 | 説明 |
|---|---|---|---|---|---|
| coin | string | 必須 | — | — | 銘柄シンボル。大文字と小文字は区別しません（例：`BTC`）。値が未指定または不正な場合は400を返します。 例: BTC |
| market | string | 任意 | all | perp, spot, all | 市場タイプ。無期限先物と現物の板を合算することはありません。 |
リクエスト例
curl -s "https://www.coinboss.com/api/sd/liquidity?coin=BTC"レスポンスフィールド
フィールド表は実際のレスポンスから生成しているため、エンドポイントが返す内容をそのまま反映しています。パスでは、配列の要素をa[]、銘柄や取引所などの動的な名前をキーとするオブジェクトを{*}で表します。
| フィールド | 型 | 単位 | 説明 |
|---|---|---|---|
| success | boolean | — | リクエストが成功した場合はtrue。失敗した場合、ボディは`{ success: false, code, error, request_id }`になります。 |
| schema | string | — | このレスポンスのスキーマID。既存フィールドの意味または型が変わった場合にのみ変更されます。 |
| now | number | ms | レスポンスを生成した時点のサーバー時刻。 |
| coin | string | — | 銘柄シンボル（大文字）。 |
| market | string | — | `perp`または`spot`。 |
| venues | array | — | 取引所 × 市場 × 契約ごとに1行。 |
| venues[] | object | — | 取引所 × 市場 × 契約ごとに1行。 |
| venues[].exchange | string | — | 取引所ID（小文字）。 |
| venues[].market | string | — | `perp`または`spot`。 |
| venues[].symbol | string | — | CoinBossの保存形式での契約シンボル。 |
| venues[].quote | string | — | 市場の建値通貨。USDT、USDC、USDは1:1でUSDとして扱います。 |
| venues[].multiplier | number | — | 建値1単位あたりのコイン数（`1000PEPE`型の契約では1000）。価格はすでにこの値で除算済みです。 |
| venues[].contract_value | number | — | 1契約のサイズ：リニア契約ではコイン数、インバース契約ではUSD。 |
| venues[].inverse | boolean | — | 1契約あたりUSD建てで建値されるコイン証拠金型の契約の場合はtrue。 |
| venues[].mid | number | USD | (best bid + best ask) ÷ 2。1コインあたりの価格。 |
| venues[].best_bid | number | USD | 1コインあたりの最良買い気配。 |
| venues[].best_ask | number | USD | 1コインあたりの最良売り気配。 |
| venues[].spread_bps | number | bp | (best ask − best bid) ÷ mid。 |
| venues[].n_bids | number | — | スナップショットに含まれる買い板の価格レベル数。 |
| venues[].n_asks | number | — | スナップショットに含まれる売り板の価格レベル数。 |
| venues[].reach_bid_pct | number | % | 仲値から、スナップショット内で最も遠い買い板の価格レベルまでの距離。 |
| venues[].reach_ask_pct | number | % | 仲値から、スナップショット内で最も遠い売り板の価格レベルまでの距離。 |
| venues[].book_complete_bid | boolean | — | 板の買い側がすべて返された場合はtrue。 |
| venues[].book_complete_ask | boolean | — | 板の売り側がすべて返された場合はtrue。 |
| venues[].bands | object | — | 価格帯ごとの板の厚み。キーの`0.5`、`1`、`2`は仲値からの距離（%）です。 |
| venues[].bands.1 | object | — | 仲値からこの距離（%）にある価格帯。 |
| venues[].bands.1.bid_depth_usd | number | USD | 仲値から価格帯の下端までにある買い指値注文の想定元本。`complete`がfalseの場合は下限値です。 |
| venues[].bands.1.ask_depth_usd | number | USD | 仲値から価格帯の上端までにある売り指値注文の想定元本。`complete`がfalseの場合は下限値です。 |
| venues[].bands.1.complete | boolean | — | スナップショットの両サイドが価格帯の端に届いている場合はtrue。不完全な行は集計値から除外されます。 |
| venues[].bands.2 | object | — | 仲値からこの距離（%）にある価格帯。 |
| venues[].bands.2.bid_depth_usd | number | USD | 仲値から価格帯の下端までにある買い指値注文の想定元本。`complete`がfalseの場合は下限値です。 |
| venues[].bands.2.ask_depth_usd | number | USD | 仲値から価格帯の上端までにある売り指値注文の想定元本。`complete`がfalseの場合は下限値です。 |
| venues[].bands.2.complete | boolean | — | スナップショットの両サイドが価格帯の端に届いている場合はtrue。不完全な行は集計値から除外されます。 |
| venues[].bands.0.5 | object | — | 仲値からこの距離（%）にある価格帯。 |
| venues[].bands.0.5.bid_depth_usd | number | USD | 仲値から価格帯の下端までにある買い指値注文の想定元本。`complete`がfalseの場合は下限値です。 |
| venues[].bands.0.5.ask_depth_usd | number | USD | 仲値から価格帯の上端までにある売り指値注文の想定元本。`complete`がfalseの場合は下限値です。 |
| venues[].bands.0.5.complete | boolean | — | スナップショットの両サイドが価格帯の端に届いている場合はtrue。不完全な行は集計値から除外されます。 |
| venues[].slippage | object | — | 成行注文のスリッページ。キー`10000`、`100000`、`1000000`はUSD建ての注文サイズです。 |
| venues[].slippage.10000 | object | — | このUSD金額の成行注文。 |
| venues[].slippage.10000.buy_bps | number | bp | 成行買いの平均約定価格と仲値との差（スプレッドの半分を含む）。スナップショットで注文を約定しきれない場合は`null`。 |
| venues[].slippage.10000.sell_bps | number|null | bp | 成行売りの平均約定価格と仲値との差（スプレッドの半分を含む）。スナップショットで注文を約定しきれない場合は`null`。 |
| venues[].slippage.10000.buy_flag | null | — | スナップショットでは注文を約定しきれない場合は`insufficient_book`、集約済みバケットを使用した場合は`upper_bound`、それ以外は`null`。 |
| venues[].slippage.10000.sell_flag | string|null | — | スナップショットでは注文を約定しきれない場合は`insufficient_book`、集約済みバケットを使用した場合は`upper_bound`、それ以外は`null`。 |
| venues[].slippage.100000 | object | — | このUSD金額の成行注文。 |
| venues[].slippage.100000.buy_bps | number|null | bp | 成行買いの平均約定価格と仲値との差（スプレッドの半分を含む）。スナップショットで注文を約定しきれない場合は`null`。 |
| venues[].slippage.100000.sell_bps | number|null | bp | 成行売りの平均約定価格と仲値との差（スプレッドの半分を含む）。スナップショットで注文を約定しきれない場合は`null`。 |
| venues[].slippage.100000.buy_flag | string|null | — | スナップショットでは注文を約定しきれない場合は`insufficient_book`、集約済みバケットを使用した場合は`upper_bound`、それ以外は`null`。 |
| venues[].slippage.100000.sell_flag | string|null | — | スナップショットでは注文を約定しきれない場合は`insufficient_book`、集約済みバケットを使用した場合は`upper_bound`、それ以外は`null`。 |
| venues[].slippage.1000000 | object | — | このUSD金額の成行注文。 |
| venues[].slippage.1000000.buy_bps | number|null | bp | 成行買いの平均約定価格と仲値との差（スプレッドの半分を含む）。スナップショットで注文を約定しきれない場合は`null`。 |
| venues[].slippage.1000000.sell_bps | number|null | bp | 成行売りの平均約定価格と仲値との差（スプレッドの半分を含む）。スナップショットで注文を約定しきれない場合は`null`。 |
| venues[].slippage.1000000.buy_flag | string|null | — | スナップショットでは注文を約定しきれない場合は`insufficient_book`、集約済みバケットを使用した場合は`upper_bound`、それ以外は`null`。 |
| venues[].slippage.1000000.sell_flag | string|null | — | スナップショットでは注文を約定しきれない場合は`insufficient_book`、集約済みバケットを使用した場合は`upper_bound`、それ以外は`null`。 |
| venues[].book_bid_usd | number | USD | スナップショットに含まれるすべての買い注文の想定元本。 |
| venues[].book_ask_usd | number | USD | スナップショットに含まれるすべての売り注文の想定元本。 |
| venues[].agg_step_bps | number|null | bp | ±2 %以内で使用した価格集約バケットのうち最も幅の広いもの。生の価格レベルのみを使用した場合は`null`。 |
| venues[].layers | number | — | この行のためにつなぎ合わせたスナップショットの数。 |
| venues[].observed_at | number|null | ms | ソースがデータに付与したタイムスタンプ。 |
| venues[].received_at | number | ms | CoinBossのコレクターがデータを受信した時刻。 |
| venues[].lag_ms | number|null | ms | 受信時刻から取引所の板タイムスタンプを引いた値。取引所がタイムスタンプを提供しない場合は`null`。 |
| venues[].age_s | number | s | 行を受信してからの経過秒数。 |
| venues[].fresh_window_s | number | s | これより古い行は鮮度切れです。 |
| venues[].is_stale | boolean | — | データが鮮度ウィンドウより古い場合はtrue。 |
| venues[].tier | string | — | 収集ティア：取引が最も活発な銘柄は`A`、それ以外は`B`。 |
| venues[].period_s | number | s | 行の収集周期。 |
| aggregate | object | — | 市場タイプ別の合計。無期限先物と現物を合算することはありません。 |
| aggregate.perp | object | — | 無期限先物の板の集計値。行がない場合は`null`。 省略される場合あり |
| aggregate.perp.n_rows | number | — | 見つかった行数（鮮度切れの行を含む）。 省略される場合あり |
| aggregate.perp.n_fresh | number | — | 鮮度内の行数。 省略される場合あり |
| aggregate.perp.mid_median | number | USD | 鮮度内の行の仲値の中央値。 省略される場合あり |
| aggregate.perp.spread_bps_min | number | bp | 鮮度内の行のうち最小のスプレッド。 省略される場合あり |
| aggregate.perp.bands | object | — | 価格帯ごとの板の厚み。キーの`0.5`、`1`、`2`は仲値からの距離（%）です。 省略される場合あり |
| aggregate.perp.bands.1 | object | — | 仲値からこの距離（%）にある価格帯。 省略される場合あり |
| aggregate.perp.bands.1.bid_depth_usd | number | USD | 仲値から価格帯の下端までにある買い指値注文の想定元本。`complete`がfalseの場合は下限値です。 省略される場合あり |
| aggregate.perp.bands.1.ask_depth_usd | number | USD | 仲値から価格帯の上端までにある売り指値注文の想定元本。`complete`がfalseの場合は下限値です。 省略される場合あり |
| aggregate.perp.bands.1.n_included | number | — | 板の厚みの合計に含まれる行数：鮮度内で、かつその価格帯について完全な行。板の厚みの値と併せて読んでください。 省略される場合あり |
| aggregate.perp.bands.1.n_fresh | number | — | 鮮度内の行数。 省略される場合あり |
| aggregate.perp.bands.1.included_exchanges | array | — | 鮮度内のデータが算入されているソース。 省略される場合あり |
| aggregate.perp.bands.1.included_exchanges[] | string | — | 鮮度内のデータが算入されているソース。 省略される場合あり |
| aggregate.perp.bands.1.excluded_incomplete | array | — | スナップショットが価格帯の端に届かないため、その価格帯から除外された鮮度内の行。 省略される場合あり |
| aggregate.perp.bands.1.excluded_incomplete[] | object | — | スナップショットが価格帯の端に届かないため、その価格帯から除外された鮮度内の行。 省略される場合あり |
| aggregate.perp.bands.1.excluded_incomplete[].exchange | string | — | 取引所ID（小文字）。 省略される場合あり |
| aggregate.perp.bands.1.excluded_incomplete[].symbol | string | — | CoinBossの保存形式での契約シンボル。 省略される場合あり |
| aggregate.perp.bands.1.excluded_incomplete[].reach_bid_pct | number | % | 仲値から、スナップショット内で最も遠い買い板の価格レベルまでの距離。 省略される場合あり |
| aggregate.perp.bands.1.excluded_incomplete[].reach_ask_pct | number | % | 仲値から、スナップショット内で最も遠い売り板の価格レベルまでの距離。 省略される場合あり |
| aggregate.perp.bands.1.lower_bound_bid_usd | number | USD | 不完全な行の観測できた部分を含む買い板の厚み。下限値であり、推定値ではありません。 省略される場合あり |
| aggregate.perp.bands.1.lower_bound_ask_usd | number | USD | 不完全な行の観測できた部分を含む売り板の厚み。下限値であり、推定値ではありません。 省略される場合あり |
| aggregate.perp.bands.1.uses_aggregated_buckets | boolean | — | 算入された行に価格集約済みのバケットを使用したものがある場合はtrue。この場合、合計は下限値になります。 省略される場合あり |
| aggregate.perp.bands.2 | object | — | 仲値からこの距離（%）にある価格帯。 省略される場合あり |
| aggregate.perp.bands.2.bid_depth_usd | number | USD | 仲値から価格帯の下端までにある買い指値注文の想定元本。`complete`がfalseの場合は下限値です。 省略される場合あり |
| aggregate.perp.bands.2.ask_depth_usd | number | USD | 仲値から価格帯の上端までにある売り指値注文の想定元本。`complete`がfalseの場合は下限値です。 省略される場合あり |
| aggregate.perp.bands.2.n_included | number | — | 板の厚みの合計に含まれる行数：鮮度内で、かつその価格帯について完全な行。板の厚みの値と併せて読んでください。 省略される場合あり |
| aggregate.perp.bands.2.n_fresh | number | — | 鮮度内の行数。 省略される場合あり |
| aggregate.perp.bands.2.included_exchanges | array | — | 鮮度内のデータが算入されているソース。 省略される場合あり |
| aggregate.perp.bands.2.included_exchanges[] | string | — | 鮮度内のデータが算入されているソース。 省略される場合あり |
| aggregate.perp.bands.2.excluded_incomplete | array | — | スナップショットが価格帯の端に届かないため、その価格帯から除外された鮮度内の行。 省略される場合あり |
| aggregate.perp.bands.2.excluded_incomplete[] | object | — | スナップショットが価格帯の端に届かないため、その価格帯から除外された鮮度内の行。 省略される場合あり |
| aggregate.perp.bands.2.excluded_incomplete[].exchange | string | — | 取引所ID（小文字）。 省略される場合あり |
| aggregate.perp.bands.2.excluded_incomplete[].symbol | string | — | CoinBossの保存形式での契約シンボル。 省略される場合あり |
| aggregate.perp.bands.2.excluded_incomplete[].reach_bid_pct | number | % | 仲値から、スナップショット内で最も遠い買い板の価格レベルまでの距離。 省略される場合あり |
| aggregate.perp.bands.2.excluded_incomplete[].reach_ask_pct | number | % | 仲値から、スナップショット内で最も遠い売り板の価格レベルまでの距離。 省略される場合あり |
| aggregate.perp.bands.2.lower_bound_bid_usd | number | USD | 不完全な行の観測できた部分を含む買い板の厚み。下限値であり、推定値ではありません。 省略される場合あり |
| aggregate.perp.bands.2.lower_bound_ask_usd | number | USD | 不完全な行の観測できた部分を含む売り板の厚み。下限値であり、推定値ではありません。 省略される場合あり |
| aggregate.perp.bands.2.uses_aggregated_buckets | boolean | — | 算入された行に価格集約済みのバケットを使用したものがある場合はtrue。この場合、合計は下限値になります。 省略される場合あり |
| aggregate.perp.bands.0.5 | object | — | 仲値からこの距離（%）にある価格帯。 省略される場合あり |
| aggregate.perp.bands.0.5.bid_depth_usd | number | USD | 仲値から価格帯の下端までにある買い指値注文の想定元本。`complete`がfalseの場合は下限値です。 省略される場合あり |
| aggregate.perp.bands.0.5.ask_depth_usd | number | USD | 仲値から価格帯の上端までにある売り指値注文の想定元本。`complete`がfalseの場合は下限値です。 省略される場合あり |
| aggregate.perp.bands.0.5.n_included | number | — | 板の厚みの合計に含まれる行数：鮮度内で、かつその価格帯について完全な行。板の厚みの値と併せて読んでください。 省略される場合あり |
| aggregate.perp.bands.0.5.n_fresh | number | — | 鮮度内の行数。 省略される場合あり |
| aggregate.perp.bands.0.5.included_exchanges | array | — | 鮮度内のデータが算入されているソース。 省略される場合あり |
| aggregate.perp.bands.0.5.included_exchanges[] | string | — | 鮮度内のデータが算入されているソース。 省略される場合あり |
| aggregate.perp.bands.0.5.excluded_incomplete | array | — | スナップショットが価格帯の端に届かないため、その価格帯から除外された鮮度内の行。 省略される場合あり |
| aggregate.perp.bands.0.5.excluded_incomplete[] | object | — | スナップショットが価格帯の端に届かないため、その価格帯から除外された鮮度内の行。 省略される場合あり |
| aggregate.perp.bands.0.5.excluded_incomplete[].exchange | string | — | 取引所ID（小文字）。 省略される場合あり |
| aggregate.perp.bands.0.5.excluded_incomplete[].symbol | string | — | CoinBossの保存形式での契約シンボル。 省略される場合あり |
| aggregate.perp.bands.0.5.excluded_incomplete[].reach_bid_pct | number | % | 仲値から、スナップショット内で最も遠い買い板の価格レベルまでの距離。 省略される場合あり |
| aggregate.perp.bands.0.5.excluded_incomplete[].reach_ask_pct | number | % | 仲値から、スナップショット内で最も遠い売り板の価格レベルまでの距離。 省略される場合あり |
| aggregate.perp.bands.0.5.lower_bound_bid_usd | number | USD | 不完全な行の観測できた部分を含む買い板の厚み。下限値であり、推定値ではありません。 省略される場合あり |
| aggregate.perp.bands.0.5.lower_bound_ask_usd | number | USD | 不完全な行の観測できた部分を含む売り板の厚み。下限値であり、推定値ではありません。 省略される場合あり |
| aggregate.perp.bands.0.5.uses_aggregated_buckets | boolean | — | 算入された行に価格集約済みのバケットを使用したものがある場合はtrue。この場合、合計は下限値になります。 省略される場合あり |
| aggregate.spot | object | — | 現物の板の集計値。行がない場合は`null`。 省略される場合あり |
| aggregate.spot.n_rows | number | — | 見つかった行数（鮮度切れの行を含む）。 省略される場合あり |
| aggregate.spot.n_fresh | number | — | 鮮度内の行数。 省略される場合あり |
| aggregate.spot.mid_median | number | USD | 鮮度内の行の仲値の中央値。 省略される場合あり |
| aggregate.spot.spread_bps_min | number | bp | 鮮度内の行のうち最小のスプレッド。 省略される場合あり |
| aggregate.spot.bands | object | — | 価格帯ごとの板の厚み。キーの`0.5`、`1`、`2`は仲値からの距離（%）です。 省略される場合あり |
| aggregate.spot.bands.1 | object | — | 仲値からこの距離（%）にある価格帯。 省略される場合あり |
| aggregate.spot.bands.1.bid_depth_usd | number | USD | 仲値から価格帯の下端までにある買い指値注文の想定元本。`complete`がfalseの場合は下限値です。 省略される場合あり |
| aggregate.spot.bands.1.ask_depth_usd | number | USD | 仲値から価格帯の上端までにある売り指値注文の想定元本。`complete`がfalseの場合は下限値です。 省略される場合あり |
| aggregate.spot.bands.1.n_included | number | — | 板の厚みの合計に含まれる行数：鮮度内で、かつその価格帯について完全な行。板の厚みの値と併せて読んでください。 省略される場合あり |
| aggregate.spot.bands.1.n_fresh | number | — | 鮮度内の行数。 省略される場合あり |
| aggregate.spot.bands.1.included_exchanges | array | — | 鮮度内のデータが算入されているソース。 省略される場合あり |
| aggregate.spot.bands.1.included_exchanges[] | string | — | 鮮度内のデータが算入されているソース。 省略される場合あり |
| aggregate.spot.bands.1.excluded_incomplete | array | — | スナップショットが価格帯の端に届かないため、その価格帯から除外された鮮度内の行。 省略される場合あり |
| aggregate.spot.bands.1.excluded_incomplete[] | object | — | スナップショットが価格帯の端に届かないため、その価格帯から除外された鮮度内の行。 省略される場合あり |
| aggregate.spot.bands.1.excluded_incomplete[].exchange | string | — | 取引所ID（小文字）。 省略される場合あり |
| aggregate.spot.bands.1.excluded_incomplete[].symbol | string | — | CoinBossの保存形式での契約シンボル。 省略される場合あり |
| aggregate.spot.bands.1.excluded_incomplete[].reach_bid_pct | number | % | 仲値から、スナップショット内で最も遠い買い板の価格レベルまでの距離。 省略される場合あり |
| aggregate.spot.bands.1.excluded_incomplete[].reach_ask_pct | number | % | 仲値から、スナップショット内で最も遠い売り板の価格レベルまでの距離。 省略される場合あり |
| aggregate.spot.bands.1.lower_bound_bid_usd | number | USD | 不完全な行の観測できた部分を含む買い板の厚み。下限値であり、推定値ではありません。 省略される場合あり |
| aggregate.spot.bands.1.lower_bound_ask_usd | number | USD | 不完全な行の観測できた部分を含む売り板の厚み。下限値であり、推定値ではありません。 省略される場合あり |
| aggregate.spot.bands.1.uses_aggregated_buckets | boolean | — | 算入された行に価格集約済みのバケットを使用したものがある場合はtrue。この場合、合計は下限値になります。 省略される場合あり |
| aggregate.spot.bands.2 | object | — | 仲値からこの距離（%）にある価格帯。 省略される場合あり |
| aggregate.spot.bands.2.bid_depth_usd | number | USD | 仲値から価格帯の下端までにある買い指値注文の想定元本。`complete`がfalseの場合は下限値です。 省略される場合あり |
| aggregate.spot.bands.2.ask_depth_usd | number | USD | 仲値から価格帯の上端までにある売り指値注文の想定元本。`complete`がfalseの場合は下限値です。 省略される場合あり |
| aggregate.spot.bands.2.n_included | number | — | 板の厚みの合計に含まれる行数：鮮度内で、かつその価格帯について完全な行。板の厚みの値と併せて読んでください。 省略される場合あり |
| aggregate.spot.bands.2.n_fresh | number | — | 鮮度内の行数。 省略される場合あり |
| aggregate.spot.bands.2.included_exchanges | array | — | 鮮度内のデータが算入されているソース。 省略される場合あり |
| aggregate.spot.bands.2.included_exchanges[] | string | — | 鮮度内のデータが算入されているソース。 省略される場合あり |
| aggregate.spot.bands.2.excluded_incomplete | array | — | スナップショットが価格帯の端に届かないため、その価格帯から除外された鮮度内の行。 省略される場合あり |
| aggregate.spot.bands.2.excluded_incomplete[] | object | — | スナップショットが価格帯の端に届かないため、その価格帯から除外された鮮度内の行。 省略される場合あり |
| aggregate.spot.bands.2.excluded_incomplete[].exchange | string | — | 取引所ID（小文字）。 省略される場合あり |
| aggregate.spot.bands.2.excluded_incomplete[].symbol | string | — | CoinBossの保存形式での契約シンボル。 省略される場合あり |
| aggregate.spot.bands.2.excluded_incomplete[].reach_bid_pct | number | % | 仲値から、スナップショット内で最も遠い買い板の価格レベルまでの距離。 省略される場合あり |
| aggregate.spot.bands.2.excluded_incomplete[].reach_ask_pct | number | % | 仲値から、スナップショット内で最も遠い売り板の価格レベルまでの距離。 省略される場合あり |
| aggregate.spot.bands.2.lower_bound_bid_usd | number | USD | 不完全な行の観測できた部分を含む買い板の厚み。下限値であり、推定値ではありません。 省略される場合あり |
| aggregate.spot.bands.2.lower_bound_ask_usd | number | USD | 不完全な行の観測できた部分を含む売り板の厚み。下限値であり、推定値ではありません。 省略される場合あり |
| aggregate.spot.bands.2.uses_aggregated_buckets | boolean | — | 算入された行に価格集約済みのバケットを使用したものがある場合はtrue。この場合、合計は下限値になります。 省略される場合あり |
| aggregate.spot.bands.0.5 | object | — | 仲値からこの距離（%）にある価格帯。 省略される場合あり |
| aggregate.spot.bands.0.5.bid_depth_usd | number | USD | 仲値から価格帯の下端までにある買い指値注文の想定元本。`complete`がfalseの場合は下限値です。 省略される場合あり |
| aggregate.spot.bands.0.5.ask_depth_usd | number | USD | 仲値から価格帯の上端までにある売り指値注文の想定元本。`complete`がfalseの場合は下限値です。 省略される場合あり |
| aggregate.spot.bands.0.5.n_included | number | — | 板の厚みの合計に含まれる行数：鮮度内で、かつその価格帯について完全な行。板の厚みの値と併せて読んでください。 省略される場合あり |
| aggregate.spot.bands.0.5.n_fresh | number | — | 鮮度内の行数。 省略される場合あり |
| aggregate.spot.bands.0.5.included_exchanges | array | — | 鮮度内のデータが算入されているソース。 省略される場合あり |
| aggregate.spot.bands.0.5.included_exchanges[] | string | — | 鮮度内のデータが算入されているソース。 省略される場合あり |
| aggregate.spot.bands.0.5.excluded_incomplete | array | — | スナップショットが価格帯の端に届かないため、その価格帯から除外された鮮度内の行。 省略される場合あり |
| aggregate.spot.bands.0.5.excluded_incomplete[] | object | — | スナップショットが価格帯の端に届かないため、その価格帯から除外された鮮度内の行。 省略される場合あり |
| aggregate.spot.bands.0.5.excluded_incomplete[].exchange | string | — | 取引所ID（小文字）。 省略される場合あり |
| aggregate.spot.bands.0.5.excluded_incomplete[].symbol | string | — | CoinBossの保存形式での契約シンボル。 省略される場合あり |
| aggregate.spot.bands.0.5.excluded_incomplete[].reach_bid_pct | number | % | 仲値から、スナップショット内で最も遠い買い板の価格レベルまでの距離。 省略される場合あり |
| aggregate.spot.bands.0.5.excluded_incomplete[].reach_ask_pct | number | % | 仲値から、スナップショット内で最も遠い売り板の価格レベルまでの距離。 省略される場合あり |
| aggregate.spot.bands.0.5.lower_bound_bid_usd | number | USD | 不完全な行の観測できた部分を含む買い板の厚み。下限値であり、推定値ではありません。 省略される場合あり |
| aggregate.spot.bands.0.5.lower_bound_ask_usd | number | USD | 不完全な行の観測できた部分を含む売り板の厚み。下限値であり、推定値ではありません。 省略される場合あり |
| aggregate.spot.bands.0.5.uses_aggregated_buckets | boolean | — | 算入された行に価格集約済みのバケットを使用したものがある場合はtrue。この場合、合計は下限値になります。 省略される場合あり |
| coverage | object | — | 数値に含まれるものと含まれないもの。他のソースと合計値を比較する前に、まずこの内容を比較してください。 |
| coverage.included_exchanges | array | — | 鮮度内のデータが算入されているソース。 |
| coverage.included_exchanges[] | string | — | 鮮度内のデータが算入されているソース。 |
| coverage.unavailable | array | — | 算入できなかったソース。それぞれ理由が付きます。0としてカウントされることはありません。 この表の生成に使用したサンプルでは空 |
| coverage.stale_excluded | array | — | 最終更新が鮮度ウィンドウの外にあるため除外された行。 この表の生成に使用したサンプルでは空 |
| coverage.no_market | array | — | 収集対象だが、この銘柄の行がない取引所 × 市場の組み合わせ。 この表の生成に使用したサンプルでは空 |
| method | object | — | このレスポンスで使用した計算式を平文で記述したもの。フィールドごとに1エントリー。 |
| method.mid | string | — | `mid`の計算式に関する注記（平文）。 |
| method.spread_bps | string | — | `spread_bps`の計算式に関する注記（平文）。 |
| method.bid_depth_usd | string | — | `bid_depth_usd`の計算式に関する注記（平文）。 |
| method.ask_depth_usd | string | — | `ask_depth_usd`の計算式に関する注記（平文）。 |
| method.complete | string | — | `complete`の計算式に関する注記（平文）。 |
| method.reach_pct | string | — | `reach_pct`の計算式に関する注記（平文）。 |
| method.slippage_bps | string | — | `slippage_bps`の計算式に関する注記（平文）。 |
| method.agg_step_bps | string | — | `agg_step_bps`の計算式に関する注記（平文）。 |
| method.aggregate | string | — | `aggregate`の計算式に関する注記（平文）。 |
| method.fresh | string | — | `fresh`の計算式に関する注記（平文）。 |
| method.lag_ms | string | — | `lag_ms`の計算式に関する注記（平文）。 |
| method.no_market | string | — | `no_market`の計算式に関する注記（平文）。 |
| 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 | number | ms | ソースがデータに付与したタイムスタンプ。 |
| 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:28 UTCに4件の実レスポンスから生成。
レスポンス例
/api/sd/liquidity?coin=BTC · 実際のレスポンス（2026-11-13 04:02:45 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は13件。
- "success"true
- "schema""coinboss.sd.liquidity/1"
- "now"1794542565757
- "coin""BTC"
- "market""all"
- "venues"
- "aggregate"
- "perp"
- "spot"
- "coverage"
- "included_exchanges"
- "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"
- "observed_at"1794542554621
- "received_at"1794542554947
- "fetched_at"1794542565757
- "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"3
検証済みサンプル
上の例に加えて、プローブは以下のパラメータでもこのエンドポイントを呼び出し、毎回スキーマを検証しています。
| パラメータ | HTTP | レイテンシ | 結果 |
|---|---|---|---|
| coin=ETH&market=spot | 200 | 3 ms | 合格 PARTIAL |
| coin=PEPE&market=perp | 200 | 4 ms | 合格 FRESH |
| coin=SOL | 200 | 4 ms | 合格 PARTIAL |
| — | 400 | 1 ms | 合格 想定どおりのエラーを返す |
2026-11-13 03:58:06 UTCにチェック
詳細
- 認証
- 不要。公開エンドポイントです。
- レート制限
- IPごとに毎分1200リクエスト
- サーバーキャッシュ
- 15s
- エッジマイクロキャッシュ
- 10s
- 更新頻度
- スナップショットは、取引が特に活発な銘柄で120秒ごと、それ以外は600秒ごとに取得します（一部の取引所は300 / 1200秒）。行は収集周期3回分、最低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行。
- ソート
- 無期限先物の行が先、次に現物。それぞれの中では±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 04:02:45 UTCにチェックHTTP 2006 msスキーマ一致最新データポイントは11s前
エンドポイントが報告するデータ品質はPARTIALです — 流動性が特に高い銘柄では、複数の大手取引所の公開スナップショットが価格帯の全体に届かないため、それらの取引所は集計値から除外され、集計値は板の厚みの合計を過小に表します。`lower_bound_*`フィールドは、観測できた部分を加えた値です。板の厚みの値は、必ず`n_included`と併せて読んでください。
可用性（過去30日間）
408回のチェック中100%が合格
エラー
失敗した呼び出しは、すべてのエンドポイントで共通の形式で返されます。一覧はエラーページにあります。 エラーとレート制限 →
| コード | HTTP | 意味 | 対処方法 |
|---|---|---|---|
| INVALID_PARAM | 400 | 必須パラメータが不足しているか、値が受け付けられません。該当するパラメータが特定できる場合は、`param`にその名前が入ります。 | そのまま再試行せず、リクエストを修正してください。 |
| UNAUTHORIZED | 401 | `CB-API-KEY`ヘッダーが送信されましたが、キーが不明か失効済みです。公開データにキーは不要です。ヘッダーを外すか、有効なキーを使用してください。 | そのまま再試行しないでください。 |
| FORBIDDEN | 403 | このルートは公開APIに含まれません（内部用またはアカウント専用）。 | 再試行しないでください。 |
| NOT_FOUND | 404 | 不明なルートであるか、リクエストされた銘柄 / 取引所 / ファンドが存在しません。 | 再試行せず、パスと識別子をカタログと照合してください。 |
| RATE_LIMITED | 429 | リクエスト数が1分あたりの上限を超えました。`Retry-After`に待機すべき秒数が示されます。 | `Retry-After`で示された時間だけ待ってから、バックオフ付きで再試行してください。 |
| INTERNAL | 500 | 予期しないサーバーエラーです。メッセージは意図的に汎用的な内容にしています。報告の際は`request_id`を引用してください。 | 数秒後に1回だけ再試行してください。解消しない場合は、リクエストIDを添えて報告してください。 |
| UPSTREAM_FAILED | 503 | このエンドポイントの背後にあるデータソースが時間内に応答しませんでした。鮮度切れの数値や代替の数値を代わりに返すことはありません。 | バックオフ付きで再試行し、ステータスページを確認してください。 |
| UNAVAILABLE | 501 / 503 | データセットが一時的に準備できていない（キャッシュのウォームアップ中）か、このエンドポイントに適法な公開ソースがまだありません。 | 時間をおいて再試行してください。仕様上利用できないエンドポイントは、カタログに明示されています。 |
| REQUEST_FAILED | 200 | 一部の古いエンドポイントは、HTTP 200で`success: false`を返します。HTTPステータスだけでなく、必ず`success`を確認してください。 | メッセージによって異なります。失敗したリクエストとして扱ってください。 |
試してみる
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.
リクエストURL
https://www.coinboss.com/api/sd/liquidity?coin=BTCエンドポイントを選択して「リクエストを送信」を押してください。レスポンス、ヘッダー、所要時間がここに表示されます。
このカテゴリの他のエンドポイント
- 板の厚みとスリッページ /api/sd/liquidity
- 板の厚みの履歴 /api/sd/liquidity/history
- 板の厚みによる銘柄ランキング /api/sd/liquidity/rank
- 大口指値注文モニター /api/indicators/large-orderbook