Home Platform Algorithms Charts Pricing Documentation Register Account

Ticker ticker.*

The ticker feed supplies 24 hour summary data for a market. The topic is in the form "ticker.<instrumentId>". Instrument IDs are in the form "<symbol>:<broker>".

Subscribe

Send

message array ["subscribe", "ticker.*"]
instruction string = "subscribe"
Specify that message is an instruction to begin streaming data.
topic string
The ticker topic in the form `ticker.<instrumentId>`.

Example:

socket.send('["subscribe", "ticker.XBTUSD:BitMEX"]')

Receive

Update messages will begin arriving in the form:

message array [topic, ticker]
topic string
The ticker topic in the form `ticker.<instrumentId>`
ticker object
The ticker data with fields below.

Fields

FieldTypeValuesFXCMOANDABitMEXBinanceBitfinex
symbol
Instrument symbol
string
time
Timestamp as ISO string
string
priceChange
Movement since 24hr price
number
priceChangePercent
Movement as percent of 24hr price
number
previousDayClose
Price at previous 24hr close
number
currentDayClose
Price at current 24hr close
number
open
24hr open price
number
high
24hr high price
number
low
24hr low price
number
volume
24hr total base currency volume traded
number
quoteVolume
24hr total quote currency volume traded
number
vwap
Volume Weighted Average Price
number
bid
Best bid price
number
ask
Best ask price
number
bidQuantity
Best bid quantity
number
askQuantity
Best ask quantity
number
tradesCount
Total number of trades
number

Was this page useful? If you find any errors or have any questions please get in touch at support@cloud9trader.com.