Skip to main content

Conditional

Conditional (Trigger) order β€” placed on the book once a trigger price is reached

orderType stringrequired

Conditional (Trigger) order β€” placed on the book once a trigger price is reached

Possible values: []

symbolstringrequired

Trading pair, e.g. BTC-USDT

orderSidestringrequired

BUY or SELL

Possible values: [BUY, SELL]

triggerPricedoublerequired

Price that activates the order

triggerOrderTypestringrequired

Trigger behavior: STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, or TAKE_PROFIT_LIMIT

Possible values: [STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, TAKE_PROFIT_LIMIT]

triggerPriceTypestringrequired

Reference price for the trigger (LAST_PRICE, MARK_PRICE, or INDEX_PRICE)

Possible values: [INDEX_PRICE, LAST_PRICE, MARK_PRICE]

clOrderIdstring

Client-supplied order identifier, echoed in the response (max 64 characters)

orderSizedouble

Order quantity in base currency; required for SELL market and for the STOP_LOSS_LIMIT / TAKE_PROFIT_LIMIT variants

quoteOrderSizedouble

only for market order in BUY side

orderPricedouble

only for limit order

timeInForcestring

Time-in-force policy for the limit variants (GTC, IOC, FOK)

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

Default value: GTC
postOnlyboolean

If true, reject the limit variant if it would immediately match (post-only / maker-only)

Conditional
{
  "orderType": "LIMIT",
  "symbol": "string",
  "orderSide": "BUY",
  "triggerPrice": 0,
  "triggerOrderType": "STOP_LOSS",
  "triggerPriceType": "INDEX_PRICE",
  "clOrderId": "string",
  "orderSize": 0,
  "quoteOrderSize": 0,
  "orderPrice": 0,
  "timeInForce": "GTC",
  "postOnly": true
}