查詢持倉 (實時)
該接口可以獲取用戶的持倉信息,比如持倉數量,累計盈虧等
統一帳戶覆蓋範圍: USDT永續 / USDC永續 / USDC交割 / 反向合約 / 期權
經典帳戶覆蓋範圍: USDT永續 / 反向合約
信息
關於反向合約的額外查詢規則,
- 通過這樣子查詢"/v5/position/list?category=inverse", 您可以查詢到所有當前持有的反向合約倉位;
symbol
字段支持傳入最多10個反向合約;
HTTP 請求
GET /v5/position/list
請求參數
參數 | 是否必需 | 類型 | 說明 |
---|---|---|---|
category | true | string | 產品類型
|
symbol | false | string | 合約名稱
|
baseCoin | false | string | 交易幣種. 僅option . 若不傳,則返回期權下所有持倉 |
settleCoin | false | string | 結算幣種. 對於USDT和USDC期貨而言,symbol 和settleCon 必傳其中一個, 若都傳,則symbol 有更高的優先級 |
limit | false | integer | 每頁數量限制. [1 , 200 ]. 默認: 20 |
cursor | false | string | 游標,用於翻頁 |
響應參數
參數 | 類型 | 說明 |
---|---|---|
category | string | 產品類型 |
list | array | Object |
> positionIdx | integer | 倉位標識符, 用于在不同仓位模式下标识仓位 |
> riskId | integer | 风险限额ID,參見風險限額接口. 注意:若賬戶為組合保證金模式(PM),該字段返回0,風險限額規則失效 |
> riskLimitValue | string | 當前風險限額ID對應的持倉限制量. 注意:若賬戶為組合保證金模式(PM),該字段返回"",風險限額規則失效 |
> symbol | string | 合約名称 |
> side | string | 持倉方向,Buy:多头;Sell:空头.
|
> size | string | 當前倉位的合约數量 |
> avgPrice | string | 當前倉位的平均入場價格 |
> positionValue | string | 仓位的價值 |
> tradeMode | integer | 交易模式。
|
> autoAddMargin | integer | 是否自動追加保證金. 0 : 否, 1 : 是. 僅當統一帳戶(除反向合約)開啟了帳戶維度的逐倉保證金模式, 該字段才有意義 |
> positionStatus | String | 倉位状态. Normal ,Liq , Adl |
> leverage | string | 當前倉位的槓桿,仅适用于合约. 注意:若賬戶為組合保證金模式(PM),該字段返回空字符串,槓桿規則失效 |
> markPrice | string | symbol 的最新標記價格 |
> liqPrice | string | 倉位強平價格,
|
> bustPrice | string | 倉位破產價格. 統一保證金模式返回"" , 無倉位破產價格 (不包括統一帳戶下的反向交易) |
> positionIM | string | 倉位起始保證金. 組合保證金模式(PM)下, 該字段返回為空字符串 |
> positionMM | string | 倉位維持保證金. 組合保證金模式(PM)下, 該字段返回為空字符串 |
> tpslMode | string | 該字段廢棄, 無意義, 總是返回"Full". 期權總是返回"" |
> positionBalance | string | 倉位保證金 |
> takeProfit | string | 止盈價格 |
> stopLoss | string | 止損價格 |
> trailingStop | string | 追蹤止損(與當前價格的距離) |
> sessionAvgPrice | string | USDC合約平均持倉價格, 會隨著8小時結算而變動 |
> delta | string | Delta, 期權的獨有字段 |
> gamma | string | Gamma, 期權的獨有字段 |
> vega | string | Vega, 期權的獨有字段 |
> theta | string | Theta, 期權的獨有字段 |
> unrealisedPnl | string | 未结盈亏 |
> curRealisedPnl | string | 當前持倉的已結盈虧 |
> cumRealisedPnl | string | 累计已结盈亏
|
> adlRankIndicator | integer | 自動減倉燈. 什麼是自動減倉機制? |
> isReduceOnly | boolean | 僅當Bybit需要降低某個Symbol的風險限額時有用
|
> mmrSysUpdatedTime | string | 僅當Bybit需要降低某個Symbol的風險限額時有用
false : 若不為空, 則表示系統已經完成了MMR調整的時間 |
> leverageSysUpdatedTime | string | 僅當Bybit需要降低某個Symbol的風險限額時有用
false : 若不為空, 則表示系統已經完成了槓桿調整的時間 |
> createdTime | string | 倉位創建時間 |
> updatedTime | string | 倉位數據更新時間 |
> seq | long | 序列號, 用於關聯成交和倉位的更新
|
nextPageCursor | string | 游標,用於翻頁 |
請求示例
- HTTP
- Python
- Java
- Node.js
GET /v5/position/list?category=linear&symbol=XRPUSDT HTTP/1.1
Host: api-testnet.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: XXXXX
X-BAPI-TIMESTAMP: 1672280218882
X-BAPI-RECV-WINDOW: 5000
from pybit.unified_trading import HTTP
session = HTTP(
testnet=True,
api_key="XXXXX",
api_secret="XXXXX",
)
print(session.get_positions(
category="linear",
symbol="XRPUSDT",
))
import com.bybit.api.client.domain.*;
import com.bybit.api.client.domain.position.*;
import com.bybit.api.client.domain.position.request.*;
import com.bybit.api.client.service.BybitApiClientFactory;
var client = BybitApiClientFactory.newInstance().newAsyncPositionRestClient();
var positionListRequest = PositionDataRequest.builder().category(CategoryType.LINEAR).symbol("BTCUSDT").build();
client.getPositionInfo(positionListRequest, System.out::println);
const { RestClientV5 } = require('bybit-api');
const client = new RestClientV5({
testnet: true,
key: 'apikey',
secret: 'apisecret',
});
client
.getPositionInfo({
category: 'inverse',
symbol: 'BTCUSD',
})
.then((response) => {
console.log(response);
})
.catch((error) => {
console.error(error);
});
響應示例
{
"retCode": 0,
"retMsg": "OK",
"result": {
"list": [
{
"positionIdx": 0,
"riskId": 1,
"riskLimitValue": "150",
"symbol": "BTCUSD",
"side": "Sell",
"size": "300",
"avgPrice": "27464.50441675",
"positionValue": "0.01092319",
"tradeMode": 0,
"positionStatus": "Normal",
"autoAddMargin": 1,
"adlRankIndicator": 2,
"leverage": "10",
"positionBalance": "0.00139186",
"markPrice": "28224.50",
"liqPrice": "",
"bustPrice": "999999.00",
"positionMM": "0.0000015",
"positionIM": "0.00010923",
"tpslMode": "Full",
"takeProfit": "0.00",
"stopLoss": "0.00",
"trailingStop": "0.00",
"unrealisedPnl": "-0.00029413",
"sessionAvgPrice": "",
"curRealisedPnl": "0.00013123",
"cumRealisedPnl": "-0.00096902",
"seq": 5723621632,
"isReduceOnly": false,
"mmrSysUpdateTime": "",
"leverageSysUpdatedTime": "",
"createdTime": "1676538056258",
"updatedTime": "1697673600012"
}
],
"nextPageCursor": "",
"category": "inverse"
},
"retExtInfo": {},
"time": 1697684980172
}