Skip to main content

Get Position Info

HTTP Request

GET/v5/earn/token/position

Request Parameters

ParameterRequiredTypeComments
cointruestringToken coin. Currently only BYUSDT is supported

Response Parameters

ParameterTypeComments
totalAmountstringTotal byUSDT holdings
totalYieldstringCumulative total yield earned
yesterdayYieldstringYesterday's yield
aprE8integerBase APR in e8 precision. Divide by 10^8 to get the actual rate
bonusAprE8integerBonus APR in e8 precision (returned when user is eligible). Divide by 10^8 to get the actual rate
bonusMaxAmountstringMaximum principal eligible for bonus APR
hasQuotabooleanWhether there is remaining mintable quota

Request Example

GET /v5/earn/token/position?coin=BYUSDT 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": {
"totalAmount": "696",
"totalYield": "0",
"yesterdayYield": "0",
"aprE8": "60000000",
"bonusAprE8": "0",
"bonusMaxAmount": "",
"hasQuota": true
},
"retExtInfo": {},
"time": 1775180113373
}