Get Stake/Redeem Order History

info

API key needs "Earn" permission

HTTP Request

GET /v5/earn/order

Request Parameters

Parameter	Required	Type	Comments
category	true	string	FlexibleSaving Remarks: currently, only flexible savings is supported
orderId	false	string	Order ID either orderId or orderLinkId is required if both are passed, make sure they're matched, otherwise returning empty result
orderLinkId	false	string	Order link ID Remarks: Always return the latest one if order link id is ever reused when querying by orderLinkId only

Response Parameters

Parameter	Type	Comments
list	array	Object
> coin	string	Coin name
> orderValue	string	amount
> orderType	string	Redeem, Stake
> orderId	string	Order ID
> orderLinkId	string	Order link ID
> status	string	Order status Success, Fail, Pending
> createdAt	string	Order created time, in milliseconds
> productId	string	Product ID
> updatedAt	string	Order updated time, in milliseconds

Request Example

HTTP

GET /v5/earn/order?orderId=0572b030-6a0b-423f-88c4-b6ce31c0c82d&category=FlexibleSaving HTTP/1.1
Host: api-testnet.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: XXXXX
X-BAPI-TIMESTAMP: 1739937044221
X-BAPI-RECV-WINDOW: 5000
Content-Type: application/json

Python

from pybit.unified_trading import HTTP
session = HTTP(
    testnet=True,
    api_key="XXXXX",
    api_secret="XXXXX",
)
print(session.get_stake_or_redemption_history(
    category="FlexibleSaving",
    orderId="0572b030-6a0b-423f-88c4-b6ce31c0c82d",
))

Node.js

Response Example

{
    "retCode": 0,
    "retMsg": "",
    "result": {
        "list": [
            {
                "coin": "BTC",
                "orderValue": "0.35",
                "orderType": "Redeem",
                "orderId": "0572b030-6a0b-423f-88c4-b6ce31c0c82d",
                "orderLinkId": "btc-earn-001",
                "status": "Success",
                "createdAt": "1739936607000",
                "productId": "430",
                "updatedAt": "1739936607000"
            }
        ]
    },
    "retExtInfo": {},
    "time": 1739937045520
}