New Order Single

REQUEST
wss://wss.prime.kraken.com/ws/v1
new-order-singleAuthentication Required

Command used to submit a new order either against any provided liquidity or an open RFQ. Results of this command will be visible in the ExecutionReport and Trade streams which will track the lifecycle of the order.

Request

Request Schema

reqid number required

Request ID.

type string required

Value: NewOrderSingle

Command type.

data array [ required

Order data array.

Symbol string required

Example: BTC-USD

Symbol of the security to submit an order on.

ClOrdID string required

Format: UUID

Unique Client Order ID for this request.

Side string required

Possible values: [Buy, Sell]

Side of the order.

OrderQty string required

Format: decimal

Order quantity in units of Currency.

OrdType string required

Possible values: [Market, Limit, RFQ]

Order type.

Price string

Order limit price, required for Limit orders.

Currency string

The currency that the quantity is specified in. If not specified, defaults to the base currency for the symbol.

TimeInForce string required

Possible values: [GoodTillCancel, FillAndKill, FillOrKill]

Specifies how long the order remains in effect.

Strategy string

Possible values: [SteadyPace, StopLimit]

Optional order strategy to use for algorithmic orders.

QuoteID string

Optional QuoteID to trade on. Must be specified when OrdType=RFQ.

RFQID string

Optional RFQID to trade on. Must be specified when OrdType=RFQ.

AllowedSlippage string

Optional allowed price slippage for Limit order placed against RFQ.

TransactTime string

Format: ISO-8601 UTC

Example: 2019-02-13T05:17:32.000000Z

Transaction timestamp.

Parameters object

Optional order strategy parameters.

]

Example

{
  "reqid": 12,
  "type": "NewOrderSingle",
  "data": [
    {
      "Symbol": "BTC-USD",
      "ClOrdID": "4d489920-15da-11ec-b5e7-7f4881f01b7d",
      "Side": "Buy",
      "TransactTime": "2021-09-15T04:06:28.530000Z",
      "OrderQty": "0.5",
      "OrdType": "Limit",
      "Price": "43000",
      "Currency": "BTC",
      "TimeInForce": "GoodTillCancel",
      "Strategy": "SteadyPace",
      "Parameters": {
        "ErrorAction": "Pause"
      }
    }
  ]
}

Supported Order Strategies

SteadyPace

A schedule-based algorithm that divides an order into suborders (clips) and submits them at equal, user defined intervals.

Parameters:

• ClipSize (Qty, required): A quantity (subset of the total order size) to send on each execution of the schedule.
• ClipInterval (string, required): Time interval between individual clips specified as an interval string.
• StartTime (string, optional): Time at which this order will activate and begin sending orders.
• EndTime (string, optional): Optional expire time for the order.
• Variance (decimal, optional): Optional degree of randomization for clip sizes.

StopLimit

This strategy will only place the order once the specified stop price has been met.

Parameters:

• TriggerPrice (Price, required): The price that must be met to trigger execution of the order.
• EndTime (string, optional): Optional expire time for the order.