Skip to main content
instrument_name
type:string
required

Instrument name

interval
type:enum
required

Frequency of notifications. Events will be aggregated over this interval. The value raw selects the finest granularity - events are aggregated over a 1 millisecond interval (Please note that raw interval is only available to authorized users)

Available options: raw, 100ms, agg2
Subscription Request
type:object

Client sends subscription request to subscribe to notification channel. Please refer to Notification page for more information.

jsonrpc
type:string
required

2.0

id
type:integer
required
method
type:enum
required
Available options: public/subscribe, private/subscribe
params
type:object
required
channels
type:array
required
item
type:string
Subscription Notification Data
type:object

Server sends subscription notification data

data
type:object
required
instrument_name
type:string
required

Unique instrument identifier

change_id
type:integer
required

Identifier of the notification

prev_change_id
type:integer

Identifier of the previous notification (it's not included for the first notification)

asks
type:array
required
item
type:array

The first notification will contain the amounts for all price levels (a list of ["new", price, amount] tuples). All following notifications will contain a list of tuples with action, price level and new amount ([action, price, amount]). Action can be new, change or delete.

bids
type:array
required
item
type:array

(See 'asks' above.)

timestamp
type:integer

The timestamp of last change (milliseconds since the Unix epoch)

type
type:enum

Type of notification: snapshot for initial, change for others

Available options: snapshot, change