Function getStrategyStatus

  • getStrategyStatus(symbol: string): Promise<StrategyStatus>

    Returns the in-memory deferred strategy-state snapshot for the current iteration: the queued createSignal, commit queue and deferred user-action flags, plus the current pending signal id.

    Automatically detects backtest/live mode from execution context.

    Parameters

    • symbol: string

      Trading pair symbol

    Returns Promise<StrategyStatus>

    Promise resolving to the current StrategyStatus snapshot

    Example

    import { getStrategyStatus } from "backtest-kit";

    const status = await getStrategyStatus("BTCUSDT");
    console.log(status.pendingSignalId, status.commitQueue.length);

Settings

Member Visibility