Amend Order

Amend the parameters of a live order in-place

WSSws-auth.kraken.com/v2amend_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.

Request

method · string · required

Value: amend_order

params · object

Hide properties

order_id · string · required

Example: OFGKYQ-FHPCQ-HUQFEK

The Kraken identifier for the order to be amended. Either order_id or cl_ord_id is required.

cl_ord_id · string

Example: 6d1b345e-2821-40e2-ad83-4ecb18a06876

The client identifier for the order to be amended. Either order_id or cl_ord_id is required.

order_qty · float

The new order quantity in terms of the base asset.

display_qty · float

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.

limit_price · float

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.

limit_price_type · string

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.

post_only · boolean

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.

trigger_price · float

Condition: For triggered order types only

The new trigger price to activate the order, used in combination with the trigger_price_type parameter.

trigger_price_type · string

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.

deadline · string

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.

symbol · string

Example: TSLAx/USD

The symbol is required on amends for non-crypto pairs, i.e. provide the pair symbol for xstocks.

token · string · required

Authentication token. See authentication guide for details.

req_id · integer

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

Response

A successful amend request will return the unique Kraken amend identifier.

method · string

Value: amend_order

result · object

Condition: if success is true

Hide properties

amend_id · string

The unique Kraken identifier generated for this amend transaction.

order_id · string

The Kraken identifier, if populated in the request.

cl_ord_id · string

The client identifier, if populated in the request.

warnings · array of string

Non-fatal warnings about the amend, if any.

error · string

Error message. Condition: if success is false.

success · boolean

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

req_id · integer

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

time_in · 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

time_out · 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