Function getPositionHighestProfitDistancePnlPercentage

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

    Returns the distance in PnL percentage between the current price and the highest profit peak.

    Computed as: max(0, peakPnlPercentage - currentPnlPercentage). Returns null if no pending signal exists.

    Parameters

    • symbol: string

      Trading pair symbol

    Returns Promise<number>

    Promise resolving to drawdown distance in PnL% (≥ 0) or null

    Example

    import { getPositionHighestProfitDistancePnlPercentage } from "backtest-kit";

    const dist = await getPositionHighestProfitDistancePnlPercentage("BTCUSDT");
    // e.g. 1.5 (gave back 1.5% from peak)

Settings

Member Visibility