Skip to main content

Get Position Info

info
  • Need authentication. Up to 10 requests per second per UID. Requires Earn permission on the API key.
  • Returns all active liquidity mining positions. Position amounts are dynamically calculated based on the current market price.

HTTP Request

GET/v5/earn/liquidity-mining/position

Request Parameters

ParameterRequiredTypeComments
productIdfalsestringFilter by product ID
baseCoinfalsestringFilter by base coin, e.g. BTC, ETH

Response Parameters

ParameterTypeComments
positionsarrayActive position list
> positionIdstringPosition ID
> productIdstringProduct ID
> baseCoinstringBase coin, e.g. BTC
> quoteCoinstringQuote coin, e.g. USDT
> quoteAmountstringCurrent quoteCoin balance in the position (dynamically calculated including leverage)
> baseAmountstringCurrent baseCoin balance in the position (dynamically calculated including leverage)
> principalQuoteAmountstringTotal quoteCoin principal invested (dynamically calculated)
> principalBaseAmountstringTotal baseCoin principal invested (dynamically calculated)
> principalLiquidityValuestringPrincipal liquidity value (quoted in quoteCoin, real-time)
> leveragedValuestringTotal leveraged position value (quoted in quoteCoin, real-time)
> loanstringBorrowed amount (in quoteCoin)
> claimableYieldstringCurrent claimable yield amount
> currentAprstringCurrent APR (real-time). Divide by 10^8 to get the actual rate
> leveragestringCurrent leverage multiplier
> marginstringCurrent margin amount
> liquidationPricestringLiquidation price (baseCoin price in quoteCoin terms)
> currentPriceYstringCurrent market price of baseCoin (real-time)
> statusstringPosition status: Active, Liquidating
> createdTimestringPosition creation time, unix timestamp in milliseconds

Request Example

GET /v5/earn/liquidity-mining/position?baseCoin=ETH HTTP/1.1
Host: api-testnet.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx
X-BAPI-TIMESTAMP: 1741651200000
X-BAPI-RECV-WINDOW: 5000

Response Example

{
"retCode": 0,
"retMsg": "",
"result": {
"positions": [
{
"positionId": "1498",
"productId": "5",
"baseCoin": "ETH",
"quoteCoin": "USDT",
"quoteAmount": "1637.7537",
"baseAmount": "0.80131605",
"principalQuoteAmount": "817.5297",
"principalBaseAmount": "0.39999891",
"principalLiquidityValue": "1635.0595",
"leveragedValue": "3275.5075",
"loan": "1640.448",
"claimableYield": "0",
"currentApr": "27856097",
"leverage": "2.003295552626342963",
"margin": "0",
"liquidationPrice": "538.272",
"currentPriceY": "2043.83",
"status": "Active",
"createdTime": "1775116860000"
}
]
},
"retExtInfo": {},
"time": 1775124245970
}