Function getTotalPercentClosed

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

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

    Automatically detects backtest/live mode from execution context.

    Parameters

    • symbol: string

      Trading pair symbol

    Returns Promise<number>

    Promise - held percentage (0–100)

    Deprecated

    The name is misleading — the function returns the HELD share, not the closed one. Use getTotalPercentHeld instead.

    Example

    import { getTotalPercentClosed } from "backtest-kit";

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

Settings

Member Visibility