v1

latestOpenAPI 3.0.32026-07-267278168.1 KB
Orders

Create Batched Orders

Creates multiple orders in a single API call. Some orders may succeed while others fail. The response code is 2XX as long as there is no internal server error. Returns 400 with error_code=batch_order_empty if the orders array is empty. Returns 400 with error_code=batch_order_too_many_orders if too many orders are provided (max 20). For the available order types and their behavior, see Order types.

post/v1/perps/orders/batch

Request body

Example request

{
  "orders": [
    {
      "side": "buy",
      "price": "1.55",
      "size": "20.30",
      "quoteSize": "13.0967",
      "market": "AAPL-USD.P",
      "clientOrderId": "order123",
      "type": "limit",
      "timeInForce": "GTC",
      "takeProfit": {
        "triggerPrice": "18000.00"
      },
      "stopLoss": {
        "triggerPrice": "18000.00"
      }
    }
  ]
}

Response

Batch order result

successboolean required

Whether the request was successful

errorstring

Error message, present only on failure

error_codestring

Semantic error code. See each endpoint's error responses for the specific codes it can return.

deprecatedstring

Deprecation notice, if applicable

Example response

{
  "success": true,
  "result": {
    "addedOrders": [
      {
        "orderId": "70a37d8f972f2494837f9dba8364cbb4",
        "clientOrderId": "order123",
        "parentOrderId": "twap_70a37d8f972f2494837f9dba8364cbb4",
        "side": "buy",
        "price": "1.55",
        "size": "20.30",
        "market": "AAPL-USD.P",
        "filledSize": "5.403",
        "lastFillSize": "5.403",
        "filledCost": "8.37465",
        "realizedPnl": "1.2345",
        "fee": "0.0837",
        "feeRebate": "0.0042",
        "status": "open",
        "createdAt": "2022-06-16T12:35:11.123456Z",
        "filledAt": "2022-06-16T12:35:11.123456Z",
        "canceledAt": "2022-06-16T12:35:11.123456Z",
        "cancelReason": "liquidation",
        "type": "limit",
        "timeInForce": "GTC",
        "liquidationId": "a1b2c3d4e5f60718293a4b5c6d7e8f90",
        "triggerPrice": "125.50"
      }
    ],
    "failedOrders": [
      {
        "order": {
          "side": "buy",
          "price": "1.55",
          "size": "20.30",
          "quoteSize": "13.0967",
          "market": "AAPL-USD.P",
          "clientOrderId": "order123",
          "type": "limit",
          "timeInForce": "GTC",
          "takeProfit": {
            "triggerPrice": "18000.00"
          },
          "stopLoss": {
            "triggerPrice": "18000.00"
          }
        },
        "error": "insufficient margin",
        "errorCode": "insufficient_margin"
      }
    ]
  }
}