Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ZENALC/algobot

Cryptocurrency trading bot with a graphical user interface with support for simulations, backtests, optimizations, and running live bots.
https://github.com/ZENALC/algobot

backtests bot crypto cryptocurrency optimizations pyqt pyqt5 python robot simulations telegram trade trading

Last synced: 3 months ago
JSON representation

Cryptocurrency trading bot with a graphical user interface with support for simulations, backtests, optimizations, and running live bots.

Host: GitHub
URL: https://github.com/ZENALC/algobot
Owner: ZENALC
License: gpl-3.0
Created: 2020-07-27T02:35:28.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2023-02-11T01:58:20.000Z (over 1 year ago)
Last Synced: 2024-06-27T13:37:12.459Z (5 months ago)
Topics: backtests, bot, crypto, cryptocurrency, optimizations, pyqt, pyqt5, python, robot, simulations, telegram, trade, trading
Language: Python
Homepage:
Size: 13.4 MB
Stars: 896
Watchers: 35
Forks: 169
Open Issues: 23
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

![logo](https://github.com/ZENALC/algobot/blob/master/media/algobot.png?raw=true)

[![CI](https://github.com/ZENALC/algobot/actions/workflows/ci.yml/badge.svg)](https://github.com/ZENALC/algobot/actions/workflows/ci.yml)
[![CodeQL](https://github.com/ZENALC/algobot/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/ZENALC/algobot/actions/workflows/codeql-analysis.yml)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/)
![Discord](https://img.shields.io/discord/863916085832974346)

Cryptocurrency trading bot that allows users to create strategies and then backtest, optimize, simulate, or run live bots using them. Telegram integration has been added to support easier and remote trading.

Algobot requires at least Python 3.7 and not over Python 3.9.

# Installation

Once you have cloned or unpacked the source code locally, run the following commands from your terminal in that directory.

```bash
pip install pipenv
pipenv install
```

If your install fails, please make sure to have [Visual Studio Build Tools](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2019) installed.

Please note that Algobot requires TA-LIB. You can view instructions on how to download TA-LIB from [here](https://github.com/mrjbq7/ta-lib). For Windows users, it's best to download the .whl package for your Python install and `pip install` it. For Linux and MacOS users, there's excellent documentation available in the link provided above.

For Windows, it's easiest to perform the following:

1) `pipenv shell`
2) `pip install `

You can find the .whl files [here](https://www.lfd.uci.edu/~gohlke/pythonlibs/#ta-lib).

# Execution

To start Algobot, run:

```bash
pipenv run bot
```

Set `DEBUG=1` to enable debug level logging.

# Community

Join our [Discord](https://discord.gg/ZWdHxhVbNP) today for contributions or help!

# Features

- View real time data.
- Create graphs with real time data and/or moving averages.
- Run simulations with parameters configured.
- Run custom backtests with parameters configured.
- Run live bots with parameters configured.
- Telegram integration that allows users to trade or view statistics.
- Create custom, trailing, or limit stop losses.
- Create take profits.
- Optimize your strategies using the built-in optimizer.
- Ability to create your own custom strategies.

# User Interface

![Main Interface](https://i.imgur.com/Y6FD5O5.png)
![Configuration](https://i.imgur.com/JTvHRXf.png)
![Graphs](https://i.imgur.com/M9Oz3Q6.png)
![News](https://i.imgur.com/Ec6Tw17.png)

# Disclaimer

Bot usage is as is. Algobot is not responsible for any financial burdens or unexpected monetary bugs or glitches.

# License

GNU General Public License v3.0

# Author

Mihir Shrestha

# Contributors

koutsie, Malachi Soord (inverse)

# Special Contributors

Peter Motin for being the founder and head of strategic development throughout the entirety of this project.

# Contribution

Check our [contributing guidelines](CONTRIBUTING.md) to get started.

# Feature Requests

For any feature requests, feel free to add a feature request through Github's Issues. We would love to hear your ideas and implement them on the application.

# Wiki

You can find documentation regarding Algobot [here](https://github.com/ZENALC/algobot/wiki).