Interface: OrderRequest
Properties
| Property | Type | Description |
|---|---|---|
attachAlgoOrds? | AttachAlgoOrdRequest[] | TP/SL / trailing (attach) when placing the parent order |
banAmend? | boolean | - |
ccy? | string | - |
clOrdId? | string | - |
instId | string | - |
isElpTakerAccess? | boolean | Deprecated Retired ELP alias. Use rpiTakerAccess; OKX ended alias support after October 31, 2026. |
ordType | OrderType | - |
outcome? | string | EVENTS: yes or no. |
posSide? | PositionSide | - |
px? | string | - |
pxAmendType? | "0" | "1" | Price amendment type: "0" = do not allow amendment, "1" = allow amendment within price limit. Default is "0" |
pxUsd? | string | Place options orders in USD. Only applicable to options. One of px/pxUsd/pxVol must be filled for option orders |
pxVol? | string | Place options orders based on implied volatility, where 1 represents 100%. Only applicable to options |
quickMgnType? | "manual" | "auto_borrow" | "auto_repay" | Legacy Quick Margin selector retained in the SDK. OKX announced retirement of Quick Margin mode for May 29, 2024, and marks the response field deprecated. The current place-order request table does not list this parameter. |
reduceOnly? | boolean | - |
rpiPxRound? | boolean | RPI maker spacing: auto-round price when true. Only for ordType rpi. |
rpiTakerAccess? | boolean | RPI taker access for limit/market/fok/ioc. Default false. Speedbump when true. Alias isElpTakerAccess accepted until 2026-10-31. |
side | OrderSide | - |
slippagePct? | string | Maximum acceptable slippage for SPOT and SPOT-margin market orders where tgtCcy is the received currency (base_ccy for buys, quote_ccy for sells). Pass the decimal fraction as a string from "0" to "0.05", inclusive. The percentage may have up to two decimal places: "0.0123" means 1.23%. Defaults to 0% when omitted. Cannot be amended on an existing order. |
slOrdPx? | string | - |
slTriggerPx? | string | - |
slTriggerPxType? | PriceTriggerType | - |
speedBump? | string | OKX documents speedBump as ignored for REST single-order placement since July 24, 2026. REST batch placement still documents speedBump="1" as required for non-post-only EVENTS orders. This type is shared by both endpoints. |
stpMode? | "cancel_maker" | "cancel_taker" | "cancel_both" | Self-trade prevention mode. When omitted, the account-level acctStpMode applies. Its initial default is cancel_maker, but the master account can change it. cancel_both is not supported for FOK orders. |
sz | string | Quantity to buy or sell |
tag? | string | - |
tdMode | TradeMode | - |
tgtCcy? | "base_ccy" | "quote_ccy" | Unit of sz for a SPOT market order. For BTC-USDT, base_ccy means BTC and quote_ccy means USDT. Defaults to quote_ccy for buys and base_ccy for sells. |
tpOrdPx? | string | - |
tpTriggerPx? | string | Take Profit & Stop Loss params |
tpTriggerPxType? | PriceTriggerType | - |
tradeQuoteCcy? | string | Quote currency used for trading. Only applicable to SPOT. Default is quote currency of instId |