Cancelling Orders

Cancel one or more open orders via PerpsClient.cancelOrders

Cancel one or more open orders through PerpsClient.cancelOrders. The registered provider plugin authorizes each cancellation with its SDK-managed credential; the user’s wallet is not prompted.

The examples on this page use Hyperliquid (provider: 'hyperliquid'). Replace the provider value with any supported provider from getProviders().

cancelOrders

const result = await perps.cancelOrders({
  provider: 'hyperliquid',
  address: userAddress,
  ids: ['12345678'],
});

Pass multiple IDs to cancel several orders in a single call:

await perps.cancelOrders({
  provider: 'hyperliquid',
  address: userAddress,
  ids: ['12345678', '12345679'],
});

Use the orderId returned from the placeOrder response to cancel orders. A venue rejection does not throw; check success on each entry of result.results. See Error Handling.

Hyperliquid’s cancelOrder takes ids only. assetId and the composite id form apply to venues with per-market order ids.

Per-market order IDs

Some venues scope order IDs per market rather than globally (e.g. Lighter’s order_index). For those, supply the market context so the cancel resolves to the right order — either pass the composite "<market_id>:<order_id>" form in ids, or set assetId to the order’s market.id:

// Composite form — market context carried inline
await perps.cancelOrders({
  provider: 'lighter',
  address: userAddress,
  ids: ['2:12345678'],
});

// Or the bare per-market id plus assetId
await perps.cancelOrders({
  provider: 'lighter',
  address: userAddress,
  ids: ['12345678'],
  assetId: '2',
});

Parameter	Type	Required	Description
provider	string	Yes	Provider identifier
address	Address	Yes	Account owner’s wallet address
ids	string[]	Yes	Venue order IDs. Per-market venues also accept the composite "<market_id>:<order_id>" form.
assetId	string	No	Market context (the order’s market.id) for per-market order IDs passed in bare form.

Cancel all orders

Where a provider’s descriptor advertises cancelAllOrders, cancel every open order in one action through execute. Lighter and Ondo advertise it; Hyperliquid does not. Ondo supports only timeInForce: 0.

import { ActionType } from '@lifi/perps-sdk';

const result = await perps.execute({
  provider: 'lighter',
  address: userAddress,
  action: ActionType.CANCEL_ALL_ORDERS,
  params: { timeInForce: 0 }, // 0 = immediate
});

Field	Type	Required	Description
timeInForce	number	Yes	0 cancels immediately, 1 schedules the cancel, 2 aborts a scheduled cancel
timestampMs	number	No	Unix ms timestamp; required for scheduled cancels

Account reads such as getOrders go directly to the venue. After cancelling, update your UI optimistically and re-read once after a short delay rather than polling.

API Reference: POST /createAction · /executeAction