Interface CancelScheduledCommit

Cancel scheduled signal event.

interface CancelScheduledCommit {
    action: "cancel-scheduled";
    backtest: boolean;
    cancelId?: string;
    exchangeName: string;
    frameName: string;
    maxDrawdown: IStrategyPnL;
    note?: string;
    originalPriceOpen: number;
    peakProfit: IStrategyPnL;
    pnl: IStrategyPnL;
    signal: IPublicSignalRow;
    signalId: string;
    strategyName: string;
    symbol: string;
    timestamp: number;
    totalEntries: number;
    totalPartials: number;
}

Hierarchy

  • SignalCommitBase
    • CancelScheduledCommit

Properties

action: "cancel-scheduled"

Discriminator for cancel-scheduled action

backtest: boolean

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

cancelId?: string

Optional identifier for the cancellation reason (user-provided)

exchangeName: string

Exchange name where signal was executed

frameName: string

Timeframe name (used in backtest mode, empty string in live mode)

maxDrawdown: IStrategyPnL

Maximum drawdown experienced during the life of this position up to the moment this public signal was created

note?: string

Optional human-readable description of signal reason

originalPriceOpen: number

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

peakProfit: IStrategyPnL

Peak profit achieved during the life of this position up to the moment this public signal was created

Total PNL of the closed position (including all entries and partials)

Signal data at the moment of this event (snapshot of IPublicSignalRow)

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

Timestamp from execution context (tick's when or backtest candle timestamp)

totalEntries: number

Total number of DCA entries at the time of this event (_entry.length). 1 = no averaging done (only initial entry). 2+ = averaged positions.

totalPartials: number

Total number of partial closes executed at the time of this event (_partial.length). 0 = no partial closes done. 1+ = partial closes executed.