adelorenzo/stable
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Free, open source crypto trading bot
1,685 Commits 14 Branches 74 Tags 197 MiB
Python 98.1%
Jinja 0.9%
Shell 0.5%
Jupyter Notebook 0.4%
13662d4e11
Go to file
creslinux 13662d4e11 Test if timerange in json file before trimming. 
trim_tickerlist throws an index out of range error when parsing a json file for a timerange outside its current contents.
This patch test for that condition and returns the the file as-is with a log warning to refresh-cache  on fail

Here is an example of the error prior to path and after patching.
This is from binannce using the pair "ZEN/BTC" and timerange "20180522-20180523"
"""
  File "/Users/creslin/PycharmProjects/freqtrade/freqtrade/optimize/__init__.py", line 107, in load_data
    pairdata = load_tickerdata_file(datadir, pair, ticker_interval, timerange=timerange)
  File "/Users/creslin/PycharmProjects/freqtrade/freqtrade/optimize/__init__.py", line 84, in load_tickerdata_file
    pairdata = trim_tickerlist(pairdata, timerange)
  File "/Users/creslin/PycharmProjects/freqtrade/freqtrade/optimize/__init__.py", line 36, in trim_tickerlist
while tickerlist[start_index][0] < start * 1000:
IndexError: list index out of range
""""

"""
2018-05-31 22:01:07,060 - freqtrade.configuration - INFO - Parameter --timerange detected: 20180522-20180523 ...
2018-05-31 22:01:07,060 - freqtrade.configuration - INFO - Parameter --datadir detected: freqtrade/tests/testdata ...
2018-05-31 22:01:13,168 - freqtrade.optimize - WARNING - start timerange for ZEN/BTC not in cache, to update cache use
2018-05-31 22:01:13,168 - freqtrade.optimize - INFO - --refresh-pairs-cached. *Nb The coin may be newer to the exchange
"""
2018-05-31 22:22:51 +03:00
.github Update ISSUE_TEMPLATE.md and PULL_REQUEST_TEMPLATE.md 2018-01-02 23:34:26 -08:00
bin call set_loggers() and pass sys.argv to main 2018-03-18 01:55:43 +01:00
docs Doc: update bot usage 2018-05-29 22:24:13 -07:00
freqtrade Test if timerange in json file before trimming. 2018-05-31 22:22:51 +03:00
scripts Make plot_dataframe able to show trades stored in database. (#692) 2018-05-19 09:14:42 +03:00
user_data user_data: change ticker_interval to new format 2018-05-02 22:56:29 +02:00
.coveragerc move plot_dataframe to scripts/ folder 2017-11-09 22:29:23 +01:00
.dockerignore Add unnecessary files to .dockerignore 2018-05-06 20:23:20 +02:00
.gitignore add config*.json to .gitignore 2018-04-22 00:35:04 +02:00
.pylintrc ignore talib.abstract in pylint 2018-01-11 07:08:56 +02:00
.travis.yml Fix tests run in random order (#599) 2018-04-21 21:21:50 +02:00
config_full.json.example Merge branch 'develop' into feat/objectify-ccxt 2018-05-02 22:49:55 +02:00
config.json.example config.json.example: add ticker_interval 2018-05-09 09:15:09 +03:00
CONTRIBUTING.md Reorder and revamp the documentation 2018-01-02 22:50:54 -08:00
Dockerfile update Docker image to python-3.6.5-slim 2018-04-22 09:21:09 +02:00
freqtrade.service add service file 2017-12-16 03:00:43 +01:00
install_ta-lib.sh pass follow redirects for curl to fix travis 2017-12-19 08:27:52 +02:00
LICENSE Initial commit 2017-05-18 02:13:02 +02:00
MANIFEST.in move qtpylib to vendor folder 2017-10-30 20:41:36 +01:00
README.md Doc: Add Buzz/trendy word 2018-05-29 22:38:48 -07:00
requirements.txt Update ccxt from 1.14.73 to 1.14.96 2018-05-30 18:42:00 +02:00
setup.cfg fix pep8 warnings 2017-12-16 03:39:47 +01:00
setup.py analyze to use the ccxt OHLCV format 2018-03-21 19:57:58 +02:00
setup.sh Auto apply default values in setup. 2018-05-22 22:09:52 +08:00

README.md

freqtrade

Build Status Coverage Status Maintainability

Simple High frequency trading bot for crypto currencies designed to support multi exchanges and be controlled via Telegram.

freqtrade

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 Dry-run 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.

Table of Contents

Branches

The project is currently setup in two main branches:

  • develop - This branch has often new features, but might also cause breaking changes.
  • master - This branch contains the latest stable release. The bot 'should' be stable on this branch, and is generally well tested.

Features

  • Based on Python 3.6+: For botting on any operating system - Windows, macOS and Linux
  • Persistence: Persistence is achieved through sqlite
  • Dry-run: Run the bot without playing money.
  • Backtesting: Run a simulation of your buy/sell strategy.
  • Strategy Optimization by machine learning: Use machine learning to optimize your buy/sell strategy parameters with real exchange data.
  • Whitelist crypto-currencies: Select which crypto-currency you want to trade.
  • Blacklist crypto-currencies: Select which crypto-currency you want to avoid.
  • Manageable via Telegram: Manage the bot with Telegram
  • Display profit/loss in fiat: Display your profit/loss in 33 fiat.
  • Daily summary of profit/loss: Provide a daily summary of your profit/loss.
  • Performance status report: Provide a performance status of your current trades.

Exchange marketplaces supported

Quick start

This quick start section is a very short explanation on how to test the bot in dry-run. We invite you to read the bot documentation to ensure you understand how the bot is working.

Easy installation

The script below will install all dependencies and help you to configure the bot.

./setup.sh --install

Manual installation

The following steps are made for Linux/MacOS environment

1. Clone the repo

git clone git@github.com:gcarq/freqtrade.git
git checkout develop
cd freqtrade

2. Create the config file
Switch "dry_run": true,

cp config.json.example config.json
vi config.json

3. Build your docker image and run it

docker build -t freqtrade .
docker run --rm -v /etc/localtime:/etc/localtime:ro -v `pwd`/config.json:/freqtrade/config.json -it freqtrade

Help / Slack

For any questions not covered by the documentation or for further information about the bot, we encourage you to join our slack channel.

Bugs / Issues

If you discover a bug in the bot, please search our issue tracker first. If it hasn't been reported, please create a new issue and ensure you follow the template guide so that our team can assist you as quickly as possible.

Feature Requests

Have you a great idea to improve the bot you want to share? Please, first search if this feature was not already discussed. If it hasn't been requested, please create a new request and ensure you follow the template guide so that it does not get lost in the bug reports.

Pull Requests

Feel like our bot is missing a feature? We welcome your pull requests! Please read our Contributing document to understand the requirements before sending your pull-requests.

Important: Always create your PR against the develop branch, not master.

Basic Usage

Bot commands

usage: main.py [-h] [-v] [--version] [-c PATH] [-d PATH] [-s NAME]
               [--strategy-path PATH] [--dynamic-whitelist [INT]]
               [--dry-run-db]
               {backtesting,hyperopt} ...

Simple High Frequency Trading Bot for crypto currencies

positional arguments:
  {backtesting,hyperopt}
    backtesting         backtesting module
    hyperopt            hyperopt module

optional arguments:
  -h, --help            show this help message and exit
  -v, --verbose         be verbose
  --version             show program's version number and exit
  -c PATH, --config PATH
                        specify configuration file (default: config.json)
  -d PATH, --datadir PATH
                        path to backtest data (default:
                        freqtrade/tests/testdata
  -s NAME, --strategy NAME
                        specify strategy class name (default: DefaultStrategy)
  --strategy-path PATH  specify additional strategy lookup path
  --dynamic-whitelist [INT]
                        dynamically generate and update whitelist based on 24h
                        BaseVolume (Default 20 currencies)
  --dry-run-db          Force dry run to use a local DB
                        "tradesv3.dry_run.sqlite" instead of memory DB. Work
                        only if dry_run is enabled.

More details on:

Telegram RPC commands

Telegram is not mandatory. However, this is a great way to control your bot. More details on our documentation

  • /start: Starts the trader
  • /stop: Stops the trader
  • /status [table]: Lists all open trades
  • /count: Displays number of open trades
  • /profit: Lists cumulative profit from all finished trades
  • /forcesell <trade_id>|all: Instantly sells the given trade (Ignoring minimum_roi).
  • /performance: Show performance of each finished trade grouped by pair
  • /balance: Show account balance per currency
  • /daily <n>: Shows profit or loss per day, over the last n days
  • /help: Show help message
  • /version: Show version

Requirements

Min hardware required

To run this bot we recommend you a cloud instance with a minimum of:

  • Minimal (advised) system requirements: 2GB RAM, 1GB disk space, 2vCPU

Software requirements