Cancel Orders (WebSocket)

Cancel one or more existing orders through the WebSocket connection for fastest order management.

Action Result Notifications

This method executes cancellations immediately. Cancellation events are automatically sent via SubAccount Updates Subscription if subscribed.

Endpoint

ws.send() wss://api.synthetix.io/v1/ws/trade

Request

Request Format

Cancel by venue order ID:

{
  "id": "cancel-1",
  "method": "post",
  "params": {
    "action": "cancelOrders",
    "subAccountId": "1867542890123456789",
    "orderIds": ["1948058938469519360", "1948058938469519361"],
    "nonce": 1704067200000,
    "expiresAfter": 1704067300,
    "signature": {
      "v": 28,
      "r": "0x1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF",
      "s": "0xABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890"
    }
  }
}

Cancel by client order ID (CLOID):

{
  "id": "cancel-2",
  "method": "post",
  "params": {
    "action": "cancelOrders",
    "subAccountId": "1867542890123456789",
    "clientOrderIds": ["my-order-alpha", "my-order-beta"],
    "nonce": 1704067200001,
    "expiresAfter": 1704067300,
    "signature": {
      "v": 28,
      "r": "0x1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF",
      "s": "0xABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890"
    }
  }
}

Note: orderIds and clientOrderIds are mutually exclusive. Providing both in the same request returns a validation error.

Parameters

Request Parameters

Parameter	Type	Required	Description
`id`	string	Yes	Client-generated unique request identifier
`method`	string	Yes	Must be `"post"`
`params`	object	Yes	Contains all parameters for the request

Params Object

Parameter	Type	Required	Description
`action`	string	Yes	Must be `"cancelOrders"`
`subAccountId`	string	Yes	Subaccount ID to cancel orders from
`orderIds`	array	Conditional	Array of venue order IDs to cancel (strings). Mutually exclusive with `clientOrderIds`.
`clientOrderIds`	array	Conditional	Array of client order IDs (CLOIDs) to cancel (strings). Mutually exclusive with `orderIds`.
`nonce`	integer	Yes	Positive integer, incrementing nonce
`expiresAfter`	integer	No	Optional expiration Unix timestamp in seconds (0 = no expiration)
`signature`	object	Yes	EIP-712 signature with v, r, s components

Exactly one of orderIds or clientOrderIds must be provided.

EIP-712 Type Definition

Cancel by venue order ID (orderIds mode) — uses primary type CancelOrders:

const CancelOrdersTypes = {
  CancelOrders: [
    { name: "subAccountId", type: "uint256" },
    { name: "orderIds", type: "uint256[]" },
    { name: "nonce", type: "uint256" },
    { name: "expiresAfter", type: "uint256" }
  ]
}

Note: orderIds is uint256[] in EIP-712, but sent as string[] in the JSON request body.

Cancel by client order ID (clientOrderIds mode) — uses primary type CancelOrdersByCloid:

const CancelOrdersByCloidTypes = {
  CancelOrdersByCloid: [
    { name: "subAccountId", type: "uint256" },
    { name: "clientOrderIds", type: "string[]" },
    { name: "nonce", type: "uint256" },
    { name: "expiresAfter", type: "uint256" }
  ]
}

clientOrderIds is string[] in both the EIP-712 type and the JSON request body. The EIP-712 primary type must match the cancel mode used.

Response Format

Success Response

{
  "id": "cancel-1",
  "status": 200,
  "result": {
    "status": "ok",
    "response": {
      "statuses": [
        {
          "canceled": {
            "order": {
              "venueId": "1948058938469519360",
              "clientId": "cli-1948058938469519360"
            },
            "id": "1948058938469519360"
          }
        },
        {
          "canceled": {
            "order": {
              "venueId": "1948058938469519361",
              "clientId": "cli-1948058938469519361"
            },
            "id": "1948058938469519361"
          }
        }
      ]
    },
    "requestId": "5ccf215d37e3ae6d"
  }
}

Partial Success Response

If some orders fail to cancel, the per-item status uses error / errorCode instead of canceled:

{
  "id": "cancel-1",
  "status": 200,
  "result": {
    "status": "ok",
    "response": {
      "statuses": [
        {
          "canceled": {
            "order": {
              "venueId": "1948058938469519360",
              "clientId": "cli-1948058938469519360"
            },
            "id": "1948058938469519360"
          }
        },
        {
          "error": "Order not found",
          "errorCode": "ORDER_NOT_FOUND"
        }
      ]
    },
    "requestId": "5ccf215d37e3ae6d"
  }
}

Migration Note: In each status object, use canceled.order.venueId as canonical. canceled.id is deprecated compatibility output.

Error Response

{
  "id": "cancel-1",
  "status": 400,
  "result": null,
  "error": {
    "code": 400,
    "message": "Invalid request parameters"
  }
}

Implementation Example

// Cancel single order
const subAccountId = "1867542890123456789";
const nonce = Date.now();
const expiresAfter = Math.floor(Date.now() / 1000) + 30; // 30 seconds from now
 
// Create EIP-712 signature (see EIP-712 Signing section below)
const signature = await signCancelOrders({
  subAccountId,
  orderIds: ["1948058938469519360"],
  nonce,
  expiresAfter
});
 
const cancelRequest = {
  id: "cancel-1",
  method: "post",
  params: {
    action: "cancelOrders",
    subAccountId,
    orderIds: ["1948058938469519360"],
    nonce,
    expiresAfter,
    signature
  }
};
 
ws.send(JSON.stringify(cancelRequest));
 
// Cancel multiple orders
const cancelMultiple = {
  id: "cancel-2",
  method: "post",
  params: {
    action: "cancelOrders",
    subAccountId,
    orderIds: ["1948058938469519360", "1948058938469519361", "1948058938469519362"],
    nonce: Date.now(),
    expiresAfter: Math.floor(Date.now() / 1000) + 30,
    signature: await signCancelOrders({
      subAccountId,
      orderIds: ["1948058938469519360", "1948058938469519361", "1948058938469519362"],
      nonce: Date.now(),
      expiresAfter: Math.floor(Date.now() / 1000) + 30
    })
  }
};
 
ws.send(JSON.stringify(cancelMultiple));
 
// Handle response
ws.onmessage = (event) => {
  const response = JSON.parse(event.data);
 
  if (response.id === "cancel-1") {
    if (response.result?.status === "ok") {
      response.result.response.statuses.forEach(status => {
        if (status.canceled) {
          const venueId = status.canceled.order?.venueId;
          console.log(`Order ${venueId}: canceled`);
        } else if (status.error) {
          console.error(`Order error: ${status.error} (${status.errorCode})`);
        }
      });
    } else if (response.error) {
      console.error(`Request error: ${response.error.message}`);
    }
  }
};

Implementation Notes

Exactly one of orderIds or clientOrderIds must be provided per request
The provided array must contain at least one entry
Client order IDs must not have leading or trailing whitespace
Orders must belong to the authenticated subaccount
Authentication timestamps must be strictly increasing per subaccount
EIP-712 domain separator must use "Synthetix" for WebSocket endpoints
When using clientOrderIds, the EIP-712 primary type must be CancelOrdersByCloid (not CancelOrders)

Cancellation Behavior

Only OPEN and PARTIALLY_FILLED orders can be cancelled
Filled portions of partially filled orders remain executed
Cancellation is immediate upon validation
Freed margin becomes available instantly

Signing

All trading methods are signed using EIP-712. Each successful trading request will contain:

A piece of structured data that includes the sender address
A signature of the hash of that structured data, signed by the sender

For detailed information on EIP-712 signing, see EIP-712 Signing.

Nonce Management

The nonce system prevents replay attacks and ensures order uniqueness:

Use any positive integer as nonce
Each nonce must be greater than the previous one (incrementing)
Date.now() is a convenient option, not a requirement
If nonce conflicts occur, increment by 1 and retry

:::note SubAccountAction Exception SubAccountAction endpoints (getPositions, getOpenOrders, getOrderHistory, getTrades, getFundingPayments, getSubAccount, getSubAccounts, getDelegatedSigners, getBalanceUpdates, getWithdrawableAmounts) do not require a nonce. Only the signature and optional expiresAfter parameters are needed. :::

Error Code	Description	Retryable
`UNAUTHORIZED`	EIP-712 signature validation failed	No
`VALIDATION_ERROR`	Request validation failed	No
`MISSING_REQUIRED_FIELD`	Required field is missing	No
`INVALID_FORMAT`	Field format is invalid	No
`INVALID_VALUE`	Invalid parameter value	No
`RATE_LIMIT_EXCEEDED`	Too many requests in time window	Yes
`INSUFFICIENT_MARGIN`	Not enough margin for trade	No
`ORDER_NOT_FOUND`	Order does not exist	No
`OPERATION_TIMEOUT`	Operation timed out	Yes

Next Steps

Modify Order - Order modification via WebSocket
Cancel All Orders - Emergency cancellation
REST Alternative - REST API comparison