GET利用可能
1銘柄の建玉サマリー
1銘柄の建玉サマリー(取引所別のOIと変化)
GET
/api/oi/summaryリクエスト
クエリパラメータ
| 名前 | 型 | 必須 | デフォルト | 指定可能な値 | 説明 |
|---|---|---|---|---|---|
| coin | string | 任意 | BTC | — | ベース銘柄のシンボル(大文字。例:BTC)。 例: BTC |
リクエスト例
curl -s "https://www.coinboss.com/api/oi/summary?coin=BTC"レスポンスフィールド
フィールド表は実際のレスポンスから生成しているため、エンドポイントが返す内容をそのまま反映しています。パスでは、配列の要素をa[]、銘柄や取引所などの動的な名前をキーとするオブジェクトを{*}で表します。
| フィールド | 型 | 単位 | 説明 |
|---|---|---|---|
| success | boolean | — | リクエストが成功した場合はtrue。失敗した場合、ボディは`{ success: false, code, error, request_id }`になります。 |
| coin | string | — | 銘柄シンボル(大文字。例:BTC)。 |
| price | number | — | 建値通貨での直近価格(特記がない限りUSDまたはUSDT)。 |
| total_usd | number | USD | 合計。 |
| total_change_24h_pct | number | % | 建玉合計の24h変化:現在と、24時間前に最も近い1時間ごとのスナップショットの両方に存在する取引所を対象に、(Σ 現在 − Σ 前回) ÷ Σ 前回で算出します。 |
| total_change_24h_basis | object | — | `total_change_24h_pct`の入力値:一致した取引所、基準時刻、基準値が動いていないため除外された契約、ルール名。変化を算出できない場合はnull。 |
| total_change_24h_basis.n_matched | number | — | 比較の両端に存在する項目。 |
| total_change_24h_basis.prev_hour_ts | number | ms | 直前の1時間バケットの開始時刻。 |
| total_change_24h_basis.frozen_excluded | object | — | ソースの値が動かなかったために除外された行。 |
| total_change_24h_basis.frozen_excluded.n_baseline | number | — | 基準スナップショット内の項目。 |
| total_change_24h_basis.frozen_excluded.n_current | number | — | 現在のスナップショット内の項目。 |
| total_change_24h_basis.frozen_excluded.cur_usd | number | USD | 現在値。 |
| total_change_24h_basis.frozen_excluded.prev_usd | number | USD | 基準値。 |
| total_change_24h_basis.rule | string | — | 比較ルールの名前。常に`same_exchange_pairing_nearest_hour_excl_frozen_baseline`です。 |
| exchange_count | number | — | 取引所数。 |
| data | array | — | ペイロード。 |
| data[] | object | — | ペイロード。 |
| data[].exchange | string | — | 取引所ID(小文字。例:`binance`)。 |
| data[].oi_usd | number | USD | USD建て想定元本での建玉。 |
| data[].share_pct | number | % | 合計に占める割合。 |
| data[].change_24h_pct | number|null | % | 24hの変化率(%)。 |
| data[].change_4h_pct | number|null | % | 取引所の建玉の、4時間前に最も近い1時間ごとのスナップショットに対する変化。CMEは日次で公表するため、常にnullです。 |
| data[].is_daily | boolean | — | CMEの行にのみ存在し、値はtrueです。CMEの建玉は取引日ごとに1回公表されます。その他の行にはありません。 省略される場合あり |
2026-11-11 23:00 UTCに4件の実レスポンスから生成。
レスポンス例
/api/oi/summary?coin=BTC · 実際のレスポンス(2026-11-13 03:57:41 UTCに取得)。 長い配列とマップは表示用に短縮しています:dataは22件。
- "success"true
- "coin""BTC"
- "price"68907.3
- "total_usd"49032953661.26
- "total_change_24h_pct"-3.57
- "total_change_24h_basis"
- "n_matched"22
- "prev_hour_ts"1794456000000
- "frozen_excluded"
- "rule""same_exchange_pairing_nearest_hour_excl_frozen_baseline"
- "exchange_count"22
- "data"
検証済みサンプル
上の例に加えて、プローブは以下のパラメータでもこのエンドポイントを呼び出し、毎回スキーマを検証しています。
| パラメータ | HTTP | レイテンシ | 結果 |
|---|---|---|---|
| coin=ETH | 200 | 36 ms | 合格 |
| coin=SOL | 200 | 22 ms | 合格 |
| coin=ARKM | 200 | 22 ms | 合格 |
2026-11-13 03:57:41 UTCにチェック
詳細
- 認証
- 不要。公開エンドポイントです。
- レート制限
- IPごとに毎分1200リクエスト
- サーバーキャッシュ
- 60s
- エッジマイクロキャッシュ
- 10s
- 更新頻度
- ほとんどの取引所は60 sごと(ティッカーと同時に書き込み。binanceの上位50銘柄とokxは専用の60 sジョブ)。binance / bingx / aster / gate / htxの全件スイープは5 minごと。コイン証拠金型/USDC建て/限月契約は120 sごと(5 minごとに共有テーブルへ反映)。cmeは取引日ごとに1回(04:10 UTC)
- ウィンドウ
- 最新スナップショット。変化は、現在 - 24 hおよび現在 - 4 hに最も近い1時間バケット(+/- 1 h以内)との比較
- データソース
- 自社のコレクターが22のデリバティブ取引所(binance、okx、bybit、gate、bitget、hyperliquidなど)の公開REST APIからポーリングした建玉と、CMEの公式な日次出来高/建玉レポートです。
- 取引所カバレッジ
- 鮮度内の行がある23ソース(22取引所 + cme)。すべての契約種別(USDT / USDC / USD建てのリニア、コイン証拠金型のインバース、無期限および限月)。bybitとgateは、取引所の開示どおり両側の建玉を報告します。3 h(cme:120 h)より古い行は除外されます
- ソート
- 固定の取引所順(binance、cme、okx、bybit、bitget、gate、htx、...)、その後はアルファベット順
- 単位
- oi_usd in USD notional; share_pct / change_*_pct in percent; price in USD
- 算出方法
- per exchange: oi_usd = SUM over fresh contracts of the coin; share_pct = oi_usd / total x 100; change = (cur - prev) / prev x 100 with same-contract pairing (frozen baselines excluded); total_change_24h_pct = same-exchange paired change across all exchanges; cme compared with its previous published value and has no 4 h change
- タイムスタンプ
- フィールドの説明に別途記載がない限り、Unixエポックミリ秒(UTC)
- レスポンス形式
- json
- 安定性
- 安定版
ライブステータス
利用可能2026-11-13 03:57:41 UTCにチェックHTTP 20034 msスキーマ一致
可用性(過去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/oi/summary利用可能パラメータ
string · デフォルト BTC — Base coin symbol (uppercase, e.g. BTC).
リクエストURL
https://www.coinboss.com/api/oi/summary?coin=BTCエンドポイントを選択して「リクエストを送信」を押してください。レスポンス、ヘッダー、所要時間がここに表示されます。
このカテゴリの他のエンドポイント
- 1銘柄の建玉 /api/sd/oi
- 取引所横断の銘柄別建玉ランキング /api/market/open-interest
- 1銘柄のOI積み上げチャート系列 /api/oi/chart
- 1銘柄の集計建玉履歴 /api/oi/history
- 建玉マトリックス /api/oi/matrix
- 1銘柄の建玉サマリー /api/oi/summary