GET利用可能
清算ヒートマップ(モデル1)
清算ヒートマップ(価格 × 時間における推定清算強度)
GET
/api/heatmapリクエスト
クエリパラメータ
| 名前 | 型 | 必須 | デフォルト | 指定可能な値 | 説明 |
|---|---|---|---|---|---|
| symbol | string | 任意 | BTC | — | 銘柄シンボル。 例: BTC |
| range | string | 任意 | 24h | 12h, 24h, 3d, 7d, 1M | 時間ウィンドウ。 例: 24h |
リクエスト例
curl -s "https://www.coinboss.com/api/heatmap?symbol=BTC&range=24h"レスポンスフィールド
フィールド表は実際のレスポンスから生成しているため、エンドポイントが返す内容をそのまま反映しています。パスでは、配列の要素をa[]、銘柄や取引所などの動的な名前をキーとするオブジェクトを{*}で表します。
| フィールド | 型 | 単位 | 説明 |
|---|---|---|---|
| symbol | string | — | CoinBossが正規化した銘柄シンボル(例:BTCUSDT)。 |
| range | string | — | リクエストされたウィンドウ。 |
| updatedAt | number | ms | データが最後に更新された時刻。 |
| currentPrice | number | — | 現在価格。 |
| prices | array | — | 価格系列。 |
| prices[] | number | — | 価格系列。 |
| times | array | — | 系列のタイムスタンプ。 |
| times[] | number | — | 系列のタイムスタンプ。 |
| grid | array | — | グリッドの値。 |
| grid[] | array | — | グリッドの値。 |
| grid[][] | number | — | グリッドの値。 |
| maxNotional | number | USD | グリッド全体で最も密度の高いセルのモデル上の清算想定元本。つまり、`grid`の値250が表す金額です。モデル推定値であり、取引所のデータではありません。 |
| clusters | array | — | 価格クラスター。 |
| clusters[] | object | — | 価格クラスター。 |
| clusters[].price | number | — | 建値通貨での直近価格(特記がない限りUSDまたはUSDT)。 |
| clusters[].strength | number | ratio | クラスターのモデル上の想定元本 ÷ `maxNotional`。0.15〜1の範囲です。クラスターは、最新の列における最も強い局所ピーク(最大8個)です。 |
| clusters[].usd | number | USD | 値。 |
2026-11-11 23:00 UTCに3件の実レスポンスから生成。
レスポンス例
/api/heatmap?symbol=BTC&range=24h · 実際のレスポンス(2026-11-13 03:58:04 UTCに取得)。 長い配列とマップは表示用に短縮しています:gridは24件; timesは24件; grid[]は250件; pricesは250件; clustersは8件。
- "symbol""BTC"
- "range""24h"
- "updatedAt"1794542175369
- "currentPrice"68700.4
- "prices"
- 65834.75
- 65878.66
- 65922.57
- 65966.48
- 66010.39
- 66054.3
- 66098.2
- 66142.11
- "times"
- 1794456000000
- 1794459600000
- 1794463200000
- 1794466800000
- 1794470400000
- 1794474000000
- 1794477600000
- 1794481200000
- "grid"
- "maxNotional"287990887
- "clusters"
検証済みサンプル
上の例に加えて、プローブは以下のパラメータでもこのエンドポイントを呼び出し、毎回スキーマを検証しています。
| パラメータ | HTTP | レイテンシ | 結果 |
|---|---|---|---|
| range=24h&symbol=ETH | 200 | 3 ms | 合格 |
| range=24h&symbol=SOL | 200 | 2 ms | 合格 |
2026-11-13 03:58:04 UTCにチェック
詳細
- 認証
- 不要。公開エンドポイントです。
- レート制限
- IPごとに毎分1200リクエスト
- サーバーキャッシュ
- 60s
- エッジマイクロキャッシュ
- 10s
- 更新頻度
- 5 minごと
- ウィンドウ
- rangeパラメータ:12h | 24h | 3d | 7d | 1M(デフォルト24h)。最新のモデルスナップショット
- データソース
- CoinBoss自社の先物1時間足(binance、フォールバックはokx)と集計建玉の履歴から自社で算出したモデル推定値です。
- 取引所カバレッジ
- BTC、ETH、SOLと、24 h先物想定元本(1時間足の出来高 × 終値)の上位30銘柄。モデルの出力であり、取引所の報告データではありません
- 単位
- estimated liquidation notional in USD per time x price cell; timestamps in Unix ms
- 算出方法
- each 1 h candle opens notional = volume x close (optionally boosted by OI delta) spread over leverage tiers 5/10/25/50/100 (weights 0.30/0.30/0.20/0.12/0.08); long liq level ~ P x (1 - 1/L + 0.004), short ~ P x (1 + 1/L - 0.004); 250 price bins with 3-bin kernel; swept bins are zeroed; hourly decay 0.999
- タイムスタンプ
- フィールドの説明に別途記載がない限り、Unixエポックミリ秒(UTC)
- レスポンス形式
- json
- 安定性
- 安定版
ライブステータス
利用可能2026-11-13 03:58:04 UTCにチェックHTTP 2001 msスキーマ一致最新データポイントは2m前
可用性(過去30日間)
410回のチェック中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/heatmap利用可能パラメータ
string · デフォルト BTC — Coin symbol.
string · デフォルト 24h — Time window.
リクエストURL
https://www.coinboss.com/api/heatmap?symbol=BTC&range=24hエンドポイントを選択して「リクエストを送信」を押してください。レスポンス、ヘッダー、所要時間がここに表示されます。
このカテゴリの他のエンドポイント
- 清算ヒートマップ(モデル1) /api/heatmap
- 清算ヒートマップの対応シンボル /api/heatmap/symbols
- 清算ヒートマップ(モデル2 / 3) /api/liq-heatmap
- 清算ヒートマップモデルの対応シンボル /api/liq-heatmap/symbols
- 清算クラスター水準 /api/liq-levels
- 清算マップ /api/liq-map
- 清算マップの対応シンボル /api/liq-map/symbols
- 清算マックスペイン水準 /api/liq-maxpain