Skip to main content

Conditional fields in Order Responses

There are fields in the order responses (e.g. order placement, order query, order cancellation) that appear only if certain conditions are met.

These fields can apply to order lists.

The fields are listed below:

FieldDescriptionVisibility conditionsExamples
icebergQtyQuantity for the iceberg orderAppears only if the parameter icebergQty was sent in the request."icebergQty": "0.00000000"
preventedMatchIdWhen used in combination with symbol, can be used to query a prevented match.Appears only if the order expired due to STP."preventedMatchId": 0
preventedQuantityOrder quantity that expired due to STPAppears only if the order expired due to STP."preventedQuantity": "1.200000"
stopPricePrice when the algorithmic order will be triggeredAppears for STOP_LOSS. TAKE_PROFIT, STOP_LOSS_LIMIT and TAKE_PROFIT_LIMIT orders."stopPrice": "23500.00000000"
strategyIdCan be used to label an order that's part of an order strategy.Appears if the parameter was populated in the request."strategyId": 37463720
strategyTypeCan be used to label an order that is using an order strategy.Appears if the parameter was populated in the request."strategyType": 1000000
trailingDeltaDelta price change required before order activationAppears for Trailing Stop Orders."trailingDelta": 10
trailingTimeTime when the trailing order is now active and tracking price changesAppears only for Trailing Stop Orders."trailingTime": -1
usedSorField that determines whether order used SORAppears when placing orders using SOR"usedSor": true
workingFloorField that determines whether the order is being filled by the SOR or by the order book the order was submitted to.Appears when placing orders using SOR"workingFloor": "SOR"
pegPriceTypePrice peg typeOnly for pegged orders"pegPriceType": "PRIMARY_PEG"
pegOffsetTypePrice peg offset typeOnly for pegged orders, if requested"pegOffsetType": "PRICE_LEVEL"
pegOffsetValuePrice peg offset valueOnly for pegged orders, if requested"pegOffsetValue": 5
peggedPriceCurrent price order is pegged atOnly for pegged orders, once determined"peggedPrice": "87523.83710000"
expiryReasonCause of the order’s expirationWhen an order has expired"expiryReason": "INSUFFICIENT_LIQUIDITY"