Function getTotalPercentHeld

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

    Returns the percentage of the position currently held (not yet closed by partials). 100 = nothing has been closed (full position), 0 = fully closed. Correctly accounts for DCA entries between partial closes.

    Correctly-named alias for getTotalPercentClosed.

    Parameters

    • symbol: string

      Trading pair symbol

    Returns Promise<number>

    Promise - held percentage (0–100)

    Example

    import { getTotalPercentHeld } from "backtest-kit";

    const heldPct = await getTotalPercentHeld("BTCUSDT");
    console.log(`Holding ${heldPct}% of position`);

Settings

Member Visibility