Docs Download
Home / Docs / Kline / Market Data / Refresh Rates / What is summary_interval used for?

What is summary_interval used for?

The summary_interval defines the base timeframe used by MagicTradeBot for analytics, reports, and performance dashboards.

It tells the bot how to map loaded Kline/candle data to the timeframe used for summaries and reporting.


⚙️ How It Works

  • The bot loads candles (e.g., 1m, 5m, 15m) for each symbol.
  • summary_interval specifies which timeframe to use when generating analytics summaries.
  • Example:
summary_interval: "30m"
  • The bot will generate summaries and performance metrics using 30-minute candle data.

⚖️ Important Considerations

  • Mismatch issue:

    • If loaded candles are 1-minute but summary_interval is set to 30m, the bot may report “no kline data found”.
    • The loaded candles must cover the summary interval or be aggregatable.
  • Purpose of mapping:

    • Analytics summaries
    • Strategy performance reports
    • Dashboard metrics
    • Multi-symbol comparison
  • Ensures all reports reflect consistent timeframes.


🚀 Summary

summary_interval is used to:

  • Map loaded candles to a base timeframe
  • Generate accurate analytics, dashboards, and reports
  • Avoid signal processing errors due to timeframe mismatch

Correct configuration ensures that performance metrics and analytics reflect real market behavior over the chosen timeframe.

Ready to trade? Download MagicTradeBot free and test in paper mode before going live.