Source tickers · WebSocket

See connection, authentication and subscription limits in the WebSocket overview.

Unsubscribe

Subscription message (type: subscribe)

SENDsubscribe / sourceTickers

Client → server

Receive sourceTicker events. sources filters exchange IDs; omit it for all sources. Prices use quote, while the event retains the native pair and native quote. No interval filter applies.

Reply: subscribed

Message fields

Field	Type	Required	Description
type	string	Yes	Always subscribe. Allowed: "subscribe"
id	string	No	Subscription ID. Default: default. Reuse it to replace the subscription. Default: "default"
symbol	string	No	Base asset, e.g. BTC; do not append the quote currency.
symbols	string[]	No	Base assets. Combined with symbol when both are supplied.
quote	string	No	JPY (default) or USD. Allowed: "JPY", "USD" Default: "JPY"
channels	string[]	Yes	Provide this value to subscribe only to this feed. Allowed: ["sourceTickers"]
sources	string[]	No	Source tickers only. Exchange IDs such as binance, bitbank. Omit for all sources.

Examples

{
  "type": "subscribe",
  "id": "btc-sources",
  "symbol": "BTC",
  "quote": "JPY",
  "channels": [
    "sourceTickers"
  ],
  "sources": [
    "binance",
    "bitbank"
  ]
}

Push message (e: sourceTicker)

RECEIVEsourceTicker

Server → client

Source ticker: s is the base asset and quote is the normalized output currency; p and q preserve the native pair and quote. c, b, a, o, h, and l use the currency in quote; v is base-asset quantity. Bid/ask or derived 24-hour fields may be absent while upstream quotes, FX, or usable recent minute data are unavailable. T is source time; E is Oracle publish time.

vc is true for native rolling-volume feeds or when all 1,440 preceding source minutes are present; false means v sums available bars and may be understated. Minute-derived v also includes the current active minute, so it can span up to one extra partial minute. Cross-currency live prices use the latest available FX rate at publication; T remains the upstream quote time.

Message fields

Field	Type	Required	Description
e	string	Yes	Always sourceTicker. Allowed: "sourceTicker"
E	integer	Yes	Oracle publish time, Unix milliseconds.
s	string	Yes	Base asset symbol.
quote	string	Yes	Output price currency: JPY or USD. Allowed: "JPY", "USD"
T	integer	Yes	Upstream quote time, Unix milliseconds.
x	string	Yes	Exchange ID.
p	string	Yes	Native exchange pair, e.g. BTCUSDT.
q	string	Yes	Native quote currency, e.g. USDT.
c	string	Yes	Latest price, as a decimal string.
b	string	No	Best bid price in quote.
a	string	No	Best ask price in quote.
o	string	No	24-hour open price in quote.
h	string	No	24-hour high price in quote.
l	string	No	24-hour low price in quote.
v	string	No	24-hour base-asset volume, as a decimal string.
vc	boolean	No	Whether the reported volume has complete coverage.

Examples

{
  "e": "sourceTicker",
  "E": 1788220801000,
  "T": 1788220800123,
  "s": "BTC",
  "quote": "JPY",
  "x": "binance",
  "p": "BTCUSDT",
  "q": "USDT",
  "c": "15018000",
  "b": "15017000",
  "a": "15019000",
  "v": "1234.5678",
  "vc": true
}