getAccount

Fetch account balances, margin, and fee tier

Returns the account summary for a DEX including balances, margin, and fee tier.

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

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

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

console.log('Balances:', account.balances); // { perps: [...], spot: [...] }
console.log('Margin used:', account.marginUsed);
console.log('Unrealized PnL:', account.unrealizedPnl);

Parameters

Parameter	Type	Required	Description
client	PerpsSDKClient	Yes	SDK client from createPerpsClient()
params.provider	string	Yes	DEX identifier
params.address	string	Yes	User’s wallet address
options	SDKRequestOptions	No	Request options

Returns

AccountResponse:

Field	Type	Description
provider	string	Provider identifier
address	string	User’s wallet address
balances	Record<string, Balance[]>	Account balances grouped by venue (e.g., "perps", "spot")
marginUsed	string	Margin currently in use
unrealizedPnl	string	Total unrealized PnL
feeTier	FeeTier	Maker and taker fee rates
config	object	DEX-specific account configuration (agent status, builder fee, etc.)

Positions and orders are fetched separately via getPositions() and getOrders().

API Reference: GET /account