Function getPositionPnlPercent

  • getPositionPnlPercent(symbol: string): Promise<number>

    Returns the unrealized PNL percentage for the current pending signal at current market price.

    Accounts for partial closes, DCA entries, slippage and fees (delegates to toProfitLossDto).

    Throws if no pending signal exists.

    Automatically detects backtest/live mode from execution context. Automatically fetches current price via getAveragePrice.

    Parameters

    • symbol: string

      Trading pair symbol

    Returns Promise<number>

    Promise resolving to PNL percentage

    Throws

    If no pending signal exists

    Example

    import { getPositionPnlPercent } from "backtest-kit";

    const pnlPct = await getPositionPnlPercent("BTCUSDT");
    // LONG at 100, current=105: pnlPct ≈ 5
    // LONG at 100, current=95: pnlPct ≈ -5

Settings

Member Visibility