Skip to main content

User Stop 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 Stop Order Subscription

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

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

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

Stop Order Update Push

  • Method: stop.update
  • Parameters:
Parameter NameTypeNotes
eventstringStop order update event type
stopobjectStop order info
stop.stop_idintOrder id
stop.marketstringMarket name
stop.margin_marketstringMargin market name, null for non-margin markets
stop.typestringOrder type, limit, market, maker_only, IOC or FOK
stop.sidestringSell or buy
stop.amountstringOrder quantity after triggering
stop.pricestringOrder price after triggering, market order as "0"
stop.trigger_pricestringStop price
stop.trigger_directionstringStop order trigger direction
stop.taker_fee_ratestringTaker rate
stop.maker_fee_ratestringMaker rate
stop.client_idstringUser-defined id
stop.statusstringStop order status
stop.created_atintOrder time, milliseconds
stop.updated_atintOrder time, milliseconds
  • Example:
{
"method": "stop.update",
"data": {
"event": 1,
"stop": {
"stop_id": 102067022299,
"market": "BTCUSDT",
"margin_market": "BTCUSDT",
"type": "limit",
"side": "buy",
"price": "20000.00",
"amount": "0.10000000",
"trigger_price": "20000.00",
"trigger_direction": "lower",
"taker_fee_rate": "0.0016",
"maker_fee_rate": "0.0016",
"status": "active_success",
"client_id": "",
"created_at": 1689152996689,
"updated_at": 1689152996689,
}
},
"id": null
}

Cancel Stop Order Subscription

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

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

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