Skip to main content

My Position

Get real-time position data

HTTP Request

GET /contract/v3/private/position/list

Request Parameters

ParameterRequiredTypeComments
symbolfalsestringSymbol name
settleCoinfalsestringSettle coin. Either symbol or settleCoin is required. symbol has a higher priority

Response Parameters

ParameterTypeComments
categorystringProduct type
nextPageCursorstringCursor. Used to pagination
listarrayObject
> symbolstringSymbol name
> sidestringSide. Buy, Sell. Return None when zero position of one-way mode
> sizestringPosition size
> entryPricestringEntry price
> leveragestringleverage
> positionValuestringPosition value
> positionIdxintegerPosition index
> riskIdintegerRisk limit id
> riskLimitValuestringPosition limit value corresponding to the risk id
> tradeModeinteger0: cross margin mode. 1: isolated margin mode
> autoAddMargininteger0: false. 1: true
> positionBalancestringPosition margin
> liqPricestringEstimated liquidation price. It returns value only when minPrice < liqPrice < maxPrice
> bustPricestringEstimated bankruptcy price
> tpSlModestringDepreciated, meaningless here, always "Full"
> takeProfitstringTake profit price
> stopLossstringStop loss price
> createdTimestringPosition created timestamp (ms)
> updatedTimestringPosition data updated timestamp (ms)
> trailingStopstringTrailing stop
> activePricestringActivate price of trailing stop
> markPricestringReal-time mark price
> unrealisedPnlstringunrealised PNL
> cumRealisedPnlstringcumulative realised PNL
> positionMMstringPosition maintenance margin
> positionIMstringPosition initial margin
> positionStatusstringPosition status
> sessionAvgPricestringSettlement price
> occClosingFeestringPre-occupancy closing fee
> adlRankIndicatorintegerAuto-deleverage rank indicator. What is Auto-Deleveraging?
> isReduceOnlybooleanUseful 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
> mmrSysUpdatedTimestringUseful 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
> leverageSysUpdatedTimestringUseful 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

Request Example

GET /contract/v3/private/position/list?symbol=ETCUSDT HTTP/1.1
Host: api-testnet.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: XXXXX
X-BAPI-TIMESTAMP: 1673421074950
X-BAPI-RECV-WINDOW: 5000
Content-Type: application/json

Response Example

{
"retCode": 0,
"retMsg": "OK",
"result": {
"list": [
{
"positionIdx": 0,
"riskId": 236,
"symbol": "ETCUSDT",
"side": "None",
"size": "0.0",
"positionValue": "0",
"entryPrice": "0",
"tradeMode": 0,
"autoAddMargin": 0,
"leverage": "10",
"positionBalance": "0",
"liqPrice": "",
"bustPrice": "0.000",
"takeProfit": "0.000",
"stopLoss": "0.000",
"trailingStop": "0.000",
"unrealisedPnl": "0",
"createdTime": "1672986751942",
"updatedTime": "1675382400091",
"tpSlMode": "Full",
"riskLimitValue": "200000",
"activePrice": "0.000",
"markPrice": "15.126",
"cumRealisedPnl": "-10.69094915",
"positionMM": "0",
"positionIM": "0",
"positionStatus": "Normal",
"sessionAvgPrice": "0.000",
"occClosingFee": "0",
"avgPrice": "0",
"adlRankIndicator": 0,
"isReduceOnly": false,
"mmrSysUpdatedTime": "",
"leverageSysUpdatedTime": ""
}
],
"category": "",
"nextPageCursor": ""
},
"retExtInfo": {},
"time": 1697685149803
}