Skip to main content
Returns the user’s open orders and trigger orders, paginated.
The examples on this page use Hyperliquid (provider: 'hyperliquid'). Replace the provider value with any supported DEX from getProviders().
import { getOrders } from '@lifi/perps-sdk';

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

for (const order of result.openOrders) {
  console.log(order.market.baseAsset.displaySymbol, order.side, order.type, order.price);
}
for (const trigger of result.triggerOrders) {
  console.log(trigger.market.baseAsset.displaySymbol, trigger.type, trigger.triggerPrice);
}

Parameters

ParameterTypeRequiredDescription
clientPerpsSDKClientYesSDK client
params.providerstringYesDEX identifier
params.addressstringYesUser’s wallet address
params.marketIdstringNoFilter by the canonical Market.id (not display symbol)
params.limitnumberNoItems per page (default 50, max 100)
params.cursorstringNoPagination cursor from previous response
optionsSDKRequestOptionsNoRequest options

Returns

OrdersResponse:
FieldTypeDescription
providerstringProvider identifier
openOrdersOpenOrder[]Resting limit orders
triggerOrdersTriggerOrder[]Pending trigger orders (TP/SL)
paginationPaginationPagination metadata

OpenOrder fields

FieldTypeDescription
orderIdstringOrder ID
marketMarketDisplayMarket identity. Display symbol is market.baseAsset.displaySymbol.
side'BUY' | 'SELL'Order direction
typeOrderTypeOrder type
sizestringOrder size
pricestringLimit price
filledSizestringAmount filled
reduceOnlybooleanWhether reduce-only
labelstring?Optional order label
createdAtstringISO 8601 timestamp

TriggerOrder fields

FieldTypeDescription
orderIdstringOrder ID
marketMarketDisplayMarket identity. Display symbol is market.baseAsset.displaySymbol.
typeOrderTypeTrigger order type (e.g., TAKE_PROFIT_MARKET, STOP_LIMIT) — see OrderType
sizestringOrder size
triggerPricestringPrice at which the order activates
limitPricestring?Execution limit price (market order if omitted)
labelstring?Optional order label
createdAtstringISO 8601 timestamp

OrderType

ValueDescription
MARKETMarket order — executes immediately at the best available price
LIMITLimit order — rests until filled, cancelled, or expired
STOP_MARKETStop-market — converts to a market order when the trigger price is hit
STOP_LIMITStop-limit — converts to a limit order when the trigger price is hit
TAKE_PROFIT_MARKETTake-profit market order
TAKE_PROFIT_LIMITTake-profit limit order
TRIGGER_ONLYTrigger-only order (provider-specific; e.g., Lighter’s bare-trigger marker for orders whose final type is decided when the trigger fires)
API Reference: GET /orders