/api/sd/oi
GET利用可能

1銘柄の建玉

自社データ層:1銘柄の建玉(取引所別/契約別、品質フラグ付き)

GET/api/sd/oi

リクエスト

クエリパラメータ

名前型必須デフォルト指定可能な値説明
coinstring必須——銘柄シンボル。未指定の場合は400。エイリアス:`base`。 例: BTC

リクエスト例

curl -s "https://www.coinboss.com/api/sd/oi?coin=BTC"

レスポンスフィールド

フィールド表は実際のレスポンスから生成しているため、エンドポイントが返す内容をそのまま反映しています。パスでは、配列の要素をa[]、銘柄や取引所などの動的な名前をキーとするオブジェクトを{*}で表します。

フィールド型単位説明
successboolean—リクエストが成功した場合はtrue。失敗した場合、ボディは`{ success: false, code, error, request_id }`になります。
coinstring—銘柄シンボル(大文字。例:BTC)。
nownumbermsレスポンスを生成した時点のサーバー時刻。
total_usdnumberUSD集計対象の全取引所・全契約の建玉。各取引所の報告値のまま合計しています(USD建て想定元本)。
n_exchangesnumber—合計に含まれる取引所の数。
n_contractsnumber—合計に含まれる契約の数。
asofnumberms集計対象の行のうち最も新しい更新時刻。
total_usd_single_adjustednumberUSD`total_usd`のうち、両側を報告する取引所(`double_sided.exchanges`)の数値を半分にした値。これにより、すべての取引所が片側でカウントされます。
double_sidedobject—ロング+ショートの建玉を1つの数値として公表していることが判明している取引所。
double_sided.exchangesarray—取引所。
double_sided.exchanges[]string—取引所。
double_sided.oi_usdnumberUSD半分にする前の、それらの取引所が報告した建玉。
by_kindobject—リニア/インバース別の内訳。
by_kind.linear_usdnumberUSDリニア契約(ステーブルコインまたはUSDを証拠金とし、同通貨で決済)の建玉。
by_kind.inverse_usdnumberUSDインバース(コイン証拠金型)契約の建玉。契約価格でUSDに換算しています。
by_marginobject—証拠金通貨別の内訳。
by_margin.othernumberUSDその他の証拠金通貨(例:CMEなどのUSD決済の取引所)。
by_margin.usdtnumberUSDUSDT建て契約。
by_margin.usdcnumberUSDUSDC建て契約。 省略される場合あり
by_margin.coinnumberUSDコイン証拠金型契約。 省略される場合あり
by_contract_typeobject—無期限/限月別の内訳。
by_contract_type.perpetual_usdnumberUSD無期限先物。
by_contract_type.delivery_usdnumberUSD限月先物(デリバリー契約)。
changeobject—1h / 4h / 24hの建玉変化。両端で同一の契約セットを対象に算出しています。 動的キー: h1,h4,h24
change.{*}object—記載された期間における変化。
change.{*}.pctnumber%`prev`と`cur`の間の変化率(%)。
change.{*}.curnumberUSDマッチした契約の現在の合計。
change.{*}.prevnumberUSD`prev_ts`時点における同じ契約の合計。
change.{*}.n_matchednumber—両端に存在する契約(または取引所)。
change.{*}.n_totalnumber—現在存在する契約(または取引所)。
change.{*}.matched_share_pctnumber%現在の建玉のうち、マッチしたセットがカバーする割合。 省略される場合あり
change.{*}.prev_tsnumberms基準スナップショットの時刻。
change.{*}.span_minnumbermin基準時点から現在までの実際の間隔。
change.{*}.basisstring—基準値の取得元となったスナップショット系列。
change.{*}.frozen_excludedobject—2つのスナップショットの間で値が動かなかった(ソースが更新されていない)ため、変化の算出から除外された行。 省略される場合あり
change.{*}.frozen_excluded.n_baselinenumber—基準スナップショット内の項目。 省略される場合あり
change.{*}.frozen_excluded.n_currentnumber—現在のスナップショット内の項目。 省略される場合あり
change.{*}.frozen_excluded.cur_usdnumberUSD現在値。 省略される場合あり
change.{*}.frozen_excluded.prev_usdnumberUSD基準値。 省略される場合あり
by_exchangearray—取引所別の内訳。
by_exchange[]object—取引所別の内訳。
by_exchange[].exchangestring—取引所ID(小文字。例:`binance`)。
by_exchange[].oi_usdnumberUSDUSD建て想定元本での建玉。
by_exchange[].share_pctnumber%合計に占める割合。
by_exchange[].n_contractsnumber—契約数。
by_exchange[].linear_usdnumberUSDリニア契約。
by_exchange[].inverse_usdnumberUSDインバース(コイン証拠金型)契約。
by_exchange[].perpetual_usdnumberUSD無期限先物。
by_exchange[].delivery_usdnumberUSD限月契約。
by_exchange[].oi_sidestring—取引所が両側を1つの数値で報告する場合は`double`、片側を報告する場合は`single`、取引所が明記していない場合は`unstated`。
by_exchange[].oi_usd_single_adjustednumber|nullUSD片側換算値。片側/両側の扱いが明記されていない場合はnull。
by_exchange[].updated_atnumbermsこの行が最後に更新された時刻。
by_exchange[].age_snumbersこの行が最後に更新されてからの経過秒数。
by_exchange[].is_staleboolean—行が鮮度ウィンドウより古い場合はtrue。鮮度切れの行は合計に使用されません。
contractsarray—契約ごとの行。
contracts[]object—契約ごとの行。
contracts[].exchangestring—取引所ID(小文字。例:`binance`)。
contracts[].symbolstring—CoinBossが正規化した銘柄シンボル(例:BTCUSDT)。
contracts[].native_symbolstring|null—取引所の表記そのままのシンボル。
contracts[].oi_usdnumberUSDUSD建て想定元本での建玉。
contracts[].oi_sidestring—`double`、`single`、`unstated`のいずれか。取引所が建玉の両側を1つの数値で報告しているかどうかを示します。
contracts[].oi_usd_singlenumber|nullUSD`oi_usd`の片側換算値。片側/両側の扱いが明記されていない場合はnull。
contracts[].marginstring—証拠金通貨の区分:`usdt`、`usdc`、`coin`、`other`。
contracts[].kindstring—`linear`または`inverse`。
contracts[].contract_typestring—`perpetual`または`delivery`。
contracts[].expiry_tsnumber|nullms限月契約の満期日。無期限先物の場合、または公表されていない場合はnull。
contracts[].margin_basisstring—証拠金区分の判定方法(契約仕様から、または取引所のデフォルトから)。
contracts[].updated_atnumbermsこの行が最後に更新された時刻。
contracts[].age_snumbersこの行が最後に更新されてからの経過秒数。
contracts[].is_staleboolean—行が鮮度ウィンドウより古い場合はtrue。鮮度切れの行は合計に使用されません。
contracts[].collectorstring—この行を生成した内部コレクター。
contracts[].included_sincenumber|nullmsこの契約が合計に算入された時刻。基本セットの場合はnull。
coverageobject—上記の数値に含まれるものと含まれないもの。他のソースと合計値を比較する前に、まずこの内容を比較してください。
coverage.included_exchangesarray—データが合計に含まれている取引所。
coverage.included_exchanges[]string—合計に含まれる取引所。
coverage.pendingarray—収集はしているが、まだ合計に算入されていない契約(たとえば、契約自体の25時間分の履歴を蓄積中の場合)。差分がわかるよう、現在値とともに記載されます。
coverage.pending[]object—収集済みだが未算入の項目。
coverage.pending[].exchangestring—取引所ID(小文字。例:`binance`)。
coverage.pending[].symbolstring—CoinBossが正規化した銘柄シンボル(例:BTCUSDT)。
coverage.pending[].native_symbolstring—取引所の表記そのままのシンボル。
coverage.pending[].marginstring—証拠金通貨の区分。
coverage.pending[].contract_typestring—`perpetual`または`delivery`。
coverage.pending[].oi_usdnumberUSDUSD建て想定元本での建玉。
coverage.pending[].age_snumbersこの行が最後に更新されてからの経過秒数。
coverage.pending[].reasonstring—理由コード。
coverage.pending[].detailstring|null—詳細。
coverage.pending_usdnumber|nullUSD保留中の契約の合計。`total_usd`には含まれません。
coverage.stale_excludedarray—最終更新が利用可能ウィンドウの外にあるため除外された行。 この表の生成に使用したサンプルでは空
coverage.unavailablearray—算入できなかった取引所/契約の組み合わせ。それぞれ理由が付きます。0としてカウントされることはありません。
coverage.unavailable[]object—データが利用できない項目とその理由。0として報告されることはありません。
coverage.unavailable[].exchangestring—取引所ID(小文字。例:`binance`)。
coverage.unavailable[].symbolstring—CoinBossが正規化した銘柄シンボル(例:BTCUSDT)。
coverage.unavailable[].native_symbolstring—取引所の表記そのままのシンボル。
coverage.unavailable[].marginstring—証拠金通貨の区分。
coverage.unavailable[].contract_typestring—`perpetual`または`delivery`。
coverage.unavailable[].reasonstring—理由コード。
coverage.unavailable[].detailstring—詳細。
methodobject—このレスポンスで使用した計算式を平文で記述したもの。
method.totalstring—合計。
method.usdstringUSD値。
method.change_h1_h4string—1hおよび4hの建玉変化の定義(平文):各契約を、ウィンドウ開始時点に最も近いその契約自身のスナップショットと比較します。
method.change_h24string—24hの建玉変化の定義(平文):24時間前に最も近い1時間ごとのスナップショットと同一取引所同士で対応付け、値が動いていない基準値は除外します。
method.oi_sidestring—`double`、`single`、`unstated`のいずれか。取引所が建玉の両側を1つの数値で報告しているかどうかを示します。

2026-11-11 23:00 UTCに4件の実レスポンスから生成。

レスポンス例

/api/sd/oi?coin=BTC · 実際のレスポンス(2026-11-13 03:57:39 UTCに取得)。 長い配列とマップは表示用に短縮しています:changeは3件; contractsは95件; by_exchangeは22件; coverage.included_exchangesは22件。

  • {
    • "success": true,
    • "coin": "BTC",
    • "now": 1794542259643,
    • "total_usd": 49005713133.94,
    • "n_exchanges": 22,
    • "n_contracts": 95,
    • "asof": 1794542258000,
    • "total_usd_single_adjusted": 43766392634.71,
    • "double_sided": {
      • "exchanges": [ … 2 ],
      • "oi_usd": 10478640998.46
      },
    • "by_kind": {
      • "linear_usd": 44169662162.94,
      • "inverse_usd": 4836050971
      },
    • "by_margin": {
      • "other": 8250815931.650002,
      • "usdt": 30919742583.03,
      • "usdc": 4999103648.259998,
      • "coin": 4836050971
      },
    • "by_contract_type": {
      • "perpetual_usd": 40820877874.21,
      • "delivery_usd": 8184835259.73
      },
    • "change": {
      • "h1": { … 9 },
      • "h4": { … 9 }
      },
    • "by_exchange": [
      • { … 13 },
      • { … 13 }
      ],
    • "contracts": [
      • { … 16 },
      • { … 16 }
      ],
    • "coverage": {
      • "included_exchanges": [ … 8 ],
      • "pending": [],
      • "pending_usd": null,
      • "stale_excluded": [ … 2 ],
      • "unavailable": [ … 1 ]
      },
    • "method": {
      • "total": "SUM(oi_usd) over fresh contracts (non-CME updated within 3h; CME within 120h)",
      • "usd": "linear: contracts × contract_size × mark/last price; inverse: contracts × contract_face_value_usd (or coin amount × price)",
      • "change_h1_h4": "same-contract pairing vs own snapshot nearest to now−W (15-minute snapshots, hourly fallback)",
      • "change_h24": "same-exchange pairing vs hourly snapshot nearest to now−24h (site-wide convention); contracts whose baseline snapshot is a frozen carry-over (identical to the c…",
      • "oi_side": "as disclosed by each exchange; double = exchange API itself reports open interest as twice the single-sided figure"
      }
    }

検証済みサンプル

上の例に加えて、プローブは以下のパラメータでもこのエンドポイントを呼び出し、毎回スキーマを検証しています。

パラメータHTTPレイテンシ結果
coin=ETH20024 ms合格
coin=SOL20021 ms合格
coin=ARKM20020 ms合格
—4001 ms合格 想定どおりのエラーを返す

2026-11-13 03:57:39 UTCにチェック

詳細

認証
不要。公開エンドポイントです。
レート制限
IPごとに毎分1200リクエスト
サーバーキャッシュ
20s
エッジマイクロキャッシュ
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)。短期ウィンドウの変化用に、契約単位のスナップショットを15分ごとに取得
ウィンドウ
最新スナップショット(3 h以内の行、cmeは120 h。is_staleフラグは15 min経過後、cmeは36 h)。1 h / 4 hの変化(15分ごとのスナップショット)と24 hの変化(1時間ごとのアーカイブ)
データソース
自社のコレクターが22のデリバティブ取引所(binance、okx、bybit、gate、bitget、hyperliquidなど)の公開REST APIからポーリングした建玉と、CMEの公式な日次出来高/建玉レポートです。
取引所カバレッジ
鮮度内の行がある23ソース(22取引所 + cme)。すべての契約種別(USDT / USDC / USD建てのリニア、コイン証拠金型のインバース、無期限および限月)。bybitとgateは、取引所の開示どおり両側の建玉を報告します。3 h(cme:120 h)より古い行は除外されます。coverageブロックには、算入済み、保留中(自社履歴が25 h分たまるのを待機中)、鮮度切れによる除外、利用不可の取引所が記載されます
単位
open interest in USD notional; total_usd_single_adjusted halves venues that report double-sided OI; changes in percent
算出方法
total_usd = SUM(oi_usd) over fresh contracts (multiplier contracts folded); breakdowns by kind / margin / contract type; h1 / h4 change by same-contract pairing against 15-minute snapshots (+/- 10 min, fallback hourly archive) and only when >= 50% of OI is matched; h24 change by same-exchange pairing against the hourly bucket nearest now - 24 h
タイムスタンプ
フィールドの説明に別途記載がない限り、Unixエポックミリ秒(UTC)
レスポンス形式
json
安定性
安定版
提供開始
2026-11-11

ライブステータス

利用可能2026-11-13 03:57:39 UTCにチェックHTTP 20032 msスキーマ一致最新データポイントは2s前

可用性(過去30日間)

411回のチェック中100%が合格

直近のプローブで検出されたスキーマのずれ
  • 返されているがドキュメントに未記載: coverage.stale_excluded[], coverage.stale_excluded[].exchange, coverage.stale_excluded[].symbol, coverage.stale_excluded[].oi_usd, coverage.stale_excluded[].age_s, coverage.stale_excluded[].reason

エラー

失敗した呼び出しは、すべてのエンドポイントで共通の形式で返されます。一覧はエラーページにあります。 エラーとレート制限 →

コードHTTP意味対処方法
INVALID_PARAM400必須パラメータが不足しているか、値が受け付けられません。該当するパラメータが特定できる場合は、`param`にその名前が入ります。そのまま再試行せず、リクエストを修正してください。
UNAUTHORIZED401`CB-API-KEY`ヘッダーが送信されましたが、キーが不明か失効済みです。公開データにキーは不要です。ヘッダーを外すか、有効なキーを使用してください。そのまま再試行しないでください。
FORBIDDEN403このルートは公開APIに含まれません(内部用またはアカウント専用)。再試行しないでください。
NOT_FOUND404不明なルートであるか、リクエストされた銘柄 / 取引所 / ファンドが存在しません。再試行せず、パスと識別子をカタログと照合してください。
RATE_LIMITED429リクエスト数が1分あたりの上限を超えました。`Retry-After`に待機すべき秒数が示されます。`Retry-After`で示された時間だけ待ってから、バックオフ付きで再試行してください。
INTERNAL500予期しないサーバーエラーです。メッセージは意図的に汎用的な内容にしています。報告の際は`request_id`を引用してください。数秒後に1回だけ再試行してください。解消しない場合は、リクエストIDを添えて報告してください。
UPSTREAM_FAILED503このエンドポイントの背後にあるデータソースが時間内に応答しませんでした。鮮度切れの数値や代替の数値を代わりに返すことはありません。バックオフ付きで再試行し、ステータスページを確認してください。
UNAVAILABLE501 / 503データセットが一時的に準備できていない(キャッシュのウォームアップ中)か、このエンドポイントに適法な公開ソースがまだありません。時間をおいて再試行してください。仕様上利用できないエンドポイントは、カタログに明示されています。
REQUEST_FAILED200一部の古いエンドポイントは、HTTP 200で`success: false`を返します。HTTPステータスだけでなく、必ず`success`を確認してください。メッセージによって異なります。失敗したリクエストとして扱ってください。

試してみる

GET/api/sd/oi利用可能
パラメータ

string — Coin symbol; 400 when missing. Alias: `base`.

リクエストURLhttps://www.coinboss.com/api/sd/oi?coin=BTC
エンドポイントを選択して「リクエストを送信」を押してください。レスポンス、ヘッダー、所要時間がここに表示されます。