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 Name | Required | Type | Notes |
---|---|---|---|
market_list | true | []string | Market 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 Name | Type | Notes |
---|---|---|
event | string | Stop order update event type |
stop | object | Stop order info |
stop.stop_id | int | Order id |
stop.market | string | Market name |
stop.margin_market | string | Margin market name, null for non-margin markets |
stop.type | string | Order type, limit, market, maker_only, IOC or FOK |
stop.side | string | Sell or buy |
stop.amount | string | Order quantity after triggering |
stop.price | string | Order price after triggering, market order as "0" |
stop.trigger_price | string | Stop price |
stop.trigger_direction | string | Stop order trigger direction |
stop.taker_fee_rate | string | Taker rate |
stop.maker_fee_rate | string | Maker rate |
stop.client_id | string | User-defined id |
stop.status | string | Stop order status |
stop.created_at | int | Order time, milliseconds |
stop.updated_at | int | Order 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 Name | Required | Type | Notes |
---|---|---|---|
market_list | true | []string | Market 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
}