板の厚みによる銘柄ランキング
1つの価格帯における板の厚みの集計値(買い+売り)で銘柄を順位付けします。含まれる契約数と最小スプレッドも返します。
/api/sd/liquidity/rankリクエスト
クエリパラメータ
| 名前 | 型 | 必須 | デフォルト | 指定可能な値 | 説明 |
|---|---|---|---|---|---|
| market | string | 任意 | perp | perp, spot | 市場タイプ。無期限先物と現物の板を合算することはありません。 |
| band | string | 任意 | 1 | 0.5, 1, 2 | 仲値からの距離(%)。 |
| limit | integer | 任意 | 50 | ≥ 1 · ≤ 200 | 行数。 |
リクエスト例
curl -s "https://www.coinboss.com/api/sd/liquidity/rank"レスポンスフィールド
フィールド表は実際のレスポンスから生成しているため、エンドポイントが返す内容をそのまま反映しています。パスでは、配列の要素をa[]、銘柄や取引所などの動的な名前をキーとするオブジェクトを{*}で表します。
| フィールド | 型 | 単位 | 説明 |
|---|---|---|---|
| success | boolean | — | リクエストが成功した場合はtrue。失敗した場合、ボディは`{ success: false, code, error, request_id }`になります。 |
| schema | string | — | このレスポンスのスキーマID。既存フィールドの意味または型が変わった場合にのみ変更されます。 |
| now | number | ms | レスポンスを生成した時点のサーバー時刻。 |
| market | string | — | `perp`または`spot`。 |
| band_pct | number | % | 選択された価格帯:仲値からの距離。 |
| limit | number | — | 適用された行数の上限。 |
| total_coins | number | — | 板の行が1つ以上ある銘柄。 |
| rows | array | — | 銘柄ごとに1行。 |
| rows[] | object | — | 銘柄ごとに1行。 |
| rows[].coin | string | — | 銘柄シンボル(大文字)。 |
| rows[].bid_depth_usd | number | USD | 仲値から価格帯の下端までにある買い指値注文の想定元本。`complete`がfalseの場合は下限値です。 |
| rows[].ask_depth_usd | number | USD | 仲値から価格帯の上端までにある売り指値注文の想定元本。`complete`がfalseの場合は下限値です。 |
| rows[].total_depth_usd | number | USD | 価格帯の買い板の厚み + 売り板の厚み。ランキングのキーとしてのみ使用します。 |
| rows[].n_included | number | — | 板の厚みの合計に含まれる行数:鮮度内で、かつその価格帯について完全な行。板の厚みの値と併せて読んでください。 |
| rows[].n_fresh | number | — | 鮮度内の行数。 |
| rows[].n_rows | number | — | 見つかった行数(鮮度切れの行を含む)。 |
| rows[].mid_median | number | USD | 鮮度内の行の仲値の中央値。 |
| rows[].spread_bps_min | number | bp | 鮮度内の行のうち最小のスプレッド。 |
| rows[].included_exchanges | array | — | 鮮度内のデータが算入されているソース。 |
| rows[].included_exchanges[] | string | — | 鮮度内のデータが算入されているソース。 |
| rows[].uses_aggregated_buckets | boolean | — | 算入された行に価格集約済みのバケットを使用したものがある場合はtrue。この場合、合計は下限値になります。 |
| rows[].rank | number | — | ランキング内の順位。順位付けできる値が行にない場合は`null`。 |
| coverage | object | — | 数値に含まれるものと含まれないもの。他のソースと合計値を比較する前に、まずこの内容を比較してください。 |
| coverage.included_exchanges | array | — | 鮮度内のデータが算入されているソース。 |
| coverage.included_exchanges[] | string | — | 鮮度内のデータが算入されているソース。 |
| coverage.unavailable | array | — | 算入できなかったソース。それぞれ理由が付きます。0としてカウントされることはありません。 この表の生成に使用したサンプルでは空 |
| coverage.stale_excluded | array | — | 最終更新が鮮度ウィンドウの外にあるため除外された行。 |
| coverage.stale_excluded[] | object | — | 最終更新が鮮度ウィンドウの外にあるため除外された行。 |
| coverage.stale_excluded[].exchange | string | — | 取引所ID(小文字)。 |
| coverage.stale_excluded[].age_s | number | s | 行を受信してからの経過秒数。 |
| coverage.n_fresh_rows | number | — | 全銘柄における鮮度内の行。 |
| coverage.n_stale_rows | number | — | 全銘柄における鮮度切れの行。 |
| coverage.n_incomplete_rows | number | — | スナップショットが価格帯の端に届かない鮮度内の行。 |
| method | object | — | このレスポンスで使用した計算式を平文で記述したもの。フィールドごとに1エントリー。 |
| method.bid_depth_usd | string | — | `bid_depth_usd`の計算式に関する注記(平文)。 |
| method.ask_depth_usd | string | — | `ask_depth_usd`の計算式に関する注記(平文)。 |
| method.complete | string | — | `complete`の計算式に関する注記(平文)。 |
| method.aggregate | string | — | `aggregate`の計算式に関する注記(平文)。 |
| method.fresh | string | — | `fresh`の計算式に関する注記(平文)。 |
| method.rank | string | — | `rank`の計算式に関する注記(平文)。 |
| 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:00 UTCに3件の実レスポンスから生成。
レスポンス例
/api/sd/liquidity/rank · 実際のレスポンス(2026-11-13 04:02:46 UTCに取得)。 長い配列とマップは表示用に短縮しています:rowsは50件; meta.sourceは23件; coverage.stale_excludedは23件; rows[].included_exchangesは19件; coverage.included_exchangesは23件。
- "success"true
- "schema""coinboss.sd.liquidity/1"
- "now"1794542566023
- "market""perp"
- "band_pct"1
- "limit"50
- "total_coins"89
- "rows"
- "coverage"
- "included_exchanges"
- "unavailable"
- "stale_excluded"
- "n_fresh_rows"1481
- "n_stale_rows"82
- "n_incomplete_rows"8
- "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…"
- "aggregate""per market and band: sum over rows that are fresh AND complete for that band; n_included / n_fresh is the denominator; lower_bound_* additionally adds the incom…"
- "fresh""a row is fresh when now - received_at <= max(3 * period_s, 300s); stale rows are listed in coverage.stale_excluded; rows older than 24h are dropped"
- "rank""coins ordered by bid_depth_usd + ask_depth_usd of the chosen market and band, aggregated as in aggregate; coins with no fresh complete row carry nulls and sort …"
- "meta"
- "schema""coinboss.sd.liquidity/1"
- "source"
- "observed_at"1794542565862
- "received_at"1794542565977
- "fetched_at"1794542566023
- "window""latest"
- "quality""PARTIAL"
- "is_stale"false
- "cache_ttl_s"30
- "fallback""stale rows (older than max(3 * period_s, 300s)) are left out; coins whose rows are all stale or incomplete keep their place in the list with null depth"
- "collector_heartbeat_age_s"4
検証済みサンプル
上の例に加えて、プローブは以下のパラメータでもこのエンドポイントを呼び出し、毎回スキーマを検証しています。
| パラメータ | HTTP | レイテンシ | 結果 |
|---|---|---|---|
| market=spot | 200 | 5 ms | 合格 PARTIAL |
| band=0.5&limit=10 | 200 | 7 ms | 合格 PARTIAL |
| limit=0 | 400 | 2 ms | 合格 想定どおりのエラーを返す |
2026-11-13 03:58:06 UTCにチェック
詳細
- 認証
- 不要。公開エンドポイントです。
- レート制限
- IPごとに毎分1200リクエスト
- サーバーキャッシュ
- 30s
- エッジマイクロキャッシュ
- 10s
- 更新頻度
- `/api/sd/liquidity`と同じ収集周期。
- ウィンドウ
- 契約ごとの最新スナップショット。
- データソース
- 24取引所(無期限先物市場および現物市場)の公開RESTの板スナップショットを、CoinBossが収集・保存しています(sd_book_latest、sd_book_hist)。板の厚みとスリッページは、CoinBossが生の価格レベルから算出しています。
- 取引所カバレッジ
- 24取引所、取引所 × 市場の組み合わせは38系統。公開スナップショットが仲値から±0.5 / 1 / 2 %に届かない場合(取引所の板段数の上限による)、その価格帯には`complete: false`のフラグが付き、値は下限値となり、集計値から除外されます。`n_included` / `n_fresh`は分母を示し、`excluded_incomplete`には除外されたものが記載されます。
- ページネーション
- ページングはありません。行数は`limit`で制限されます(最大200)。
- ソート
- `total_depth_usd`の降順。完全かつ鮮度内の行が1つもない銘柄は、`rank: null`として末尾に並びます。
- 単位
- 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
ライブステータス
エンドポイントが報告するデータ品質はPARTIALです
可用性(過去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`を確認してください。 | メッセージによって異なります。失敗したリクエストとして扱ってください。 |
試してみる
/api/sd/liquidity/rank一部string · デフォルト perp — Market type. Perpetual and spot books are never added together.
string · デフォルト 1 — Distance from mid price in percent.
integer · デフォルト 50 · 最小 1 · 最大 200 — Number of rows.
https://www.coinboss.com/api/sd/liquidity/rankこのカテゴリの他のエンドポイント
- 板の厚みとスリッページ /api/sd/liquidity
- 板の厚みの履歴 /api/sd/liquidity/history
- 板の厚みによる銘柄ランキング /api/sd/liquidity/rank
- 大口指値注文モニター /api/indicators/large-orderbook