跳至主要内容

查詢持倉 (實時)

該接口可以獲取用戶的持倉信息,比如持倉數量,累計盈虧等

信息

交易帳戶2.0 - 查詢反向合約倉位

  1. 通過這種查詢方式 "/v3/position/list?category=inverse", 可以獲得所有持倉數據
  2. 不支持傳入多個symbol來查詢 關於反向合約的額外查詢規則

HTTP 請求

GET /cloud/trade/v3/position/list

請求參數

參數是否必需類型說明
categorytruestring產品類型
  • 交易帳戶:linear, inverse
  • 普通帳戶: linear, inverse. 這裡category字段不參與業務邏輯,僅做路由使用
symbolfalsestring合約名稱
  • 若傳了symbol, 則不管是否有倉位都返回該symbol數據
  • symbol不傳但傳了settleCoin, 則僅返回有實際倉位的數據
baseCoinfalsestring交易幣種.
settleCoinfalsestring結算幣種. 對於期貨而言,symbolsettleCon必傳其中一個, 若都傳,則symbol有更高的優先級
limitfalseinteger每頁數量限制. [1, 200]. 默認: 20
cursorfalsestring游標,用於翻頁

響應參數

參數類型說明
categorystring產品類型
listarrayObject
> positionIdxinteger倉位標識符, 用于在不同仓位模式下标识仓位
> riskIdinteger风险限额ID,參見風險限額接口.
> riskLimitValuestring當前風險限額ID對應的持倉限制量.
> symbolstring合約名称
> sidestring持倉方向, Buy: 多头; Sell: 空头.
  • 單向持倉: 經典帳戶, 空倉返回None.
  • 交易帳戶(linear): 空倉時, 單向或者雙向持倉模式都返回空字符串 "".
> sizestring當前倉位的合约數量
> avgPricestring當前倉位的平均入場價格
> positionValuestring仓位的價值
> tradeModeinteger交易模式。
  • 經典帳戶: 0 全倉保證金, 1 逐倉保證金
  • 交易帳戶(除了反向): 該字段無效, 總是 0,請通過接口查詢帳戶配置以獲取帳戶保證金模式
> positionStatusString倉位状态. Normal,Liq, Adl
> leveragestring當前倉位的槓桿,仅适用于合约.
> markPricestringsymbol 的最新標記價格
> liqPricestring倉位強平價格。
  • 對於交易帳戶(逐倉)、經典帳戶: 是逐倉和全倉持倉的真實價格;當強平價 <= minPrice 或者 強平價 >= maxPrice,則為 ""
  • 對於交易帳戶(全倉保證金): 請注意, 這是預計強平價格僅供參考。僅當帳戶維持保證金率達到100%時會觸發強平, 當強平價 <= minPrice或者 強平價 >= maxPrice, 則為 ""
對於組合保證金模式,此字段為空,不會提供強平價格
> bustPricestring倉位破產價格.
> positionIMstring倉位起始保證金。
  • 經典帳戶: 忽略該字段
  • 交易帳戶組合保證金模式(PM)下,該字段返回為空字符串
> positionMMstring倉位維持保證金。
  • 經典帳戶: 忽略該字段
  • 交易帳戶組合保證金模式(PM)下,該字段返回為空字符串
> tpslModestring該字段廢棄, 無意義, 總是返回"Full".
> positionBalancestring倉位保證金.
  • 經典帳戶可以根據這個字段了解倉位初始保證金 + 平倉手續費
> takeProfitstring止盈價格
> stopLossstring止損價格
> trailingStopstring追蹤止損(與當前價格的距離)
> unrealisedPnlstring未结盈亏
> cumRealisedPnlstring累计已结盈亏
> isReduceOnlyboolean僅當Zoomex需要降低某個Symbol的風險限額時有用。
  • true: 僅允許減倉操作。您可以考慮一系列的方式,比如,降低 risk limit 檔位,或者同檔位修改槓桿或減少倉位,或者增加保證金,或者撤單。這些操作做完後,可以主動調用「確認新的風險限額」接口
  • false(默認): 無交易限制,表示您的倉位在系統調整時處於風險水平之下
  • 僅對逐倉和全倉的期貨倉位有意義
> mmrSysUpdatedTimestring僅當Zoomex需要降低某個Symbol的風險限額時有用。
  • 當 isReduceOnly=true: 這個時間戳表示系統強制修改 MMR 的時間
  • 當 isReduceOnly=false: 若不為空,則表示系統已經完成了 MMR 調整的時間
  • 僅當系統調整才會賦值,對於主動的調整,不會在這裡展示時間戳
  • 默認為 "",但如果曾經這個 symbol 有過系統降檔的操作,那麼這裡會顯示上一次操作的時間
  • 僅對逐倉和全倉的期貨倉位有意義
> leverageSysUpdatedTimestring僅當Zoomex需要降低某個Symbol的風險限額時有用。
  • 當 isReduceOnly=true: 這個時間戳表示系統強制修改槓桿的時間
  • 當 isReduceOnly=false: 若不為空,則表示系統已經完成了槓桿調整的時間
  • 僅當系統調整才會賦值,對於主動的調整,不會在這裡展示時間戳
  • 默認為 "",但如果曾經這個 symbol 有過系統降檔的操作,那麼這裡會顯示上一次操作的時間
  • 僅對逐倉和全倉的期貨倉位有意義
> adlRankIndicatorinteger自動減倉燈. 什麼是自動減倉機制?
> createdTimestring倉位創建時間
> updatedTimestring倉位數據更新時間
nextPageCursorstring游標,用於翻頁

請求示例

GET /cloud/trade/v3/position/list?category=linear&symbol=XRPUSDT HTTP/1.1
Host: openapi-testnet.zoomex.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: XXXXX
X-BAPI-TIMESTAMP: 1672280218882
X-BAPI-RECV-WINDOW: 5000

響應示例

{
"retCode": 0,
"retMsg": "OK",
"result": {
"nextPageCursor": "updateAt%3D1672279322668",
"category": "linear",
"list": [
{
"symbol": "XRPUSDT",
"leverage": "10",
"avgPrice": "0.3615",
"liqPrice": "0.0001",
"riskLimitValue": "200000",
"takeProfit": "",
"positionValue": "36.15",
"tpslMode": "Full",
"riskId": 41,
"trailingStop": "0",
"unrealisedPnl": "-1.83",
"markPrice": "0.3432",
"cumRealisedPnl": "0.48805876",
"positionMM": "0.381021",
"createdTime": "1672121182216",
"positionIdx": 0,
"positionIM": "3.634521",
"updatedTime": "1672279322668",
"side": "Buy",
"bustPrice": "",
"size": "100",
"positionStatus": "Normal",
"stopLoss": "",
"tradeMode": 0,
"adlRankIndicator": 2
}
]
},
"retExtInfo": {},
"time": 1672280219169
}