> ## Documentation Index > Fetch the complete documentation index at: https://mintlify.com/drift-labs/protocol-v2/llms.txt > Use this file to discover all available pages before exploring further. # User > User account management and position tracking for Drift Protocol v2 # User The `User` class provides methods for managing individual user accounts, tracking positions, calculating margins, and analyzing account health. ## Constructor ```typescript theme={null} new User(config: UserConfig) ``` Configuration object for initializing the User DriftClient instance Public key of the user account Account subscription configuration ## Subscription Methods ### subscribe Subscribes to user account state updates. ```typescript theme={null} await user.subscribe(userAccount?: UserAccount): Promise ``` Optional pre-fetched user account data Returns `true` if subscription was successful ### unsubscribe Unsubscribes from user account updates. ```typescript theme={null} await user.unsubscribe(): Promise ``` ### fetchAccounts Forces a fetch of fresh account data from RPC. ```typescript theme={null} await user.fetchAccounts(): Promise ``` ## Account Data Methods ### getUserAccount Returns the current user account data. ```typescript theme={null} user.getUserAccount(): UserAccount ``` User account containing positions, orders, and settings ### getUserAccountAndSlot Returns user account data with the slot number. ```typescript theme={null} user.getUserAccountAndSlot(): DataAndSlot | undefined ``` User account data with slot information ### exists Checks if the user account exists on-chain. ```typescript theme={null} await user.exists(): Promise ``` Returns `true` if the account exists ## Position Methods ### getPerpPosition Returns the user's position for a specific perpetual market. ```typescript theme={null} user.getPerpPosition(marketIndex: number): PerpPosition | undefined ``` Perpetual market index Perpetual position data or undefined if no position exists ### getSpotPosition Returns the user's position for a specific spot market. ```typescript theme={null} user.getSpotPosition(marketIndex: number): SpotPosition | undefined ``` Spot market index Spot position data or undefined if no position exists ### getActivePerpPositions Returns all active perpetual positions. ```typescript theme={null} user.getActivePerpPositions(): PerpPosition[] ``` Array of active perpetual positions ### getActiveSpotPositions Returns all active spot positions. ```typescript theme={null} user.getActiveSpotPositions(): SpotPosition[] ``` Array of active spot positions ### getTokenAmount Returns the token amount for a spot market position in the token's native precision. ```typescript theme={null} user.getTokenAmount(marketIndex: number): BN ``` Spot market index Token amount (positive for deposits, negative for borrows) ## Order Methods ### getOrder Returns an order by its order ID. ```typescript theme={null} user.getOrder(orderId: number): Order | undefined ``` Order ID to retrieve Order data or undefined if not found ### getOrderByUserOrderId Returns an order by its user-defined order ID. ```typescript theme={null} user.getOrderByUserOrderId(userOrderId: number): Order | undefined ``` User-defined order ID Order data or undefined if not found ### getOpenOrders Returns all open orders. ```typescript theme={null} user.getOpenOrders(): Order[] ``` Array of open orders ## Margin & Collateral Methods ### getFreeCollateral Calculates free collateral available for trading. ```typescript theme={null} user.getFreeCollateral( marginCategory?: MarginCategory, enterHighLeverageMode?: boolean, perpMarketIndex?: number ): BN ``` Margin category: 'Initial' or 'Maintenance' Whether to calculate for high leverage mode Specific perp market index for isolated margin calculation Free collateral in USDC precision (1e6) ### getTotalCollateral Calculates total collateral including unrealized PnL. ```typescript theme={null} user.getTotalCollateral( marginCategory?: MarginCategory, strict?: boolean, includeOpenOrders?: boolean, liquidationBuffer?: BN, perpMarketIndex?: number ): BN ``` Margin category: 'Initial' or 'Maintenance' Whether to use strict oracle prices Whether to include open orders in calculation Liquidation buffer to apply Specific perp market for isolated margin Total collateral in USDC precision (1e6) ### getMarginRequirement Calculates the margin requirement for the account. ```typescript theme={null} user.getMarginRequirement( marginCategory: MarginCategory, liquidationBuffer?: BN, strict?: boolean, includeOpenOrders?: boolean, enteringHighLeverage?: boolean, perpMarketIndex?: number ): BN ``` Margin category: 'Initial' or 'Maintenance' Additional buffer for liquidation calculations Whether to use strict pricing Whether to include open orders Whether entering high leverage mode Specific perp market for isolated margin Margin requirement in USDC precision (1e6) ### getInitialMarginRequirement Calculates the initial margin requirement. ```typescript theme={null} user.getInitialMarginRequirement( enterHighLeverageMode?: boolean, perpMarketIndex?: number ): BN ``` Whether to calculate for high leverage mode Specific perp market for isolated margin Initial margin requirement in USDC precision (1e6) ### getMaintenanceMarginRequirement Calculates the maintenance margin requirement. ```typescript theme={null} user.getMaintenanceMarginRequirement( liquidationBuffer?: BN, perpMarketIndex?: number ): BN ``` Liquidation buffer to apply Specific perp market for isolated margin Maintenance margin requirement in USDC precision (1e6) ## PnL & Value Methods ### getUnrealizedPNL Calculates unrealized profit and loss. ```typescript theme={null} user.getUnrealizedPNL( withFunding?: boolean, marketIndex?: number, withWeightMarginCategory?: MarginCategory, strict?: boolean, liquidationBuffer?: BN ): BN ``` Whether to include funding payments Specific market index (or all markets if undefined) Apply margin category weights to PnL Use strict oracle pricing Liquidation buffer to apply Unrealized PnL in USDC precision (1e6) ### getUnrealizedFundingPNL Calculates unrealized funding payment PnL. ```typescript theme={null} user.getUnrealizedFundingPNL(marketIndex?: number): BN ``` Specific market index (or all markets if undefined) Unrealized funding PnL in USDC precision (1e6) ### getNetUsdValue Calculates the net USD value of the account. ```typescript theme={null} user.getNetUsdValue(): BN ``` Net USD value in USDC precision (1e6) ### getTotalAllTimePnl Calculates all-time profit and loss. ```typescript theme={null} user.getTotalAllTimePnl(): BN ``` All-time PnL in USDC precision (1e6) ## Leverage & Risk Methods ### getLeverage Calculates current account leverage. ```typescript theme={null} user.getLeverage( includeOpenOrders?: boolean, perpMarketIndex?: number ): BN ``` Whether to include open orders Specific perp market for isolated position Leverage with precision TEN\_THOUSAND (1e4) ### getMarginRatio Calculates the margin ratio (inverse of leverage). ```typescript theme={null} user.getMarginRatio(): BN ``` Margin ratio with precision TEN\_THOUSAND (1e4) ### getHealth Calculates account health as a percentage. ```typescript theme={null} user.getHealth(perpMarketIndex?: number): number ``` Specific perp market for isolated position health Health percentage from 0-100 (0 = liquidatable, 100 = max health) ### canBeLiquidated Checks if the account can be liquidated. ```typescript theme={null} user.canBeLiquidated(): AccountLiquidatableStatus & { isolatedPositions: Map } ``` Liquidation status for cross margin and isolated positions Whether the account can be liquidated Current margin requirement Current total collateral Liquidation status for each isolated position by market index ### liquidationPrice Calculates the liquidation price for a perpetual position. ```typescript theme={null} user.liquidationPrice( marketIndex: number, positionBaseSizeChange?: BN, estimatedEntryPrice?: BN, marginCategory?: MarginCategory, includeOpenOrders?: boolean, offsetCollateral?: BN, enteringHighLeverage?: boolean, marginType?: MarginType ): BN ``` Perpetual market index Change in position size to calculate for Estimated entry price for the trade Margin category to use Whether to include open orders Additional collateral to add Whether entering high leverage mode 'Cross' or 'Isolated' Liquidation price in PRICE\_PRECISION (1e6), or -1 if position won't liquidate ## Properties Reference to the DriftClient instance Public key of the user account Whether the user is subscribed to account updates ## Usage Example ```typescript theme={null} import { User } from '@drift-labs/sdk'; // Get user from DriftClient const user = driftClient.getUser(); // Subscribe to user account updates await user.subscribe(); // Get account data const userAccount = user.getUserAccount(); console.log('Authority:', userAccount.authority.toBase58()); // Get positions const perpPositions = user.getActivePerpPositions(); console.log('Active perp positions:', perpPositions.length); // Calculate account metrics const freeCollateral = user.getFreeCollateral(); const leverage = user.getLeverage(); const health = user.getHealth(); console.log('Free Collateral:', freeCollateral.toString()); console.log('Leverage:', leverage.toNumber() / 10000); // Convert from precision console.log('Health:', health, '%'); // Check specific position const solPerpPosition = user.getPerpPosition(0); // SOL-PERP if (solPerpPosition) { console.log('SOL-PERP base amount:', solPerpPosition.baseAssetAmount.toString()); // Calculate liquidation price const liqPrice = user.liquidationPrice(0); console.log('Liquidation price:', liqPrice.toNumber() / 1e6); } // Unsubscribe when done await user.unsubscribe(); ```