CryptoBot

Version 0.0.11-alpha (changelog)

Disclaimer

This software is for educational purposes only. Do not risk money which
you are afraid to lose. USE THE SOFTWARE AT YOUR OWN RISK. THE AUTHORS
AND ALL AFFILIATES ASSUME NO RESPONSIBILITY FOR YOUR TRADING RESULTS.

Always start by running a trading bot in simulation mode and do not engage money
before you understand how it works and what profit/loss you should
expect.

We strongly recommend you to have coding and Python knowledge. Do not
hesitate to read the source code and understand the mechanism of this bot.

Moreover, we are in the alpha phase so you should not expect the bot to be stable.

Demo

See live demo here

Install

See installation wiki page

With python3 :

git clone https://github.com/Trading-Bot/CryptoBot
cd CryptoBot
pip install -r requirements.txt

Configuration

Create a config.json file in the config folder with the following example :

Rename config/default_config.json to config/config.json

More configuration

See Configuration Wiki

"crypto_currencies": {
    "Bitcoin": {
      "pairs" : ["BTC/USDT"]
    }
}

See Exchanges Wiki

"exchanges": {
    "binance": {
      "api-key": "",
      "api-secret": ""
    }
}

See Notifications Wiki

"notification":{
    "enabled": true,
    "type": [1, 2]
}

See Trader Wiki

"trader":{
    "enabled": false,
    "risk": 0.5
}

See Simulator Wiki

"simulator":{
    "enabled": true,
    "risk": 0.5,
    "starting_portfolio": {
      "BTC": 10,
      "USDT": 1000
    }
}

See Services Wiki

"services": {}

Usage

python start.py

Customize you CryptoBot !

Adding implementations of any evaluator

To add another implementation of an existing evaluator, 3 simple steps:
1. Create a class inheriting the evaluator to improve
2. Store it in the evaluator's Advanced folder (in CryptoBot/evaluator/evaluator_type/Advanced).
3. In this Advanced folder, create or update the __init__.py file to add the following line:

from .file_containing_new_implementation_name.py import *

Adding implementations of any analysis tool

To add another implementation of an existing analysis tool, 3 simple steps:
1. Create a class inheriting the analyser to improve
2. Store it in the Advanced folder (in CryptoBot/evaluator/Util/Advanced).
3. In this Advanced folder, create or update the __init__.py file to add the following line:

from .file_containing_new_implementation_name.py import *

More information and examples on the wiki

Testing

Use pytest command in the root folder :

pytest

Changelog

See changelog file

More

For more details see the project wiki.