Interface SignalOpenedNotification

Signal opened notification. Emitted when a new trading position is opened.

interface SignalOpenedNotification {
    backtest: boolean;
    cost: number;
    createdAt: number;
    exchangeName: string;
    id: string;
    note?: string;
    originalPriceOpen: number;
    originalPriceStopLoss: number;
    originalPriceTakeProfit: number;
    pendingAt: number;
    pnl: IStrategyPnL;
    pnlCost: number;
    pnlEntries: number;
    pnlPercentage: number;
    pnlPriceClose: number;
    pnlPriceOpen: number;
    position: "long" | "short";
    priceOpen: number;
    priceStopLoss: number;
    priceTakeProfit: number;
    scheduledAt: number;
    signalId: string;
    strategyName: string;
    symbol: string;
    timestamp: number;
    totalEntries: number;
    totalPartials: number;
    type: "signal.opened";
}

Properties

backtest: boolean

Whether this notification is from backtest mode (true) or live mode (false)

cost: number

Cost of the initial position entry in USD (from signal.cost)

createdAt: number

Unix timestamp in milliseconds when the tick result was created (from candle timestamp in backtest or execution context when in live)

exchangeName: string

Exchange name where signal was executed

id: string

Unique notification identifier

note?: string

Optional human-readable description of signal reason

originalPriceOpen: number

Original entry price at signal creation (unchanged by DCA averaging)

originalPriceStopLoss: number

Original stop loss price before any trailing adjustments

originalPriceTakeProfit: number

Original take profit price before any trailing adjustments

pendingAt: number

Pending timestamp in milliseconds (when position became pending/active at priceOpen)

Unrealized PNL at the moment of signal open (from signal.pnl)

pnlCost: number

Absolute profit/loss in USD

pnlEntries: number

Total invested capital in USD

pnlPercentage: number

Profit/loss as percentage (e.g., 1.5 for +1.5%, -2.3 for -2.3%)

pnlPriceClose: number

Exit price from PNL calculation (adjusted with slippage and fees)

pnlPriceOpen: number

Entry price from PNL calculation (effective price adjusted with slippage and fees)

position: "long" | "short"

Trade direction: "long" (buy) or "short" (sell)

priceOpen: number

Entry price for the position

priceStopLoss: number

Stop loss exit price

priceTakeProfit: number

Take profit target price

scheduledAt: number

Signal creation timestamp in milliseconds (when signal was first created/scheduled)

signalId: string

Unique signal identifier (UUID v4)

strategyName: string

Strategy name that generated this signal

symbol: string

Trading pair symbol (e.g., "BTCUSDT")

timestamp: number

Unix timestamp in milliseconds when signal was opened (pendingAt)

totalEntries: number

Total number of DCA entries (_entry.length). 1 = no averaging.

totalPartials: number

Total number of partial closes executed (_partial.length). 0 = no partial closes done.

type: "signal.opened"

Discriminator for type-safe union