Skip to content

Interface: WSAPIPlaceOrderRequestV5 ​

Properties ​

PropertyTypeDescription
attachAlgoOrds?AttachAlgoOrdRequest[]-
banAmend?boolean-
ccy?string-
clOrdId?string-
instId?stringRetained legacy field. OKX removed this parameter from WebSocket order placement in March 2026; use instIdCode obtained from Get instruments.
instIdCode?numberInstrument code required by the current WebSocket order-placement API. Obtain it from Get instruments for the target instrument and environment.
isElpTakerAccess?booleanDeprecated Retired ELP alias. Use rpiTakerAccess; OKX ended alias support after October 31, 2026.
ordTypeOrderType-
outcome?stringEVENTS: yes or no.
posSide?PositionSide-
px?string-
pxUsd?string-
pxVol?string-
reduceOnly?boolean-
rpiPxRound?booleanRPI maker spacing: auto-round price when true. Only for ordType rpi.
rpiTakerAccess?booleanRPI taker access for limit/market/fok/ioc. Default false. Alias isElpTakerAccess accepted until 2026-10-31.
sideOrderSide-
slippagePct?stringMaximum 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.
speedBump?stringThe WebSocket placement request tables require speedBump="1" for non-post-only EVENTS orders. OKX’s July 24, 2026 removal notice names REST single-order placement, not WebSocket placement.
stpMode?"cancel_maker" | "cancel_taker" | "cancel_both"-
szstringQuantity to buy or sell
tag?string-
tdModeTradeMode-
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.
tradeQuoteCcy?string-

Built by Siebly. Open source SDKs for exchange APIs.