Trading

Add Order Batch

Sends a collection of orders (minimum of 2 and maximum 15):

  • Validation is performed on the whole batch prior to submission to the engine. If an order fails validation, the whole batch will be rejected.
  • On submission to the engine, if an order fails pre-match checks (i.e. funding), then the individual order will be rejected and remainder of the batch will be processed.
  • All orders in batch are limited to a single pair.

Note: See the AssetPairs endpoint for details on the available trading pairs, their price and quantity precisions, order minimums, available leverage, etc.

API Key Permissions Required: Orders and trades - Create & modify orders and Orders and trades - Cancel & close orders

post/private/AddOrderBatch

Request

  • Base URL: https://api.kraken.com/0
  • URL: https://api.kraken.com/0/private/AddOrderBatch
  • Auth: API key in header API-Key and API key in header API-Sign

Request body

nonceinteger required

Nonce used in construction of API-Sign header

pairstring required

Asset pair id or altname

asset_class'tokenized_asset'

This parameter is required on requests for non-crypto pairs, i.e. use tokenized_asset for xStocks.

deadlinestring

RFC3339 timestamp (e.g. 2021-04-01T00:18:45Z) after which the matching engine should reject the new order request, in presence of latency or order queueing. min now() + 2 seconds, max now() + 60 seconds.

validateboolean

Validate inputs only. Do not submit order.

brokerstring nullable

Broker IIBAN (Partner's Kraken IIBAN)

Example request

{
  "nonce": 1695828490,
  "orders": [
    {
      "close": {
        "ordertype": "stop-loss-limit",
        "price": "37000",
        "price2": "36000"
      },
      "ordertype": "limit",
      "price": "40000",
      "price2": "string",
      "timeinforce": "GTC",
      "type": "buy",
      "cl_ord_id": "6d1b345e-2821-40e2-ad83-4ecb18a06876",
      "volume": "1.2"
    },
    {
      "ordertype": "limit",
      "price": "42000",
      "starttm": "string",
      "timeinforce": "GTC",
      "type": "sell",
      "cl_ord_id": "da8e4ad59b78481c93e589746b0cf91",
      "volume": "1.2"
    }
  ],
  "pair": "BTC/USD",
  "validate": false,
  "deadline": "2023-09-24T14:15:22Z"
}

Response

The order of returned orders in the response array is the same as the order of the order list sent in request.

Example response

{
  "error": [],
  "result": {
    "orders": [
      {
        "txid": "65LRD3-AHGRA-YAH8E5",
        "descr": {
          "order": "buy 1.02010000 XBTUSD @ limit 29000.0"
        }
      },
      {
        "txid": "OK8HFF-5J2PL-XLR17S",
        "descr": {
          "order": "sell 0.14000000 XBTUSD @ limit 40000.0"
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.