getPositions

Fetch open positions

Returns the user’s open positions.

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

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

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

for (const pos of result.positions) {
  console.log(pos.market.baseAsset.displaySymbol, pos.side, pos.size, 'PnL:', pos.unrealizedPnl);
}

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.marketId	string	No	Filter by the canonical Market.id (not display symbol)
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

Returns

PositionsResponse:

Field	Type	Description
provider	string	Provider identifier
positions	Position[]	Open positions
pagination	Pagination	Pagination metadata. Hyperliquid, Lighter and Ondo return all open positions in one response with hasMore: false.

Position fields

Field	Type	Description
market	PerpsMarketDisplay	Market identity (providerId, id, categoryId, baseAsset, quoteAsset, isDelisted, positionMarginAdjustment). Display symbol is market.baseAsset.displaySymbol.
side	'LONG' | 'SHORT'	Position direction
size	string	Position size, in base-asset units
entryPrice	string	Average entry price
markPrice	string	Current mark price
liquidationPrice	string	Estimated liquidation price
unrealizedPnl	string	Unrealized profit/loss, in quote-currency units
accruedFunding	string	Funding accrued since the position opened. Positive means funding received, negative means funding paid.
leverage	number	Current leverage
marginUsed	string	Margin reserved by the position, as the venue reports it. Hyperliquid isolated marginUsed includes the position’s unrealized PnL; Lighter allocated_margin excludes it. See Position Margin.
initialMarginRequirement	string	Exact initial margin the venue currently requires for the position, safe for risk calculations
marginMode	'ISOLATED' | 'CROSS'	Margin mode

Prices and PnL are in quote-currency units; size is in base-asset units.

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