Skip to main content

QueryOrderResp

requestIdint64

Request identifier associated with the order submission.

orderIdstring

Server-assigned unique order identifier.

clOrderIdstring

Client-supplied order identifier (custom tag).

symbolstring

Trading pair, formatted as BASE-QUOTE (e.g. BTC-USDT).

quotestring

Quote currency of the trading pair.

orderStatestring

Current order status label (e.g. active, inactive, cancelled).

orderTypeint32

Numeric order-type code (limit, market, peg, TWAP).

orderSidestring

Order side: BUY or SELL.

orderPricedouble

Order limit price. Zero for market orders.

orderValuedouble

Current order value expressed in the user's account currency.

timestampint64

Order creation timestamp in Unix epoch milliseconds.

timeInForcestring

Time-in-force policy: GTC, IOC, FOK, or null if not applicable.

orderCurrencystring

Indicates which size fields are populated: "quote" (quote-denominated) or "base" (base-denominated).

originalOrderBaseSizedouble

Original order size in base currency. Populated only when orderCurrency is "base".

originalOrderQuoteSizedouble

Original order size in quote currency. Populated only when orderCurrency is "quote".

currentOrderBaseSizedouble

Current outstanding order size in base currency. Populated only when orderCurrency is "base".

currentOrderQuoteSizedouble

Current outstanding order size in quote currency. Populated only when orderCurrency is "quote".

remainingOrderBaseSizedouble

Remaining unfilled size in base currency. Populated only when orderCurrency is "base".

remainingOrderQuoteSizedouble

Remaining unfilled size in quote currency. Populated only when orderCurrency is "quote".

totalFilledBaseSizedouble

Cumulative filled quantity in base currency.

avgFilledPricedouble

Volume-weighted average fill price across all executions of this order.

orderDetailTypestring

Order detail category classifying the order's purpose or subtype.

Possible values: [TWAP, PARTIAL_LIQUIDATION, FORCED_MARKET_BUY, FORCED_MARKET_SELL]

orderDetailOrderDetail

Additional order detail metadata associated with orderDetailType.

triggerOrderboolean

True if this is a trigger (conditional) order.

triggeredboolean

True once the trigger condition has fired and the underlying order has been released.

triggerUseLastPriceboolean

True if the trigger evaluates against the last-traded price; false if it evaluates against the mark price. Only meaningful for trigger orders.

triggerPricedouble

Effective trigger price. Only meaningful for trigger orders.

triggerOriginalPricedouble

Trigger price originally submitted by the client. Only meaningful for trigger orders.

triggerOrderTypeint32

Numeric trigger order-type code (stop-loss, take-profit, stop-loss-limit, or take-profit-limit). Only meaningful for trigger orders.

triggerStopPricedouble

Stop price for the trigger order. Only meaningful for trigger orders.

triggerTrailingStopDeviationdouble

Trailing stop deviation from the reference price. Only meaningful for trailing-stop trigger orders.

trailValuedouble

Trailing offset magnitude. Only meaningful for trailing-stop orders.

trailValueTypestring

Interpretation of trailValue (e.g. absolute amount or percentage). Only meaningful for trailing-stop orders.

Possible values: [DISTANCE, PERCENTAGE]

pegPriceMindouble

Lower cap of the peg price band. Only meaningful for peg orders.

pegPriceMaxdouble

Upper cap of the peg price band. Only meaningful for peg orders.

pegPriceDeviationdouble

Offset applied to the reference price when pegging. Only meaningful for peg orders.

currentPegPricedouble

Current effective peg price. Only meaningful for peg orders.

wrapperOrderboolean

True if the order is a wrapper for a group of related orders (e.g. bracket/OCO).

activationPricedouble

Activation price at which the order becomes eligible for execution. Only present for orders that use an activation-price feature.

activationPriceTypestring

Reference price type used when evaluating activationPrice. Only present for orders that use an activation-price feature.

Possible values: [INDEX_PRICE, LAST_PRICE, MARK_PRICE]

QueryOrderResp
{
"requestId": 0,
"orderId": "string",
"clOrderId": "string",
"symbol": "string",
"quote": "string",
"orderState": "string",
"orderType": 0,
"orderSide": "string",
"orderPrice": 0,
"orderValue": 0,
"timestamp": 0,
"timeInForce": "string",
"orderCurrency": "string",
"originalOrderBaseSize": 0,
"originalOrderQuoteSize": 0,
"currentOrderBaseSize": 0,
"currentOrderQuoteSize": 0,
"remainingOrderBaseSize": 0,
"remainingOrderQuoteSize": 0,
"totalFilledBaseSize": 0,
"avgFilledPrice": 0,
"orderDetailType": "TWAP",
"triggerOrder": true,
"triggered": true,
"triggerUseLastPrice": true,
"triggerPrice": 0,
"triggerOriginalPrice": 0,
"triggerOrderType": 0,
"triggerStopPrice": 0,
"triggerTrailingStopDeviation": 0,
"trailValue": 0,
"trailValueType": "DISTANCE",
"pegPriceMin": 0,
"pegPriceMax": 0,
"pegPriceDeviation": 0,
"currentPegPrice": 0,
"wrapperOrder": true,
"activationPrice": 0,
"activationPriceType": "INDEX_PRICE"
}