Skip to main content

Get Yield Records

info
  • Need authentication. Up to 10 requests per second per UID. Requires Earn permission on the API key.
  • Returns yield claim history, including both manual claims and yields settled on removal.

HTTP Request

GET/v5/earn/liquidity-mining/yield-records

Request Parameters

ParameterRequiredTypeComments
baseCoinfalsestringFilter by base coin, e.g. BTC, ETH
quoteCoinfalsestringFilter by quote coin, e.g. USDT
startTimefalsestringStart time, unix timestamp in milliseconds
endTimefalsestringEnd time, unix timestamp in milliseconds
limitfalseintegerNumber of items per page. Default: 20, Max: 50
cursorfalsestringPagination cursor. Use nextPageCursor from the previous response

Response Parameters

ParameterTypeComments
recordsarrayYield record list
> coinstringYield coin received
> amountstringAmount received
> baseCoinstringBase coin of the pool, e.g. BTC
> quoteCoinstringQuote coin of the pool, e.g. USDT
> typestringClaim type: Manual (manually claimed), RemoveLiquidity (yield settled on removal)
> statusstringRecord status: Complete, Processing
> createdTimestringRecord creation time, unix timestamp in milliseconds
nextPageCursorstringCursor for next page. Empty string means no more data

Request Example

GET /v5/earn/liquidity-mining/yield-records?baseCoin=ETH HTTP/1.1
Host: api-testnet.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": {
"records": [
{
"coin": "USDT",
"amount": "0.0098",
"baseCoin": "ETH",
"quoteCoin": "USDT",
"type": "Manual",
"status": "Complete",
"createdTime": "1775125850000"
}
],
"nextPageCursor": ""
},
"retExtInfo": {},
"time": 1775126002035
}