Function getRuntimeInfo

  • getRuntimeInfo<Data extends RuntimeData = RuntimeData>(): Promise<
        IRuntimeInfo<Data>,
    >

    Gets runtime information about the current execution environment.

    This includes details such as the current symbol, exchange, timeframe, strategy, and whether it's a backtest or live run.

    Type Parameters

    Returns Promise<IRuntimeInfo<Data>>

    Promise resolving to an object containing runtime information

    Throws

    Error if method context or execution context is not active

    Example

    const runtimeInfo = await getRuntimeInfo();
    console.log(runtimeInfo);
    // {
    //   symbol: "BTCUSDT",
    //   context: {,
    //     exchangeName: "Binance",
    //     frameName: "1m",
    //     strategyName: "MyStrategy",
    //   },
    //   backtest: false
    // }

Settings

Member Visibility