PnL & Risk

const user = driftClient.getUser();
const health = user.getHealth(); // returns number 0-100
console.log(health); // e.g. 85 means 85% healthy

import { QUOTE_PRECISION, convertToNumber } from "@drift-labs/sdk";
 
// getTotalCollateral returns BN in QUOTE_PRECISION (1e6)
// marginCategory defaults to 'Initial'; pass 'Maintenance' for liquidation checks
const total = driftClient.getUser().getTotalCollateral();
console.log(convertToNumber(total, QUOTE_PRECISION)); // e.g. 1500.50 (USD)

// getMarginRequirement(marginCategory, strict?)
// marginCategory: 'Initial' (for new positions) or 'Maintenance' (for liquidation)
const req = driftClient.getUser().getMarginRequirement('Initial');
console.log(convertToNumber(req, QUOTE_PRECISION)); // USD

const free = driftClient.getUser().getFreeCollateral();
console.log(convertToNumber(free, QUOTE_PRECISION)); // USD available

import { TEN_THOUSAND } from "@drift-labs/sdk";
 
// getLeverage() returns BN scaled by 10000 (e.g. 2x = BN(20000))
const lev = driftClient.getUser().getLeverage();
console.log(lev.toNumber() / TEN_THOUSAND.toNumber()); // e.g. 2.5 (2.5x leverage)

// Returns BN in QUOTE_PRECISION. Positive = profit, negative = loss.
// Pass withWeightMarginCategory to apply asset/liability weights.
const pnl = driftClient.getUser().getUnrealizedPNL(true); // withFunding=true
console.log(convertToNumber(pnl, QUOTE_PRECISION)); // e.g. -25.50 (USD)

// Funding PnL only (accumulated funding payments)
const fundingPnl = driftClient.getUser().getUnrealizedFundingPNL();
console.log(convertToNumber(fundingPnl, QUOTE_PRECISION)); // USD

import { calculateEntryPrice, PRICE_PRECISION, convertToNumber } from "@drift-labs/sdk";
 
const position = driftClient.getUser().getPerpPosition(0);
if (position) {
  const entryPrice = calculateEntryPrice(position); // BN in PRICE_PRECISION
  console.log(convertToNumber(entryPrice, PRICE_PRECISION)); // e.g. 150.25
}

const user = driftClient.getUser();
await driftClient.settlePNL(user.userAccountPublicKey, user.getUserAccount(), 0);