Interface TickEvent

Unified tick event data for report generation. Contains all information about a tick event regardless of action type.

interface TickEvent {
    action:
        | "waiting"
        | "active"
        | "closed"
        | "idle"
        | "opened"
        | "scheduled"
        | "cancelled";
    cancelReason?: string;
    closeReason?: string;
    currentPrice: number;
    duration?: number;
    fallPnl?: number;
    note?: string;
    originalPriceOpen?: number;
    originalPriceStopLoss?: number;
    originalPriceTakeProfit?: number;
    partialExecuted?: number;
    peakPnl?: number;
    pendingAt?: number;
    percentSl?: number;
    percentTp?: number;
    pnl?: number;
    pnlCost?: number;
    pnlEntries?: number;
    position?: string;
    priceOpen?: number;
    priceStopLoss?: number;
    priceTakeProfit?: number;
    scheduledAt?: number;
    signalId?: string;
    symbol?: string;
    timestamp: number;
    totalEntries?: number;
    totalPartials?: number;
}

Properties

action cancelReason? closeReason? currentPrice duration? fallPnl? note? originalPriceOpen? originalPriceStopLoss? originalPriceTakeProfit? partialExecuted? peakPnl? pendingAt? percentSl? percentTp? pnl? pnlCost? pnlEntries? position? priceOpen? priceStopLoss? priceTakeProfit? scheduledAt? signalId? symbol? timestamp totalEntries? totalPartials?

Properties

action

action:
    | "waiting"
    | "active"
    | "closed"
    | "idle"
    | "opened"
    | "scheduled"
    | "cancelled"

Event action type

OptionalcancelReason

cancelReason?: string

Cancel reason (only for cancelled)

OptionalcloseReason

closeReason?: string

Close reason (only for closed)

currentPrice

currentPrice: number

Current price

Optionalduration

duration?: number

Duration in minutes (only for closed)

OptionalfallPnl

fallPnl?: number

Fall PNL percentage at worst price during position (_fall.pnlPercentage, only for closed)

Optionalnote

note?: string

Signal note (only for scheduled/waiting/opened/active/closed/cancelled)

OptionaloriginalPriceOpen

originalPriceOpen?: number

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

OptionaloriginalPriceStopLoss

originalPriceStopLoss?: number

Original stop loss price before modifications (only for scheduled/waiting/opened/active/closed/cancelled)

OptionaloriginalPriceTakeProfit

originalPriceTakeProfit?: number

Original take profit price before modifications (only for scheduled/waiting/opened/active/closed/cancelled)

OptionalpartialExecuted

partialExecuted?: number

Total executed percentage from partial closes (only for scheduled/waiting/opened/active/closed/cancelled)

OptionalpeakPnl

peakPnl?: number

Peak PNL percentage at best price during position (_peak.pnlPercentage, only for closed)

OptionalpendingAt

pendingAt?: number

Timestamp when position became active (only for opened/active/closed)

OptionalpercentSl

percentSl?: number

Percentage progress towards stop loss (only for active/waiting)

OptionalpercentTp

percentTp?: number

Percentage progress towards take profit (only for active/waiting)

Optionalpnl

pnl?: number

PNL percentage (for active/waiting: unrealized, for closed: realized)

OptionalpnlCost

pnlCost?: number

Absolute profit/loss in USD (for active/waiting: unrealized, for closed: realized)

OptionalpnlEntries

pnlEntries?: number

Total invested capital in USD

Optionalposition

position?: string

Position type (only for scheduled/waiting/opened/active/closed/cancelled)

OptionalpriceOpen

priceOpen?: number

Open price (only for scheduled/waiting/opened/active/closed/cancelled)

OptionalpriceStopLoss

priceStopLoss?: number

Stop loss price (only for scheduled/waiting/opened/active/closed/cancelled)

OptionalpriceTakeProfit

priceTakeProfit?: number

Take profit price (only for scheduled/waiting/opened/active/closed/cancelled)

OptionalscheduledAt

scheduledAt?: number

Timestamp when signal was created/scheduled (only for scheduled/waiting/opened/active/closed/cancelled)

OptionalsignalId

signalId?: string

Signal ID (only for scheduled/waiting/opened/active/closed/cancelled)

Optionalsymbol

symbol?: string

Trading pair symbol (only for non-idle events)

timestamp

timestamp: number

Event timestamp in milliseconds (scheduledAt for scheduled events, pendingAt for opened/closed events)

OptionaltotalEntries

totalEntries?: number

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

OptionaltotalPartials

totalPartials?: number

Total number of partial closes executed (_partial.length)

Settings

Member Visibility

On This Page

Properties