getOrders

Fetch active and historical orders (regular, trigger, and TWAP) by status

Returns the user’s orders as a single Order[] list. By default it returns active orders; pass statuses to read order history.

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

import { getOrders, isRegularOrder, isTriggerOrder, isTwapOrder } from '@lifi/perps-sdk';

const result = await getOrders(client, {
  provider: 'hyperliquid',
  address: userAddress,
});

for (const order of result.orders) {
  if (isTriggerOrder(order)) {
    console.log(order.market.baseAsset.displaySymbol, order.type, order.triggerPrice, order.triggerCondition);
  } else if (isTwapOrder(order)) {
    console.log(order.market.baseAsset.displaySymbol, 'TWAP', order.durationSeconds, order.startedAt);
  } else if (isRegularOrder(order)) {
    console.log(order.market.baseAsset.displaySymbol, order.side, order.type, order.price, order.timeInForce);
  }
}

​

Parameters

Parameter	Type	Required	Description
client	PerpsSDKClient	Yes	SDK client
params.provider	string	Yes	Provider identifier
params.address	Address	Yes	User’s wallet address (viem 0x${string})
params.statuses	OrderStatus[]	No	Lifecycle statuses to return. Defaults to the active set: OPEN, PENDING, ACCEPTED, PARTIALLY_FILLED, TRIGGERED. An empty array returns no orders. On Ondo, an empty array without a session throws SetupRequired.
params.marketId	string	No	Filter by the canonical Market.id (not display symbol). Applies to TWAP parents too.
params.limit	number	No	Maximum items returned; provider defaults and caps apply
params.cursor	string	No	Opaque pagination cursor from a previous response
options	SDKRequestOptions	No	Request options

Hyperliquid getOrders is not paginated. Lighter pages order history at 100 items.

​

Order history

Pass terminal statuses to read historical orders. Hyperliquid reads historicalOrders; Lighter reads accountInactiveOrders. TWAP parents are always fetched and filtered by statuses.

import { getOrders, OrderStatus } from '@lifi/perps-sdk';

const history = await getOrders(client, {
  provider: 'hyperliquid',
  address: userAddress,
  statuses: [OrderStatus.FILLED, OrderStatus.CANCELLED, OrderStatus.REJECTED, OrderStatus.EXPIRED],
  limit: 50,
});

for (const order of history.orders) {
  console.log(order.orderId, order.status, order.statusReason, order.filledSize);
}

if (history.pagination.hasMore) {
  const nextPage = await getOrders(client, {
    provider: 'hyperliquid',
    address: userAddress,
    statuses: [OrderStatus.FILLED],
    cursor: history.pagination.cursor,
  });
}

​

Returns

OrdersResponse:

Field	Type	Description
provider	string	Provider identifier
orders	Order[]	RegularOrder | TriggerOrder | TwapOrder, discriminated on type
pagination	Pagination	Pagination metadata

Narrow the union with isRegularOrder, isTriggerOrder and isTwapOrder, all exported from @lifi/perps-sdk.

​

Order fields

Every order carries these fields:

Field	Type	Description
orderId	string	Venue-assigned id: Hyperliquid oid, Lighter order_index, Ondo orderId
clientOrderId	string?	Client-set id, absent when the placer set none
market	MarketDisplay	Market identity. Display symbol is market.baseAsset.displaySymbol.
side	OrderSide	Order direction
type	OrderType	Order type — see OrderType
status	OrderStatus	Lifecycle status — see Order Status
statusReason	string?	Venue text for a REJECTED or CANCELLED order, when the venue gives one
originalSize	string	Quantity the order was submitted for, in base-asset units
remainingSize	string	Quantity not yet filled, in base-asset units
filledSize	string	Quantity already filled, in base-asset units
averagePrice	string?	Average fill price
reduceOnly	boolean	Whether reduce-only
parentOrderId	string?	Parent of a placement TP/SL leg or TWAP child. Absent on position-level triggers.
explorerLink	string?	Set only when the venue row carries a transaction hash
createdAt	string	ISO 8601 timestamp
updatedAt	string	ISO 8601 timestamp

RegularOrder (type is MARKET or LIMIT) adds:

Field	Type	Description
price	string?	Limit price
timeInForce	TimeInForce	Time-in-force policy
expiresAt	string?	Expiry, when the order has one

TriggerOrder (type is a stop or take-profit type) adds:

Field	Type	Description
triggerPrice	string?	Price at which the order activates. Absent when the venue reports none.
triggerCondition	TriggerCondition	Whether the trigger fires above or below triggerPrice
limitPrice	string?	For a *_LIMIT type, the limit price. For a *_MARKET type, the slippage-adjusted limit price that the venue holds, when the venue holds one.

TwapOrder (type is TWAP) adds:

Field	Type	Description
durationSeconds	number	Total execution window in seconds
startedAt	string	ISO 8601 timestamp the TWAP started executing

​

OrderType

Value	Description
MARKET	Market order — executes immediately at the best available price
LIMIT	Limit order — rests until filled, cancelled, or expired
STOP_MARKET	Stop-market — converts to a market order when the trigger price is hit
STOP_LIMIT	Stop-limit — converts to a limit order when the trigger price is hit
TAKE_PROFIT_MARKET	Take-profit market order
TAKE_PROFIT_LIMIT	Take-profit limit order
TWAP	Read-side only — a TWAP parent surfaced in the venue’s order feed. Placement always goes through placeTwapOrder, never a type on placeOrder.

​

Reading TWAP orders

TWAP parents are returned by getOrders as TwapOrders. There is no separate TWAP read. Filter with isTwapOrder; the parent’s orderId is the twapId that cancelTwapOrder expects.

import { getOrders, isTwapOrder } from '@lifi/perps-sdk';

const { orders } = await getOrders(client, {
  provider: 'hyperliquid',
  address: userAddress,
});

for (const twap of orders.filter(isTwapOrder)) {
  console.log(twap.orderId, twap.status, twap.filledSize, '/', twap.originalSize);
}

A running TWAP has status OPEN or PARTIALLY_FILLED; a finished one is FILLED, a terminated one CANCELLED, and an errored one REJECTED. Child orders carry the parent’s id in parentOrderId. See TWAP Orders for cancelling.

To look up a single order by id rather than listing orders, use getOrder() (see Order Status). On Lighter, getOrder() accepts a client_order_index-prefixed id built from a placed order’s clientOrderIndex — see Lighter / Trading.

​

Throws

PerpsError with one code for the account’s access state. See Account access.

• SetupRequired — the venue needs a credential (a Lighter auth token or an Ondo session) and none is stored.
• Unauthorized — the venue rejects the credential.
• AccountNotFound — the wallet has no venue account.

An account with no matching orders returns an empty orders list.

Data shapes: getOrders — a direct-to-provider read, not a LI.FI HTTP endpoint.