Modify Order
writes · destructive
Modify a pending order’s parameters.
Changes volume, price, or stop price on an existing pending order. Only works for orders that have not been filled or cancelled.
PARAMETERS:
- orderId or clOrdId: Identify the order (use clOrdId from place_order response)
- volume: New order volume in units (optional)
- price: New limit price (optional, for LIMIT orders)
- stopPrice: New stop trigger price (optional, for STOP orders)
USAGE:
- Provide at least one parameter to modify
- Order must be in NEW or PENDING status
- Risk checks apply to modified parameters
- Cannot modify filled, cancelled, or rejected orders
Returns updated order details on success. Returns ORDER_NOT_FOUND if order doesn’t exist or is not pending.
Show the user the new volume/price (volume in lots and units) and confirm once before calling. The server enforces all risk checks — one confirmation is sufficient.
Parameters
Section titled “Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
orderId | string | No | Broker-assigned order ID (if known) |
clOrdId | string | No | Client order ID (our ID from place_order response) |
volume | number | No | New order volume in UNITS (fractional allowed for instruments with small lot sizes) |
price | number | No | New limit price (for LIMIT orders) |
stopPrice | number | No | New stop price (for STOP orders) |