Documentation

Welcome to the Frans' Bot developer manual. This system allows you to build, backtest, and deploy automated trading strategies using JavaScript. It is designed to be powerful yet safe.

The Workflow

To successfully deploy a trading bot, follow this standard lifecycle:

1. Write Code: Implement your logic in the provided editor.
2. Get Chart: Load historical data for your desired symbol and timeframe.
3. Run Backtest: Validate your strategy against historical data.
4. Configure Settings: Adjust TP, SL, and custom parameters in the settings panel.
5. Deploy: Deploy your strategy to send signals to the live bot.

Script Structure

Every strategy MUST be contained within a single main function named indicator. This function is called for every candle in the dataset.

function indicator(data, params) {
    // 1. Extract Data
    const { close } = data;

    // 2. Compute Indicators
    const rsi = RSI(close, 14);

    // 3. Logic & Signals
    if (rsi[rsi.length - 1] < 30) {
        signal('BUY_SIGNAL');
    }
}

Data Access

The data object passed to your main function contains arrays of historical price data. Index 0 is the oldest candle, and length - 1 is the most recent (current) candle.

Warm-up Period

Most indicators require a certain number of candles before they can produce valid values. During this "warm-up" period, they return null. Always check for null values before using indicator output in your logic.

function indicator(data, params) {
    const { close } = data;

    // Calculate Bollinger Bands (needs 20 candles by default)
    const bb = BB(close, 20, 2);

    // Get the most recent values
    const currentLower = bb.lower[bb.lower.length - 1];
    const currentUpper = bb.upper[bb.upper.length - 1];

    // ALWAYS check for null before using!
    if (currentLower === null || currentUpper === null) {
        return; // Not enough data yet, skip this candle
    }

    // Now safe to use the values
    if (close[close.length - 1] <= currentLower) {
        signal('BUY');
    }
}

Indicator Library

The system includes a comprehensive suite of built-in technical indicators. All indicators return arrays aligned with the input data (index 0 = oldest, last index = most recent).

Moving Averages

Oscillators & Momentum

Trend Indicators

Volatility & Volume

Pivot Detection

Utility Functions

Signals & Deploying

To make a trade, your script must emit a signal using the signal() function.

The signal() Function

signal('MY_SIGNAL_NAME');

You can name signals whatever you want (e.g., LONG, SHORT, PANIC_SELL). When you Deploy your strategy, you will map each signal name to a specific bot action (e.g., Open Long, Close Position).

Plotting Indicators

The plot() function lets you visualize indicator values in a sub-chart below the main candlestick chart during backtesting. This is useful for debugging your strategy and understanding how your indicators behave over time.

The plot() Function

Options

function indicator(data, params) {
    const { close, high, low } = data;

    // Calculate indicators
    const rsi = RSI(close, params.rsiPeriod || 14);
    const macdResult = MACD(close, 12, 26, 9);

    const currentRsi = rsi[rsi.length - 1];
    const currentMacd = macdResult.histogram[macdResult.histogram.length - 1];

    if (currentRsi === null || currentMacd === null) return;

    // Plot RSI as a line with reference levels
    plot('RSI', currentRsi, { color: '#c77dff' });
    plot('Overbought', 70, { color: '#ff6b6b', lineWidth: 1 });
    plot('Oversold', 30, { color: '#51cf66', lineWidth: 1 });

    // Plot MACD histogram as bars
    plot('MACD Hist', currentMacd, { color: '#74b9ff', type: 'histogram' });

    // Trading logic
    if (currentRsi < 30) signal('BUY');
    if (currentRsi > 70) signal('SELL');
}

Parameters System

You can make your scripts configurable without changing the code. The system automatically parses your code for parameter definitions using a specific pattern.

// Correct usage - Will appear in Settings UI
const period = params.rsiPeriod || 14;
const threshold = params.buyThreshold || 30;

// Incorrect - Will NOT appear in UI
const period = 14; 

Once defined in code, these parameters will appear in the Indicator Settings panel under "Indicator Parameters". Prioritize using these over hardcoded values.

Backtesting & Settings Workflow

Understanding how settings interact with your code is crucial for accurate testing.

Settings Hierarchy

Values set in the UI always override values in your code.

• Code Defaults: Used only if no UI setting exists.
• UI Settings: Overwrite code defaults instantly.

Take Profit & Stop Loss

The "Backtest Settings" panel (TP/SL/Pyramiding) handles trade management externally from your indicator logic.

• TP Levels: Supports multiple targets (e.g., exit 50% at 2%, 50% at 4%).
• SL Levels: Supports multiple stagged stops.
• Add to Position: Enables pyramiding.

These settings mimic the bot's execution engine and are applied after your signal is generated.