Interface: WSAPIAmendOrderRequestV5
Properties
| Property | Type | Description |
|---|---|---|
attachAlgoOrds? | AmendAttachedTrailingStop[] | - |
clOrdId? | string | - |
cxlOnFail? | boolean | - |
instId? | string | Retained legacy field. Use instIdCode for WebSocket amend-order and batch-amend-orders, together with ordId or clOrdId. |
instIdCode? | number | Instrument code required for WebSocket amend-order and batch-amend-orders. Obtain it from Get instruments for the target instrument and environment. |
isElpTakerAccess? | boolean | Deprecated Retired ELP alias. Use rpiTakerAccess; OKX ended alias support after October 31, 2026. |
newPx? | string | - |
newPxUsd? | string | - |
newPxVol? | string | - |
newSz? | string | - |
ordId? | string | - |
reqId? | string | - |
rpiPxRound? | boolean | RPI maker spacing: auto-round price when true. Only for ordType rpi. |
rpiTakerAccess? | boolean | RPI taker access. Not inherited on amend - omit = false. |
speedBump? | string | The WebSocket amendment 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 amendment. |