Trading

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.

API Key Permissions Required: Orders and trades - Create & modify orders or Orders and trades - Cancel & close orders

post/private/AmendOrder

Request

  • Base URL: https://api.kraken.com/0
  • URL: https://api.kraken.com/0/private/AmendOrder
  • Auth: API key in header API-Key and API key in header API-Sign

Request body

txidstring

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

cl_ord_idstring

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

order_qtystring

The new order quantity in terms of the base asset.

display_qtystring

For iceberg orders only, it 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_pricestring

The new limit price restriction on the order (for order types that support limit price only).

The relative pricing can be set by using the +, - prefixes and/or % suffix.

  • • + adds the amount from the reference price, i.e. market rises 50 USD "+50".
  • • - subtracts the amount from the reference price, i.e. market drops 100 USD "-100".
trigger_pricestring

The new trigger price to activate the order (for triggered order types only).

The relative pricing can be set by using the +, - prefixes and/or % suffix.

  • • + adds the amount from the reference price, i.e. market rises 50 USD "+50".
  • • - subtracts the amount from the reference price, i.e. market drops 100 USD "-100".
pairstring

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

post_onlyboolean

An optional flag for limit_price amends. If true, the limit price change will be rejected if the order cannot be posted passively in the book.

deadlinestring

RFC3339 timestamp (e.g. 2021-04-01T00:18:45Z) after which the matching engine should reject the new order request, in presence of latency or order queueing. min now() + 2 seconds, max now() + 60 seconds.

nonceinteger required

Nonce used in construction of API-Sign header

Example request

{
  "nonce": 1695828490,
  "cl_ord_id": "6d1b345e-2821-40e2-ad83-4ecb18a06876",
  "order_qty": "1.25"
}

Response

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

Example response

{
  "error": [],
  "result": {
    "amend_id": "TEZA4R-DSDGT-IJBOJK"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.