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. Amend is supported for both spot and futures (derivatives) orders.

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.

Request
Response

string

required

Value: amend_order

object

Hide properties

string

required

One of: spot, derivativesThe asset class for the request.

string

required

Example: cff769bb-dc52-56e1-98c8-22301dc888aeThe Kraken identifier for the order to be amended. Either order_id or cl_ord_id is required.

string

Example: 6d1b345e-2821-40e2-ad83-4ecb18a06876The client identifier for the order to be amended. Either order_id or cl_ord_id is required.

float

The new order quantity in terms of the base asset.

float

Condition: Not available for derivativesDefines 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.

float

Condition: For order types that support limit price onlyThe new limit price restriction on the order, used in combination with the limit_price_type parameter.

string

One of: static
Condition: Currently only available on trailing-stop-limit ordersThe units for limit_price. Only static is supported for derivatives.

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.

boolean

One of: true, false
Default: false
Condition: Optional parameter for limit price amendsIf true, the limit price change will be rejected if the order cannot be posted passively in the book.

float

Condition: For triggered order types onlyThe new trigger price to activate the order, used in combination with the trigger_price_type parameter.

string

One of: static
Default: static
Condition: For triggered order types onlyThe units for trigger_price. Only static is supported for derivatives.

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.

string

Format: RFC3339
Example: 2022-12-25T09:30:59.123ZRange 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.

string

Example: TSLAx/USDThe symbol is required on amends for non-crypto pairs, i.e. provide the pair symbol for xStocks.

string

required

Authentication token. See authentication guide for details.

integer

Optional client originated request identifier sent as acknowledgment in the response.

For spot orders, a successful amend request returns the unique Kraken amend identifier. Futures (derivatives) has no amend identifier, so amend_id is empty on derivatives amends.

string

Value: amend_order

object

Condition: if success is true

Hide properties

string

Condition: Spot onlyThe unique Kraken identifier generated for this amend transaction. Futures has no concept of an amend identifier, so this is always empty ("") for derivatives.

string

The Kraken identifier, if populated in the request.

string

The client identifier, if populated in the request.

array of string

Non-fatal warnings about the amend, if any.

string

Error message. Condition: if success is false.

boolean

Indicates if the request was successfully processed by the engine. One of: true, false

integer

Optional client originated request identifier sent as acknowledgment in the response.

string

The timestamp when the request was received on the wire, just prior to parsing data. Format: RFC3339. Example: 2022-12-25T09:30:59.123456Z

string

The timestamp when the response was sent on the wire, just prior to transmitting data. Format: RFC3339. Example: 2022-12-25T09:30:59.123456Z

Public Channels

Trading

Account

System