Oracle WebSocket API

このリファレンスは Oracle AsyncAPI 3.0 定義から生成されます。価格と出来高は十進数文字列、イベント時刻は Unix ミリ秒です。

AsyncAPI JSON をダウンロード

Oracle マーケットビュー でリアルタイムのデータを確認できます。

購読一覧

• ローソク足
• 集約ティッカー
• ソースティッカー
• サービス状態
• 購読解除
• 共通メッセージ

接続と認証

WSwss://api.coinpost.ai/oracle/v2/ws

CP Auth が有効な場合、接続時に oracle スコープの Authorization: Bearer <token> を送信します。ブラウザーではこのエンドポイントの ?token=<token> または ?access_token=<token> も利用できます。

市場購読は新しいイベントを配信し、初期スナップショットは送りません。必要な初期データは REST API から取得してください。再接続後は購読を再送してください。市場イベントに購読 ID は含まれず、購読が重複しても一致するイベントは 1 回だけ配信されます。

認証方法

方法	場所	名前
bearer	header	Authorization
httpApiKey	query	token
httpApiKey	query	access_token

例

const url = new URL('wss://api.coinpost.ai/oracle/v2/ws')
// url.searchParams.set('token', '<token>')
const socket = new WebSocket(url)

socket.addEventListener('open', () => {
  socket.send(JSON.stringify({
    type: 'subscribe',
    id: 'btc-jpy',
    symbol: 'BTC',
    quote: 'JPY',
    channels: ['klines'],
    intervals: ['1m'],
  }))
})

socket.addEventListener('message', ({ data }) => {
  console.log(JSON.parse(data))
})

購読 (type: subscribe)

type: "subscribe" で購読を作成・置換します。対象データは channels の klines、tickers、sourceTickers、status で選択します。各購読ページでは、そのフィードに適用されるフィールドを示します。単一のフィードだけを購読するには、記載した channels の値を明示してください。

購読の制限

接続あたり最大 100 件の購読と 100 個の異なるシンボルをサポートします。

symbol と symbols を両方省略する全アセットの市場購読は、その接続のシンボル枠をすべて使用します。接続ごとにこの購読は 1 件だけ許可され、個別シンボルの購読や別の全アセット購読とは併用できません。quote が異なる場合も同様です。追加の市場購読には別の接続を使ってください。シンボルを指定せず、status チャネルだけを含む購読は併用できます。制限に違反すると code: "symbol_limit" のエラーが返り、既存の購読は維持されます。同じ購読 id を再利用すると、その購読を置き換えます。

組み合わせと既定の購読

SENDsubscribe

クライアント → サーバー

同じ ID で複数のフィードを購読する場合は channels にまとめて指定します。intervals は klines、sources は sourceTickers にのみ適用されます。channels を省略または空にすると klines、tickers、sourceTickers が既定となり、status は明示的な追加が必要です。同じ ID は購読全体を置き換えるため、必要なフィールドをすべて再送してください。別々の購読には異なる ID が必要で、id 省略時は常に default です。

応答: subscribed

例

{
  "type": "subscribe",
  "id": "btc-market",
  "symbol": "BTC",
  "quote": "JPY",
  "channels": [
    "klines",
    "tickers",
    "sourceTickers"
  ],
  "intervals": [
    "1m"
  ],
  "sources": [
    "binance"
  ]
}

購読解除 (type: unsubscribe)

SENDunsubscribe

クライアント → サーバー

リクエストの id に対応する購読全体（すべての channels）を解除します。id を省略または空にすると default を解除します。存在しない ID に対しても、サーバーは subscription_id で応答します。

応答: unsubscribed

メッセージのフィールド

フィールド	型	必須	説明
type	string	はい	unsubscribe 固定。 許容値: "unsubscribe"
id	string	いいえ	解除する購読 ID。既定値は default。 既定値: "default"

例

{
  "type": "unsubscribe",
  "id": "btc-jpy"
}

購読解除の確認 (type: unsubscribed)

RECEIVEunsubscribed

サーバー → クライアント

存在しなかった ID を含め、解除した ID を返します。

メッセージのフィールド

フィールド	型	必須	説明
type	string	はい	許容値: "unsubscribed"
subscription_id	string	はい	リクエストの購読 ID。省略または空の場合は default。

例

{
  "type": "unsubscribed",
  "subscription_id": "btc-jpy"
}