Type Alias BrokerIdlePingPayload

BrokerIdlePingPayload: {
    backtest: boolean;
    context: {
        exchangeName: ExchangeName;
        frameName?: FrameName;
        strategyName: StrategyName;
    };
    currentPrice: number;
    symbol: string;
}

Payload for the idle-ping broker event.

Emitted automatically via idlePingSubject on every live tick while the strategy has no pending or scheduled signal. Forwarded to the registered IBroker adapter via onSignalIdlePing. Purely informational — carries no signal because none is active.

Type declaration

  • backtest: boolean

    true when called during a backtest run — adapter should skip exchange calls

  • context: {
        exchangeName: ExchangeName;
        frameName?: FrameName;
        strategyName: StrategyName;
    }

    Strategy/exchange/frame routing context

  • currentPrice: number

    Market price at the moment of the ping

  • symbol: string

    Trading pair symbol, e.g. "BTCUSDT"

Example

const payload: BrokerIdlePingPayload = {
  symbol: "BTCUSDT",
  currentPrice: 50500,
  context: { strategyName: "my-strategy", exchangeName: "binance", frameName: "1h" },
  backtest: false,
};

Settings

Member Visibility