Get Active HF Orders List
This interface is to obtain all active order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order.
After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.
There is no time limit for querying orders in the "active" state.
HTTP REQUEST
GET /api/v1/hf/orders/active
Example
GET /api/v1/hf/orders/active?symbol=BTC-ETH
// response
{
"code" : "200000",
"data" : [
"id": "5c35c02703aa673ceec2a168",
"symbol": "BTC-USDT",
"opType": "DEAL",
"type": "limit",
"side": "buy",
"price": "10",
"size": "2",
"funds": "0",
"dealFunds": "0.166",
"dealSize": "2",
"fee": "0",
"feeCurrency": "USDT",
"stp": "",
"timeInForce": "GTC",
"postOnly": false,
"hidden": false,
"iceberg": false,
"visibleSize": "0",
"cancelAfter": 0,
"channel": "IOS",
"clientOid": "",
"remark": "",
"tags": "",
"active": true,
"inOrderBook": true,
"cancelExist": false,
"createdAt": 1547026471000,
"lastUpdatedAt": 1547026471001,
"tradeType": "TRADE",
"cancelledSize": "0",
"cancelledFunds": "0",
"remainSize": "0",
"remainFunds": "0"
}
]
}
API KEY PERMISSIONS
This endpoint requires the General permission.
REQUEST URL
This endpoint support Spot URL
REQUEST RATE LIMIT
Spot weight
:2
PARAMETERS
Param | Type | Mandatory | Description |
---|---|---|---|
symbol | String | Yes | Only returns order information for the specified trading pair |
RESPONSES
Param | Description |
---|---|
id | Order id,a unique identifier pertaining to the order |
symbol | Trading pair |
opType | Operation type: DEAL |
type | Order type |
side | Buy or sell |
price | Order price |
size | Order size |
dealSize | Number of filled transactions |
cancelledSize | Number of canceled transactions |
remainSize | Number of remain transactions |
funds | Order amount |
dealFunds | Number of filled funds |
cancelledFunds | Number of canceled funds |
remainFunds | Number of remain funds |
fee | Service fee |
feeCurrency | currency used to calculate fees |
stp | Self trade protection |
timeInForce | Time in force |
postOnly | Is it post only? |
hidden | Is it a hidden order? |
iceberg | Is it an iceberg order? |
visibleSize | Visible size of iceberg order in order book. |
cancelAfter | A GTT timeInForce that expires in n seconds |
channel | Source of orders |
clientOid | Identifier created by the client |
remark | Order description |
tags | Order identifier |
active | Order status: true -The status of the order isactive ; false -The status of the order isdone |
inOrderBook | Whether to enter the orderbook: true : enter the orderbook; false : not enter the orderbook |
cancelExist | Are there any cancellation records pertaining to the order? |
createdAt | order creation time |
lastUpdatedAt | Last update time of order |
tradeType | Trade type: TRADE (Spot Trading) |
Order Polling
For high-frequency trading users, we recommend locally caching, maintaining your own order records, and using market data streams to update your order information in real time.