Skip to main content

Conditional

Conditional order that stays inactive until its trigger price is reached, then submits a limit or market order.

orderType stringrequired

Conditional order that stays inactive until its trigger price is reached, then submits a limit or market order.

Possible values: []

clOrderIdstring

Client-assigned order identifier for tracking and idempotency.

symbolstringrequired

Trading pair symbol.

orderSidestringrequired

Order side: BUY or SELL.

Possible values: [BUY, SELL]

orderSizeint64required

Order size in number of contracts.

positionModestring

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

Possible values: [ONE_WAY, HEDGE, ISOLATED]

Default value: ONE_WAY
timeInForcestring

Time-in-force policy applied once the order is triggered.

Possible values: [FOK, GTC, IOC, HALFSEC, HALFMIN, FIVEMIN, HOUR, TWELVEHOUR, DAY, WEEK, MONTH]

Default value: GTC
reduceOnlyboolean

If true, the order can only reduce an existing position and cannot open or increase one.

postOnlyboolean

If true, the triggered order is rejected if it would take liquidity, ensuring maker-only execution.

orderPricedouble

Limit price used once the order is triggered. Omit for a market-style trigger.

triggerPricedouble

Price at which the order becomes active.

triggerTypestring

Reference price type used to evaluate the trigger.

Possible values: [INDEX_PRICE, LAST_PRICE, MARK_PRICE]

takeProfitTriggerTypestring

Reference price type used to evaluate the take-profit trigger.

Possible values: [INDEX_PRICE, LAST_PRICE, MARK_PRICE]

stopLossTriggerTypestring

Reference price type used to evaluate the stop-loss trigger.

Possible values: [INDEX_PRICE, LAST_PRICE, MARK_PRICE]

takeProfitTriggerPricedouble

Take-profit trigger price attached to the resulting order.

stopLossTriggerPricedouble

Stop-loss trigger price attached to the resulting order.

Conditional
{
"orderType": "LIMIT",
"clOrderId": "string",
"symbol": "string",
"orderSide": "BUY",
"orderSize": 0,
"positionMode": "ONE_WAY",
"timeInForce": "GTC",
"reduceOnly": true,
"postOnly": true,
"orderPrice": 0,
"triggerPrice": 0,
"triggerType": "INDEX_PRICE",
"takeProfitTriggerType": "INDEX_PRICE",
"stopLossTriggerType": "INDEX_PRICE",
"takeProfitTriggerPrice": 0,
"stopLossTriggerPrice": 0
}