Type Alias BrokerSchedulePingPayload

BrokerSchedulePingPayload: {
    backtest: boolean;
    context: {
        exchangeName: ExchangeName;
        frameName?: FrameName;
        strategyName: StrategyName;
    };
    currentPrice: number;
    position: "long"
    | "short";
    priceOpen: number;
    priceStopLoss: number;
    priceTakeProfit: number;
    signalId: string;
    symbol: string;
}

Payload for the schedule-ping broker event.

Emitted automatically via schedulePingSubject on every live tick while a scheduled signal is monitored (waiting for priceOpen activation). Forwarded to the registered IBroker adapter via onSignalSchedulePing. Purely informational.

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

  • position: "long" | "short"

    Position direction

  • priceOpen: number

    Pending entry price the scheduled signal is waiting for

  • priceStopLoss: number

    Stop-loss price configured for the scheduled signal

  • priceTakeProfit: number

    Take-profit price configured for the scheduled signal

  • signalId: string

    Unique signal identifier (UUID v4) of the scheduled signal

  • symbol: string

    Trading pair symbol, e.g. "BTCUSDT"

Example

const payload: BrokerSchedulePingPayload = {
  symbol: "BTCUSDT",
  position: "long",
  currentPrice: 49800,
  priceOpen: 50000,
  priceTakeProfit: 55000,
  priceStopLoss: 48000,
  context: { strategyName: "my-strategy", exchangeName: "binance", frameName: "1h" },
  backtest: false,
};

Settings

Member Visibility