Skip to main content
Messages
kind
type:enum
required

Instrument kind

Allowed values: future, option, spot, future_combo, option_combo

Available options: future, option, spot, future_combo, option_combo
currency
type:enum
required

Currency code or any for all

Allowed values: BTC, ETH, USDC, USDT, EURR, any

Available options: BTC, ETH, USDC, USDT, EURR, any
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

data
type:object
required
trade_id
type:string
required

Unique (per currency) trade identifier

trade_seq
type:integer
required

The sequence number of the trade within instrument

instrument_name
type:string
required

Unique instrument identifier

timestamp
type:integer
required

The timestamp of the trade (milliseconds since the UNIX epoch)

direction
type:enum
required

Direction: buy, or sell

Available options: buy, sell
tick_direction
type:enum
required

Direction of the "tick" (0 = Plus Tick, 1 = Zero-Plus Tick, 2 = Minus Tick, 3 = Zero-Minus Tick).

Available options: 0, 1, 2, 3
index_price
type:number
required

Index Price at the moment of trade

price
type:number
required

Price in base currency

amount
type:number
required

Trade amount. For perpetual and inverse futures the amount is in USD units. For options and linear futures it is the underlying base currency coin.

contracts
type:number

Trade size in contract units (optional, may be absent in historical trades)

iv
type:number

Option implied volatility for the price (Option only)

liquidation
type:enum

Optional field (only for trades caused by liquidation): "M" when maker side of trade was under liquidation, "T" when taker side was under liquidation, "MT" when both sides of trade were under liquidation

Available options: M, T, MT
mark_price
type:number
required

Mark Price at the moment of trade

block_trade_id
type:string

Block trade id - when trade was part of a block trade

block_trade_leg_count
type:integer

Block trade leg count - when trade was part of a block trade

combo_id
type:string

Optional field containing combo instrument name if the trade is a combo trade

combo_trade_id
type:number

Optional field containing combo trade identifier if the trade is a combo trade

block_rfq_id
type:integer

ID of the Block RFQ - when trade was part of the Block RFQ