獲取訂單列表

HTTP請求

GET /api/v1/orders

示例

GET /api/v1/orders?status=active 獲取所有活動的訂單

{
  "data" : {
    "totalNum" : 1,
    "currentPage" : 1,
    "pageSize" : 50,
    "totalPage" : 1,
    "items" : [
      {
        "updatedAt" : 1716819743503,
        "timeInForce" : "GTC",
        "id" : "184576812976783360",
        "symbol" : "XBTUSDTM",
        "stp" : "",
        "stopTriggered" : false,
        "remark" : null,
        "filledValue" : "138.374",
        "clientOid" : "10a27086-d6fb-4068-9037-5bc2b6b1a6a8",
        "forceHold" : false,
        "dealSize" : 2,
        "endAt" : 1716819743503,
        "dealValue" : "138.374",
        "hidden" : false,
        "reduceOnly" : false,
        "cancelExist" : false,
        "settleCurrency" : "USDT",
        "type" : "market",
        "value" : "138.3442",
        "closeOrder" : false,
        "stop" : "",
        "createdAt" : 1716819743485,
        "isActive" : false,
        "status" : "done",
        "price" : "0",
        "stopPriceType" : "",
        "leverage" : "4",
        "tags" : "",
        "size" : 2,
        "visibleSize" : 0,
        "stopPrice" : null,
        "postOnly" : false,
        "orderTime" : 1716819743485399462,
        "iceberg" : false,
        "side" : "buy",
        "filledSize" : 2,
		"marginMode": "ISOLATED" // 新增保证金模式:ISOLATED-逐倉,CROSS-全倉
      }
    ]
  },
  "code" : "200000"
}
API權限

此接口需要通用權限

請求URL

此接口支持合約URL

頻率限制

合约类权重:2

參數
參數 數據類型 是否必須 含義
status String 訂單狀態。活躍(active)狀態或已完成單(done)狀態。默認設置爲“已完成”狀態。請求發送成功後,僅返回指定狀態的委託列表。
symbol String 僅返回指定的委託列表,如:XBTUSDM。
side String buysell
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 只減倉標記
avgDealPrice 成交均價,正向合約成交均價 = sum(成交價值)/ sum(成交數量),反向合約成交均價 = sum(成交數量) / sum(成交價值)。 成交數量 = 張數 * 乘數
marginMode 保证金模式:ISOLATED-逐倉,CROSS-全倉

請求返回數據使用了Pagination分頁方式。

訂單狀態和結算

在買賣盤上,所有限價委託都處於活躍(Active)狀態,從買賣盤上移除的訂單則被標記爲已完成(Done)狀態。訂單被成交後到入賬,因系統清算可能會有毫秒級別的延遲。

您可發送請求,查詢任一狀態的訂單。如果您未指定狀態參數,系統將默認返回“已完結”(Done)狀態的訂單。

查詢“活躍”狀態的訂單,沒有時間限制。但查詢“已完成”狀態的訂單時,您只能獲取 7 * 24 小時時間範圍內的數據(即:查詢時,開始時間到結束時間的時間範圍不能超過24 * 7小時)。若超出時間範圍,系統會報錯。如果您只指定了結束時間,沒有指定開始時間,系統將按照 24小時的範圍自動計算開始時間(開始時間=結束時間-24小時)並返回相應數據,反之亦然。

POLLING 輪詢

對於高頻交易的用戶,建議您在本地緩存和維護一份自己的活動委託列表,並使用市場數據流實時更新自己的訂單信息。

如果需要低延時獲取自己的最近成交歷史訂單記錄, 請使用“24小時內完成訂單列表”小節中的接口(Get List of Orders Completed in 24H)。 此接口返回的歷史訂單可能存在一定的延遲。