獲取訂單列表
此接口,可獲取訂單列表 返回值是分頁後的數據,根據時間降序排序。
HTTP請求
GET /api/v1/orders
請求示例
GET /api/v1/orders?status=active
GET /api/v1/orders?status=active?tradeType=MARGIN_ISOLATED_TRADE
{
"currentPage": 1,
"pageSize": 1,
"totalNum": 153408,
"totalPage": 153408,
"items": [
{
"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": "",
"stop": "",
"stopTriggered": false,
"stopPrice": "0",
"timeInForce": "GTC",
"postOnly": false,
"hidden": false,
"iceberg": false,
"visibleSize": "0",
"cancelAfter": 0,
"channel": "IOS",
"clientOid": "",
"remark": "",
"tags": "",
"isActive": false,
"cancelExist": false,
"createdAt": 1547026471000,
"tradeType": "TRADE"
}
]
}
API權限
此接口需要通用權限
請求URL
此接口支持現貨URL
頻率限制
現貨類權重
:2
TIP
這個接口需要使用分頁
請求參數
請求參數 | 類型 | 是否必須 | 含義 |
---|---|---|---|
status | String | 否 | active (活躍) 或 done (完成),默認爲done 。只返回指定狀態的訂單信息 |
symbol | String | 否 | 只返回指定交易對的訂單信息 |
side | String | 否 | buy (買)或 sell (賣) |
type | String | 否 | 訂單類型: limit (限價單), market (市價單), limit_stop (限價止盈止損單), market_stop (市價止盈止損單) |
tradeType | String | 否 | 交易類型: TRADE (現貨交易), MARGIN_TRADE (全倉槓桿交易), MARGIN_ISOLATED_TRADE (逐倉槓桿交易), 默認爲TRADE 。 |
startAt | long | 否 | 開始時間(毫秒) |
endAt | long | 否 | 截止時間(毫秒) |
返回值
字段 | 含義 |
---|---|
id | 訂單id,訂單唯一標識 |
symbol | 交易對 |
opType | 操作類型: DEAL |
type | 訂單類型 |
side | 買或賣 |
price | 訂單價格 |
size | 下單數量 |
funds | 下單金額 |
dealFunds | 成交額 |
dealSize | 成交數量 |
fee | 手續費 |
feeCurrency | 計手續費幣種 |
stp | 自成交保護 |
stop | 止盈止損類型, entry:止盈; loss:止損 |
stopTriggered | 是否觸發止盈止損 |
stopPrice | 止盈止損觸發價格 |
timeInForce | 訂單時效策略 |
postOnly | 是否爲被動委託 |
hidden | 是否爲隱藏單 |
iceberg | 是否爲冰山單 |
visibleSize | 冰山單在買賣盤可見數量 |
cancelAfter | timeInForce 爲 GTT n秒後過期 |
channel | 下單來源 |
clientOid | 客戶端生成的標識 |
remark | 訂單說明 |
tags | 訂單標籤 |
isActive | 訂單狀態 true: 訂單狀態爲 open; false: 訂單已成交或取消 |
cancelExist | 訂單是否存在取消記錄 |
createdAt | 創建時間 |
tradeType | 交易類型 |
訂單狀態和結算
在買賣盤上,所有委託都處於活躍(Active)狀態,從買賣盤上移除的訂單則被標記爲已完成(Done)狀態。
訂單被成交後到入賬,因系統清算可能會有毫秒級別的延遲。
您可發送請求,查詢任一狀態的訂單。如果您未指定狀態參數,系統將默認返回“已完結”(Done)狀態的訂單。
查詢“active”狀態的訂單,沒有時間限制。但查詢“已完成”狀態的訂單時,您只能獲取 7 * 24 小時時間範圍內的數據(即:查詢時,開始時間到結束時間的時間範圍不能超過24 * 7小時)。若超出時間範圍,系統會報錯。如果您只指定了結束時間,沒有指定開始時間,系統將按照 24小時的範圍自動計算開始時間(開始時間=結束時間-7*24小時)並返回相應數據,反之亦然。
已取消訂單的歷史記錄僅保留一個月。您將無法查詢一個月以前已取消的訂單。 已完成訂單的歷史記錄僅保留六個月。您將無法查詢六個月以前已完成的訂單。
TIP
檢索的總條目不能超過5萬條,如果超過,請縮短查詢時間範圍。
訂單輪詢(Polling)
對於高頻交易的用戶,建議您在本地緩存和維護一份自己的活動委託列表,並使用市場數據流實時更新自己的訂單信息。