Function getSessionData

  • getSessionData<Value extends object = object>(symbol: string): Promise<Value>

    Reads the session value scoped to the current (symbol, strategy, exchange, frame) context.

    Session data persists across candles within a single run and can survive process restarts in live mode — useful for caching LLM inference results, intermediate indicator state, or any cross-candle accumulator that is not tied to a specific signal.

    Automatically detects backtest/live mode from execution context.

    Type Parameters

    • Value extends object = object

    Parameters

    • symbol: string

      Trading pair symbol

    Returns Promise<Value>

    Promise resolving to current session value, or null if not set

    Example

    import { getSession } from "backtest-kit";

    const session = await getSession<{ lastLlmSignal: string }>("BTCUSDT");
    if (session?.lastLlmSignal === "buy") {
      // reuse cached LLM result instead of calling the model again
    }

Settings

Member Visibility