Skip to main content
Messages
instrument_name
type:string
required

The name of the instrument

group
type:enum
required

Group prices (by rounding). Use none for no grouping.

For ETH cryptocurrency, the real group is divided by 100.0. Example: a value of 5 means using 0.05.

Allowed values:

  • BTC: none, 1, 2, 5, 10
  • ETH: none, 5, 10, 25, 100, 250

Allowed values: none, 1, 2, 5, 10, 25, 100, 250

Available options: none, 1, 2, 5, 10, 25, 100, 250
depth
type:enum
required

Number of price levels to be included

Allowed values: 1, 10, 20

Available options: 1, 10, 20
interval
type:enum
required

Frequency of notifications. Events will be aggregated over this interval. The value raw means no aggregation will be applied (Please note that raw interval is only available to authorized users)

Allowed values: raw, 100ms, agg2

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.

Subscription Notification Data
type:object

Server sends subscription notification data