Skip to main content

Get Order List

API ker permission: Earn
API rate limit: 10 reqs / sec

info
  • Pass orderId alone to retrieve a single order. Omit to query the full order list with optional filters.
  • For Stake orders, startTime/endTime filters on order creation time. For Redeem orders, filters are applied on settlement time.
  • When productId is passed, category is required.

HTTP Request

GET/v5/earn/fixed-term/order

Request Parameters

ParameterRequiredTypeComments
orderTypefalsestringFilter by order type: Stake, Redeem, Reinvest. Returns all types if omitted
productIdfalsestringFilter by product ID. Requires category when passed
categoryfalsestringProduct sub-type: FixedTermSaving, FundPool, FundPoolPremium. Required when productId is passed
orderIdfalsestringSystem order ID for single order lookup
startTimefalseintegerStart timestamp in ms
endTimefalseintegerEnd timestamp in ms
limitfalseintegerNumber of items per page. Default: 20, Max: 50
cursorfalsestringPagination cursor. Use nextPageCursor from the previous response

Response Parameters

ParameterTypeComments
listarrayOrder list
> orderIdstringSystem-generated order ID
> orderLinkIdstringUser-customised idempotent ID
> orderTypestringOrder type: Stake, Redeem, Reinvest
> statusstringOrder status: Processing, Active, Complete, Failed
> productIdstringProduct ID
> categorystringProduct sub-type: FixedTermSaving, FundPool, FundPoolPremium
> coinstringCoin
> amountstringOrder amount
> durationstringFixed term duration, e.g. 1d, 8h, 2m
> accountTypestringAccount type: FUND, UNIFIED. Redeem orders always show FUND
> settlementTimestringSettlement time, unix timestamp in ms
> createdAtstringOrder creation time, unix timestamp in ms
> yieldInfoListarrayYield info list. Populated after settlement
>> coinstringYield coin
>> amountstringYield amount
>> statusstringYield status: Pending, Distributed, Fail, ReinvestSuccess
>> createdAtstringYield record creation time, unix timestamp in ms
>> apystringAPY applied for this yield
nextPageCursorstringCursor for the next page. Empty string means no more data

Request Example

GET /v5/earn/fixed-term/order?productId=546&category=FixedTermSaving 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": {
"list": [
{
"orderId": "6f2530d6-46b9-41f9-880a-4addbd152398",
"orderLinkId": "",
"orderType": "Redeem",
"status": "Complete",
"productId": "546",
"category": "FixedTermSaving",
"coin": "USDT",
"amount": "100.056",
"duration": "1d",
"accountType": "UNIFIED",
"settlementTime": "1750811400000",
"createdAt": "1750648976000",
"yieldInfoList": [
{
"coin": "USDT",
"amount": "0.0063",
"status": "Distributed",
"createdAt": "1750811401000",
"apy": "2.33%"
}
]
}
],
"nextPageCursor": ""
},
"retExtInfo": {},
"time": 1776070828622
}