Skip to main content

Get Order Info

info
  • Need authentication. Up to 10 requests per second per UID. Requires Earn permission on the API key.
  • Pass orderId or orderLinkId alone to retrieve a single order. Omit both to query the order list with optional filters.

HTTP Request

GET/v5/earn/liquidity-mining/order

Request Parameters

ParameterRequiredTypeComments
orderIdfalsestringOrder ID. Pass to retrieve a single order (mutually exclusive with orderLinkId for exact lookup)
orderLinkIdfalsestringUser-customised order ID. Pass to retrieve a single order
productIdfalsestringFilter by product ID
orderTypefalsestringFilter by order type: AddLiquidity, RemoveLiquidity, Reinvest, AddMargin
startTimefalsestringStart time (order creation time), unix timestamp in milliseconds
endTimefalsestringEnd time, unix timestamp in milliseconds
statusfalsestringFilter by status: Success, Processing. Returns all terminal statuses if not specified
limitfalseintegerNumber of items per page. Default: 20, Max: 50
cursorfalsestringPagination cursor. Use nextPageCursor from the previous response

Response Parameters

ParameterTypeComments
ordersarrayOrder list
> orderIdstringOrder ID
> orderLinkIdstringUser-customised order ID
> productIdstringProduct ID
> orderTypestringOrder type: AddLiquidity, RemoveLiquidity, Reinvest, AddMargin
> baseCoinstringBase coin
> quoteCoinstringQuote coin
> quoteAmountstringquoteCoin amount
> baseAmountstringbaseCoin amount
> statusstringOrder status: Success, Processing, Fail
> removeTypestringWithdrawal mode (only for RemoveLiquidity): Normal, SingleQuoteCoin, SingleBaseCoin
> removeRateintegerWithdrawal percentage, integer (only for RemoveLiquidity)
> leveragestringLeverage multiplier at order time (only for AddLiquidity)
> slippageValuestringSlippage deduction amount (only for AddLiquidity, populated after Success)
> createdTimestringOrder creation time, unix timestamp in milliseconds
nextPageCursorstringCursor for next page. Empty string means no more data

Request Example

GET /v5/earn/liquidity-mining/order?orderLinkId=lm-001 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": {
"orders": [
{
"orderId": "5e651d09-6169-4f72-a609-8622ff421d19",
"orderLinkId": "lm-001",
"productId": "36",
"orderType": "AddLiquidity",
"baseCoin": "TON",
"quoteCoin": "USDT",
"quoteAmount": "200",
"baseAmount": "0",
"status": "Success",
"removeType": "Normal",
"removeRate": 0,
"leverage": "2",
"slippageValue": "0.02",
"createdTime": "1775123507000"
}
],
"nextPageCursor": ""
},
"retExtInfo": {},
"time": 1775123797220
}