Skip to main content

User Order Subscription

Reminder
  • Before using this endpoint, please call the "server.sign" method for signature authorization.
  • The push delay of this method is: real-time

User Order Subscription

  • Method: order.subscribe
  • Parameters:
Parameter NameRequiredTypeNotes
market_listtrue[]stringMarket list. Empty list to subscribe to all markets.
  • Example:
// Subscribe to a singular market
{
"method": "order.subscribe",
"params": {"market_list": ["BTCUSDT"]},
"id": 1
}

// Subscribe to multiple markets
{
"method": "order.subscribe",
"params": {"market_list": ["BTCUSDT", "ETHUSDT"]},
"id": 1
}

// Subscribe to all markets
{
"method": "order.subscribe",
"params": {"market_list": []},
"id": 1
}

User Order Update Push

  • Method: order.update
  • Parameters:
Parameter NameTypeNotes
eventstringOrder update event type
orderobjectOrder data
order.order_idintOrder id
order.stop_idintRelated stop order id
order.marketstringMarket name
order.sidestringOrder side, buy or sell
order.typestringOrder type, limit, market, GTC, IOC or FOK
order.amountstringOrder amount
order.pricestringPrice
order.unfilled_amountstringThe remaining unfilled amount
order.filled_amountstringFilled volume
order.filled_valuestringFilled value
order.client_idstringUser-defined id
order.feestringTrading fee charged
order.fee_ccystringTrading fee currency
order.taker_fee_ratestringTaker rate
order.maker_fee_ratestringMaker rate
order.last_filled_amountstringFilled amount of the last transaction
order.last_filled_pricestringFilled price of the last transaction
order.created_atintOrder timestamp (millisecond)
order.updated_atintLatest update timestamp (milliseconds)
  • Example:
{
"method": "order.update",
"data": {
"event": "put",
"order": {
"order_id": 98388656341,
"stop_id": 0,
"market": "BTCUSDT",
"side": "buy",
"type": "limit",
"amount": "0.0010",
"price": "50000.00",
"unfilled_amount": "0.0010",
"filled_amount": "0",
"filled_value": "0",
"fee": "0",
"fee_ccy": "USDT",
"taker_fee_rate": "0.00046",
"maker_fee_rate": "0.00000000000000000000",
"client_id": "",
"last_filled_amount": "0.0010",
"last_filled_price": "30721.35",
"created_at": 1689145715129,
"updated_at": 1689145715129
}
},
"id": null
}

Cancel Order Subscription

  • Method: order.unsubscribe
  • Parameters:
Parameter NameRequiredTypeNotes
market_listtrue[]stringMarket list. Empty list to unsubscribe to all markets.
  • Example:
// Unsubscribe to a singular market
{
"method": "order.unsubscribe",
"params": {"market_list": ["BTCUSDT"]},
"id": 1
}

// Unsubscribe to multiple markets
{
"method": "order.unsubscribe",
"params": {"market_list": ["BTCUSDT", "ETHUSDT"]},
"id": 1
}

// Unsubscribe to all markets
{
"method": "order.unsubscribe",
"params": {"market_list": []},
"id": 1
}