Skip to main content

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.

To submit a new order, the client needs to send a NewOrderSingle message. All orders are submitted from the client’s perspective to Kraken exchange to place bid/offer on the Kraken Order book. A range of order types, Time-In-Force (TIF) and order flags can be specified by the parameters below. The supported order types are:
  • market: The full order quantity executes immediately at the best available price in the order book.
  • limit: The full order quantity is placed immediately with a limit price restriction to only trade at this price or better.
  • limitallin: The limit order price and quantity includes the fees.
​
header
required
MsgType D
​
1 - Account
string
The specific account for this order. Required if multiple accounts are enabled.
​
11 - ClOrdID
string
required
Unique identifier for Order as assigned by the client. Must be <= 36 characters. UUIDs are recommended.
​
55 - Symbol
string
required
The symbol of the currency pair to place an order on in the format BASE-QUOTE.
​
54 - Side
integer
required
Side of the order.
    Possible values:
  • 1 : Buy
  • 2 : Sell
​
40 - OrdType
char
required
The execution model of the order.
    Possible values:
  • 1 : market
  • 2 : Limit
  • A : LimitAllIn
​
38 - OrderQty
float
required
Order quantity in terms of the base asset.
​
15 - Currency
string
The currency the quantity is specified in. If not specified, defaults to the base currency for the symbol.
​
44 - Price
float
Limit price of the order to be placed in the Order Book. Required when OrderType=Limit/LimitAllIn.
​
59 - TimeInForce
string
required
Specifies how long the order remains in effect.
    Possible values:
  • 1 : GTC (Good till canceled)
  • 3 : IOC (Immediate or Cancel)
  • 4 : Fill Or Kill (FOK)
​
60 - TransactTime
string
required
Business timestamp for this request. Format: YYYYMMDD-HH:MM:SS.uuu
​
126 - ExpireTime
string
Optional expiration time for the order. Only valid on orders with TimeInForce=1 (GTC). Required when TimeinForce=GTD. Format: YYYYMMDD-HH:MM:SS
​
168 - EffectiveTime
string
Time at which this order will activate and begin sending orders to the market. Format: YYYYMMDD-HH:MM:SS.uuu
​
847 - TargetStrategy
string
Allows Specifying an Order Strategy Type.
    Possible values:
  • StopLimit : This strategy will only place the order once the specified stop price has been met. For a Buy StopLimit order, the stop price must be above the current market price. For a Sell StopLimit order, the stop price must be below the current market price.
  • TakeProfitLimit : This strategy will only place the order once the specified take profit price has been met. For a Buy TakeProfitLimit order, the take profit price must be below the current market price. For a Sell TakeProfitLimit order, the take profit price must be above the current market price.
​
957 - NoStrategyParams
integer
The number of strategy parameter repeating groups
​
958 - StrategyParameterName
string
The name of the StrategyParameter being set
​
960 - StrategyParameterValue
string
The value for the StrategyParameter being set
​
20030 - CancelOnDisconnect
string
Whether or not this order should be canceled when this session is disconnected. Possible values: Y, N. Default: Y
​
trailer
required