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.
- Request
- Response
string
required
Value:
amend_orderobject
Hide properties
Hide properties
string
required
Example:
OFGKYQ-FHPCQ-HUQFEKThe 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: 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.
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:
Condition: Currently only available on trailing-stop-limit ordersThe units for
static, pct, quoteCondition: Currently only available on trailing-stop-limit ordersThe 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.boolean
One of:
Default:
Condition: Optional parameter for limit price amendsIf
true, falseDefault:
falseCondition: 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:
Default:
Condition: For triggered order types onlyThe units for
static, pct, quoteDefault:
staticCondition: For triggered order types onlyThe 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.
string
Format: RFC3339
Example:
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.
A successful amend request will return the unique Kraken amend identifier.
string
Value:
amend_orderobject
string
Error message. Condition: if
success is false.boolean
Indicates if the request was successfully processed by the engine. One of:
true, falseinteger
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.123456Zstring
The timestamp when the response was sent on the wire, just prior to transmitting data. Format: RFC3339. Example:
2022-12-25T09:30:59.123456Z