Get Position Info

Query real-time position data, such as position size, cumulative realized PNL, etc.

info

UTA2.0(inverse)

1. You can query all open positions with /v5/position/list?category=inverse;
2. Cannot query multiple symbols in one request

UTA1.0(inverse) & Classic (inverse)

1. You can query all open positions with /v5/position/list?category=inverse;
2. symbol parameter can pass up to 10 symbols, e.g., symbol=BTCUSD,ETHUSD

HTTP Request

GET /v5/position/list

Request Parameters

Parameter	Required	Type	Comments
category	true	string	Product type UTA2.0, UTA1.0: linear, inverse, option Classic account: linear, inverse
symbol	false	string	Symbol name, like BTCUSDT, uppercase only If symbol passed, it returns data regardless of having position or not. If symbol=null and settleCoin specified, it returns position size greater than zero.
baseCoin	false	string	Base coin, uppercase only. option only. Return all option positions if not passed
settleCoin	false	string	Settle coin linear: either symbol or settleCoin is required. symbol has a higher priority
limit	false	integer	Limit for data size per page. [1, 200]. Default: 20
cursor	false	string	Cursor. Use the nextPageCursor token from the response to retrieve the next page of the result set

Response Parameters

Parameter	Type	Comments
category	string	Product type
nextPageCursor	string	Refer to the cursor request parameter
list	array	Object
> positionIdx	integer	Position idx, used to identify positions in different position modes 0: One-Way Mode 1: Buy side of both side mode 2: Sell side of both side mode
> riskId	integer	Risk tier ID for portfolio margin mode, this field returns 0, which means risk limit rules are invalid
> riskLimitValue	string	Risk limit value for portfolio margin mode, this field returns 0, which means risk limit rules are invalid
> symbol	string	Symbol name
> side	string	Position side. Buy: long, Sell: short one-way mode: classic & UTA1.0(inverse), an empty position returns None. UTA2.0(linear, inverse) & UTA1.0(linear): either one-way or hedge mode returns an empty string "" for an empty position.
> size	string	Position size, always positive
> avgPrice	string	Average entry price For USDC Perp & Futures, it indicates average entry price, and it will not be changed with 8-hour session settlement
> positionValue	string	Position value
> tradeMode	integer	Trade mode Classic & UTA1.0(inverse): 0: cross-margin, 1: isolated margin UTA2.0, UTA1.0(execpt inverse): deprecated, always 0, check Get Account Info to know the margin mode
> autoAddMargin	integer	Whether to add margin automatically when using isolated margin mode 0: false 1: true
> positionStatus	String	Position status. Normal, Liq, Adl
> leverage	string	Position leverage for portfolio margin mode, this field returns "", which means leverage rules are invalid
> markPrice	string	Mark price
> liqPrice	string	Position liquidation price UTA2.0(isolated margin), UTA1.0(isolated margin), UTA1.0(inverse), Classic account: it is the real price for isolated and cross positions, and keeps "" when liqPrice <= minPrice or liqPrice >= maxPrice UTA2.0(Cross margin), UTA1.0(Cross margin): it is an estimated price for cross positions(because the unified mode controls the risk rate according to the account), and keeps "" when liqPrice <= minPrice or liqPrice >= maxPrice this field is empty for Portfolio Margin Mode, and no liquidation price will be provided
> bustPrice	string	Bankruptcy price: Only applicable to the classic account
> positionIM	string	Initial margin Classic & UTA1.0(inverse): ignore this field UTA portfolio margin mode, it returns ""
> positionIMByMp	string	Initial margin calculated by mark price Classic & UTA1.0(inverse) : ignore this field UTA portfolio margin mode, it returns ""
> positionMM	string	Maintenance margin Classic & UTA1.0(inverse): ignore this field UTA portfolio margin mode, it returns ""
> positionMMByMp	string	Maintenance margin calculated by mark price Classic & UTA1.0(inverse) : ignore this field UTA portfolio margin mode, it returns ""
> positionBalance	string	Position margin Classic & UTA1.0(inverse) can refer to this field to get the position initial margin plus position closing fee
> takeProfit	string	Take profit price
> stopLoss	string	Stop loss price
> trailingStop	string	Trailing stop (The distance from market price)
> sessionAvgPrice	string	USDC contract session avg price, it is the same figure as avg entry price shown in the web UI
> delta	string	Delta
> gamma	string	Gamma
> vega	string	Vega
> theta	string	Theta
> unrealisedPnl	string	Unrealised PnL
> curRealisedPnl	string	The realised PnL for the current holding position
> cumRealisedPnl	string	Cumulative realised pnl Futures & Perps: it is the all time cumulative realised P&L Option: always "", meaningless
> adlRankIndicator	integer	Auto-deleverage rank indicator. What is Auto-Deleveraging?
> createdTime	string	Timestamp of the first time a position was created on this symbol (ms)
> updatedTime	string	Position updated timestamp (ms)
> seq	long	Cross sequence, used to associate each fill and each position update Different symbols may have the same seq, please use seq + symbol to check unique Returns "-1" if the symbol has never been traded Returns the seq updated by the last transaction when there are settings like leverage, risk limit
> isReduceOnly	boolean	Useful when Bybit lower the risk limit true: Only allowed to reduce the position. You can consider a series of measures, e.g., lower the risk limit, decrease leverage or reduce the position, add margin, or cancel orders, after these operations, you can call confirm new risk limit endpoint to check if your position can be removed the reduceOnly mark false: There is no restriction, and it means your position is under the risk when the risk limit is systematically adjusted Only meaningful for isolated margin & cross margin of USDT Perp, USDC Perp, USDC Futures, Inverse Perp and Inverse Futures, meaningless for others
> mmrSysUpdatedTime	string	Useful when Bybit lower the risk limit When isReduceOnly=true: the timestamp (ms) when the MMR will be forcibly adjusted by the system When isReduceOnly=false: the timestamp when the MMR had been adjusted by system It returns the timestamp when the system operates, and if you manually operate, there is no timestamp Keeps "" by default, if there was a lower risk limit system adjustment previously, it shows that system operation timestamp Only meaningful for isolated margin & cross margin of USDT Perp, USDC Perp, USDC Futures, Inverse Perp and Inverse Futures, meaningless for others
> leverageSysUpdatedTime	string	Useful when Bybit lower the risk limit When isReduceOnly=true: the timestamp (ms) when the leverage will be forcibly adjusted by the system When isReduceOnly=false: the timestamp when the leverage had been adjusted by system It returns the timestamp when the system operates, and if you manually operate, there is no timestamp Keeps "" by default, if there was a lower risk limit system adjustment previously, it shows that system operation timestamp Only meaningful for isolated margin & cross margin of USDT Perp, USDC Perp, USDC Futures, Inverse Perp and Inverse Futures, meaningless for others
> tpslMode	string	deprecated, always "Full"

---

Request Example

HTTP

GET /v5/position/list?category=inverse&symbol=BTCUSD HTTP/1.1
Host: api-testnet.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx
X-BAPI-TIMESTAMP: 1672280218882
X-BAPI-RECV-WINDOW: 5000

Python

from pybit.unified_trading import HTTP
session = HTTP(
    testnet=True,
    api_key="xxxxxxxxxxxxxxxxxx",
    api_secret="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
)
print(session.get_positions(
    category="inverse",
    symbol="BTCUSD",
))

Java

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);

Node.js

const { RestClientV5 } = require('bybit-api');

const client = new RestClientV5({
    testnet: true,
    key: 'xxxxxxxxxxxxxxxxxx',
    secret: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
});

client
    .getPositionInfo({
        category: 'inverse',
        symbol: 'BTCUSD',
    })
    .then((response) => {
        console.log(response);
    })
    .catch((error) => {
        console.error(error);
    });

Response Example

{
    "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",
                "positionMMByMp": "0.0000015",
                "positionIM": "0.00010923",
                "positionIMByMp": "0.00010923",
                "tpslMode": "Full",
                "takeProfit": "0.00",
                "stopLoss": "0.00",
                "trailingStop": "0.00",
                "unrealisedPnl": "-0.00029413",
                "curRealisedPnl": "0.00013123",
                "cumRealisedPnl": "-0.00096902",
                "seq": 5723621632,
                "isReduceOnly": false,
                "mmrSysUpdateTime": "",
                "leverageSysUpdatedTime": "",
                "sessionAvgPrice": "",
                "createdTime": "1676538056258",
                "updatedTime": "1697673600012"
            }
        ],
        "nextPageCursor": "",
        "category": "inverse"
    },
    "retExtInfo": {},
    "time": 1697684980172
}