Channels
Subaccount orders
Channel name: {subaccount_id}.orders. Private channel (requires authentication) that streams live order updates (opens, fills, cancels, and status changes) for your subaccount, where is the numeric subaccount identifier.
WSS
/
v3
/
ws
Messages
{
"id": 1,
"method": "subscribe",
"params": {
"channels": [
"orderbook.ETH-PERP.10.20"
]
}
}No examples found{
"algo_duration_sec": 123,
"algo_num_slices": 123,
"algo_slices_completed": 123,
"algo_type": "<string>",
"amount": "<string>",
"average_price": "<string>",
"cancel_reason": "<string>",
"creation_timestamp": 123,
"direction": "<string>",
"extra_fee": "<string>",
"filled_amount": "<string>",
"instrument_name": "<string>",
"is_transfer": true,
"label": "<string>",
"last_update_timestamp": 123,
"limit_price": "<string>",
"max_fee": "<string>",
"mmp": true,
"nonce": "<string>",
"order_fee": "<string>",
"order_id": "<string>",
"order_status": "<string>",
"order_type": "<string>",
"quote_id": "<string>",
"replaced_order_id": "<string>",
"signature": "<string>",
"signature_expiry_sec": 123,
"signed_limit_price": "<string>",
"signer": "<string>",
"subaccount_id": 123,
"time_in_force": "<string>",
"trigger_price": "<string>",
"trigger_price_type": "<string>",
"trigger_reject_message": "<string>",
"trigger_type": "<string>"
}subscribeRequest
type:object
Send to subscribe: list this channel's address (with the {param} segments filled, e.g. orderbook.ETH-PERP.10.20) in params.channels.
unsubscribeRequest
type:object
Send to unsubscribe: list the channel addresses to drop in params.channels, or omit it to unsubscribe from everything.
subaccountOrdersNotification
type:object
Pushed as a JSON array; each element has the fields below.
Messages
{
"id": 1,
"method": "subscribe",
"params": {
"channels": [
"orderbook.ETH-PERP.10.20"
]
}
}No examples found{
"algo_duration_sec": 123,
"algo_num_slices": 123,
"algo_slices_completed": 123,
"algo_type": "<string>",
"amount": "<string>",
"average_price": "<string>",
"cancel_reason": "<string>",
"creation_timestamp": 123,
"direction": "<string>",
"extra_fee": "<string>",
"filled_amount": "<string>",
"instrument_name": "<string>",
"is_transfer": true,
"label": "<string>",
"last_update_timestamp": 123,
"limit_price": "<string>",
"max_fee": "<string>",
"mmp": true,
"nonce": "<string>",
"order_fee": "<string>",
"order_id": "<string>",
"order_status": "<string>",
"order_type": "<string>",
"quote_id": "<string>",
"replaced_order_id": "<string>",
"signature": "<string>",
"signature_expiry_sec": 123,
"signed_limit_price": "<string>",
"signer": "<string>",
"subaccount_id": 123,
"time_in_force": "<string>",
"trigger_price": "<string>",
"trigger_price_type": "<string>",
"trigger_reject_message": "<string>",
"trigger_type": "<string>"
}