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.marketstringMarket name
order.margin_marketstringMargin market name, null for non-margin markets
order.typestringOrder type, limit, market, maker_only, IOC or FOK
order.sidestringOrder side, buy or sell
order.amountstringOrder amount
order.pricestringPrice
order.unfilled_amountstringThe remaining unfilled amount
order.filled_valuestringFilled value
order.taker_fee_ratestringTaker rate
order.maker_fee_ratestringMaker rate
order.base_ccy_feestringTrading fee paid in base currency
order.quote_ccy_feestringTrading fee paid in quote currency
order.discount_ccy_feestringTrading fee paid mainly in CET
order.last_filled_amountstringFilled amount of the last transaction
order.last_filled_pricestringFilled price of the last transaction
order.client_idstringUser-defined id
order.created_atintOrder timestamp, unit: millisecond
order.updated_atintLatest update timestamp, unit: millisecond
  • Example:
{
"method": "order.update",
"data": {
"event": "put",
"order": {
"order_id": 12750,
"market": "BTCUSDT",
"margin_market": "BTCUSDT",
"type": "limit",
"side": "buy",
"price": "5999.00",
"amount": "1.50000000",
"unfill_amount": "1.50000000",
"fill_value": "1.50000000",
"taker_fee_rate": "0.0001",
"maker_fee_rate": "0.0001",
"base_ccy_fee": "0.0001",
"quote_ccy_fee": "0.0001",
"discount_ccy_fee": "0.0001",
"last_fill_amount": "0",
"last_fill_price": "0",
"client_id": "buy1_1234",
"created_at": 1689152421692,
"updated_at": 1689152421692,
}
},
"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
}