Crypto AlgoTrading Framework

Algorithmic trading framework for cryptocurrencies in Python

Algotrading Framework is a repository with tools to build and run working trading bots, backtest strategies, assist on trading, define simple stop losses and trailing stop losses, etc. This framework work with data directly from Crypto exchanges API, from a DB or CSV files. Can be used for data-driven and event-driven systems. Made exclusively for crypto markets for now and written in Python.

---

Follow this Quickstart Guide if you want to start right away

---

A Medium story dedicated to this project

---

Index

• Operating modes
• Realtime
• Tick-by-tick

• Backtest

• How to start

• Pre Requesites

• Collecting data

  • Database
  • Script

• Entry functions

• cross SMA

• Exit functions

• cross SMA

• Plot data

• Logs

• Examples

• Realtime alert for volume increasing

• Backtest a strategy on BTC-DGB pair using SMA

• Pypy

• TODO

• Additional info

---

Operating modes

Framework has three operating modes:

• Realtime -- Trades with real data in real time, with real money or in simulation mode.
• Tick-by-tick -- Testing strategies in real time frames, so user can follow its entries and exits strategies.
• Backtest -- Backtesting strategies and presenting the results.

Realtime

In realtime, Trading Bot operates in real-time, with live data from exchanges APIs. It doesn't need pre-stored data or DB to work. In this mode, a bot can trade real money, simulate or alert the user when its time to buy or sell, based on entry and exit strategies defined by the user. Can also simulate users strategies and present the results in real-time.

Tick-by-tick

Tick-by-tick mode allows users to check strategies in a visible timeframe, to better check entries and exit points or to detect strategies faults or new entry and exit points. Use data from CSV files or DB.

Backtest

Allows users to backtest strategies, with previously stored data. Can also plot trading data showing entry and exit points for implemented strategies.

How to start

Pre requisites

To get algotrading fully working is necessary to install some packages and Python libs, as IPython, Pandas, Matplotlib, Numpy, Python-Influxdb and Python-tk. On Linux machines these packages could be installed with:

bash pip install -r requirements.txt

Collecting data

The first step is to collect data. To get markets data is necessary to run a DB, to get and manage all data or save the data to CSV files. There are two options:

• Install and configure a database.
• Run a script to collect data and save it to CSV files.

Database

Trading Bot is ready to operate with InfluxDB, but can work with other databases, with some small changes.

To install, configure and use a InfluxDB database, you can clone this repository: https://github.com/ivopetiz/crypto-database

Script

If you don't want to install and manage any databases and simply want to get data to CSV files you can use the script in this Gist: https://gist.github.com/ivopetiz/051eb8dcef769e655254df21a093831a

Using a database is the best option, once you can analyse and plot data using DB tools, as Chronograf, and can always extract data to CSV if needed.

Entry functions

Entry functions aggregate all strategies to enter in a specific market. Once data fill all the requisites to enter a specific market, an action is taken. Users can use one or several functions in the same call, to fill the requisites and enter market/markets. Functions should return True, if the available data represent an entry point for the user. If not, the return needs to be False. should aggregate all users entry functions.

Example

cross SMA

Function will return True if first SMA cross the second one. If not will return False.

```python def cross_smas(data, smas=[5, 10]): ''' Checks if it's an entry point based on crossed smas. ''' if data.Last.rolling(smas[0]).mean().iloc[-1] > \ data.Last.rolling(smas[1]).mean().iloc[-1] and \ data.Last.rolling(smas[0]).mean().iloc[-2] < \ data.Last.rolling(smas[1]).mean().iloc[-2]: return True

return False

```

Exit functions

Exit functions have all functions responsible for exit strategies. When a user is in the market, and data met exit criteria, the bot will exit the market. Exit functions can be used with other exit functions, to cover more situations, as used in entry functions. Stop loss and trailing stop loss are also implemented, to exit markets in case of an unexpected price drop. Functions should return True, if the available data represent an exit point for the user. If not, the return needs to be False. should aggregate all users' exit functions.

Example

cross SMA

Function will return True if first SMA cross the second one. If not will return False.

```python def cross_smas(data, smas=[10, 20]): ''' Checks if it's an exit point based on crossed smas. ''' if data.Last.rolling(smas[0]).mean().iloc[-1] < \ data.Last.rolling(smas[1]).mean().iloc[-1] and \ data.Last.rolling(smas[0]).mean().iloc[-2] > \ data.Last.rolling(smas[1]).mean().iloc[-2]: return True

return False

```

Plot data

It's possible to plot entry and exit points, among market data, using Matplotlib lib for Python with the option plot=True on function call.

Log

Can log entry and exit points in order to evaluate strategies, presenting P&L for specific markets and total.

Examples

Here are some examples of how to use this framework.

Realtime alert for volume increasing

To get an alert when a market doubles its volume:

```python from cryptoalgotrading.cryptoalgotrading import realtime

def alert_volume_x2(data): if pd.vol.iloc[-1] > pd.vol.iloc[-2]*2: return True return False

realtime([], alert_volume_x2, interval='10m') ```

alert_volume_x2 checks the value of actual market volume and compare it with the last time frame volume value, alerting user when actual market volume is bigger than last time frame volume value multiplied by 2. Can add functions live on IPython for example of add them to entry and exit python files.

Backtest a strategy on BTC-DGB pair using SMA

To backtest a cross simple moving average strategy in a specific market and plot the entry points:

```python from cryptoalgotrading.cryptoalgotrading import backtest import cryptoalgotrading.entry as entry

backtest(["BTC-XRP"], entry.cross_smas, smas=[15,40], interval='10m', from_file=True, plot=True) ```

Based on market data available for BTC_XRP pair, code above can present an output like this:

The figure has three charts. The chart on top presents on top BTC-XRP data from a certain period, with its Bollinger bands and 3 SMA lines. Green points represent the entry points for the defined strategy. In the middle is a chart representing volume data and at the bottom is represented the number of selling orders among time. All these fields and charts are configurable on plot function.

Can also add exit points by adding an exit function or functions to backtest function. It is possible to enter multiple entries and exit functions to backtest, to define different entry and exit positions.

Both functions are available on entry.py and exit.py as example.

In finance.py are some functions which could be useful to implement some strategies.

Pypy

This Crypto AlgoTrading Framework can be used with Pypy, but the results will not be great, during the use of Pandas and Numpy libs.

TODO

• [x] Python 3 implementation
• [ ] Cython version
• [ ] Pure Python for Pypy (without Pandas and Numpy dependency)

Additional Info

API Key is just needed in case of buy/sell operations. For backtest, tick-by-tick and realtime alert implementations API Key can be left empty.

Buy and sell options are commented and should only be used if you know what you are doing.

If you are interested in using this bot and don't have an account on Binance Exchange yet, please help me, creating an account through my referral code here: https://accounts.binance.com/en/register?ref=17181609

---

USE THIS AT YOUR OWN RISK.

Issues

Bump certifi from 2018.4.16 to 2022.12.7

opened on 2022-12-08 02:16:35 by dependabot[bot]

Bumps certifi from 2018.4.16 to 2022.12.7.

Commits

• 9e9e840 2022.12.07
• b81bdb2 2022.09.24
• 939a28f 2022.09.14
• aca828a 2022.06.15.2
• de0eae1 Only use importlib.resources's new files() / Traversable API on Python ≥3.11 ...
• b8eb5e9 2022.06.15.1
• 47fb7ab Fix deprecation warning on Python 3.11 (#199)
• b0b48e0 fixes #198 -- update link in license
• 9d514b4 2022.06.15
• 4151e88 Add py.typed to MANIFEST.in to package in sdist (#196)
• Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

---

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) - `@dependabot use these labels` will set the current labels as the default for future PRs for this repo and language - `@dependabot use these reviewers` will set the current reviewers as the default for future PRs for this repo and language - `@dependabot use these assignees` will set the current assignees as the default for future PRs for this repo and language - `@dependabot use this milestone` will set the current milestone as the default for future PRs for this repo and language You can disable automated security fix PRs for this repo from the [Security Alerts page](https://github.com/ivopetiz/algotrading/network/alerts).

Allow defining strat strength

opened on 2021-09-05 10:14:29 by ivopetiz

Add new param to strats funcs to define strat strength in order to define buy size.

[FIX] Connection reset by peer in Binance

opened on 2021-08-21 09:06:23 by ivopetiz None

[FEAT] Replace implemented SL for Binance API SL

opened on 2021-08-19 21:42:46 by ivopetiz

Use Binance API SL from POST /api/v3/order

Renames aux.py to aux_file.py

opened on 2021-06-02 07:47:43 by dan-marshman

Aux is a reserved word/file on windows, so this renames it to aux_file.py - see #18

https://www.howtogeek.com/fyi/windows-10-still-wont-let-you-use-these-file-names-reserved-in-1974/

aux is a reserved keyword on key windows - can't checkout aux.py

opened on 2021-05-30 00:52:38 by dan-marshman

The file aux.py in the cryptoalgotrading directory raises and error when checking out on Windows as aux is a reserved key word.

error: invalid path 'cryptoalgotrading/aux.py' fatal: unable to checkout working tree warning: Clone succeeded, but checkout failed. You can inspect what was checked out with 'git status' and retry with 'git restore --source=HEAD :/'

More info from WIndows

It might be worth renaming that file to algo_aux.py or something like that?

(I normally use Linux but happened to be looking at the project on my windows machine)

Cool project by the way - are you looking for contributors?