fast-trade 0.4.1

About low code backtesting library utilizing pandas and technical analysis indicators

Fast Trade

A library built with backtest portability and performance in mind for backtest trading strategies. There is also a DataDownloader, which can be used to download compatible kline data from Binance (.com or .us)

Motivations

Strategies are cheap. This is the main motivation behind fast-trade. Since a backtest is just a JSON object, strategies can be created, stored, modified, versioned, and re-run easily. Ideally, a backtest could be generated and tested quickly; fast-trade is just the library to handle that. Fast Trade is also useful for quickly analyzing chart (ohlcv) data and downloading it.

Beta Testing

I'm using this library to build a platform (live data, charting, paper trading, etc.) and I'm looking for beta testers. If you like this library, send me an email at [e-mail].

Contributing

If you'd like to add a feature, fix a bug, or something else, please clone the repo and fork it. When you're ready, open a PR into this main repo.

To get started with local dev, clone the repo, set up a virtual env, source it, then install the dev requirements.

git clone [e-mail]:<YOUR GIT USERNAME>/fast-trade.git
cd ./fast-trade
python -m venv .fast_trade
source .fast_trade/bin/activate
pip install -r dev_requirements.txt

To generate testing coverage, run

coverage run -m pytest
coverage report -m

Install

pip install fast-trade

Usage

See sma_strategy.json and strategy.json for an example strategy. The basic idea is you describe the "datapoints" then compare them in the "logics". The "datapoints" describe the technical analysis functions to run, and the "logics" describe the logic to use to determine when to enter and exit trades.

Example backtest script

from fast_trade import run_backtest, validate_backtest

backtest = {
    "base_balance": 1000, # start with a balance of 1000
    "chart_period": "5Min", # time period selected on the chard
    "chart_start": "2021-08-30 18:00:00", # when to start the chart
    "chart_stop": "2021-09-06 16:39:00", # when to stop the chart
    "comission": 0.01, # a comission to pay per transaction 
    "datapoints": [ # describes the data to use in the logic
        {
            "args": [ # args are passed to the transformer function
                30
            ],
            "transformer": "sma", # technical analysis function to run
            "name": "sma_short" # reference point for use in logic
        },
        {
            "args": [
                90
            ],
            "transformer": "sma",
            "name": "sma_long"
        },
    ],
    "enter": [
      [
        "close", # field to reference, by default this is any column in the data file. Could also be a float or int
        ">", # operator to compare these to
        "sma_long" # name of datapoint that was prevously defined
      ],
      [
        "close",
        ">",
        "sma_short"
      ]
    ],
    "exit": [
      [
        "close",
        "<",
        "sma_short"
      ]
    ],
    "trailing_stop_loss": 0.05, # optional trailing stop loss 
    "exit_on_end": False, # at then end of the backtest, if true, the trade will exit
}
# backtests can also come from urls
# backtest = "https://raw.githubusercontent.com/jrmeier/fast-trade/master/sma_strategy.json"

# returns a mirror of the object, with errors if any
print(validate_backtest(backtest))

# also accepts urls 
# datafile_path = "https://raw.githubusercontent.com/jrmeier/fast-trade/master/test/ohlcv_data.csv.txt"
datafile_path = "./BTCUSDT.csv"

# returns the summary object and the dataframe
result = run_backtest(backtest, datafile_path)

summary = result["summary"]
df = result["df"]
trade_log_df = result["trade_df"]

print(summary)
print(df.head())

CLI

You can also use the package from the command line. Each command's specific help feature can be viewed by running ft <command> -h.

List the commands and their help. ft -h

Basic usage

This will download the last month of data for BTCUSD from binance.us and store in a archive/ directory.

ft download BTCUSD --exchange binance.us

This will backtest a file with a strategy. By default, it will only show a summary of the backtest. However, if you want to save the results, add the --save flag and it will go the saved_backtests/ directory.

ft backtest ./strategy.json ./archive/BTCUSD_2022.csv

You can also pass in url instead of files.

ft backtest https://raw.githubusercontent.com/jrmeier/fast-trade/master/strategy.json ./archive/BTCUSD_2022.csv

ft backtest strategy.json https://example.com/BTCUSDT_2022.csv

You can validate a backtest before you run it. This doesn't help with the data, but does help with the logic. ft validate stategy.json

Backteset Modifiers

Modifying the chart_period

ft backtest ./strategy.json ./archive/BTCUSD_2022.csv --mods chart_period 1H

Modifying the chart_period and the trailing_stop_loss

ft backtest ./strategy.json ./archive/BTCUSD_2022.csv --mods chart_period 1H trailing_stop_loss .05

Saving a test result This generates creates the saved_backtest directory (if it doesn't exist), then inside of there, is another directory with a timestamp, with a chart, the backtest file, the summary, and the raw dataframe as a csv. ft backtest ./strategy.json ./archive/BTCUSD_2022.csv --save

DataDownloader

Download 1 minute kline/ohlcv from Binance and store them in CSVs in the archive path. You can rerun this command to keep the files updated. It may take awhile to download all of the data the first time, so be patient. It only need to download all of it once, then it will be updated from the most recent date. Check out the file update_symbol_data.py if you want to see how it works.

Basic example Download the last 30 days of BTCUSDT from binance.com python -m fast_trade download BTCUSDT

ft download SYMBOL --archive ARCHIVE_PATH --start START_DATE --end END_DATE --exchange=EXCHANGE

Defaults are:

EXCHANGE="binance.com" # can be binance.us
START= "2020-01-01" # start date
END= "2020-01-31" # end date
END='current date' # you'll probably never need this
ARCHIVE='./archive' # path the archive folder, which is where the CSVs are stored

Examples

downloads according to the defaults

ft download

download data for the symbol LTCBTC using the other defaults

ft download LTCBTC

download data starting January 2021 ft download LTCBTC --start=2021-01-01

Testing

python -m pytest

Coverage

coverage run -m pytest
coverage report -m

Output

The output its a dictionary. The summary is a summary all the inputs and of the performace of the model. The df is a Pandas Dataframe, which contains all of the data used in the simulation. And the trade_df is a subset of the df frame which just has all the rows when there was an event. The backtest object is also returned, with the details of how the backtest was run.

Example output:

{
  "return_perc": -3.608,
  "sharpe_ratio": -0.018705921376959495,
  "buy_and_hold_perc": -13.661,
  "median_trade_len": 1260.0,
  "mean_trade_len": 1430.121951,
  "max_trade_held": 4680.0,
  "min_trade_len": 360.0,
  "total_num_winning_trades": 46,
  "total_num_losing_trades": 119,
  "avg_win_per": 0.134,
  "avg_loss_per": -0.081,
  "best_trade_perc": 0.592,
  "min_trade_perc": -2.588,
  "median_trade_perc": -0.01,
  "mean_trade_perc": -0.021,
  "num_trades": 165,
  "win_perc": 27.879,
  "loss_perc": 72.121,
  "equity_peak": 10053.901,
  "equity_final": 9651.792,
  "max_drawdown": 9651.792,
  "total_fees": 81.745,
  "first_tic": "2020-08-30 18:00:00",
  "last_tic": "2020-09-06 16:39:00",
  "total_tics": 3334,
  "test_duration": 0.199153
}

Backtest

The real goal of this project is to get to the point where these strategies can be generated and tested quickly and then be easily iterated on.

Below is an example of a very simple strategey. Basically, datapoints are used to build a list of datapoints to look at which must all be true to produce an enter or exit status for that tick.

Backtests include all the instructions needed to run the backtest minus the data.

Backtest Requirements

• name:

  • string, optional
  • default: None
  • description: a string for quick reference of the backtest

• chart_period:

  • string, optional
  • default: "1Min"
  • description: a charting period string. allowed values are "Min" (minute), "T" (minute), "D" (day),"H" (hour)
  • Ex.
    • "1Min" is 1 minute
    • "2H" is 2 hours
    • "5D" is 5 days

• start: string or timestamp

  • optional,
  • default: ""
  • description: The time string of when to start the backtest with %Y-%m-%d %H:%M:%S date format or a timestamp. It will be tested
  • Ex.
    • "2018-05-01 00:00:00" May 1st, 2018 at midnight

• stop: sting or timestamp

  • optional
  • default: ""
  • description: The time string of when to stop the backtest with %Y-%m-%d %H:%M:%S date format or a timestamp
  • Ex.
    • "2020-12-28 00:08:00" December 28th, 2020 at 8am.
    • "2020-06-01"June 6th, 2020
    • 1590969600 (seconds) June 6th, 2020
    • 1590969600000 (milliseconds) June 6th, 2020

• base_balance: float or int

  • optional
  • default: 1000
  • description: The starting balance of trade account. Usually $ or "base" coins for cryptocurrencies.

• comission: float

  • optional
  • default: 0.0
  • description: The "trading fee" per trade. This is subtracted per trade.

• enter: list,

  • required
  • default: None
  • description: a list of Logic's with instructions to compare the data on each tick. EVERY logic item must return True to ENTER the trade.

• any_enter: list,

  • optional
  • default: None
  • description: a list of Logic's with instructions to compare the data on each tick. ANY LOGIC ITEM can return True to ENTER the trade.

• exit: list

  • required
  • default: None
  • description: a list of Logic's with instructions to compare the data on each tick. EVERY LOGIC ITEM must return True to EXIT the trade.

• any_exit: list

  • optional
  • default: None
  • description: a list of Logic's with instructions to compare the data on each tick. ANY LOGIC ITEM can return True to EXIT the trade.

• datapoints: list

  • optional
  • default: None
  • description: This describes how to create the datapoints. Each individual transformer has name that can be referenced in either the enter or exit logizs. For more information, see (Datapoints)

• trailing_stop_loss: float

  • optional
  • default 0
  • description: This sets a trailing stop loss, so the trade will exit immediately, without considering any other action. It is the percentage ot follow for example, to set a stop loss of 5%, set 0.05

Simple Moving Average Cross example

This is an example of a simple moving average cross backtest.

{
    "base_balance": 1000,
    "chart_period": "5T",
    "chart_start": "2020-08-30 18:00:00",
    "chart_stop": "2020-09-06 16:39:00",
    "comission": 0.01,
    "datapoints": [
        {
            "args": [
                30
            ],
            "transformer": "sma",
            "name": "sma_short"
        },
        {
            "args": [
                90
            ],
            "transformer": "sma",
            "name": "sma_long"
        },
    ],
    "enter": [
      ["close", ">", "sma_long"],
      ["close", ">", "sma_short"]
    ],
    "exit": [["close", "<", "sma_short"]],
    "trailing_stop_loss": 0.05,
    "exit_on_end": False,
}

LogicDetail

Each logic is contains a single if statement. The two variables are the first and last item in the list, with the operator to compare them >, < =.

To think of this easily, just say it out loud. Ex.

If the close (closing price) at X time is greater than the "short_sma" (custom datapoint), then return True, else return False.

[
  "close", # datapoint or column in provided data
  ">", # operator for comparisson
  "sma_short" # datapoint or column in provided data
]

Valid datapoints:

• open
• high
• low
• close
• volume
• any datapoint (see LogicExample1)
• any additional columns in your data file or your dataframe (see LogicExample2)

LogicExample1

    [
      "close", # valid datapoint, always provided
      ">", # logic to use to compare
      "short" # valid custom datapoint, defined in datapoints
    ]

LogicExample2

    [
      "rsi", # valid custom datapoint, should be defined in datapoints
      "<", # logic to use to compare
      70 # integer, float, or string 
    ]

Logic Lookbacks

Logic lookbacks allow you to confirm a signal by checking the last N periods.

    [
      "rsi", # valid custom datapoint, should be defined in datapoints
      ">", # logic to use to compare
      30, # integer, float, or string
      2 # optional, default 0, LogicalLookback number of periods to confirm this signal
    ]

Datapoints

Datapoints are user defined technical indicators. You can select a defined transformer function to apply the technical analysis. They can reference data and calculate the new values to be referenced inside of any of the logics.

Simple SMA example

      {
         "name": "sma_short", # transformer name
         "transformer": "sma", # technical analysis function to be used
         "args": [20], # arguments to pass to the function, for multiple args, add a "," behind each
      }

Transfomers (Technical Indicators)

Available transformer functions are from FinTA

Custom datapoints can be added by setting a function name in the datapoints, then setting that equal to a function that takes in a dataframe as the first argument and whatever arguments passed in.

Note:

If a transfomer function returns multiple series, fast-trade will name concate the name of the series with the name of the transfomer function.

Example:

The bbands function returns two series, one for the upper band and one for the lower band. The name of the series will be bbands_upper and bbands_lower.

bbands returns 3 columns upper_bb, middle_band, lower_bb