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/positionRequest Parameters
| Parameter | Required | Type | Comments |
|---|---|---|---|
| productId | false | string | Filter by product ID |
| category | false | string | Filter by product sub-type: FixedTermSaving, FundPool, FundPoolPremium |
| coin | false | string | Filter by coin, e.g. BTC, ETH |
Response Parameters
| Parameter | Type | Comments |
|---|---|---|
| list | array | Position list |
| > positionId | string | Position ID |
| > productId | string | Product ID |
| > category | string | Product sub-type: FixedTermSaving, FundPool, FundPoolPremium |
| > coin | string | Staking coin |
| > amount | string | Position amount |
| > effectiveAmount | string | Effective amount earning interest (takes effect T+1) |
| > duration | string | Fixed term duration, e.g. 1d, 8h, 2m |
| > status | string | Position status: Active, EarlyRedemptionProcessing |
| > settlementTime | string | Maturity time, unix timestamp in ms |
| > createdAt | string | Position creation time, unix timestamp in ms |
| > orderId | string | Associated order ID |
| > earlyRedeemInfo | object | Early redemption info |
| >> allowEarlyRedeem | boolean | Whether early redemption is available |
| >> earlyRedeemEarning | string | Estimated earnings if redeemed early now |
| >> returnCoin | string | Coin returned upon redemption |
| >> redemptionLimitDuration | string | Minimum hold time required before early redemption, e.g. 1d, 8h, 2m |
| > allowAutoReinvest | boolean | Whether the product supports auto-reinvest |
| > autoReinvest | string | User's current auto-reinvest setting: Enable, Disable |
| > interestCoinApyList | array | Multi-coin reward APY list |
| >> coin | string | Reward coin |
| >> apy | string | Reward APY |
| >> expectReturnEarning | string | Expected earnings for this position |
| >> price | string | Locked 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
}