README.md

Signal

SignalPayload

type SignalPayload = {
    name? : string,         // A custom name for the alert (optional)
    symbol: string,         // The target trading pair (e.g., 'BTCUSDT', 'ETHUSDT')
    side: OrderSide,        // The order side, either 'BUY' or 'SELL'
    size?: number,          // The order size in quote currency, which overrides the default size from the database (optional)
    stop?: number,          // The stop-loss value for the order (optional)
    take?: number,          // The take-profit value for the order (optional)
    dilution?: boolean,     // Determines if the order should be managed if a position on the same side already exists (optional)
    public?: boolean        // Indicates whether the signal should be broadcasted (Default: true)
    flag?: FlagType,        // A flag indicating the nature of the signal ('TEST', 'DEBUG', 'REVERSE') (optional)
    debug?: any,            // Any additional data for debugging purposes (optional)
}

The SignalPayload defines the JSON schema that should be used to configure a TradingView alert message.

Broadcast Station

StationType

type StationType = {
    url: string;               // The URL to which the signal is forwarded
    headers?: {                // Optional headers to include with the signal
        [key: string]: string; // Key-value pairs representing the headers
    };
};

This StationType defines the structure for an object that includes a URL to forward signals and optional headers to be sent with the signal.

🔨 Install

docker-compose up -d

pnpm i

🛂 Migrate

pnpm migrate

🏃‍♂️ Run

pnpm dev

---

🦥 Lazy Cold Start

docker-compose up -d && pnpm i && pnpm migrate && pnpm dev