Skip to main content
Messages
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
nonce
type:string
required

Nonce that can be used to approve or reject pending block trade.

timestamp
type:integer
required

Timestamp that can be used to approve or reject pending block trade.

trades
type:object
required
instrument_name
type:string
required

Unique instrument identifier

direction
type:enum
required

Direction: buy, or sell

Available options: buy, sell
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.

app_name
type:string
required

The name of the application that executed the block trade on behalf of the user (optional).

username
type:string

Username of the user who initiated the block trade.

role
type:enum
required

Trade role of the user: maker or taker

Available options: maker, taker
user_id
type:integer
required

Unique user identifier

broker_code
type:string

Broker code associated with the broker block trade.

broker_name
type:string

Name of the broker associated with the block trade.

state
type:object
required

State of the pending block trade for current user.

counterparty_state
type:object

State of the pending block trade for the other party (optional).

combo_id
type:string

Combo instrument identifier