Skip to main content

Get Hourly Yield History

info

API key needs "Earn" permission

HTTP Request

GET /v5/earn/hourly-yield

Request Parameters

ParameterRequiredTypeComments
categorytruestringFlexibleSaving
productIdfalsestringProduct ID
startTimefalseintegerThe start timestamp (ms).
  • 1. If both are not provided, the default is to return data from the last 7 days.
  • 2. If both are provided, the difference between the endTime and startTime must be less than or equal to 7 days.
endTimefalseintegerThe endTime timestamp (ms)
limitfalseintegerLimit for data size per page. Range: [1, 100]. Default: 50
cursorfalsestringCursor, use the returned nextPageCursor to query data for the next page.

Response Parameters

ParameterTypeComments
nextPageCursorstringRefer to the cursor request parameter
listarrayObject
> productIdstringProduct ID
> coinstringCoin name:"BTC", "ETH"
> idstringUnique key (guaranteed to be unique only under the same user)
> amountstringYield Amount.Example: 10
> effectiveStakingAmountstringEffective staking amount, e.g., 1000.00
> statusstringOrder status: Pending, Success, Fail
> hourlyDatestringHourly yield time(ms) eg: 1755478800000
> createdAtstringOrder creation time in milliseconds, e.g., 1684738540561

Request Example

GET /v5/earn/hourly-yield?category=FlexibleSaving HTTP/1.1
Host: api-testnet.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx
X-BAPI-TIMESTAMP: 1739937044221
X-BAPI-RECV-WINDOW: 5000
Content-Type: application/json

Response Example

{
"retCode": 0,
"retMsg": "",
"result": {
"list": [
{
"productId": "428",
"coin": "USDT",
"amount": "0.060810502283105022",
"effectiveStakingAmount": "1000",
"hourlyDate": "1759989600000",
"status": "Success",
"createdAt": "1759989603000"
}
],
"nextPageCursor": ""
},
"retExtInfo": {},
"time": 1759993045287
}