v1

latestOpenAPI 3.0.32026-07-267278168.1 KB

Orders

Batch Cancel Orders

Cancels multiple orders in a single call. Returns results for each order. Provide a comma-separated list of order IDs via the orderIDs query parameter. Each entry can be an internal order ID or client:{clientOrderID}.

delete/v1/perps/orders/batch

Query parameters

orderIDsstring required

Example:abc123,def456

Comma-separated list of order IDs to cancel

Response

Batch cancel 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": {
    "successfulCancels": [
      {
        "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"
      }
    ],
    "failedCancels": [
      {
        "orderId": "70a37d8f972f2494837f9dba8364cbb4",
        "error": "order_already_canceled",
        "errorCode": "order_already_canceled"
      }
    ]
  }
}