Skip to main content

getPositions

Get all active DeFi positions for a user across protocols. Optionally filter by chain.

Signature

getPositions(userAddress: string, chainId?: SupportedChainId): Promise<PositionsResponse>

Parameters

ParameterTypeRequiredDescription
userAddressstringUser's EOA address
chainIdSupportedChainIdOptional: Filter by specific chain ID

Returns

User's positions across all protocols

Return Type

interface PositionsResponse {
success: boolean;
userAddress: string;
positions: Position[];
}

Example

// Get all positions across all chains
const positions = await sdk.getPositions("0xUser...");

// Get positions on Arbitrum only
const arbPositions = await sdk.getPositions("0xUser...", 42161);