API Reference

Query Algo Order Detail

Rate Limit: 3 requests per 10 seconds

Retrieve order details for all order status.

Request

NameTypeMandatoryDescription
algoOrderIdStringNAlgo order ID
clientOrderIdStringNCustomer-defined order ID , consists of letters(a-z) and numbers(0-9)
attachedOrderIdStringOrder ID with TP/SL

Tip:Either algoOrderId or clientOrderId or attachedOrderId must be sent.

Response

FieldTyperemark
portfolioIdStringPortfolio ID
algoOrderIdStringAlgo order id
algoOrderTypeStringAlgo order types: TPSL, ATTACHED_TPSL
clientOrderIdStringCustomer defined order ID
symStringTrading unique identifier, example: BINANCE_SPOT_BTC_USDT, BINANCE_PERP_BTC_USDT
If you want to know other trading unique identifiers, please go to the introduction page.
exchangeTypeStringExchange type(BINANCE, OKX)
businessTypeStringBusiness type(SPOT, PERP)
sideStringSide(BUY,SELL)
limitPriceStringOrder price
orderQtyStringOrder quantity, note: trading unit of OKX is the number of contracts/ trading unit of Binance is the number of coin
Note: The trading unit on OKX is measured in the number of contracts, while the trading unit on Binance is measured in the number of coins.
positionSideStringPosition side, NONE/LONG/SHORT, default NONE. NONE stands for one-way mode.
reduceOnlyStringReduce position orders only, must "true" or "false"
orderStateStringOrder state(
PENDING_NEW,
NEW,
PROCESSING,
PENDING_CANCEL,
CANCELLED,
COMPLETED,
REJECTED,
FAILED,
EXPIRED)
reasonStringFail reason
executedQtyStringTransaction quantity
Note: The trading unit on OKX is measured in the number of contracts, while the trading unit on Binance is measured in the number of coins.
executedAmountStringTransaction amount
executedAvgPriceStringAverage transaction price
createAtStringCreate time
updateAtStringUpdate time
conditionTypeStringCONDITIONAL, OCO, ENTIRE_CLOSE_POSITION, PARTIAL_CLOSE_POSITION
conditionalTriggerPriceStringConditional Order Trigger Price
conditionalTriggerPriceTypeStringConditional Order Trigger Price Type:
LAST_PRICE, MARK_PRICE
conditionalPriceStringLimit Price After Triggering Conditional Order ;
0 Indicates Market Price.
attachedOrderIdStringOrder ID with TP/SL
tpTriggerPriceStringTake-profit trigger price.
tpTriggerTypeStringTake-profit trigger price type
LAST_PRICE, MARK_PRICE
The default is LAST_PRICE
tpPriceStringTake-profit order price.
slTriggerPriceStringStop-loss trigger price.
slTriggerTypeStringStop-loss trigger price type
LAST_PRICE, MARK_PRICE
The default is LAST_PRICE
slPriceStringStop-loss order price.
Language