Skip to main content
instrument_name
type:string
required

The name of the instrument

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)

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

data
type:object
required
interest
type:number
required

Current interest

timestamp
type:integer
required

The timestamp (milliseconds since the Unix epoch)

index_price
type:number
required

Current index price