獲取訂單列表
{
"code": "200000",
"data": {
"currentPage": 1,
"pageSize": 100,
"totalNum": 1000,
"totalPage": 10,
"items": [
{
"id": "5cdfc138b21023a909e5ad55", //訂單編號
"symbol": "XBTUSDM", //合約編號
"type": "limit", //類型, 市價單或限價單
"side": "buy", //買賣方向
"price": "3600", //下單價格
"size": 20000, //數量
"value": "56.1167227833", //訂單價值
"dealValue": "56.1167227833", //成交額
"dealSize": 20000,//成交數量
"stp": "", //stp 類型
"stop": "", //止損訂單類型
"stopPriceType": "", //止損訂單觸發價格類型
"stopTriggered": true, //止損訂單是否觸發標誌
"stopPrice": null, //止損訂單觸發價格
"timeInForce": "GTC", //timeInForce類型
"postOnly": false, //postOnly標誌
"hidden": false, //隱藏單標誌
"iceberg": false, //冰山單標誌
"leverage": "20", //槓桿倍數
"forceHold": false, //強制凍結單標誌
"closeOrder": false, //平倉單標誌
"visibleSize": null, //冰山單可見數量
"clientOid": "5ce24c16b210233c36ee321d", //客戶訂單編號
"remark": null, //註解
"tags": null,//訂單標籤
"isActive": false, //未完成訂單標誌
"cancelExist": false, //訂單存在取消數量標誌
"createdAt": 1558167872000, //創建時間
"updatedAt": 1558167872000, //最新更新時間
"endAt": 1558167872000,//截止時間
"orderTime": 1558167872000000000, //下單時間納秒
"settleCurrency": "XBT", //結算幣種
"status": "done", //訂單狀態: “open” 或 “done”
"filledValue": "56.1167227833", //已經成交訂單價值
"filledSize": 20000, //已經成交訂單數量
"reduceOnly": false //只減倉標記
}
]
}
}
結果返回當前所有委託。
HTTP請求
GET /api/v1/orders
示例
GET /api/v1/orders?status=active
獲取所有活動訂單
API權限
此接口需要通用權限
請求URL
此接口支持合約URL
頻率限制
合约类权重
:2
參數
參數 | 數據類型 | 是否必須 | 含義 |
---|---|---|---|
status | String | 否 | 訂單狀態。活躍(active)狀態或已完成單(done)狀態。默認設置爲“已完成”狀態。請求發送成功後,僅返回指定狀態的委託列表。 |
symbol | String | 否 | 僅返回指定的委託列表,如:XBTUSDM。 |
side | String | 否 | buy 或 sell |
type | String | 否 | 訂單類型,包括:限價單、市價單、限價止損、市價止損。limit, market, limit_stop or market_stop |
startAt | long | 否 | 開始時間(毫秒) |
endAt | long | 否 | 截止時間(毫秒) |
currentPage | long | 否 | 頁數,不傳默認1 |
pageSize | long | 否 | 頁碼,不傳默認50,最大不能超過1000 |
返回值
參數 | 含義 |
---|---|
id | 訂單編號 |
symbol | 合約編號 |
type | 類型, 市價單或限價單 |
side | 買賣方向 |
price | 下單價格 |
size | 數量 |
value | 訂單價值 |
dealValue | 成交額 |
dealSize | 成交數量 |
stp | stp 類型 |
stop | 止損訂單類型 |
stopPriceType | 止損訂單觸發價格類型 |
stopTriggered | 止損訂單是否觸發標誌 |
stopPrice | 止損訂單觸發價格 |
timeInForce | timeInForce類型 |
postOnly | postOnly標誌 |
hidden | 隱藏單標誌 |
iceberg | 冰山單標誌 |
leverage | 槓桿倍數 |
forceHold | 強制凍結單標誌 |
closeOrder | 平倉單標誌 |
visibleSize | 冰山單可見數量 |
clientOid | 客戶訂單編號 |
remark | 註解 |
tags | 訂單標籤 |
isActive | 未完成訂單標誌 |
cancelExist | 訂單存在取消數量標誌 |
createdAt | 創建時間 |
updatedAt | 最新更新時間 |
endAt | 截止時間 |
orderTime | 下單時間納秒 |
settleCurrency | 結算幣種 |
status | 訂單狀態: “open” 或 “done” |
filledSize | 已經成交訂單價值 |
filledValue | 已經成交訂單數量 |
reduceOnly | 只減倉標記 |
請求返回數據使用了Pagination分頁方式。
訂單狀態和結算
在買賣盤上,所有限價委託都處於活躍(Active)狀態,從買賣盤上移除的訂單則被標記爲已完成(Done)狀態。訂單被成交後到入賬,因系統清算可能會有毫秒級別的延遲。
您可發送請求,查詢任一狀態的訂單。如果您未指定狀態參數,系統將默認返回“已完結”(Done)狀態的訂單。
查詢“活躍”狀態的訂單,沒有時間限制。但查詢“已完成”狀態的訂單時,您只能獲取 7 * 24 小時時間範圍內的數據(即:查詢時,開始時間到結束時間的時間範圍不能超過24 * 7小時)。若超出時間範圍,系統會報錯。如果您只指定了結束時間,沒有指定開始時間,系統將按照 24小時的範圍自動計算開始時間(開始時間=結束時間-24小時)並返回相應數據,反之亦然。
POLLING 輪詢
對於高頻交易的用戶,建議您在本地緩存和維護一份自己的活動委託列表,並使用市場數據流實時更新自己的訂單信息。
如果需要低延時獲取自己的最近成交歷史訂單記錄, 請使用“24小時內完成訂單列表”小節中的接口(Get List of Orders Completed in 24H)。 此接口返回的歷史訂單可能存在一定的延遲。