Skip to main content
{
    "event": "amendOrder",
    "token": "AxBH/MuD3MyJWjkiViDd1FLPoinFBC8MHQg0/952jKE",
    "cl_ord_id": "906bcc85-1866-4b4b-9d0d-880bbcbe7447",
    "trigger_price": "61036.4"
}

Documentation Index

Fetch the complete documentation index at: https://kraken-sandbox.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

WSSws-auth.kraken.comamendOrder
The amend request enables clients to modify 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, and queue priority in the order book will be maintained where possible.
​
event
string
required
Value: amendOrder
​
txid
string
Example: OFGKYQ-FHPCQ-HUQFEKThe Kraken identifier for the order to be amended. Either txid or cl_ord_id is required.
​
cl_ord_id
string
Example: 6d1b345e-2821-40e2-ad83-4ecb18a06876The client identifier for the order to be amended. Either txid or cl_ord_id is required.
​
volume
string
The new order quantity in terms of the base asset.
​
display_volume
string
Condition: iceberg orders onlyDefines 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
string
Condition: For order types that support limit price onlyThe new limit price restriction on the order.To specify a relative price, this field can be prefixed by + or - to specify the order price as an offset relative to the market price.
  • + prefix: adds the amount to the reference price.
  • - prefix: subtracts the amount from the reference price.
  • % suffix: signifies the relative amount as a percentage, i.e., for a limit price 2% from last price use "+2%".
​
post_only
boolean
One of: true, false
Default: false
Condition: Optional parameter for limit price changesApplies to limit_price changes in this amend transaction. If true, the limit price change will be rejected if the order cannot be posted passively in the book.
​
trigger_price
string
Condition: For triggered order types onlyThe new trigger price to activate the order.To specify a relative price, this field can be prefixed by + or - to specify the order price as an offset relative to the market price.
  • + prefix: adds the amount to the reference price.
  • - prefix: subtracts the amount from the reference price.
  • % suffix: signifies the relative amount as a percentage, i.e., for a limit price 2% from last price use "+2%".
​
pair
string
Example: TSLAx/USDThe symbol is required on amends for non-crypto pairs, i.e. provide the pair symbol for xstocks.
​
deadline
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.
​
reqid
integer
Optional client originated request identifier sent as acknowledgment in the response.
​
token
string
required
Session token from the GetWebSocketsToken REST endpoint.