Skip to main content

Get Hourly Yield Records

HTTP Request​

GET/v5/earn/token/hourly-yield

Request Parameters​

ParameterRequiredTypeComments
cointruestringToken coin. Currently only BYUSDT is supported
startTimefalseintegerStart timestamp in seconds
endTimefalseintegerEnd timestamp in seconds
cursorfalsestringPagination cursor. Use nextPageCursor from the previous response
limitfalseintegerNumber of items per page. Default: 20

Response Parameters​

ParameterTypeComments
listarrayHourly yield record list
> effectiveAmountstringPrincipal amount used to calculate yield for this hour
> yieldstringYield amount for this hour
> rewardTypeintegerYield type: 0 = base yield, 1 = bonus yield
> aprE8stringActual APR applied for this hour in e8 precision. Divide by 10^8 to get the actual rate
> hourlyDatestringStart of the yield hour, unix timestamp in seconds
> createdTimestringRecord creation time, unix timestamp in seconds
nextPageCursorstringCursor for the next page. Empty string means no more data

Request Example​

GET /v5/earn/token/hourly-yield?coin=BYUSDT&limit=20 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": "success",
"result": {
"list": [
{
"effectiveAmount": "500.00",
"yield": "0.02",
"rewardType": 0,
"aprE8": "500000000",
"hourlyDate": "1710691200",
"createdTime": "1710694800"
}
],
"nextPageCursor": "eyJpZCI6MTIzNDU2fQ=="
},
"retExtInfo": {},
"time": 1741651200000
}