Skip to main content

OrderResp

orderIdstring

Server-assigned order id.

clOrderIdstring

Client-assigned order id echoed from placement.

symbolstring

Trading pair symbol.

orderSidestring

Order side: BUY or SELL.

Possible values: [BUY, SELL]

typeint32

Order type code.

orderPricedouble

Limit price of the order.

originalOrderSizeint32

Original order size in number of contracts at placement.

currentOrderSizeint32

Current remaining order size in number of contracts after fills and amendments.

totalFilledSizeint32

Cumulative filled size in number of contracts.

remainingSizeint32

Remaining unfilled size in number of contracts.

averageFillPricedouble

Average fill price across executions so far.

orderStatestring

Human-readable order state name.

timestampint64

Server timestamp of the last state change, in milliseconds since epoch.

reduceOnlyboolean

True if the order can only reduce an existing position.

positionModestring

Position mode this order applies to (one-way or hedge).

Possible values: [ONE_WAY, HEDGE, ISOLATED]

positionDirectionstring

Position direction the order affects: LONG or SHORT.

Possible values: [LONG, SHORT]

positionIdstring

Identifier of the position the order is bound to.

closeOrderboolean

True if the order is a close-position order.

pegPriceMindouble

Lower bound of the peg order price band.

pegPriceMaxdouble

Upper bound of the peg order price band.

pegPriceDeviationdouble

Offset applied to the pegged reference price.

currentPegPricedouble

Current pegged working price.

triggerOrderboolean

True if this order is a conditional trigger order that has not yet fired.

triggeredboolean

True once the trigger condition has fired.

triggerPricedouble

Configured trigger price.

triggerOriginalPricedouble

Original submitted trigger price prior to any amendment.

triggerOrderTypeint32

Order type code the trigger will submit once fired.

triggerTrailingStopDeviationdouble

Trailing distance for the trigger's trailing-stop behavior.

triggerStopPricedouble

Stop price used by the triggered order once activated.

triggerUseLastPriceboolean

True if last-traded-price is used as the trigger reference, otherwise mark price is used.

trailValuedouble

Trailing distance the stop maintains from the best reached reference price.

trailValueTypestring

How trailValue is interpreted (absolute price offset or percentage).

Possible values: [DISTANCE, PERCENTAGE]

activationPricedouble

Price at which trailing or scheduled logic activates.

activationPriceTypestring

Reference price type used to evaluate the activation price.

Possible values: [INDEX_PRICE, LAST_PRICE, MARK_PRICE]

takeProfitOrder object

Attached take-profit trigger, if any.

orderIdstring

Server-assigned order id of the attached trigger order.

sidestring

Order side of the trigger leg: BUY or SELL.

Possible values: [BUY, SELL]

triggerPricedouble

Price at which this trigger fires.

triggerUseLastPriceboolean

True if last-traded-price is used as the trigger reference, otherwise mark price is used.

stopLossOrder object

Attached stop-loss trigger, if any.

orderIdstring

Server-assigned order id of the attached trigger order.

sidestring

Order side of the trigger leg: BUY or SELL.

Possible values: [BUY, SELL]

triggerPricedouble

Price at which this trigger fires.

triggerUseLastPriceboolean

True if last-traded-price is used as the trigger reference, otherwise mark price is used.

cancelDurationint64

Cancel duration in milliseconds derived from time-in-force. Zero for GTC.

timeInForcestring

Time-in-force policy applied to the order (e.g. GTC, IOC, FOK).

stealthdouble

Portion of the order size displayed on the book; the remainder is hidden.

contractSizedouble

Contract size (units of underlying per contract) for this symbol.

wrapperOrderboolean

True if the order is a wrapper that spawns child orders (e.g. activation wrappers).

ocoPeerOrderIdstring

Order id of the peer OCO leg, if this order is part of an OCO pair.

orderDetailTypestring

Fine-grained order detail type classification.

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

originalOrderValuedouble

Notional value at placement, computed from original size, contract size and reference price.

currentOrderValuedouble

Current notional value, computed from remaining size, contract size and current working price.

OrderResp
{
"orderId": "string",
"clOrderId": "string",
"symbol": "string",
"orderSide": "BUY",
"type": 0,
"orderPrice": 0,
"originalOrderSize": 0,
"currentOrderSize": 0,
"totalFilledSize": 0,
"remainingSize": 0,
"averageFillPrice": 0,
"orderState": "string",
"timestamp": 0,
"reduceOnly": true,
"positionMode": "ONE_WAY",
"positionDirection": "LONG",
"positionId": "string",
"closeOrder": true,
"pegPriceMin": 0,
"pegPriceMax": 0,
"pegPriceDeviation": 0,
"currentPegPrice": 0,
"triggerOrder": true,
"triggered": true,
"triggerPrice": 0,
"triggerOriginalPrice": 0,
"triggerOrderType": 0,
"triggerTrailingStopDeviation": 0,
"triggerStopPrice": 0,
"triggerUseLastPrice": true,
"trailValue": 0,
"trailValueType": "DISTANCE",
"activationPrice": 0,
"activationPriceType": "INDEX_PRICE",
"takeProfitOrder": {
"orderId": "string",
"side": "BUY",
"triggerPrice": 0,
"triggerUseLastPrice": true
},
"stopLossOrder": {
"orderId": "string",
"side": "BUY",
"triggerPrice": 0,
"triggerUseLastPrice": true
},
"cancelDuration": 0,
"timeInForce": "string",
"stealth": 0,
"contractSize": 0,
"wrapperOrder": true,
"ocoPeerOrderId": "string",
"orderDetailType": "TWAP",
"originalOrderValue": 0,
"currentOrderValue": 0
}