Type Alias BrokerSignalOpenPayload

BrokerSignalOpenPayload: {
    backtest: boolean;
    context: {
        exchangeName: ExchangeName;
        frameName?: FrameName;
        strategyName: StrategyName;
    };
    cost: number;
    maxDrawdown: IStrategyPnL;
    peakProfit: IStrategyPnL;
    pnl: IStrategyPnL;
    position: "long"
    | "short";
    priceOpen: number;
    priceStopLoss: number;
    priceTakeProfit: number;
    symbol: string;
}

Payload for the signal-open broker event.

Emitted automatically via syncSubject when a new pending signal is activated. Forwarded to the registered IBroker adapter via onSignalOpenCommit.

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
cost: number
Dollar cost of the position entry (CC_POSITION_ENTRY_COST)
maxDrawdown: IStrategyPnL
Maximum drawdown experienced during the life of this position up to the moment this public signal was created
peakProfit: IStrategyPnL
Peak profit achieved during the life of this position up to the moment this public signal was created
pnl: IStrategyPnL
Market price at the moment of activation (VWAP or candle average)
position: "long" | "short"
Position direction
priceOpen: number
Activation price — the price at which the signal became active
priceStopLoss: number
Original stop-loss price from the signal
priceTakeProfit: number
Original take-profit price from the signal
symbol: string
Trading pair symbol, e.g. "BTCUSDT"

Example

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

Type Alias BrokerSignalOpenPayload

Type declaration

backtest: boolean

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

cost: number

maxDrawdown: IStrategyPnL

peakProfit: IStrategyPnL

pnl: IStrategyPnL

position: "long" | "short"

priceOpen: number

priceStopLoss: number

priceTakeProfit: number

symbol: string

Example

Settings

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