> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kraken.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Amend Order
> Amend the parameters of a live order in-place
WSS
ws-auth.kraken.com/v2
amend\_order
The amend request enables clients to modify the order parameters in-place without the need to cancel the existing order and create a new one.
* The order identifiers assigned by Kraken and/or client will stay the same.
* Queue priority in the order book will be maintained where possible.
* If an amend request will reduce the order quantity below the existing filled quantity, the remaining quantity will be cancelled.
For more detail, see [amend transaction guide](/exchange/guides/general/amends).
Value: `amend_order`
Example: `OFGKYQ-FHPCQ-HUQFEK`
The Kraken identifier for the order to be amended. Either `order_id` or `cl_ord_id` is required.
Example: `6d1b345e-2821-40e2-ad83-4ecb18a06876`
The client identifier for the order to be amended. Either `order_id` or `cl_ord_id` is required.
The new order quantity in terms of the base asset.
Condition: iceberg orders only
Defines the new quantity to show in the book while the rest of order quantity remains hidden. Minimum value is 1 / 15 of remaining order quantity.
Condition: For order types that support limit price only
The new limit price restriction on the order, used in combination with the `limit_price_type` parameter.
One of: `static`, `pct`, `quote`
Condition: Currently only available on trailing-stop-limit orders
The units for `limit_price`.
* `static`: a static market price for the asset, i.e. limit price at 29000.5 BTC/USD, use price=29000.5 and price\_type=static.
* `pct`: a percentage offset from the reference price, i.e. limit price when market rises by 5%, use price=5 and price\_type=pct.
* `quote`: a notional offset from the reference price in the quote currency, i.e, limit price when market drops by 150 USD, use price=-150 and price\_type=quote.
`static` is the default for all order types except for `trailing-stop-limit` which has the default `quote` offset.
One of: `true`, `false`
Default: `false`
Condition: Optional parameter for limit price amends
If `true`, the limit price change will be rejected if the order cannot be posted passively in the book.
Condition: For triggered order types only
The new trigger price to activate the order, used in combination with the `trigger_price_type` parameter.
One of: `static`, `pct`, `quote`
Default: `static`
Condition: For triggered order types only
The units for `trigger_price`.
* `static`: a static market price for the asset, i.e. to trigger at 29000.5 BTC/USD, use price=29000.5 and price\_type=static.
* `pct`: a percentage offset from the reference price, i.e. to trigger when price rises by 5%, use price=5 and price\_type=pct.
* `quote`: a notional offset from the reference price in the quote currency, i.e, to trigger when price drops by 150 USD, use price=-150 and price\_type=quote.
Format: RFC3339
Example: `2022-12-25T09:30:59.123Z`
Range of valid offsets (from current time) is 500 milliseconds to 60 seconds, default is 5 seconds. The precision of this parameter is to the millisecond. The engine will prevent this order from matching after this time, it provides protection against latency on time sensitive orders.
Example: `TSLAx/USD`
The `symbol` is required on amends for non-crypto pairs, i.e. provide the pair symbol for xstocks.
Authentication token. See [authentication guide](/exchange/guides/websockets/authentication) for details.
Optional client originated request identifier sent as acknowledgment in the response.
A successful amend request will return the unique Kraken amend identifier.
Value: `amend_order`
Condition: if `success` is `true`
The unique Kraken identifier generated for this amend transaction.
The Kraken identifier, if populated in the request.
The client identifier, if populated in the request.
Non-fatal warnings about the amend, if any.
Error message. Condition: if `success` is `false`.
Indicates if the request was successfully processed by the engine. One of: `true`, `false`
Optional client originated request identifier sent as acknowledgment in the response.
The timestamp when the request was received on the wire, just prior to parsing data. Format: RFC3339. Example: `2022-12-25T09:30:59.123456Z`
The timestamp when the response was sent on the wire, just prior to transmitting data. Format: RFC3339. Example: `2022-12-25T09:30:59.123456Z`
```json Basic theme={null}
{
"method": "amend_order",
"params": {
"cl_ord_id": "2c6be801-1f53-4f79-a0bb-4ea1c95dfae9",
"limit_price": 490795,
"order_qty": 1.2,
"token": "PM5Qm0MDrS54l657aQAtb7AhrwN30e2LBg1nUYOd6vU"
}
}
```
```json Advanced theme={null}
{
"method": "amend_order",
"params": {
"order_id": "OAIYAU-LGI3M-PFM5VW",
"limit_price": 61031.3,
"deadline": "2024-07-21T09:53:59.050Z",
"post_only": true,
"token": "DGB00LiKlPlLI/amQaSKUUr8niqXDb+1zwvtjp34nzk"
}
}
```
```json Response theme={null}
{
"method": "amend_order",
"result": {
"amend_id": "TTW6PD-RC36L-ZZSWNU",
"cl_ord_id": "2c6be801-1f53-4f79-a0bb-4ea1c95dfae9"
},
"success": true,
"time_in": "2024-07-26T13:39:04.922699Z",
"time_out": "2024-07-26T13:39:04.924912Z"
}
```