adelorenzo/stable
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Free, open source crypto trading bot
2,086 Commits 14 Branches 74 Tags 197 MiB
Python 98.1%
Jinja 0.9%
Shell 0.5%
Jupyter Notebook 0.4%
dcbdbecae0
Go to file
creslinux dcbdbecae0 Implemented local restful flask service and provided cmdline client 
Added only the "Daily" call so far, submitting for early review/feedback

Called as example "./rest_client.py daily 3"

This depends on listed as requirements.
Flask==1.0.2
flask-jsonpify==1.5.0 (will do later)
flask-restful==0.3.6
TODO: make loading optional, cleanly unload on close
      unit tests, take feedback, tidy output,
      add other Telegram functions, onwards

local rest server is enabled/disabled from within config.json. E.g

     "localrest": {
        "enabled": true
    },

The server is enabled from within existing rpc manager
and makes use of the existing superclass (RPC)

Through making use of the existing hard work done in rpc.py
It *should be easy to add the other Telegram calls into local_rpc_server.py

The server is wrapped in a thread to be non-blocking
The server and client accept serialised calls or not, used in daily to return json
The client can be used from command line or in a python client script

As example, from cmdline for last 3 days Daily

DannyMBP:rpc creslin$ ./rest_client.py daily 3
[
    [
        "2018-06-13",
        "0.00000000 USDT",
        "0.000 USD",
        "0 trade"
    ],
    [
        "2018-06-12",
        "0.00000000 USDT",
        "0.000 USD",
        "0 trade"
    ],
    [
        "2018-06-11",
        "0.00000000 USDT",
        "0.000 USD",
        "0 trade"
    ]
]
2018-06-25 14:03:14 +00:00
.github update issue template to include ccxt version 2018-06-12 07:00:58 +02:00
bin call set_loggers() and pass sys.argv to main 2018-03-18 01:55:43 +01:00
docs Merge with develop 2018-06-23 16:50:27 +03:00
freqtrade Implemented local restful flask service and provided cmdline client 2018-06-25 14:03:14 +00:00
scripts update plot_dataframe script to objectify exchange 2018-06-18 22:32:29 +02:00
user_data remove use of hyperopt_conf.py 2018-06-16 09:09:28 +03:00
.coveragerc fix typo in coverage-omit 2018-06-16 21:28:41 +02:00
.dockerignore Add unnecessary files to .dockerignore 2018-05-06 20:23:20 +02:00
.gitignore Remove hardcoded backtest-result.json in Plot scripts 2018-06-04 21:17:20 -07:00
.pylintrc ignore talib.abstract in pylint 2018-01-11 07:08:56 +02:00
.pyup.yml create pyup.io config file 2018-06-07 00:55:09 +02:00
.travis.yml Revert "also unit tests now need config.json" 2018-06-17 11:34:12 +02:00
config_full.json.example don't sell if buy is still active 2018-06-22 20:23:23 +02:00
config.json.example don't sell if buy is still active 2018-06-22 20:23:23 +02:00
CONTRIBUTING.md Add not about flake8 pre-commit hooks 2018-06-11 14:55:39 +03: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 store ta-lib locally in a zip for Travis 2018-06-08 08:15:04 +03: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 README: note to open an issue before starting major feature work 2018-06-23 08:36:32 -05:00
requirements.txt Update ccxt from 1.14.253 to 1.14.256 2018-06-23 14:23:07 +02:00
setup.cfg mypy - ignore tests folder 2018-06-08 19:58:01 +02:00
setup.py Docs: point links to freqtrade org 2018-06-05 13:27:24 +03:00
setup.sh Setup.sh: fix Python3.6 when broken on macOS 2018-05-29 20:49:37 -07:00
ta-lib-0.4.0-src.tar.gz store ta-lib locally in a zip for Travis 2018-06-08 08:15:04 +03: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.

Exchange marketplaces supported

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.

Table of Contents

Quick start

Freqtrade provides a Linux/macOS script to install all dependencies and help you to configure the bot.

git clone git@github.com:freqtrade/freqtrade.git
git checkout develop
cd freqtrade
./setup.sh --install

Windows installation is explained in Installation doc

Documentation

We invite you to read the bot documentation to ensure you understand how the bot is working.

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.

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

Development 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.

Support

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.

Note before starting any major new feature work, please open an issue describing what you are planning to do or talk to us on Slack. This will ensure that interested parties can give valuable feedback on the feature, and let others know that you are working on it.

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

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