Function getPositionPnlCost

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

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

    Calculated as: pnlPercentage / 100 × totalInvestedCost. Accounts for partial closes, DCA entries, slippage and fees.

    Returns null 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 in dollars or null

    Example

    import { getPositionPnlCost } from "backtest-kit";

    const pnlCost = await getPositionPnlCost("BTCUSDT");
    // LONG at 100, invested $100, current=105: pnlCost ≈ 5
    // LONG at 100, invested $200 (DCA), current=95: pnlCost ≈ -10

Settings

Member Visibility