Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

Alpaca API within backtrader

Project description

PyPI version CircleCI Updates Python 3


alpaca-backtrader-api is a python library for the Alpaca trade API within backtrader framework. It allows rapid trading algo development easily, with support for the both REST and streaming interfaces. For details of each API behavior, please see the online API document.

Note this module supports only python version 3.5 and above, due to the underlying library alpaca-trade-api.


$ pip3 install alpaca-backtrader-api


These examples only work if you have a funded brokerage account or another means of accessing Polygon data.

you can find example strategies in the samples folder.

remember to add you credentials.

you can toggle between backtesting and paper trading by changing ALPACA_PAPER

a strategy looks like this:

In order to call Alpaca's trade API, you need to obtain API key pairs. Replace <key_id> and <secret_key> with what you get from the web console.

import alpaca_backtrader_api
import backtrader as bt
from datetime import datetime

ALPACA_API_KEY = <key_id>
ALPACA_SECRET_KEY = <secret_key>

class SmaCross(bt.SignalStrategy):
  def __init__(self):
    sma1, sma2 = bt.ind.SMA(period=10), bt.ind.SMA(period=30)
    crossover = bt.ind.CrossOver(sma1, sma2)
    self.signal_add(bt.SIGNAL_LONG, crossover)

cerebro = bt.Cerebro()

store = alpaca_backtrader_api.AlpacaStore(

  broker = store.getbroker()  # or just alpaca_backtrader_api.AlpacaBroker()

DataFactory = store.getdata  # or use alpaca_backtrader_api.AlpacaData
data0 = DataFactory(dataname='AAPL', historical=True, fromdate=datetime(
    2015, 1, 1), timeframe=bt.TimeFrame.Days)

print('Starting Portfolio Value: %.2f' %
print('Final Portfolio Value: %.2f' %

API Document

The HTTP API document is located in


The Alpaca API requires API key ID and secret key, which you can obtain from the web console after you sign in. You can set them in the AlpacaStore constructor, using 'key_id' and 'secret_key'.

Paper/Live mode

The 'paper' parameter is default to False, which allows live trading. If you set it to True, then you are in the paper trading mode.

Support and Contribution

For technical issues particular to this module, please report the issue on this GitHub repository. Any API issues can be reported through Alpaca's customer support.

New features, as well as bug fixes, by sending pull request is always welcomed.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for alpaca-backtrader-api, version 0.10.0
Filename, size File type Python version Upload date Hashes
Filename, size alpaca_backtrader_api-0.10.0-py3-none-any.whl (23.1 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size alpaca-backtrader-api-0.10.0.tar.gz (19.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page