Skip to main content

Get Position Info

API ker permission: Earn
API rate limit: 10 reqs / sec

info
  • Only active positions are returned. Settled positions (status REVENUE_DISTRIBUTED) are excluded.
  • All filters are optional — omit them to return all active positions.

HTTP Request

GET/v5/earn/fixed-term/position

Request Parameters

ParameterRequiredTypeComments
productIdfalsestringFilter by product ID
categoryfalsestringFilter by product sub-type: FixedTermSaving, FundPool, FundPoolPremium
coinfalsestringFilter by coin, e.g. BTC, ETH

Response Parameters

ParameterTypeComments
listarrayPosition list
> positionIdstringPosition ID
> productIdstringProduct ID
> categorystringProduct sub-type: FixedTermSaving, FundPool, FundPoolPremium
> coinstringStaking coin
> amountstringPosition amount
> effectiveAmountstringEffective amount earning interest (takes effect T+1)
> durationstringFixed term duration, e.g. 1d, 8h, 2m
> statusstringPosition status: Active, EarlyRedemptionProcessing
> settlementTimestringMaturity time, unix timestamp in ms
> createdAtstringPosition creation time, unix timestamp in ms
> orderIdstringAssociated order ID
> earlyRedeemInfoobjectEarly redemption info
>> allowEarlyRedeembooleanWhether early redemption is available
>> earlyRedeemEarningstringEstimated earnings if redeemed early now
>> returnCoinstringCoin returned upon redemption
>> redemptionLimitDurationstringMinimum hold time required before early redemption, e.g. 1d, 8h, 2m
> allowAutoReinvestbooleanWhether the product supports auto-reinvest
> autoReinveststringUser's current auto-reinvest setting: Enable, Disable
> interestCoinApyListarrayMulti-coin reward APY list
>> coinstringReward coin
>> apystringReward APY
>> expectReturnEarningstringExpected earnings for this position
>> pricestringLocked price of the reward coin

Request Example

GET /v5/earn/fixed-term/position?category=FixedTermSaving HTTP/1.1
Host: api.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": {
"list": [
{
"positionId": "4064",
"productId": "724",
"category": "FixedTermSaving",
"coin": "USDT",
"amount": "201",
"effectiveAmount": "201",
"duration": "3d",
"status": "Active",
"settlementTime": "1776385800000",
"createdAt": "1776068177000",
"orderId": "86468516-5497-4a2b-8c4c-f9c58e01e12c",
"earlyRedeemInfo": null,
"allowAutoReinvest": false,
"autoReinvest": "Disable",
"interestCoinApyList": [
{
"coin": "USDT",
"apy": "555.00%",
"expectReturnEarning": "9.1689",
"price": "1.00"
}
]
}
]
},
"retExtInfo": {},
"time": 1776070463687
}