Function getPositionHighestPnlPercentage

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

    Returns the PnL percentage at the moment the best profit price was recorded during this position's life.

    Throws if no pending signal exists.

    Parameters

    • symbol: string

      Trading pair symbol

    Returns Promise<number>

    Promise resolving to PnL percentage or null

    Example

    import { getPositionHighestPnlPercentage } from "backtest-kit";

    const pnl = await getPositionHighestPnlPercentage("BTCUSDT");
    // e.g. 3.5

Settings

Member Visibility