Skip to main content
instrument_name
type:string
required

Instrument name

interval
type:enum
required

Notification interval. The raw interval selects unaggregated updates and is available only to authorized users.

Available options: agg2, 100ms, raw
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
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)

starbase_timestamp
type:integer

Optional field: the Starbase causal timestamp of the trade, in nanoseconds since the UNIX epoch (present only for trades matched in Starbase)

direction
type:enum
required

Trade direction of the taker

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

The price of the trade

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:numbernull
required

Mark Price at the moment of trade

block_trade_id
type:string

ID of the Block Trade or Block RFQ trade, when the trade was part of one

block_trade_leg_count
type:integer

Number of legs in the Block Trade or Block RFQ trade, when the trade was part of one

block_delayed
type:integer

Optional field (only for Block RFQ trades with delayed publication): the time the trade is published to public data feeds, in milliseconds since the UNIX epoch. Until then, the trade is returned only to its counterparties and is not included in public trades or the Block RFQ trade tape. The trade never updates the ticker last_price or tick direction, or the 24-hour high, low and price_change; its volume is reported in volume_delayed.

combo_id
type:string

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

combo_trade_id
type:string

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

starbase_match_id
type:integer

Optional field containing the Starbase match identifier (present only for trades matched via Starbase)

block_rfq_id
type:integer

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

legs
type:array

Leg trades, present when querying only combo trades.