Orders

Cancel batch of orders by order IDs

Changed on

Queues cancellation for multiple orders by providing identifiers in a batch.

The request body can contain either or both of:

  • order_ids: Array of order IDs assigned by Paradex
  • client_order_ids: Array of client-assigned order IDs
{
  "order_ids": ["order-id-1", "order-id-2"],
  "client_order_ids": ["client-id-1", "client-id-2"]
}

Returns a 200 OK status code with detailed results for each order:

{
  "results": [
    {
      "id": "order-id-1",
      "client_id": "client-id-X",
      "account": "account-1",
      "market": "BTC-USD-PERP",
      "status": "QUEUED_FOR_CANCELLATION"
    },
    {
      "id": "order-id-2",
      "client_id": "client-id-Y",
      "account": "account-1",
      "market": "ETH-USD-PERP",
      "status": "ALREADY_CLOSED"
    },
    {
      "id": "order-id-3",
      "client_id": "client-id-1",
      "account": "account-1",
      "market": "BTC-USD-PERP",
      "status": "QUEUED_FOR_CANCELLATION"
    },
    {
      "client_id": "client-id-2",
      "status": "NOT_FOUND"
    }
  ]
}

Each result includes:

  • id: Order ID (if the order was found)
  • client_id: Client order ID (if available)
  • account: Account that owns the order
  • market: Market of the order
  • status: One of:
    • QUEUED_FOR_CANCELLATION: Order was successfully queued for cancellation
    • ALREADY_CLOSED: Order was already in a closed state
    • NOT_FOUND: The order with the provided ID/client ID was not found

Confirmation of cancellation will be sent via websocket or can be verified from GET /orders/:id endpoint.

Orders that are already in a CLOSED state will be included in the response with status "ALREADY_CLOSED".

delete/orders/batch

Request

  • Base URL
    https://api.prod.paradex.trade/v1
  • URL
    https://api.prod.paradex.trade/v1/orders/batch
  • Auth
    API key in header Authorization

Request body

client_order_idsstring[]

List of client order IDs to cancel

order_idsstring[]

List of order IDs to cancel

Example request

{
  "client_order_ids": [
    "[\"client-id-1\"",
    "\"client-id-2\"]"
  ],
  "order_ids": [
    "[\"order-id-1\"",
    "\"order-id-2\"]"
  ]
}

Response

List of cancellation results

Changes

    • warning

      added the new ADDRESS_BOOK_NOT_PARADEX_ACCOUNT enum value to the //// response property for the response status

    • warning

      added the new ADDRESS_BOOK_REPEATED_IN_IMPORT enum value to the //// response property for the response status

    • warning

      added the new STARKNET_PARENT_ONBOARDING_DISABLED enum value to the //// response property for the response status

    • warning

      added the new SESSION_EXPIRED enum value to the //// response property for the response status

    • warning

      added the new SESSION_REVOKED enum value to the //// response property for the response status