UWSuws.kraken.com/v2/privateadd_order
Sends a single, new order into the exchange. A range of order types, Time-In-Force (TIF) and order flags can be specified by the parameters below.
For triggered order types (stop-loss, take-profit, trailing-stop), the triggers section contains the parameters for price tracking and trigger thresholds.
For One-Triggers-Other (OTO) orders, the conditional section contains the parameters to add a secondary close order to the primary order.
- Request
- Response
string
required
Value:
add_orderobject
required
Hide properties
Hide properties
string
required
One of:
spot, derivativesThe asset class for the request.string
required
One of:
limit, market, stop-loss, stop-loss-limit, take-profit, take-profit-limit, trailing-stop, trailing-stop-limitThe execution model of the order.limit: The full order quantity is placed immediately with a limit price restriction to only trade at this price or better.market: The full order quantity executes immediately at the best available price in the order book.stop-loss: A market order is triggered when the reference price reaches the stop price (from an unfavourable direction).stop-loss-limit: A limit order is triggered when the reference price reaches the stop price (from an unfavourable direction).take-profit: A market order is triggered when the reference price reaches the stop price (from a favourable direction).take-profit-limit: A limit order is triggered when the reference price reaches the stop price (from a favourable direction).trailing-stop: A market order is triggered when the market reverts a specified distance from the peak price.trailing-stop-limit: A limit order is triggered when the market reverts a specified distance from the peak price.
string
required
One of:
buy, sellSide of the order.float
required
Order quantity in terms of the base asset.
string
required
Example:
"BTC/USD"The symbol of the currency pair.float
Limit price for order types that support limit price restriction.
string
One of:
Default:
Condition: Only available on trailing-stop-limit ordersThe units for the limit price. Only
staticDefault:
staticCondition: Only available on trailing-stop-limit ordersThe units for the limit price. Only
static is supported for derivatives.static: a static market price for the asset, i.e. 30000 for BTC/USD.
trailing-stop-limit order type, the value represents offset from the trigger price. 0 would set a limit price the same as the trigger price.object
Condition: Required for triggered order types onlyThe parameters for setting the trigger price conditions.
Hide properties
Hide properties
string
One of:
Default:
index, lastDefault:
lastThe reference price to track for triggering orders.index: the index price in the broader market (for this pair). Note, to keep triggers serviceable during connectivity issues with external index feeds, the last price will be used as the reference price.last: the last traded price in the Kraken order book (for this pair).
float
required
Specifies the amount for the trigger price - it supports both static market prices and relative prices. This field is used in combination with the
price_type field below to determine the effective trigger price.Examples:- To trigger at 29000.5 BTC/USD, use price=29000.5, price_type=static.
- To trigger when price rises by 5%, use price=5, price_type=pct.
- To trigger when price drops by 150 USD, use price=-150, price_type=quote.
string
One of:
Default:
staticDefault:
staticThe units for the trigger price. Only static is supported for derivatives.static: a static market price for the asset, i.e. 30000 for BTC/USD.
string
One of:
Default:
gtc, iocDefault:
gtcTime-in-force specifies how long an order remains in effect before being expired.gtc: Good Till Canceled - until user has cancelled.ioc: Immediate Or Cancel - immediately cancels back any quantity that cannot be filled on arrival.
boolean
One of:
Default:
Condition: Not available for derivatives (futures are inherently margined)Funds the order on margin using the maximum leverage for the pair (maximum is leverage of 5).
false, trueDefault:
falseCondition: Not available for derivatives (futures are inherently margined)Funds the order on margin using the maximum leverage for the pair (maximum is leverage of 5).
boolean
One of:
Default:
Condition: Orders with limit price onlyCancels the order if it will take liquidity on arrival. Post only orders will always be posted passively in the book.
true, falseDefault:
falseCondition: Orders with limit price onlyCancels the order if it will take liquidity on arrival. Post only orders will always be posted passively in the book.
boolean
One of:
Default:
true, falseDefault:
falseReduces an existing margin position without opening an opposite long or short position worth more than the current value of your leveraged assets.string
Format: RFC3339
Example:
Condition: Not available for derivativesScheduled start time (precision to seconds).
Example:
2022-12-25T09:30:59ZCondition: Not available for derivativesScheduled start time (precision to seconds).
string
Format: RFC3339
Example:
Condition: Not available for derivativesExpiration time of the order (precision to seconds).
Example:
2022-12-25T09:30:59ZCondition: Not available for derivativesExpiration time of the order (precision to seconds).
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
Adds a client order identifier which uniquely identifies an open order for each client.For derivatives,
cl_ord_id must be in UUIDv4 format:- Long UUID:
6d1b345e-2821-40e2-ad83-4ecb18a0687632 hex characters separated with 4 dashes.
integer
Condition: Not available for derivatives (use
cl_ord_id instead)This is an optional non-unique, numeric identifier which can associated with a number of orders by the client. This field is mutually exclusive with cl_ord_id parameter.Many clients choose a unique integer value generated by their systems (i.e. a timestamp). However, because we don’t enforce uniqueness on our side, it can also be used to easily tag a group of orders for querying or cancelling.object
The conditional parameters are used as a template for generating the secondary close orders when the primary order fills. Each fill on the primary order will generate a new secondary order. The size of the secondary order will be the same size as the executed quantity and have the opposite side.
Hide properties
Hide properties
string
One of:
limit, stop-loss, stop-loss-limit, take-profit, take-profit-limit, trailing-stop, trailing-stop-limitDefines the order type of the secondary close orders which will be created on each fill.float
Defines the limit price on the secondary close orders. Only required on secondary order types that support limit price:
limit, stop-loss-limit, take-profit-limit.string
One of:
Default:
Condition: Only available on trailing-stop-limit ordersThe units for the limit price on the secondary order. Only
staticDefault:
staticCondition: Only available on trailing-stop-limit ordersThe units for the limit price on the secondary order. Only
static is supported for derivatives.static: a static market price for the asset, i.e. 30000 for BTC/USD.
trailing-stop-limit order type, the value represents offset from the trigger price. 0 would set a limit price the same as the trigger price.float
Specifies the amount for the trigger price - it supports both static market prices and relative prices. This field is used in combination with the
price_type field below to determine the effective trigger price.Examples:- To trigger at 29000.5 BTC/USD, use price=29000.5, price_type=static.
- To trigger when price rises by 5%, use price=5, price_type=pct.
- To trigger when price drops by 150 USD, use price=-150, price_type=quote.
trailing-stop and trailing-stop-limit order types, the price represents the reversion from the peak. It is always a positive offset value.string
One of:
Default:
staticDefault:
staticThe units for the trigger price. Only static is supported for derivatives.static: a static market price for the asset, i.e. 30000 for BTC/USD.
float
deprecated
Deprecated: Use trigger_priceDefines the trigger price on the secondary close orders. Only required on triggered secondary order types:
stop-loss, stop-loss-limit, take-profit, take-profit-limit.float
Condition: Not available for derivativesDefines the quantity to show in the book while the rest of order quantity remains hidden. Minimum value is 1 / 15 of
order_qty.string
One of:
Condition: Not available for derivatives (fee currency is fixed per contract)Fee preference base or quote currency.
base, quoteCondition: Not available for derivatives (fee currency is fixed per contract)Fee preference base or quote currency.
quote is the default for buy orders, base is the default for sell orders.boolean
deprecated
One of:
Default:
Condition: Market orders only
Deprecated: If supplied, the flag is accepted but ignoredDisables Market Price Protection (MPP) if set to
true, falseDefault:
falseCondition: Market orders only
Deprecated: If supplied, the flag is accepted but ignoredDisables Market Price Protection (MPP) if set to
true. MPP is a feature that protects market orders from filling at a bad price due to price slippage in an illiquid or volatile market.string
One of:
Default:
cancel_newestDefault:
cancel_newestSelf Trade Prevention (STP) is a protection feature to prevent users from inadvertently or deliberately trading against themselves. Only cancel_newest is available for derivatives.cancel_newest: arriving order will be canceled.
float
Condition: Not available for derivativesOrder volume expressed in quote currency.
boolean
One of:
Default:
true, falseDefault:
falseIf set to true the order will be validated only, it will not trade in the matching engine.string
Condition: Not available for derivativesAdds a alphanumeric sub-account/trader identifier which enables STP to be performed at a more granular level.The
sender_sub_id parameter can be one of the following formats:- Long UUID:
6d1b345e-2821-40e2-ad83-4ecb18a0687632 hex characters separated with 4 dashes. - Short UUID:
da8e4ad59b78481c93e589746b0cf91f32 hex characters with no dashes. - Free text:
arb-20240509-00010Free format ascii text up to 18 characters.
string
Format: 16 alphanumeric characters (
Example:
A-Z, 0-9) in 4 groups of 4Example:
AA16N84GV574COOQBroker IIBAN (Partner’s Kraken IIBAN). Attributes the order to the broker placing it on behalf of their client, so partner commission can be paid.Available to qualified partners in Kraken’s API Partner Program. Both spellings are accepted and are equivalent:- Grouped:
AA16 N84G V574 COOQwith a single space between each group of 4 characters. - Unspaced:
AA16N84GV574COOQ16 characters with no separators.
float
deprecated
Deprecated: Use ‘triggers’ objectThe stop price for trigger order types.
string
deprecated
One of:
Default:
Condition: Triggered order types only
Deprecated: Use ‘triggers’ objectThe reference price to trigger the order.
last, indexDefault:
lastCondition: Triggered order types only
Deprecated: Use ‘triggers’ objectThe reference price to trigger the order.
index: the index price for the broader market for this symbol.last: the last traded price in the order book for this symbol.
string
required
Authentication token. See authentication guide for details.
integer
Optional client originated request identifier sent as acknowledgment in the response.
string
Value:
add_orderobject
Hide properties
Hide properties
string
Unique order identifier generated by Kraken.
string
An optional, alphanumeric identifier specified by the client in the
add_order parameters.integer
An optional non-unique, numeric identifier specified by the client in the
add_order parameters.array of string
Non-fatal warnings about the order, if any.
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