Backtrader API Reference

This section contains complete API documentation for the Backtrader framework, automatically generated from source code docstrings.

Core Package

• backtrader.plot package
  • Submodules
    • backtrader.plot.finance module
    • backtrader.plot.formatters module
    • backtrader.plot.locator module
    • backtrader.plot.multicursor module
    • backtrader.plot.plot module
    • backtrader.plot.plot_plotly module
    • backtrader.plot.scheme module
    • backtrader.plot.utils module

Quick Reference

Core Classes

The main classes you’ll work with in Backtrader:

• backtrader.Cerebro - The main engine that orchestrates everything

• backtrader.Strategy - Base class for trading strategies

• backtrader.Indicator - Base class for technical indicators

• backtrader.Analyzer - Base class for performance analyzers

• backtrader.Observer - Base class for observers

• backtrader.Sizer - Base class for position sizers

• backtrader.Order - Order representation

• backtrader.Trade - Trade representation

• backtrader.Position - Position tracking

Data Feeds

Available data feed classes for loading market data:

• backtrader.feeds.GenericCSVData - Flexible CSV data loader

• backtrader.feeds.PandasData - Load from pandas DataFrame

• backtrader.feeds.YahooFinanceCSVData - Yahoo Finance format

• backtrader.feeds.BacktraderCSVData - Native Backtrader format

Technical Indicators

Backtrader includes 50+ built-in indicators:

Moving Averages: SMA, EMA, WMA, SMMA, DEMA, KAMA, HMA, ZLEMA

Oscillators: RSI, Stochastic, MACD, CCI, Williams %R, Ultimate Oscillator

Volatility: ATR, Bollinger Bands, Standard Deviation

Trend: ADX, Aroon, Parabolic SAR, Ichimoku, DPO

Momentum: ROC, Momentum, KST, TSI, TRIX

See the indicators API reference for complete list.

Performance Analyzers

Built-in analyzers for strategy evaluation:

• backtrader.analyzers.SharpeRatio - Sharpe ratio calculation

• backtrader.analyzers.DrawDown - Drawdown analysis

• backtrader.analyzers.TradeAnalyzer - Trade statistics

• backtrader.analyzers.Returns - Return metrics

• backtrader.analyzers.SQN - System Quality Number

• backtrader.analyzers.VWR - Variability-Weighted Return

See the analyzers API reference for complete list.

Position Sizers

Built-in sizers for position sizing:

• backtrader.sizers.FixedSize - Fixed number of units

• backtrader.sizers.PercentSizer - Percentage of portfolio

• backtrader.sizers.AllInSizer - Use all available cash

See the sizers API reference for complete list.