Skip to main content

Get Order Info

info
  • Requires Earn permission on the API key.

HTTP Request

GET/v5/earn/advance/order

Request Parameters

ParameterRequiredTypeComments
categorytruestringProduct category. DoubleWin
productIdfalsestringFilter by product ID
orderIdfalsestringFilter by order ID
orderLinkIdfalsestringFilter by user customised order ID
startTimefalsestringStart time (order creation time), Unix timestamp in ms
endTimefalsestringEnd time, Unix timestamp in ms
limitfalseintNumber of items per page. Default: 20, Max: 20
cursorfalsestringPagination cursor. Use nextPageCursor from previous response

Response Parameters

ParameterTypeComments
categorystringProduct category. DoubleWin
nextPageCursorstringNext page cursor. Empty string if no more data
listarrayObject
> orderIdstringOrder ID
> orderLinkIdstringUser customised order ID
> productIdstringProduct ID
> categorystringProduct category
> orderTypestringStake: subscribe; Redeem: early redemption
> investCoinstringInvestment coin, e.g. USDT
> amountstringOrder amount
> underlyingAssetstringUnderlying asset, e.g. BTC, ETH
> leveragestringLeverage multiplier
> initialPricestringUnderlying asset index price at order time
> lowerPricestringLower bound of the price range
> upperPricestringUpper bound of the price range
> durationstringProduct term, e.g. 1d, 3d
> settlementTimestringSettlement time, Unix timestamp in ms
> createdTimestringOrder creation time, Unix timestamp in ms
> updatedTimestringOrder last updated time, Unix timestamp in ms
> statusstringPending: confirming; Success: order successful, position created; Settled: settled (on expiry or early redemption); Fail: order failed
> settlementPricestringSettlement price. Only available when status=Settled
> pnlstringProfit and loss amount. Only available when status=Settled
> refundStatusstringRefund status. Only valid when status=Fail: Processing (refund in progress), Processed (refund completed)
> accountTypestringStaking account: FUND or UNIFIED
> toAccountTypestringAccount that receives the settlement. Only available when status=Settled or status=Fail

Request Example

GET /v5/earn/advance/order?category=DoubleWin&orderId=97f198e9-b14b-4703-b4a6-a4aa06ba1499 HTTP/1.1
Host: api-testnet.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx
X-BAPI-TIMESTAMP: 1672280218882
X-BAPI-RECV-WINDOW: 5000

Response Example

{
"retCode": 0,
"retMsg": "",
"result": {
"category": "DoubleWin",
"list": [
{
"orderId": "05184c23-8a98-456c-a2af-0ef1c45116cc",
"orderLinkId": "usdt-earn-009",
"productId": "14084",
"category": "DoubleWin",
"orderType": "Stake",
"investCoin": "USDT",
"amount": "150",
"underlyingAsset": "BTC",
"initialPrice": "66445.69",
"lowerPrice": "66245.69",
"upperPrice": "66645.69",
"leverage": "9.3309793178843419",
"settlementTime": "1775203200000",
"duration": "1d",
"createdTime": "1775107011000",
"updatedTime": "1775107011000",
"status": "Success",
"settlementPrice": "",
"pnl": "",
"refundStatus": "",
"accountType": "FUND",
"toAccountType": ""
}
],
"nextPageCursor": ""
},
"retExtInfo": {},
"time": 1775107200953
}