Active orders
Real-time updates for active orders. Authentication required.
warning
This is a private channel. You must authenticate the WebSocket connection before subscribing. See the WebSocket overview for authentication details.
Subscribe Request:
{
"id": "12345",
"method": "subscribe",
"params": {
"channel": "activeOrders"
}
}
Responsesβ
Subscribe Response:
{
"id": "12345",
"result": {
"success": true
}
}
Limit Orderβ
Subscription Push Example (Limit Order Update):
{
"method": "subscription",
"params": {
"channel": "activeOrders",
"data": {
"orders": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"clientOrderId": "928a68bc-d67c-465a-9d65-5c58c8bb8970",
"symbol": "BTC-USDT",
"side": "buy",
"type": "limit",
"status": "working",
"createdAt": "2024-12-05T12:51:20.917Z",
"updatedAt": "2024-12-05T12:51:20.917Z",
"dealSize": "0.1",
"dealFunds": "5000.0",
"fee": "1.82",
"feeAsset": "USDT",
"remark": "string",
"timeInForce": "GTC",
"size": "1.0",
"funds": "50000.0",
"price": "50000.0"
}
]
}
}
}
Limit Order Response Parametersβ
| Parameter | Description |
|---|---|
| id (required) | Unique identifier of the order. Type: string. |
| clientOrderId (optional) | Client order ID. Type: string. |
| symbol (required) | Trading pair. Type: string. |
| side (required) | Order side. Available values: buy, sell. |
| type (required) | For a limit order: limit. Available values: limit, market, stopMarket, stopLimit. |
| status (required) | Order status. Available values: working, rejected, cancelled, completed, expired, pending, sending. |
| createdAt (required) | Order creation timestamp. Type: string. |
| updatedAt (required) | Order update timestamp. Type: string. |
| dealSize (required) | The accumulated amount of the base currency that has already been filled. Type: string. |
| dealFunds (required) | The accumulated amount of the quote currency that has already been spent or received. Type: string. |
| fee (required) | Fee amount. Type: string. |
| feeAsset (required) | Fee asset. Type: string. |
| remark (optional) | A user-defined note or label attached to the order. Type: string. |
| timeInForce (required) | Time in force. Available values: GTC, IOC, FOK. |
| size (required) | The total size or quantity of the order in the base currency (the amount intended to be bought/sold). Type: string. |
| funds (required) | The total funds or amount of the quote currency involved in the order. Type: string. |
| price (required) | The limit price of the order in the quote currency. Type: string. |
Market Orderβ
Subscription Push Example (Market Order Update):
{
"method": "subscription",
"params": {
"channel": "activeOrders",
"data": {
"orders": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"clientOrderId": "928a68bc-d67c-465a-9d65-5c58c8bb8970",
"symbol": "BTC-USDT",
"side": "buy",
"type": "market",
"status": "working",
"createdAt": "2024-12-05T12:51:20.917Z",
"updatedAt": "2024-12-05T12:51:20.917Z",
"dealSize": "0.1",
"dealFunds": "5000.0",
"fee": "1.82",
"feeAsset": "USDT",
"remark": "string",
"timeInForce": "GTC",
"size": "1.0",
"funds": "50000.0"
}
]
}
}
}
Market Order Response Parametersβ
| Parameter | Description |
|---|---|
| id (required) | Unique identifier of the order. Type: string. |
| clientOrderId (optional) | Client order ID. Type: string. |
| symbol (required) | Trading pair. Type: string. |
| side (required) | Order side. Available values: buy, sell. |
| type (required) | For a market order: market. Available values: limit, market, stopMarket, stopLimit. |
| status (required) | Order status. Available values: working, rejected, cancelled, completed, expired, pending, sending. |
| createdAt (required) | Order creation timestamp. Type: string. |
| updatedAt (required) | Order update timestamp. Type: string. |
| dealSize (required) | The accumulated amount of the base currency that has already been filled. Type: string. |
| dealFunds (required) | The accumulated amount of the quote currency that has already been spent or received. Type: string. |
| fee (required) | Fee amount. Type: string. |
| feeAsset (required) | Fee asset. Type: string. |
| remark (optional) | A user-defined note or label attached to the order. Type: string. |
| timeInForce (required) | Time in force. Available values: GTC, IOC, FOK. |
| size (optional) | The total size or quantity of the order in the base currency (the amount intended to be bought/sold). Type: string. |
| funds (optional) | The total funds or amount of the quote currency involved in the order. Type: string. |
Stop Market Orderβ
Subscription Push Example (Stop Market Order Update):
{
"method": "subscription",
"params": {
"channel": "activeOrders",
"data": {
"orders": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"clientOrderId": "928a68bc-d67c-465a-9d65-5c58c8bb8970",
"symbol": "BTC-USDT",
"side": "sell",
"type": "stopMarket",
"status": "working",
"createdAt": "2024-12-05T12:51:20.917Z",
"updatedAt": "2024-12-05T12:51:20.917Z",
"dealSize": "0.0",
"dealFunds": "0.0",
"fee": "0.0",
"feeAsset": "USDT",
"remark": "string",
"timeInForce": "IOC",
"size": "1.0",
"stopTriggered": false,
"stopPrice": "46000.0"
}
]
}
}
}
Stop Market Order Response Parametersβ
| Parameter | Description |
|---|---|
| id (required) | Unique identifier of the order. Type: string. |
| clientOrderId (optional) | Client order ID. Type: string. |
| symbol (required) | Trading pair. Type: string. |
| side (required) | Order side. Available values: buy, sell. |
| type (required) | For a stop market order: stopMarket. Available values: limit, market, stopMarket, stopLimit. |
| status (required) | Order status. Available values: working, rejected, cancelled, completed, expired, pending, sending. |
| createdAt (required) | Order creation timestamp. Type: string. |
| updatedAt (required) | Order update timestamp. Type: string. |
| dealSize (required) | The accumulated amount of the base currency that has already been filled. Type: string. |
| dealFunds (required) | The accumulated amount of the quote currency that has already been spent or received. Type: string. |
| fee (required) | Fee amount. Type: string. |
| feeAsset (required) | Fee asset. Type: string. |
| remark (optional) | A user-defined note or label attached to the order. Type: string. |
| timeInForce (required) | Time in force. Available values: GTC, IOC, FOK. |
| size (required) | The total size or quantity of the order in the base currency (the amount intended to be bought/sold). Type: string. |
| stopTriggered (required) | Indicates whether the stop price has been reached and the order has been triggered. true β triggered, false β waiting. Type: boolean. |
| stopPrice (required) | The trigger price at which the stop order is activated. Once the market price reaches this level, the order is submitted as a market or limit order. Type: string. |
Stop Limit Orderβ
Subscription Push Example (Stop Limit Order Update):
{
"method": "subscription",
"params": {
"channel": "activeOrders",
"data": {
"orders": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"clientOrderId": "928a68bc-d67c-465a-9d65-5c58c8bb8970",
"symbol": "BTC-USDT",
"side": "sell",
"type": "stopLimit",
"status": "working",
"createdAt": "2024-12-05T12:51:20.917Z",
"updatedAt": "2024-12-05T12:51:20.917Z",
"dealSize": "0.0",
"dealFunds": "0.0",
"fee": "0.0",
"feeAsset": "USDT",
"remark": "string",
"timeInForce": "IOC",
"size": "1.0",
"funds": "50000.0",
"price": "50000.0",
"stopTriggered": false,
"stopPrice": "46000.0"
}
]
}
}
}
Stop Limit Order Response Parametersβ
| Parameter | Description |
|---|---|
| id (required) | Unique identifier of the order. Type: string. |
| clientOrderId (optional) | Client order ID. Type: string. |
| symbol (required) | Trading pair. Type: string. |
| side (required) | Order side. Available values: buy, sell. |
| type (required) | For a stop limit order: stopLimit. Available values: limit, market, stopMarket, stopLimit. |
| status (required) | Order status. Available values: working, rejected, cancelled, completed, expired, pending, sending. |
| createdAt (required) | Order creation timestamp. Type: string. |
| updatedAt (required) | Order update timestamp. Type: string. |
| dealSize (required) | The accumulated amount of the base currency that has already been filled. Type: string. |
| dealFunds (required) | The accumulated amount of the quote currency that has already been spent or received. Type: string. |
| fee (required) | Fee amount. Type: string. |
| feeAsset (required) | Fee asset. Type: string. |
| remark (optional) | A user-defined note or label attached to the order. Type: string. |
| timeInForce (required) | Time in force. Available values: GTC, IOC, FOK. |
| size (required) | The total size or quantity of the order in the base currency (the amount intended to be bought/sold). Type: string. |
| funds (required) | The total funds or amount of the quote currency involved in the order. Type: string. |
| price (required) | The limit price of the order in the quote currency. Type: string. |
| stopTriggered (required) | Indicates whether the stop price has been reached and the order has been triggered. true β triggered, false β waiting. Type: boolean. |
| stopPrice (required) | The trigger price at which the stop order is activated. Once the market price reaches this level, the order is submitted as a market or limit order. Type: string. |