Function getPositionMaxDrawdownPrice

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

    Returns the worst price reached in the loss direction during this position's life.

    Returns null if no pending signal exists.

    Parameters

    • symbol: string

      Trading pair symbol

    Returns Promise<number>

    Promise resolving to price or null

    Example

    import { getPositionMaxDrawdownPrice } from "backtest-kit";

    const price = await getPositionMaxDrawdownPrice("BTCUSDT");
    // e.g. 41000 (lowest price seen for a LONG position)

Settings

Member Visibility