GET利用可能
1銘柄の集計建玉履歴
1銘柄の集計建玉履歴
GET
/api/oi/historyリクエスト
クエリパラメータ
| 名前 | 型 | 必須 | デフォルト | 指定可能な値 | 説明 |
|---|---|---|---|---|---|
| base | string | 必須 | — | — | ベース銘柄のシンボル(大文字。例:BTC)。 例: BTC |
| hours | integer | 任意 | 168 | ≥ 1 · ≤ 2160 | 遡及期間(時間)。 例: 168 |
リクエスト例
curl -s "https://www.coinboss.com/api/oi/history?base=BTC&hours=168"レスポンスフィールド
フィールド表は実際のレスポンスから生成しているため、エンドポイントが返す内容をそのまま反映しています。パスでは、配列の要素をa[]、銘柄や取引所などの動的な名前をキーとするオブジェクトを{*}で表します。
| フィールド | 型 | 単位 | 説明 |
|---|---|---|---|
| success | boolean | — | リクエストが成功した場合はtrue。失敗した場合、ボディは`{ success: false, code, error, request_id }`になります。 |
| base | string | — | ベース資産のシンボル。 |
| hours | number | — | 1時間ごとの値、または時間数。 |
| exchanges | array | — | 取引所。 |
| exchanges[] | string | — | 取引所。 |
| count | number | — | 項目数。 |
| data | array | — | ペイロード。 |
| data[] | object | — | ペイロード。 |
| data[].hour_ts | number | ms | 1時間バケットの開始時刻。 |
| data[].total_usd | number | USD | 合計。 |
| data[].byExchange | object | — | その1時間ごとのスナップショットにおける取引所別の建玉。キーは取引所ID、値はその取引所における銘柄の契約を合計したUSD建ての値です。 |
| data[].byExchange.bitfinex | number | — | 取引所`bitfinex`の値(キーは取引所ID)。 省略される場合あり |
| data[].byExchange.edgex | number | — | 取引所`edgex`の値(キーは取引所ID)。 省略される場合あり |
| data[].byExchange.aster | number | — | 取引所`aster`の値(キーは取引所ID)。 |
| data[].byExchange.bingx | number | — | 取引所`bingx`の値(キーは取引所ID)。 省略される場合あり |
| data[].byExchange.kucoin | number | — | 取引所`kucoin`の値(キーは取引所ID)。 |
| data[].byExchange.deribit | number | — | 取引所`deribit`の値(キーは取引所ID)。 省略される場合あり |
| data[].byExchange.okx | number | — | 取引所`okx`の値(キーは取引所ID)。 |
| data[].byExchange.dydx | number | — | 取引所`dydx`の値(キーは取引所ID)。 省略される場合あり |
| data[].byExchange.hyperliquid | number | — | 取引所`hyperliquid`の値(キーは取引所ID)。 省略される場合あり |
| data[].byExchange.backpack | number | — | 取引所`backpack`の値(キーは取引所ID)。 省略される場合あり |
| data[].byExchange.bitget | number | — | 取引所`bitget`の値(キーは取引所ID)。 |
| data[].byExchange.htx | number | — | 取引所`htx`の値(キーは取引所ID)。 省略される場合あり |
| data[].byExchange.lighter | number | — | 取引所`lighter`の値(キーは取引所ID)。 省略される場合あり |
| data[].byExchange.bybit | number | — | 取引所`bybit`の値(キーは取引所ID)。 |
| data[].byExchange.binance | number | — | 取引所`binance`の値(キーは取引所ID)。 |
| data[].byExchange.gate | number | — | 取引所`gate`の値(キーは取引所ID)。 |
| data[].byExchange.mexc | number | — | 取引所`mexc`の値(キーは取引所ID)。 |
| data[].byExchange.cryptocom | number | — | 取引所`cryptocom`の値(キーは取引所ID)。 |
| data[].byExchange.kraken | number | — | 取引所`kraken`の値(キーは取引所ID)。 省略される場合あり |
| data[].byExchange.paradex | number | — | 取引所`paradex`の値(キーは取引所ID)。 省略される場合あり |
| data[].byExchange.whitebit | number | — | 取引所`whitebit`の値(キーは取引所ID)。 |
| data[].byExchange.cme | number | — | 取引所`cme`の値(キーは取引所ID)。 省略される場合あり |
2026-11-11 23:00 UTCに4件の実レスポンスから生成。
レスポンス例
/api/oi/history?base=BTC&hours=168 · 実際のレスポンス(2026-11-13 04:02:34 UTCに取得)。 長い配列とマップは表示用に短縮しています:dataは168件; exchangesは22件。
- "success"true
- "base""BTC"
- "hours"168
- "exchanges"
- "aster"
- "backpack"
- "binance"
- "bingx"
- "bitfinex"
- "bitget"
- "bybit"
- "cme"
- "count"168
- "data"
検証済みサンプル
上の例に加えて、プローブは以下のパラメータでもこのエンドポイントを呼び出し、毎回スキーマを検証しています。
| パラメータ | HTTP | レイテンシ | 結果 |
|---|---|---|---|
| base=ETH&hours=168 | 200 | 32 ms | 合格 |
| base=SOL&hours=168 | 200 | 32 ms | 合格 |
| base=ARKM&hours=168 | 200 | 34 ms | 合格 |
2026-11-13 03:57:41 UTCにチェック
詳細
- 認証
- 不要。公開エンドポイントです。
- レート制限
- IPごとに毎分1200リクエスト
- サーバーキャッシュ
- 5m
- エッジマイクロキャッシュ
- 10s
- 更新頻度
- UTCの毎時の切り替わりで1時間ごとにアーカイブ(最新テーブルのスナップショット)。ClickHouseのコピーは5 minごとに同期
- ウィンドウ
- hoursパラメータ、デフォルト168 h、範囲1〜2160 h。1時間ごとのポイント
- データソース
- 自社のコレクターが22のデリバティブ取引所(binance、okx、bybit、gate、bitget、hyperliquidなど)の公開REST APIからポーリングした建玉と、CMEの公式な日次出来高/建玉レポートです。
- 取引所カバレッジ
- その銘柄の1時間ごとのアーカイブに存在する取引所。2026-11-11以降は鮮度内の行のみをアーカイブします(OIは3 h、cmeは120 h)。cmeの日次値は1時間ごとに繰り越されます
- 単位
- open interest in USD notional; hour_ts in Unix ms
- 算出方法
- per hour and exchange: SUM(oi_usd) over all contract symbols of the coin; total_usd = sum over exchanges
- タイムスタンプ
- フィールドの説明に別途記載がない限り、Unixエポックミリ秒(UTC)
- レスポンス形式
- json
- 安定性
- 安定版
ライブステータス
利用可能2026-11-13 04:02:34 UTCにチェックHTTP 2002 msスキーマ一致最新データポイントは63m前
可用性(過去30日間)
411回のチェック中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/history利用可能パラメータ
string — Base coin symbol (uppercase, e.g. BTC).
integer · デフォルト 168 · 最小 1 · 最大 2160 — Look-back window in hours.
リクエストURL
https://www.coinboss.com/api/oi/history?base=BTC&hours=168エンドポイントを選択して「リクエストを送信」を押してください。レスポンス、ヘッダー、所要時間がここに表示されます。
このカテゴリの他のエンドポイント
- 1銘柄の建玉 /api/sd/oi
- 取引所横断の銘柄別建玉ランキング /api/market/open-interest
- 1銘柄のOI積み上げチャート系列 /api/oi/chart
- 1銘柄の集計建玉履歴 /api/oi/history
- 建玉マトリックス /api/oi/matrix
- 1銘柄の建玉サマリー /api/oi/summary