Merge pull request #2 from freqtrade/develop

catch up forked dev with original dev

.coveragerc

@@ -1,6 +1,7 @@
 [run]
 omit =
     scripts/*
-    freqtrade/tests/*
+    freqtrade/templates/*
     freqtrade/vendor/*
     freqtrade/__main__.py
+    tests/*

.devcontainer/Dockerfile

@@ -0,0 +1,18 @@
+FROM freqtradeorg/freqtrade:develop
+
+# Install dependencies
+COPY requirements-dev.txt /freqtrade/
+RUN apt-get update \
+    && apt-get -y install git sudo vim \
+    && apt-get clean \
+    && pip install autopep8 -r docs/requirements-docs.txt -r requirements-dev.txt --no-cache-dir \
+    && useradd -u 1000 -U -m ftuser \
+    && mkdir -p /home/ftuser/.vscode-server /home/ftuser/.vscode-server-insiders /home/ftuser/commandhistory \
+    && echo "export PROMPT_COMMAND='history -a'" >> /home/ftuser/.bashrc \
+    && echo "export HISTFILE=~/commandhistory/.bash_history" >> /home/ftuser/.bashrc \
+    && chown ftuser: -R /home/ftuser/
+
+USER ftuser
+
+# Empty the ENTRYPOINT to allow all commands
+ENTRYPOINT []

.devcontainer/devcontainer.json

@@ -0,0 +1,44 @@
+{
+    "name": "freqtrade Develop",
+
+    "dockerComposeFile": [
+        "docker-compose.yml"
+    ],
+
+    "service": "ft_vscode",
+
+    "workspaceFolder": "/freqtrade/",
+
+    "settings": {
+        "terminal.integrated.shell.linux": "/bin/bash",
+        "editor.insertSpaces": true,
+        "files.trimTrailingWhitespace": true,
+        "[markdown]": {
+            "files.trimTrailingWhitespace": false,
+        },
+        "python.pythonPath": "/usr/local/bin/python",
+    },
+
+    // Add the IDs of extensions you want installed when the container is created.
+    "extensions": [
+        "ms-python.python",
+        "ms-python.vscode-pylance",
+        "davidanson.vscode-markdownlint",
+        "ms-azuretools.vscode-docker",
+    ],
+
+    // Use 'forwardPorts' to make a list of ports inside the container available locally.
+    // "forwardPorts": [],
+
+    // Uncomment the next line if you want start specific services in your Docker Compose config.
+    // "runServices": [],
+
+    // Uncomment the next line if you want to keep your containers running after VS Code shuts down.
+    // "shutdownAction": "none",
+
+    // Uncomment the next line to run commands after the container is created - for example installing curl.
+    // "postCreateCommand": "sudo apt-get update && apt-get install -y git",
+
+    // Uncomment to connect as a non-root user if you've added one. See https://aka.ms/vscode-remote/containers/non-root.
+    "remoteUser": "ftuser"
+}

.devcontainer/docker-compose.yml

@@ -0,0 +1,24 @@
+---
+version: '3'
+services:
+  ft_vscode:
+    build:
+      context: ..
+      dockerfile: ".devcontainer/Dockerfile"
+    volumes:
+      # Allow git usage within container
+      - "${HOME}/.ssh:/home/ftuser/.ssh:ro"
+      - "${HOME}/.gitconfig:/home/ftuser/.gitconfig:ro"
+      - ..:/freqtrade:cached
+      # Persist bash-history
+      - freqtrade-vscode-server:/home/ftuser/.vscode-server
+      - freqtrade-bashhistory:/home/ftuser/commandhistory
+    # Expose API port
+    ports:
+      - "127.0.0.1:8080:8080"
+    command: /bin/sh -c "while sleep 1000; do :; done"
+
+
+volumes:
+  freqtrade-vscode-server:
+  freqtrade-bashhistory:

.dockerignore

@@ -13,3 +13,4 @@ CONTRIBUTING.md
 MANIFEST.in
 README.md
 freqtrade.service
+user_data

.github/ISSUE_TEMPLATE.md

@@ -1,32 +0,0 @@
-## Step 1: Have you search for this issue before posting it?
-
-If you have discovered a bug in the bot, please [search our issue tracker](https://github.com/freqtrade/freqtrade/issues?q=is%3Aissue). 
-If it hasn't been reported, please create a new issue.
-
-## Step 2: Describe your environment
-
-  * Python Version: _____ (`python -V`)
-  * CCXT version: _____ (`pip freeze | grep ccxt`)
-  * Branch: Master | Develop
-  * Last Commit ID: _____ (`git log --format="%H" -n 1`)
-  
-## Step 3: Describe the problem:
-
-*Explain the problem you have encountered*
-
-### Steps to reproduce:
-
-  1. _____
-  2. _____
-  3. _____
-  
-### Observed Results:
-
-  * What happened?
-  * What did you expect to happen?
-
-### Relevant code exceptions or logs:
-
-  ```
-  // paste your log here
-  ```

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,48 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: "Triage Needed"
+assignees: ''
+
+---
+<!-- 
+Have you searched for similar issues before posting it?
+
+If you have discovered a bug in the bot, please [search our issue tracker](https://github.com/freqtrade/freqtrade/issues?q=is%3Aissue). 
+If it hasn't been reported, please create a new issue.
+
+Please do not use bug reports to request new features.
+-->
+
+## Describe your environment
+
+  * Operating system: ____
+  * Python Version: _____ (`python -V`)
+  * CCXT version: _____ (`pip freeze | grep ccxt`)
+  * Freqtrade Version: ____ (`freqtrade -V` or `docker-compose run --rm freqtrade -V` for Freqtrade running in docker)
+  
+Note: All issues other than enhancement requests will be closed without further comment if the above template is deleted or not filled out.
+
+## Describe the problem:
+
+*Explain the problem you have encountered*
+
+### Steps to reproduce:
+
+  1. _____
+  2. _____
+  3. _____
+  
+### Observed Results:
+
+  * What happened?
+  * What did you expect to happen?
+
+### Relevant code exceptions or logs
+
+Note: Please copy/paste text of the messages, no screenshots of logs please.
+
+  ```
+  // paste your log here
+  ```

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,27 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+<!-- 
+Note: this section will not show up in the issue.
+Have you search for this feature before requesting it? It's highly likely that a similar request was already filed.
+-->
+
+## Describe your environment
+(if applicable)
+
+  * Operating system: ____
+  * Python Version: _____ (`python -V`)
+  * CCXT version: _____ (`pip freeze | grep ccxt`)
+  * Freqtrade Version: ____ (`freqtrade -V` or `docker-compose run --rm freqtrade -V` for Freqtrade running in docker)
+
+
+## Describe the enhancement
+
+*Explain the enhancement you would like*
+

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,25 @@
+---
+name: BQuestion
+about: Ask a question you could not find an answer in the docs
+title: ''
+labels: "Question"
+assignees: ''
+
+---
+<!-- 
+Have you searched for similar issues before posting it?
+Did you have a VERY good look at the [documentation](https://www.freqtrade.io/en/latest/) and are sure that the question is not explained there
+
+Please do not use the question template to report bugs or to request new features.
+-->
+
+## Describe your environment
+
+  * Operating system: ____
+  * Python Version: _____ (`python -V`)
+  * CCXT version: _____ (`pip freeze | grep ccxt`)
+  * Freqtrade Version: ____ (`freqtrade -V` or `docker-compose run --rm freqtrade -V` for Freqtrade running in docker)
+  
+## Your question
+
+*Ask the question you have not been able to find an answer in our [Documentation](https://www.freqtrade.io/en/latest/)*

.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+- package-ecosystem: docker
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+- package-ecosystem: pip
+  directory: "/"
+  schedule:
+    interval: weekly
+  open-pull-requests-limit: 10
+  target-branch: develop

.github/workflows/ci.yml

@@ -0,0 +1,317 @@
+name: Freqtrade CI
+
+on:
+  push:
+    branches:
+      - master
+      - stable
+      - develop
+    tags:
+  release:
+    types: [published]
+  pull_request:
+  schedule:
+    - cron:  '0 5 * * 4'
+
+jobs:
+  build:
+
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ ubuntu-18.04, ubuntu-20.04, macos-latest ]
+        python-version: [3.7, 3.8]
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Cache_dependencies
+      uses: actions/cache@v1
+      id: cache
+      with:
+        path: ~/dependencies/
+        key: ${{ runner.os }}-dependencies
+
+    - name: pip cache (linux)
+      uses: actions/cache@preview
+      if: startsWith(matrix.os, 'ubuntu')
+      with:
+        path: ~/.cache/pip
+        key: test-${{ matrix.os }}-${{ matrix.python-version }}-pip
+
+    - name: pip cache (macOS)
+      uses: actions/cache@preview
+      if: startsWith(matrix.os, 'macOS')
+      with:
+        path: ~/Library/Caches/pip
+        key: test-${{ matrix.os }}-${{ matrix.python-version }}-pip
+
+    - name: TA binary *nix
+      if: steps.cache.outputs.cache-hit != 'true'
+      run: |
+        cd build_helpers && ./install_ta-lib.sh ${HOME}/dependencies/; cd ..
+
+    - name: Installation - *nix
+      run: |
+        python -m pip install --upgrade pip
+        export LD_LIBRARY_PATH=${HOME}/dependencies/lib:$LD_LIBRARY_PATH
+        export TA_LIBRARY_PATH=${HOME}/dependencies/lib
+        export TA_INCLUDE_PATH=${HOME}/dependencies/include
+        pip install -r requirements-dev.txt
+        pip install -e .
+
+    - name: Tests
+      run: |
+        pytest --random-order --cov=freqtrade --cov-config=.coveragerc
+
+    - name: Coveralls
+      if: (startsWith(matrix.os, 'ubuntu-20') && matrix.python-version == '3.8')
+      env:
+        # Coveralls token. Not used as secret due to github not providing secrets to forked repositories
+        COVERALLS_REPO_TOKEN: 6D1m0xupS3FgutfuGao8keFf9Hc0FpIXu
+      run: |
+        # Allow failure for coveralls
+        coveralls -v  || true
+
+    - name: Backtesting
+      run: |
+        cp config.json.example config.json
+        freqtrade create-userdir --userdir user_data
+        freqtrade backtesting --datadir tests/testdata --strategy SampleStrategy
+
+    - name: Hyperopt
+      run: |
+        cp config.json.example config.json
+        freqtrade create-userdir --userdir user_data
+        freqtrade hyperopt --datadir tests/testdata -e 5 --strategy SampleStrategy --hyperopt SampleHyperOpt --hyperopt-loss SharpeHyperOptLossDaily --print-all
+
+    - name: Flake8
+      run: |
+        flake8
+
+    - name: Sort imports (isort)
+      run: |
+        isort --check .
+
+    - name: Mypy
+      run: |
+        mypy freqtrade scripts
+
+    - name: Slack Notification
+      uses: homoluctus/slatify@v1.8.0
+      if: failure() && ( github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false)
+      with:
+        type: ${{ job.status }}
+        job_name: '*Freqtrade CI ${{ matrix.os }}*'
+        mention: 'here'
+        mention_if: 'failure'
+        channel: '#notifications'
+        url: ${{ secrets.SLACK_WEBHOOK }}
+
+  build_windows:
+
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ windows-latest ]
+        python-version: [3.7, 3.8]
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Pip cache (Windows)
+      uses: actions/cache@preview
+      if: startsWith(runner.os, 'Windows')
+      with:
+        path: ~\AppData\Local\pip\Cache
+        key: ${{ matrix.os }}-${{ matrix.python-version }}-pip
+
+    - name: Installation
+      run: |
+        ./build_helpers/install_windows.ps1
+
+    - name: Tests
+      run: |
+        pytest --random-order --cov=freqtrade --cov-config=.coveragerc
+
+    - name: Backtesting
+      run: |
+        cp config.json.example config.json
+        freqtrade create-userdir --userdir user_data
+        freqtrade backtesting --datadir tests/testdata --strategy SampleStrategy
+
+    - name: Hyperopt
+      run: |
+        cp config.json.example config.json
+        freqtrade create-userdir --userdir user_data
+        freqtrade hyperopt --datadir tests/testdata -e 5 --strategy SampleStrategy --hyperopt SampleHyperOpt --hyperopt-loss SharpeHyperOptLossDaily --print-all
+
+    - name: Flake8
+      run: |
+        flake8
+
+    - name: Mypy
+      run: |
+        mypy freqtrade scripts
+
+    - name: Slack Notification
+      uses: homoluctus/slatify@v1.8.0
+      if: failure() && ( github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false)
+      with:
+        type: ${{ job.status }}
+        job_name: '*Freqtrade CI windows*'
+        mention: 'here'
+        mention_if: 'failure'
+        channel: '#notifications'
+        url: ${{ secrets.SLACK_WEBHOOK }}
+
+  docs_check:
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Documentation syntax
+      run: |
+        ./tests/test_docs.sh
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+
+    - name: Documentation build
+      run: |
+        pip install -r docs/requirements-docs.txt
+        pip install mkdocs
+        mkdocs build
+
+    - name: Slack Notification
+      uses: homoluctus/slatify@v1.8.0
+      if: failure() && ( github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false)
+      with:
+        type: ${{ job.status }}
+        job_name: '*Freqtrade Docs*'
+        channel: '#notifications'
+        url: ${{ secrets.SLACK_WEBHOOK }}
+
+  cleanup-prior-runs:
+    runs-on: ubuntu-20.04
+    steps:
+    - name: Cleanup previous runs on this branch
+      uses: rokroskar/workflow-run-cleanup-action@v0.2.2
+      if: "!startsWith(github.ref, 'refs/tags/') && github.ref != 'refs/heads/stable' && github.repository == 'freqtrade/freqtrade'"
+      env:
+        GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+
+  # Notify on slack only once - when CI completes (and after deploy) in case it's successfull
+  notify-complete:
+    needs: [ build, build_windows, docs_check ]
+    runs-on: ubuntu-20.04
+    steps:
+    - name: Slack Notification
+      uses: homoluctus/slatify@v1.8.0
+      if: always() && ( github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false)
+      with:
+        type: ${{ job.status }}
+        job_name: '*Freqtrade CI*'
+        channel: '#notifications'
+        url: ${{ secrets.SLACK_WEBHOOK }}
+
+  deploy:
+    needs: [ build, build_windows, docs_check ]
+    runs-on: ubuntu-20.04
+    if: (github.event_name == 'push' || github.event_name == 'schedule' || github.event_name == 'release') && github.repository == 'freqtrade/freqtrade'
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+
+    - name: Extract branch name
+      shell: bash
+      run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF##*/})"
+      id: extract_branch
+
+    - name: Build distribution
+      run: |
+        pip install -U setuptools wheel
+        python setup.py sdist bdist_wheel
+
+    - name: Publish to PyPI (Test)
+      uses: pypa/gh-action-pypi-publish@master
+      if: (github.event_name == 'release')
+      with:
+        user: __token__
+        password: ${{ secrets.pypi_test_password }}
+        repository_url: https://test.pypi.org/legacy/
+
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@master
+      if: (github.event_name == 'release')
+      with:
+        user: __token__
+        password: ${{ secrets.pypi_password }}
+
+    - name: Dockerhub login
+      env:
+        DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
+        DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+      run: |
+        echo "${DOCKER_PASSWORD}" | docker login --username ${DOCKER_USERNAME} --password-stdin
+
+    - name: Build and test and push docker image
+      env:
+        IMAGE_NAME: freqtradeorg/freqtrade
+        BRANCH_NAME: ${{ steps.extract_branch.outputs.branch }}
+      run: |
+        build_helpers/publish_docker.sh
+
+    # We need docker experimental to pull the ARM image.
+    - name: Switch docker to experimental
+      run: |
+          docker version -f '{{.Server.Experimental}}'
+          echo $'{\n    "experimental": true\n}' | sudo tee /etc/docker/daemon.json
+          sudo systemctl restart docker
+          docker version -f '{{.Server.Experimental}}'
+
+    - name: Set up Docker Buildx
+      id: buildx
+      uses: crazy-max/ghaction-docker-buildx@v1
+      with:
+        buildx-version: latest
+        qemu-version: latest
+
+    - name: Available platforms
+      run: echo ${{ steps.buildx.outputs.platforms }}
+
+    - name: Build Raspberry docker image
+      env:
+        IMAGE_NAME: freqtradeorg/freqtrade
+        BRANCH_NAME: ${{ steps.extract_branch.outputs.branch }}_pi
+      run: |
+        build_helpers/publish_docker_pi.sh
+
+
+    - name: Slack Notification
+      uses: homoluctus/slatify@v1.8.0
+      if: always() && ( github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false)
+      with:
+        type: ${{ job.status }}
+        job_name: '*Freqtrade CI Deploy*'
+        mention: 'here'
+        mention_if: 'failure'
+        channel: '#notifications'
+        url: ${{ secrets.SLACK_WEBHOOK }}
+

.github/workflows/docker_update_readme.yml

@@ -0,0 +1,18 @@
+name: Update Docker Hub Description
+on:
+  push:
+    branches:
+    - stable
+
+jobs:
+  dockerHubDescription:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Docker Hub Description
+      uses: peter-evans/dockerhub-description@v2.1.0
+      env:
+        DOCKERHUB_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+        DOCKERHUB_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
+        DOCKERHUB_REPOSITORY: freqtradeorg/freqtrade
+

.gitignore

@@ -1,12 +1,11 @@
 # Freqtrade rules
-freqtrade/tests/testdata/*.json
-hyperopt_conf.py
 config*.json
 *.sqlite
-.hyperopt
 logfile.txt
-hyperopt_trials.pickle
+user_data/*
-user_data/
+!user_data/strategy/sample_strategy.py
+!user_data/notebooks
+user_data/notebooks/*
 freqtrade-plot.html
 freqtrade-profit-plot.html
 
@@ -80,8 +79,7 @@ docs/_build/
 target/
 
 # Jupyter Notebook
-.ipynb_checkpoints
+*.ipynb_checkpoints
-*.ipynb
 
 # pyenv
 .python-version
@@ -93,3 +91,6 @@ target/
 
 .pytest_cache/
 .mypy_cache/
+
+#exceptions
+!*.gitkeep

.pyup.yml

@@ -1,37 +0,0 @@
-# autogenerated pyup.io config file
-# see https://pyup.io/docs/configuration/ for all available options
-
-# configure updates globally
-# default: all
-# allowed: all, insecure, False
-update: all
-
-# configure dependency pinning globally
-# default: True
-# allowed: True, False
-pin: True
-
-# update schedule
-# default: empty
-# allowed: "every day", "every week", ..
-schedule: "every week"
-
-
-search: False
-# Specify requirement files by hand, default is empty
-# default: empty
-# allowed: list
-requirements:
-  - requirements.txt
-  - requirements-dev.txt
-  - requirements-plot.txt
-  - requirements-common.txt
-
-
-# configure the branch prefix the bot is using
-# default: pyup-
-branch_prefix: pyup/
-
-# allow to close stale PRs
-# default: True
-close_prs: True

.travis.yml

@@ -1,4 +1,3 @@
-sudo: true
 os:
 - linux
 dist: xenial
@@ -10,15 +9,11 @@ services:
 env:
   global:
     - IMAGE_NAME=freqtradeorg/freqtrade
-addons:
-  apt:
-    packages:
-    - libelf-dev
-    - libdw-dev
-    - binutils-dev
 install:
-- cd build_helpers && ./install_ta-lib.sh; cd ..
+- cd build_helpers && ./install_ta-lib.sh ${HOME}/dependencies; cd ..
-- export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH
+- export LD_LIBRARY_PATH=${HOME}/dependencies/lib:$LD_LIBRARY_PATH
+- export TA_LIBRARY_PATH=${HOME}/dependencies/lib
+- export TA_INCLUDE_PATH=${HOME}/dependencies/include
 - pip install -r requirements-dev.txt
 - pip install -e .
 jobs:
@@ -26,28 +21,36 @@ jobs:
   include:
     - stage: tests
       script:
-      - pytest --random-order --cov=freqtrade --cov-config=.coveragerc freqtrade/tests/
+      - pytest --random-order --cov=freqtrade --cov-config=.coveragerc
       # Allow failure for coveralls
-      - coveralls || true
+      # - coveralls || true
       name: pytest
     - script:
       - cp config.json.example config.json
-      - freqtrade --datadir freqtrade/tests/testdata backtesting
+      - freqtrade create-userdir --userdir user_data
+      - freqtrade backtesting --datadir tests/testdata --strategy SampleStrategy
       name: backtest
     - script:
       - cp config.json.example config.json
-      - freqtrade --datadir freqtrade/tests/testdata hyperopt -e 5
+      - freqtrade create-userdir --userdir user_data
+      - freqtrade hyperopt --datadir tests/testdata -e 5 --strategy SampleStrategy --hyperopt SampleHyperOpt --hyperopt-loss SharpeHyperOptLossDaily
       name: hyperopt
-    - script: flake8 freqtrade scripts
+    - script: flake8
       name: flake8
+    - script:
+      # Test Documentation boxes -
+      # !!! <TYPE>: is not allowed!
+      # !!! <TYPE> "title" - Title needs to be quoted!
+      - grep -Er '^!{3}\s\S+:|^!{3}\s\S+\s[^"]' docs/*; test $? -ne 0
+      name: doc syntax
     - script: mypy freqtrade scripts
       name: mypy
 
-    - stage: docker
+    # - stage: docker
-      if: branch in (master, develop, feat/improve_travis) AND (type in (push, cron))
+    #   if: branch in (master, develop, feat/improve_travis) AND (type in (push, cron))
-      script:
+    #   script:
-        - build_helpers/publish_docker.sh
+    #     - build_helpers/publish_docker.sh
-      name: "Build and test and push docker image"
+    #   name: "Build and test and push docker image"
 
 notifications:
   slack:
@@ -55,4 +58,4 @@ notifications:
 cache:
   pip: True
   directories:
-    - /usr/local/lib/
+    - $HOME/dependencies

CONTRIBUTING.md

@@ -8,17 +8,17 @@ Issues labeled [good first issue](https://github.com/freqtrade/freqtrade/labels/
 
 Few pointers for contributions:
 
-- Create your PR against the `develop` branch, not `master`.
+- Create your PR against the `develop` branch, not `stable`.
-- New features need to contain unit tests and must be PEP8 conformant (max-line-length = 100).
+- New features need to contain unit tests, must conform to PEP8 (max-line-length = 100) and should be documented with the introduction PR.
+- PR's can be declared as `[WIP]` - which signify Work in Progress Pull Requests (which are not finished).
 
-If you are unsure, discuss the feature on our [Slack](https://join.slack.com/t/highfrequencybot/shared_invite/enQtNjU5ODcwNjI1MDU3LWEyODBiNzkzNzcyNzU0MWYyYzE5NjIyOTQxMzBmMGUxOTIzM2YyN2Y4NWY1YTEwZDgwYTRmMzE2NmM5ZmY2MTg)
+If you are unsure, discuss the feature on our [discord server](https://discord.gg/MA9v74M), on [Slack](https://join.slack.com/t/highfrequencybot/shared_invite/zt-jaut7r4m-Y17k4x5mcQES9a9swKuxbg) or in a [issue](https://github.com/freqtrade/freqtrade/issues) before a PR.
-or in a [issue](https://github.com/freqtrade/freqtrade/issues) before a PR.
 
 ## Getting started
 
 Best start by reading the [documentation](https://www.freqtrade.io/) to get a feel for what is possible with the bot, or head straight to the [Developer-documentation](https://www.freqtrade.io/en/latest/developer/) (WIP) which should help you getting started.
 
-## Before sending the PR:
+## Before sending the PR
 
 ### 1. Run unit tests
 
@@ -28,19 +28,19 @@ make it pass. It means you have introduced a regression.
 #### Test the whole project
 
 ```bash
-pytest freqtrade
+pytest
 ```
 
 #### Test only one file
 
 ```bash
-pytest freqtrade/tests/test_<file_name>.py
+pytest tests/test_<file_name>.py
 ```
 
 #### Test only one method from one file
 
 ```bash
-pytest freqtrade/tests/test_<file_name>.py::test_<method_name>
+pytest tests/test_<file_name>.py::test_<method_name>
 ```
 
 ### 2. Test if your code is PEP8 compliant
@@ -48,7 +48,7 @@ pytest freqtrade/tests/test_<file_name>.py::test_<method_name>
 #### Run Flake8
 
 ```bash
-flake8 freqtrade
+flake8 freqtrade tests scripts
 ```
 
 We receive a lot of code that fails the `flake8` checks.
@@ -64,6 +64,14 @@ Guide for installing them is [here](http://flake8.pycqa.org/en/latest/user/using
 mypy freqtrade
 ```
 
+### 4. Ensure all imports are correct
+
+#### Run isort
+
+``` bash
+isort .
+```
+
 ## (Core)-Committer Guide
 
 ### Process: Pull Requests
@@ -109,11 +117,11 @@ Exceptions:
 
 Contributors may be given commit privileges. Preference will be given to those with:
 
-1. Past contributions to FreqTrade and other related open-source projects. Contributions to FreqTrade include both code (both accepted and pending) and friendly participation in the issue tracker and Pull request reviews. Quantity and quality are considered.
+1. Past contributions to Freqtrade and other related open-source projects. Contributions to Freqtrade include both code (both accepted and pending) and friendly participation in the issue tracker and Pull request reviews. Quantity and quality are considered.
 1. A coding style that the other core committers find simple, minimal, and clean.
 1. Access to resources for cross-platform development and testing.
 1. Time to devote to the project regularly.
 
-Beeing a Committer does not grant write permission on `develop` or `master` for security reasons (Users trust FreqTrade with their Exchange API keys).
+Being a Committer does not grant write permission on `develop` or `stable` for security reasons (Users trust Freqtrade with their Exchange API keys).
 
-After beeing Committer for some time, a Committer may be named Core Committer and given full repository access.
+After being Committer for some time, a Committer may be named Core Committer and given full repository access.

Dockerfile

@@ -1,7 +1,7 @@
-FROM python:3.7.3-slim-stretch
+FROM python:3.8.6-slim-buster
 
 RUN apt-get update \
-    && apt-get -y install curl build-essential libssl-dev \
+    && apt-get -y install curl build-essential libssl-dev sqlite3 \
     && apt-get clean \
     && pip install --upgrade pip
 
@@ -16,11 +16,14 @@ RUN cd /tmp && /tmp/install_ta-lib.sh && rm -r /tmp/*ta-lib*
 ENV LD_LIBRARY_PATH /usr/local/lib
 
 # Install dependencies
-COPY requirements.txt requirements-common.txt /freqtrade/
+COPY requirements.txt requirements-hyperopt.txt /freqtrade/
 RUN pip install numpy --no-cache-dir \
-  && pip install -r requirements.txt --no-cache-dir
+  && pip install -r requirements-hyperopt.txt --no-cache-dir
 
 # Install and execute
 COPY . /freqtrade/
-RUN pip install -e . --no-cache-dir
+RUN pip install -e . --no-cache-dir \
+  && mkdir /freqtrade/user_data/
 ENTRYPOINT ["freqtrade"]
+# Default to trade mode
+CMD [ "trade" ]

Dockerfile.armhf

@@ -0,0 +1,29 @@
+FROM --platform=linux/arm/v7 python:3.7.7-slim-buster
+
+RUN apt-get update \
+  && apt-get -y install curl build-essential libssl-dev libffi-dev libatlas3-base libgfortran5 sqlite3 \
+  && apt-get clean \
+  && pip install --upgrade pip \
+  && echo "[global]\nextra-index-url=https://www.piwheels.org/simple" > /etc/pip.conf
+
+# Prepare environment
+RUN mkdir /freqtrade
+WORKDIR /freqtrade
+
+# Install TA-lib
+COPY build_helpers/* /tmp/
+RUN cd /tmp && /tmp/install_ta-lib.sh && rm -r /tmp/*ta-lib*
+
+ENV LD_LIBRARY_PATH /usr/local/lib
+
+# Install dependencies
+COPY requirements.txt /freqtrade/
+RUN pip install numpy --no-cache-dir \
+  && pip install -r requirements.txt --no-cache-dir
+
+# Install and execute
+COPY . /freqtrade/
+RUN pip install -e . --no-cache-dir
+ENTRYPOINT ["freqtrade"]
+# Default to trade mode
+CMD [ "trade" ]

Dockerfile.pi

@@ -1,40 +0,0 @@
-FROM balenalib/raspberrypi3-debian:stretch
-
-RUN [ "cross-build-start" ]
-
-RUN apt-get update \
- && apt-get -y install wget curl build-essential libssl-dev libffi-dev \
- && apt-get clean
-
-# Prepare environment
-RUN mkdir /freqtrade
-WORKDIR /freqtrade
-
-# Install TA-lib
-COPY build_helpers/ta-lib-0.4.0-src.tar.gz /freqtrade/
-RUN tar -xzf /freqtrade/ta-lib-0.4.0-src.tar.gz \
- && cd /freqtrade/ta-lib/ \
- && ./configure \
- && make \
- && make install \
- && rm /freqtrade/ta-lib-0.4.0-src.tar.gz
-
-ENV LD_LIBRARY_PATH /usr/local/lib
-
-# Install berryconda
-RUN wget https://github.com/jjhelmus/berryconda/releases/download/v2.0.0/Berryconda3-2.0.0-Linux-armv7l.sh \
- && bash ./Berryconda3-2.0.0-Linux-armv7l.sh -b \
- && rm Berryconda3-2.0.0-Linux-armv7l.sh
-
-# Install dependencies
-COPY requirements-common.txt /freqtrade/
-RUN ~/berryconda3/bin/conda install -y numpy pandas scipy \
- && ~/berryconda3/bin/pip install -r requirements-common.txt --no-cache-dir
-
-# Install and execute
-COPY . /freqtrade/
-RUN ~/berryconda3/bin/pip install -e . --no-cache-dir
-
-RUN [ "cross-build-end" ]
-
-ENTRYPOINT ["/root/berryconda3/bin/python","./freqtrade/main.py"]

MANIFEST.in

@@ -2,4 +2,4 @@ include LICENSE
 include README.md
 include config.json.example
 recursive-include freqtrade *.py
-include freqtrade/tests/testdata/*.json
+recursive-include freqtrade/templates/ *.j2 *.ipynb

README.md

@@ -1,6 +1,6 @@
 # Freqtrade
 
-[![Build Status](https://travis-ci.org/freqtrade/freqtrade.svg?branch=develop)](https://travis-ci.org/freqtrade/freqtrade)
+[![Freqtrade CI](https://github.com/freqtrade/freqtrade/workflows/Freqtrade%20CI/badge.svg)](https://github.com/freqtrade/freqtrade/actions/)
 [![Coverage Status](https://coveralls.io/repos/github/freqtrade/freqtrade/badge.svg?branch=develop&service=github)](https://coveralls.io/github/freqtrade/freqtrade?branch=develop)
 [![Documentation](https://readthedocs.org/projects/freqtrade/badge/)](https://www.freqtrade.io)
 [![Maintainability](https://api.codeclimate.com/v1/badges/5737e6d668200b7518ff/maintainability)](https://codeclimate.com/github/freqtrade/freqtrade/maintainability)
@@ -25,7 +25,8 @@ hesitate to read the source code and understand the mechanism of this bot.
 ## Exchange marketplaces supported
 
 - [X] [Bittrex](https://bittrex.com/)
-- [X] [Binance](https://www.binance.com/) ([*Note for binance users](#a-note-on-binance))
+- [X] [Binance](https://www.binance.com/) ([*Note for binance users](docs/exchanges.md#blacklists))
+- [X] [Kraken](https://kraken.com/)
 - [ ] [113 others to tests](https://github.com/ccxt/ccxt/). _(We cannot guarantee they will work)_
 
 ## Documentation
@@ -54,94 +55,90 @@ Please find the complete documentation on our [website](https://www.freqtrade.io
 Freqtrade provides a Linux/macOS script to install all dependencies and help you to configure the bot.
 
 ```bash
-git clone git@github.com:freqtrade/freqtrade.git
+git clone -b develop https://github.com/freqtrade/freqtrade.git 
 cd freqtrade
-git checkout develop
 ./setup.sh --install
 ```
 
 For any other type of installation please refer to [Installation doc](https://www.freqtrade.io/en/latest/installation/).
 
-
 ## Basic Usage
 
 ### Bot commands
 
 ```
-usage: freqtrade [-h] [-v] [--logfile FILE] [--version] [-c PATH] [-d PATH]
+usage: freqtrade [-h] [-V]
-                 [-s NAME] [--strategy-path PATH] [--dynamic-whitelist [INT]]
+                 {trade,create-userdir,new-config,new-hyperopt,new-strategy,download-data,convert-data,convert-trade-data,backtesting,edge,hyperopt,hyperopt-list,hyperopt-show,list-exchanges,list-hyperopts,list-markets,list-pairs,list-strategies,list-timeframes,show-trades,test-pairlist,plot-dataframe,plot-profit}
-                 [--db-url PATH] [--sd-notify]
+                 ...
-                 {backtesting,edge,hyperopt} ...
 
 Free, open source crypto trading bot
 
 positional arguments:
-  {backtesting,edge,hyperopt}
+  {trade,create-userdir,new-config,new-hyperopt,new-strategy,download-data,convert-data,convert-trade-data,backtesting,edge,hyperopt,hyperopt-list,hyperopt-show,list-exchanges,list-hyperopts,list-markets,list-pairs,list-strategies,list-timeframes,show-trades,test-pairlist,plot-dataframe,plot-profit}
+    trade               Trade module.
+    create-userdir      Create user-data directory.
+    new-config          Create new config
+    new-hyperopt        Create new hyperopt
+    new-strategy        Create new strategy
+    download-data       Download backtesting data.
+    convert-data        Convert candle (OHLCV) data from one format to
+                        another.
+    convert-trade-data  Convert trade data from one format to another.
     backtesting         Backtesting module.
     edge                Edge module.
     hyperopt            Hyperopt module.
+    hyperopt-list       List Hyperopt results
+    hyperopt-show       Show details of Hyperopt results
+    list-exchanges      Print available exchanges.
+    list-hyperopts      Print available hyperopt classes.
+    list-markets        Print markets on exchange.
+    list-pairs          Print pairs on exchange.
+    list-strategies     Print available strategies.
+    list-timeframes     Print available timeframes for the exchange.
+    show-trades         Show trades.
+    test-pairlist       Test your pairlist configuration.
+    plot-dataframe      Plot candles with indicators.
+    plot-profit         Generate plot showing profits.
 
 optional arguments:
   -h, --help            show this help message and exit
-  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
+  -V, --version         show program's version number and exit
-  --logfile FILE        Log to the file specified
+
-  --version             show program's version number and exit
-  -c PATH, --config PATH
-                        Specify configuration file (default: None). Multiple
-                        --config options may be used.
-  -d PATH, --datadir PATH
-                        Path to backtest data.
-  -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). DEPRECATED.
-  --db-url PATH         Override trades database URL, this is useful if
-                        dry_run is enabled or in custom deployments (default:
-                        None).
-  --sd-notify           Notify systemd service manager.
 ```
 
 ### Telegram RPC commands
 
-Telegram is not mandatory. However, this is a great way to control your bot. More details on our [documentation](https://www.freqtrade.io/en/latest/telegram-usage/)
+Telegram is not mandatory. However, this is a great way to control your bot. More details and the full command list on our [documentation](https://www.freqtrade.io/en/latest/telegram-usage/)
 
-- `/start`: Starts the trader
+- `/start`: Starts the trader.
-- `/stop`: Stops the trader
+- `/stop`: Stops the trader.
-- `/status [table]`: Lists all open trades
+- `/stopbuy`: Stop entering new trades.
-- `/count`: Displays number of open trades
+- `/status [table]`: Lists all 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
+- `/balance`: Show account balance per currency.
-- `/daily <n>`: Shows profit or loss per day, over the last n days
+- `/daily <n>`: Shows profit or loss per day, over the last n days.
-- `/help`: Show help message
+- `/help`: Show help message.
-- `/version`: Show version
+- `/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.
+- `develop` - This branch has often new features, but might also contain breaking changes. We try hard to keep this branch as stable as possible.
-- `master` - This branch contains the latest stable release. The bot 'should' be stable on this branch, and is generally well tested.
+- `stable` - This branch contains the latest stable release. This branch is generally well tested.
 - `feat/*` - These are feature branches, which are being worked on heavily. Please don't use these unless you want to test a specific feature.
 
-## A note on Binance
-
-For Binance, please add `"BNB/<STAKE>"` to your blacklist to avoid issues.
-Accounts having BNB accounts use this to pay for fees - if your first trade happens to be on `BNB`, further trades will consume this position and make the initial BNB order unsellable as the expected amount is not there anymore.
-
 ## Support
 
-### Help / Slack
+### Help / Discord / Slack
 
-For any questions not covered by the documentation or for further
+For any questions not covered by the documentation or for further information about the bot, or to simply engage with like-minded individuals, we encourage you to join our slack channel.
-information about the bot, we encourage you to join our slack channel.
 
-- [Click here to join Slack channel](https://join.slack.com/t/highfrequencybot/shared_invite/enQtNjU5ODcwNjI1MDU3LWEyODBiNzkzNzcyNzU0MWYyYzE5NjIyOTQxMzBmMGUxOTIzM2YyN2Y4NWY1YTEwZDgwYTRmMzE2NmM5ZmY2MTg).
+Please check out our [discord server](https://discord.gg/MA9v74M).
+
+You can also join our [Slack channel](https://join.slack.com/t/highfrequencybot/shared_invite/zt-jaut7r4m-Y17k4x5mcQES9a9swKuxbg).
 
 ### [Bugs / Issues](https://github.com/freqtrade/freqtrade/issues?q=is%3Aissue)
 
@@ -169,18 +166,18 @@ Please read our
 [Contributing document](https://github.com/freqtrade/freqtrade/blob/develop/CONTRIBUTING.md)
 to understand the requirements before sending your pull-requests.
 
-Coding is not a neccessity to contribute - maybe start with improving our documentation?
+Coding is not a necessity to contribute - maybe start with improving our documentation?
 Issues labeled [good first issue](https://github.com/freqtrade/freqtrade/labels/good%20first%20issue) can be good first contributions, and will help get you familiar with the codebase.
 
-**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](https://join.slack.com/t/highfrequencybot/shared_invite/enQtNjU5ODcwNjI1MDU3LWEyODBiNzkzNzcyNzU0MWYyYzE5NjIyOTQxMzBmMGUxOTIzM2YyN2Y4NWY1YTEwZDgwYTRmMzE2NmM5ZmY2MTg). This will ensure that interested parties can give valuable feedback on the feature, and let others know that you are working on it.
+**Note** before starting any major new feature work, *please open an issue describing what you are planning to do* or talk to us on [discord](https://discord.gg/MA9v74M) or [Slack](https://join.slack.com/t/highfrequencybot/shared_invite/zt-jaut7r4m-Y17k4x5mcQES9a9swKuxbg). 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`.
+**Important:** Always create your PR against the `develop` branch, not `stable`.
 
 ## Requirements
 
-### Uptodate clock
+### Up-to-date clock
 
-The clock must be accurate, syncronized to a NTP server very frequently to avoid problems with communication to the exchanges.
+The clock must be accurate, synchronized to a NTP server very frequently to avoid problems with communication to the exchanges.
 
 ### Min hardware required
 

bin/freqtrade

@@ -1,11 +0,0 @@
-#!/usr/bin/env python3
-
-import sys
-import warnings
-
-from freqtrade.main import main
-
-warnings.warn(
-    "Deprecated - To continue to run the bot like this, please run `pip install -e .` again.",
-    DeprecationWarning)
-main(sys.argv[1:])

build_helpers/install_ta-lib.sh

@@ -1,8 +1,14 @@
-if [ ! -f "/usr/local/lib/libta_lib.a" ]; then
+if [ -z "$1" ]; then
+  INSTALL_LOC=/usr/local
+else
+  INSTALL_LOC=${1}
+fi
+echo "Installing to ${INSTALL_LOC}"
+if [ ! -f "${INSTALL_LOC}/lib/libta_lib.a" ]; then
   tar zxvf ta-lib-0.4.0-src.tar.gz
   cd ta-lib \
   && sed -i.bak "s|0.00000001|0.000000000000000001 |g" src/ta_func/ta_utility.h \
-  && ./configure \
+  && ./configure --prefix=${INSTALL_LOC}/ \
   && make \
   && which sudo && sudo make install || make install \
   && cd ..

build_helpers/install_windows.ps1

@@ -0,0 +1,17 @@
+# Downloads don't work automatically, since the URL is regenerated via javascript.
+# Downloaded from https://www.lfd.uci.edu/~gohlke/pythonlibs/#ta-lib
+# Invoke-WebRequest -Uri "https://download.lfd.uci.edu/pythonlibs/xxxxxxx/TA_Lib-0.4.17-cp37-cp37m-win_amd64.whl" -OutFile "TA_Lib-0.4.17-cp37-cp37m-win_amd64.whl"
+
+python -m pip install --upgrade pip
+
+$pyv = python -c "import sys; print(f'{sys.version_info.major}.{sys.version_info.minor}')"
+
+if ($pyv -eq '3.7') {
+    pip install build_helpers\TA_Lib-0.4.19-cp37-cp37m-win_amd64.whl
+}
+if ($pyv -eq '3.8') {
+    pip install build_helpers\TA_Lib-0.4.19-cp38-cp38-win_amd64.whl
+}
+
+pip install -r requirements-dev.txt
+pip install -e .

build_helpers/publish_docker.sh

@@ -1,21 +1,28 @@
 #!/bin/sh
-# - export TAG=`if [ "$TRAVIS_BRANCH" == "develop" ]; then echo "latest"; else echo $TRAVIS_BRANCH ; fi`
-# Replace / with _ to create a valid tag
-TAG=$(echo "${TRAVIS_BRANCH}" | sed -e "s/\//_/")
 
+# Replace / with _ to create a valid tag
+TAG=$(echo "${BRANCH_NAME}" | sed -e "s/\//_/g")
+TAG_PLOT=${TAG}_plot
+echo "Running for ${TAG}"
 
 # Add commit and commit_message to docker container
-echo "${TRAVIS_COMMIT} ${TRAVIS_COMMIT_MESSAGE}" > freqtrade_commit
+echo "${GITHUB_SHA}" > freqtrade_commit
 
-if [ "${TRAVIS_EVENT_TYPE}" = "cron" ]; then
+if [ "${GITHUB_EVENT_NAME}" = "schedule" ]; then
-    echo "event ${TRAVIS_EVENT_TYPE}: full rebuild - skipping cache"
+    echo "event ${GITHUB_EVENT_NAME}: full rebuild - skipping cache"
     docker build -t freqtrade:${TAG} .
 else
-    echo "event ${TRAVIS_EVENT_TYPE}: building with cache"
+    echo "event ${GITHUB_EVENT_NAME}: building with cache"
     # Pull last build to avoid rebuilding the whole image
     docker pull ${IMAGE_NAME}:${TAG}
     docker build --cache-from ${IMAGE_NAME}:${TAG} -t freqtrade:${TAG} .
 fi
+# Tag image for upload and next build step
+docker tag freqtrade:$TAG ${IMAGE_NAME}:$TAG
+
+docker build --cache-from freqtrade:${TAG} --build-arg sourceimage=${TAG} -t freqtrade:${TAG_PLOT} -f docker/Dockerfile.plot .
+
+docker tag freqtrade:$TAG_PLOT ${IMAGE_NAME}:$TAG_PLOT
 
 if [ $? -ne 0 ]; then
     echo "failed building image"
@@ -23,33 +30,23 @@ if [ $? -ne 0 ]; then
 fi
 
 # Run backtest
-docker run --rm -it -v $(pwd)/config.json.example:/freqtrade/config.json:ro freqtrade:${TAG} --datadir freqtrade/tests/testdata backtesting
+docker run --rm -v $(pwd)/config.json.example:/freqtrade/config.json:ro -v $(pwd)/tests:/tests freqtrade:${TAG} backtesting --datadir /tests/testdata --strategy-path /tests/strategy/strats/ --strategy DefaultStrategy
 
 if [ $? -ne 0 ]; then
     echo "failed running backtest"
     return 1
 fi
 
-# Tag image for upload
-docker tag freqtrade:$TAG ${IMAGE_NAME}:$TAG
 if [ $? -ne 0 ]; then
     echo "failed tagging image"
     return 1
 fi
 
 # Tag as latest for develop builds
-if [ "${TRAVIS_BRANCH}" = "develop" ]; then
+if [ "${TAG}" = "develop" ]; then
     docker tag freqtrade:$TAG ${IMAGE_NAME}:latest
 fi
 
-# Login
-echo "$DOCKER_PASS" | docker login -u $DOCKER_USER --password-stdin
-
-if [ $? -ne 0 ]; then
-    echo "failed login"
-    return 1
-fi
-
 # Show all available images
 docker images
 

build_helpers/publish_docker_pi.sh

@@ -0,0 +1,36 @@
+#!/bin/sh
+
+# The below assumes a correctly setup docker buildx environment
+
+# Replace / with _ to create a valid tag
+TAG=$(echo "${BRANCH_NAME}" | sed -e "s/\//_/g")
+PI_PLATFORM="linux/arm/v7"
+echo "Running for ${TAG}"
+CACHE_TAG=freqtradeorg/freqtrade_cache:${TAG}_cache
+
+# Add commit and commit_message to docker container
+echo "${GITHUB_SHA}" > freqtrade_commit
+
+if [ "${GITHUB_EVENT_NAME}" = "schedule" ]; then
+    echo "event ${GITHUB_EVENT_NAME}: full rebuild - skipping cache"
+    docker buildx build \
+        --cache-to=type=registry,ref=${CACHE_TAG} \
+        -f Dockerfile.armhf \
+        --platform ${PI_PLATFORM} \
+        -t ${IMAGE_NAME}:${TAG} --push .
+else
+    echo "event ${GITHUB_EVENT_NAME}: building with cache"
+    # Pull last build to avoid rebuilding the whole image
+    # docker pull --platform ${PI_PLATFORM} ${IMAGE_NAME}:${TAG}
+    docker buildx build \
+        --cache-from=type=registry,ref=${CACHE_TAG} \
+        --cache-to=type=registry,ref=${CACHE_TAG} \
+        -f Dockerfile.armhf \
+        --platform ${PI_PLATFORM} \
+        -t ${IMAGE_NAME}:${TAG} --push .
+fi
+
+if [ $? -ne 0 ]; then
+    echo "failed building image"
+    return 1
+fi

config.json.example

@@ -2,17 +2,18 @@
     "max_open_trades": 3,
     "stake_currency": "BTC",
     "stake_amount": 0.05,
+    "tradable_balance_ratio": 0.99,
     "fiat_display_currency": "USD",
-    "ticker_interval" : "5m",
+    "timeframe": "5m",
-    "dry_run": false,
+    "dry_run": true,
-    "trailing_stop": false,
+    "cancel_open_orders_on_exit": false,
     "unfilledtimeout": {
         "buy": 10,
         "sell": 30
     },
     "bid_strategy": {
-        "ask_last_balance": 0.0,
         "use_order_book": false,
+        "ask_last_balance": 0.0,
         "order_book_top": 1,
         "check_depth_of_market": {
             "enabled": false,
@@ -22,7 +23,10 @@
     "ask_strategy":{
         "use_order_book": false,
         "order_book_min": 1,
-        "order_book_max": 9
+        "order_book_max": 1,
+        "use_sell_signal": true,
+        "sell_profit_only": false,
+        "ignore_roi_if_buy_signal": false
     },
     "exchange": {
         "name": "bittrex",
@@ -40,8 +44,8 @@
             "DASH/BTC",
             "ZEC/BTC",
             "XLM/BTC",
-            "NXT/BTC",
+            "XRP/BTC",
-            "POWR/BTC",
+            "TRX/BTC",
             "ADA/BTC",
             "XMR/BTC"
         ],
@@ -49,16 +53,13 @@
             "DOGE/BTC"
         ]
     },
-    "experimental": {
+    "pairlists": [
-        "use_sell_signal": false,
+        {"method": "StaticPairList"}
-        "sell_profit_only": false,
+    ],
-        "ignore_roi_if_buy_signal": false
-    },
     "edge": {
         "enabled": false,
         "process_throttle_secs": 3600,
         "calculate_since_number_of_days": 7,
-        "capital_available_percentage": 0.5,
         "allowed_risk": 0.01,
         "stoploss_range_min": -0.01,
         "stoploss_range_max": -0.1,
@@ -70,10 +71,20 @@
         "remove_pumps": false
     },
     "telegram": {
-        "enabled": true,
+        "enabled": false,
         "token": "your_telegram_token",
         "chat_id": "your_telegram_chat_id"
     },
+    "api_server": {
+        "enabled": false,
+        "listen_ip_address": "127.0.0.1",
+        "listen_port": 8080,
+        "verbosity": "info",
+        "jwt_secret_key": "somethingrandom",
+        "CORS_origins": [],
+        "username": "",
+        "password": ""
+    },
     "initial_state": "running",
     "forcebuy_enable": false,
     "internals": {

config_binance.json.example

@@ -2,10 +2,11 @@
     "max_open_trades": 3,
     "stake_currency": "BTC",
     "stake_amount": 0.05,
+    "tradable_balance_ratio": 0.99,
     "fiat_display_currency": "USD",
-    "ticker_interval" : "5m",
+    "timeframe": "5m",
     "dry_run": true,
-    "trailing_stop": false,
+    "cancel_open_orders_on_exit": false,
     "unfilledtimeout": {
         "buy": 10,
         "sell": 30
@@ -22,7 +23,10 @@
     "ask_strategy":{
         "use_order_book": false,
         "order_book_min": 1,
-        "order_book_max": 9
+        "order_book_max": 1,
+        "use_sell_signal": true,
+        "sell_profit_only": false,
+        "ignore_roi_if_buy_signal": false
     },
     "exchange": {
         "name": "binance",
@@ -34,33 +38,33 @@
             "rateLimit": 200
         },
         "pair_whitelist": [
-            "AST/BTC",
+            "ALGO/BTC",
-            "ETC/BTC",
+            "ATOM/BTC",
-            "ETH/BTC",
+            "BAT/BTC",
+            "BCH/BTC",
+            "BRD/BTC",
             "EOS/BTC",
+            "ETH/BTC",
             "IOTA/BTC",
+            "LINK/BTC",
             "LTC/BTC",
-            "MTH/BTC",
+            "NEO/BTC",
-            "NCASH/BTC",
+            "NXS/BTC",
-            "TNT/BTC",
             "XMR/BTC",
-            "XLM/BTC",
+            "XRP/BTC",
-            "XRP/BTC"
+            "XTZ/BTC"
         ],
         "pair_blacklist": [
             "BNB/BTC"
         ]
     },
-    "experimental": {
+    "pairlists": [
-        "use_sell_signal": false,
+        {"method": "StaticPairList"}
-        "sell_profit_only": false,
+    ],
-        "ignore_roi_if_buy_signal": false
-    },
     "edge": {
         "enabled": false,
         "process_throttle_secs": 3600,
         "calculate_since_number_of_days": 7,
-        "capital_available_percentage": 0.5,
         "allowed_risk": 0.01,
         "stoploss_range_min": -0.01,
         "stoploss_range_max": -0.1,
@@ -76,6 +80,16 @@
         "token": "your_telegram_token",
         "chat_id": "your_telegram_chat_id"
     },
+    "api_server": {
+        "enabled": false,
+        "listen_ip_address": "127.0.0.1",
+        "listen_port": 8080,
+        "verbosity": "info",
+        "jwt_secret_key": "somethingrandom",
+        "CORS_origins": [],
+        "username": "",
+        "password": ""
+    },
     "initial_state": "running",
     "forcebuy_enable": false,
     "internals": {

config_full.json.example

@@ -2,10 +2,14 @@
     "max_open_trades": 3,
     "stake_currency": "BTC",
     "stake_amount": 0.05,
+    "tradable_balance_ratio": 0.99,
     "fiat_display_currency": "USD",
     "amount_reserve_percent": 0.05,
-    "dry_run": false,
+    "amend_last_stake_amount": false,
-    "ticker_interval": "5m",
+    "last_stake_amount_min_ratio": 0.5,
+    "dry_run": true,
+    "cancel_open_orders_on_exit": false,
+    "timeframe": "5m",
     "trailing_stop": false,
     "trailing_stop_positive": 0.005,
     "trailing_stop_positive_offset": 0.0051,
@@ -22,6 +26,7 @@
         "sell": 30
     },
     "bid_strategy": {
+        "price_side": "bid",
         "use_order_book": false,
         "ask_last_balance": 0.0,
         "order_book_top": 1,
@@ -31,13 +36,18 @@
         }
     },
     "ask_strategy":{
+        "price_side": "ask",
         "use_order_book": false,
         "order_book_min": 1,
-        "order_book_max": 9
+        "order_book_max": 1,
+        "use_sell_signal": true,
+        "sell_profit_only": false,
+        "ignore_roi_if_buy_signal": false
     },
     "order_types": {
         "buy": "limit",
         "sell": "limit",
+        "emergencysell": "market",
         "stoploss": "market",
         "stoploss_on_exchange": false,
         "stoploss_on_exchange_interval": 60
@@ -46,14 +56,19 @@
         "buy": "gtc",
         "sell": "gtc"
     },
-    "pairlist": {
+    "pairlists": [
+        {"method": "StaticPairList"},
+        {
             "method": "VolumePairList",
-        "config": {
             "number_assets": 20,
             "sort_key": "quoteVolume",
-            "precision_filter": false
+            "refresh_period": 1800
-        }
         },
+        {"method": "AgeFilter", "min_days_listed": 10},
+        {"method": "PrecisionFilter"},
+        {"method": "PriceFilter", "low_price_ratio": 0.01, "min_price": 0.00000010},
+        {"method": "SpreadFilter", "max_spread_ratio": 0.005}
+    ],
     "exchange": {
         "name": "bittrex",
         "sandbox": false,
@@ -74,7 +89,7 @@
             "ZEC/BTC",
             "XLM/BTC",
             "NXT/BTC",
-            "POWR/BTC",
+            "TRX/BTC",
             "ADA/BTC",
             "XMR/BTC"
         ],
@@ -88,7 +103,6 @@
         "enabled": false,
         "process_throttle_secs": 3600,
         "calculate_since_number_of_days": 7,
-        "capital_available_percentage": 0.5,
         "allowed_risk": 0.01,
         "stoploss_range_min": -0.01,
         "stoploss_range_max": -0.1,
@@ -99,20 +113,27 @@
         "max_trade_duration_minute": 1440,
         "remove_pumps": false
     },
-    "experimental": {
-        "use_sell_signal": false,
-        "sell_profit_only": false,
-        "ignore_roi_if_buy_signal": false
-    },
     "telegram": {
         "enabled": true,
         "token": "your_telegram_token",
-        "chat_id": "your_telegram_chat_id"
+        "chat_id": "your_telegram_chat_id",
+        "notification_settings": {
+            "status": "on",
+            "warning": "on",
+            "startup": "on",
+            "buy": "on",
+            "sell": "on",
+            "buy_cancel": "on",
+            "sell_cancel": "on"
+        }
     },
     "api_server": {
         "enabled": false,
         "listen_ip_address": "127.0.0.1",
         "listen_port": 8080,
+        "verbosity": "info",
+        "jwt_secret_key": "somethingrandom",
+        "CORS_origins": [],
         "username": "freqtrader",
         "password": "SuperSecurePassword"
     },
@@ -120,8 +141,12 @@
     "initial_state": "running",
     "forcebuy_enable": false,
     "internals": {
-        "process_throttle_secs": 5
+        "process_throttle_secs": 5,
+        "heartbeat_interval": 60
     },
+    "disable_dataframe_checks": false,
     "strategy": "DefaultStrategy",
-    "strategy_path": "user_data/strategies/"
+    "strategy_path": "user_data/strategies/",
+    "dataformat_ohlcv": "json",
+    "dataformat_trades": "jsongz"
 }

config_kraken.json.example

@@ -2,10 +2,11 @@
     "max_open_trades": 5,
     "stake_currency": "EUR",
     "stake_amount": 10,
+    "tradable_balance_ratio": 0.99,
     "fiat_display_currency": "EUR",
-    "ticker_interval" : "5m",
+    "timeframe": "5m",
     "dry_run": true,
-    "trailing_stop": false,
+    "cancel_open_orders_on_exit": false,
     "unfilledtimeout": {
         "buy": 10,
         "sell": 30
@@ -22,31 +23,53 @@
     "ask_strategy":{
         "use_order_book": false,
         "order_book_min": 1,
-        "order_book_max": 9
+        "order_book_max": 1,
+        "use_sell_signal": true,
+        "sell_profit_only": false,
+        "ignore_roi_if_buy_signal": false
     },
     "exchange": {
         "name": "kraken",
-        "key": "",
+        "key": "your_exchange_key",
-        "secret": "",
+        "secret": "your_exchange_key",
         "ccxt_config": {"enableRateLimit": true},
         "ccxt_async_config": {
             "enableRateLimit": true,
             "rateLimit": 1000
         },
         "pair_whitelist": [
-            "ETH/EUR",
+            "ADA/EUR",
+            "ATOM/EUR",
+            "BAT/EUR",
+            "BCH/EUR",
             "BTC/EUR",
-            "BCH/EUR"
+            "DAI/EUR",
+            "DASH/EUR",
+            "EOS/EUR",
+            "ETC/EUR",
+            "ETH/EUR",
+            "LINK/EUR",
+            "LTC/EUR",
+            "QTUM/EUR",
+            "REP/EUR",
+            "WAVES/EUR",
+            "XLM/EUR",
+            "XMR/EUR",
+            "XRP/EUR",
+            "XTZ/EUR",
+            "ZEC/EUR"
         ],
         "pair_blacklist": [
 
         ]
     },
+    "pairlists": [
+        {"method": "StaticPairList"}
+    ],
     "edge": {
         "enabled": false,
         "process_throttle_secs": 3600,
         "calculate_since_number_of_days": 7,
-        "capital_available_percentage": 0.5,
         "allowed_risk": 0.01,
         "stoploss_range_min": -0.01,
         "stoploss_range_max": -0.1,
@@ -62,9 +85,20 @@
         "token": "your_telegram_token",
         "chat_id": "your_telegram_chat_id"
     },
+    "api_server": {
+        "enabled": false,
+        "listen_ip_address": "127.0.0.1",
+        "listen_port": 8080,
+        "verbosity": "info",
+        "jwt_secret_key": "somethingrandom",
+        "CORS_origins": [],
+        "username": "",
+        "password": ""
+    },
     "initial_state": "running",
     "forcebuy_enable": false,
     "internals": {
         "process_throttle_secs": 5
-    }
+    },
+    "download_trades": true
 }

docker-compose.yml

@@ -0,0 +1,23 @@
+---
+version: '3'
+services:
+  freqtrade:
+    image: freqtradeorg/freqtrade:stable
+    # image: freqtradeorg/freqtrade:develop
+    # Use plotting image
+    # image: freqtradeorg/freqtrade:develop_plot
+    # Build step - only needed when additional dependencies are needed
+    # build:
+    #   context: .
+    #   dockerfile: "./Dockerfile.technical"
+    restart: unless-stopped
+    container_name: freqtrade
+    volumes:
+      - "./user_data:/freqtrade/user_data"
+    # Default command used when running `docker compose up`
+    command: >
+      trade
+      --logfile /freqtrade/user_data/logs/freqtrade.log
+      --db-url sqlite:////freqtrade/user_data/tradesv3.sqlite
+      --config /freqtrade/user_data/config.json
+      --strategy SampleStrategy

docker/Dockerfile.develop

@@ -2,6 +2,7 @@ FROM freqtradeorg/freqtrade:develop
 
 # Install dependencies
 COPY requirements-dev.txt /freqtrade/
+
 RUN pip install numpy --no-cache-dir \
   && pip install -r requirements-dev.txt --no-cache-dir
 

docker/Dockerfile.jupyter

@@ -0,0 +1,7 @@
+FROM freqtradeorg/freqtrade:develop_plot
+
+
+RUN pip install jupyterlab --no-cache-dir
+
+# Empty the ENTRYPOINT to allow all commands
+ENTRYPOINT []

docker/Dockerfile.plot

@@ -0,0 +1,7 @@
+ARG sourceimage=develop
+FROM freqtradeorg/freqtrade:${sourceimage}
+
+# Install dependencies
+COPY requirements-plot.txt /freqtrade/
+
+RUN pip install -r requirements-plot.txt --no-cache-dir

docker/docker-compose-jupyter.yml

@@ -0,0 +1,16 @@
+---
+version: '3'
+services:
+  ft_jupyterlab:
+    build:
+      context: ..
+      dockerfile: docker/Dockerfile.jupyter
+    restart: unless-stopped
+    container_name: freqtrade
+    ports:
+      - "127.0.0.1:8888:8888"
+    volumes:
+      - "./user_data:/freqtrade/user_data"
+    # Default command used when running `docker compose up`
+    command: >
+      jupyter lab --port=8888 --ip 0.0.0.0 --allow-root

docs/advanced-hyperopt.md

@@ -0,0 +1,91 @@
+# Advanced Hyperopt
+
+This page explains some advanced Hyperopt topics that may require higher
+coding skills and Python knowledge than creation of an ordinal hyperoptimization
+class.
+
+## Derived hyperopt classes
+
+Custom hyperop classes can be derived in the same way [it can be done for strategies](strategy-customization.md#derived-strategies).
+
+Applying to hyperoptimization, as an example, you may override how dimensions are defined in your optimization hyperspace:
+
+```python
+class MyAwesomeHyperOpt(IHyperOpt):
+    ...
+    # Uses default stoploss dimension
+
+class MyAwesomeHyperOpt2(MyAwesomeHyperOpt):
+    @staticmethod
+    def stoploss_space() -> List[Dimension]:
+        # Override boundaries for stoploss
+        return [
+            Real(-0.33, -0.01, name='stoploss'),
+        ]
+```
+
+and then quickly switch between hyperopt classes, running optimization process with hyperopt class you need in each particular case:
+
+```
+$ freqtrade hyperopt --hyperopt MyAwesomeHyperOpt --hyperopt-loss SharpeHyperOptLossDaily --strategy MyAwesomeStrategy ...
+or
+$ freqtrade hyperopt --hyperopt MyAwesomeHyperOpt2 --hyperopt-loss SharpeHyperOptLossDaily --strategy MyAwesomeStrategy ...
+```
+
+## Creating and using a custom loss function
+
+To use a custom loss function class, make sure that the function `hyperopt_loss_function` is defined in your custom hyperopt loss class.
+For the sample below, you then need to add the command line parameter `--hyperopt-loss SuperDuperHyperOptLoss` to your hyperopt call so this function is being used.
+
+A sample of this can be found below, which is identical to the Default Hyperopt loss implementation. A full sample can be found in [userdata/hyperopts](https://github.com/freqtrade/freqtrade/blob/develop/freqtrade/templates/sample_hyperopt_loss.py).
+
+``` python
+from freqtrade.optimize.hyperopt import IHyperOptLoss
+
+TARGET_TRADES = 600
+EXPECTED_MAX_PROFIT = 3.0
+MAX_ACCEPTED_TRADE_DURATION = 300
+
+class SuperDuperHyperOptLoss(IHyperOptLoss):
+    """
+    Defines the default loss function for hyperopt
+    """
+
+    @staticmethod
+    def hyperopt_loss_function(results: DataFrame, trade_count: int,
+                               min_date: datetime, max_date: datetime,
+                               *args, **kwargs) -> float:
+        """
+        Objective function, returns smaller number for better results
+        This is the legacy algorithm (used until now in freqtrade).
+        Weights are distributed as follows:
+        * 0.4 to trade duration
+        * 0.25: Avoiding trade loss
+        * 1.0 to total profit, compared to the expected value (`EXPECTED_MAX_PROFIT`) defined above
+        """
+        total_profit = results['profit_percent'].sum()
+        trade_duration = results['trade_duration'].mean()
+
+        trade_loss = 1 - 0.25 * exp(-(trade_count - TARGET_TRADES) ** 2 / 10 ** 5.8)
+        profit_loss = max(0, 1 - total_profit / EXPECTED_MAX_PROFIT)
+        duration_loss = 0.4 * min(trade_duration / MAX_ACCEPTED_TRADE_DURATION, 1)
+        result = trade_loss + profit_loss + duration_loss
+        return result
+```
+
+Currently, the arguments are:
+
+* `results`: DataFrame containing the result  
+    The following columns are available in results (corresponds to the output-file of backtesting when used with `--export trades`):  
+    `pair, profit_percent, profit_abs, open_time, close_time, open_index, close_index, trade_duration, open_at_end, open_rate, close_rate, sell_reason`
+* `trade_count`: Amount of trades (identical to `len(results)`)
+* `min_date`: Start date of the hyperopting TimeFrame
+* `min_date`: End date of the hyperopting TimeFrame
+
+This function needs to return a floating point number (`float`). Smaller numbers will be interpreted as better results. The parameters and balancing for this is up to you.
+
+!!! Note
+    This function is called once per iteration - so please make sure to have this as optimized as possible to not slow hyperopt down unnecessarily.
+
+!!! Note
+    Please keep the arguments `*args` and `**kwargs` in the interface to allow us to extend this interface later.

docs/advanced-setup.md

@@ -0,0 +1,140 @@
+# Advanced Post-installation Tasks
+
+This page explains some advanced tasks and configuration options that can be performed after the bot installation and may be uselful in some environments.
+
+If you do not know what things mentioned here mean, you probably do not need it.
+
+## Running multiple instances of Freqtrade
+
+This section will show you how to run multiple bots at the same time, on the same machine.
+
+### Things to consider
+
+* Use different database files.
+* Use different Telegram bots (requires multiple different configuration files; applies only when Telegram is enabled).
+* Use different ports (applies only when Freqtrade REST API webserver is enabled).
+
+### Different database files
+
+In order to keep track of your trades, profits, etc., freqtrade is using a SQLite database where it stores various types of information such as the trades you performed in the past and the current position(s) you are holding at any time. This allows you to keep track of your profits, but most importantly, keep track of ongoing activity if the bot process would be restarted or would be terminated unexpectedly.
+
+Freqtrade will, by default, use separate database files for dry-run and live bots (this assumes no database-url is given in either configuration nor via command line argument).
+For live trading mode, the default database will be `tradesv3.sqlite` and for dry-run it will be `tradesv3.dryrun.sqlite`.
+
+The optional argument to the trade command used to specify the path of these files is `--db-url`, which requires a valid SQLAlchemy url.
+So when you are starting a bot with only the config and strategy arguments in dry-run mode, the following 2 commands would have the same outcome.
+
+``` bash
+freqtrade trade -c MyConfig.json -s MyStrategy
+# is equivalent to
+freqtrade trade -c MyConfig.json -s MyStrategy --db-url sqlite:///tradesv3.dryrun.sqlite
+```
+
+It means that if you are running the trade command in two different terminals, for example to test your strategy both for trades in USDT and in another instance for trades in BTC, you will have to run them with different databases.
+
+If you specify the URL of a database which does not exist, freqtrade will create one with the name you specified. So to test your custom strategy with BTC and USDT stake currencies, you could use the following commands (in 2 separate terminals):
+
+``` bash
+# Terminal 1:
+freqtrade trade -c MyConfigBTC.json -s MyCustomStrategy --db-url sqlite:///user_data/tradesBTC.dryrun.sqlite
+# Terminal 2:
+freqtrade trade -c MyConfigUSDT.json -s MyCustomStrategy --db-url sqlite:///user_data/tradesUSDT.dryrun.sqlite
+```
+
+Conversely, if you wish to do the same thing in production mode, you will also have to create at least one new database (in addition to the default one) and specify the path to the "live" databases, for example:
+
+``` bash
+# Terminal 1:
+freqtrade trade -c MyConfigBTC.json -s MyCustomStrategy --db-url sqlite:///user_data/tradesBTC.live.sqlite
+# Terminal 2:
+freqtrade trade -c MyConfigUSDT.json -s MyCustomStrategy --db-url sqlite:///user_data/tradesUSDT.live.sqlite
+```
+
+For more information regarding usage of the sqlite databases, for example to manually enter or remove trades, please refer to the [SQL Cheatsheet](sql_cheatsheet.md).
+
+## Configure the bot running as a systemd service
+
+Copy the `freqtrade.service` file to your systemd user directory (usually `~/.config/systemd/user`) and update `WorkingDirectory` and `ExecStart` to match your setup.
+
+!!! Note
+    Certain systems (like Raspbian) don't load service unit files from the user directory. In this case, copy `freqtrade.service` into `/etc/systemd/user/` (requires superuser permissions).
+
+After that you can start the daemon with:
+
+```bash
+systemctl --user start freqtrade
+```
+
+For this to be persistent (run when user is logged out) you'll need to enable `linger` for your freqtrade user.
+
+```bash
+sudo loginctl enable-linger "$USER"
+```
+
+If you run the bot as a service, you can use systemd service manager as a software watchdog monitoring freqtrade bot 
+state and restarting it in the case of failures. If the `internals.sd_notify` parameter is set to true in the 
+configuration or the `--sd-notify` command line option is used, the bot will send keep-alive ping messages to systemd 
+using the sd_notify (systemd notifications) protocol and will also tell systemd its current state (Running or Stopped) 
+when it changes. 
+
+The `freqtrade.service.watchdog` file contains an example of the service unit configuration file which uses systemd 
+as the watchdog.
+
+!!! Note
+    The sd_notify communication between the bot and the systemd service manager will not work if the bot runs in a Docker container.
+
+## Advanced Logging
+
+On many Linux systems the bot can be configured to send its log messages to `syslog` or `journald` system services. Logging to a remote `syslog` server is also available on Windows. The special values for the `--logfile` command line option can be used for this.
+
+### Logging to syslog
+
+To send Freqtrade log messages to a local or remote `syslog` service use the `--logfile` command line option with the value in the following format:
+
+* `--logfile syslog:<syslog_address>` -- send log messages to `syslog` service using the `<syslog_address>` as the syslog address.
+
+The syslog address can be either a Unix domain socket (socket filename) or a UDP socket specification, consisting of IP address and UDP port, separated by the `:` character.
+
+So, the following are the examples of possible usages:
+
+* `--logfile syslog:/dev/log` -- log to syslog (rsyslog) using the `/dev/log` socket, suitable for most systems.
+* `--logfile syslog` -- same as above, the shortcut for `/dev/log`.
+* `--logfile syslog:/var/run/syslog` -- log to syslog (rsyslog) using the `/var/run/syslog` socket. Use this on MacOS.
+* `--logfile syslog:localhost:514` -- log to local syslog using UDP socket, if it listens on port 514.
+* `--logfile syslog:<ip>:514` -- log to remote syslog at IP address and port 514. This may be used on Windows for remote logging to an external syslog server.
+
+Log messages are send to `syslog` with the `user` facility. So you can see them with the following commands:
+
+* `tail -f /var/log/user`, or 
+* install a comprehensive graphical viewer (for instance, 'Log File Viewer' for Ubuntu).
+
+On many systems `syslog` (`rsyslog`) fetches data from `journald` (and vice versa), so both `--logfile syslog` or `--logfile journald` can be used and the messages be viewed with both `journalctl` and a syslog viewer utility. You can combine this in any way which suites you better.
+
+For `rsyslog` the messages from the bot can be redirected into a separate dedicated log file. To achieve this, add
+```
+if $programname startswith "freqtrade" then -/var/log/freqtrade.log
+```
+to one of the rsyslog configuration files, for example at the end of the `/etc/rsyslog.d/50-default.conf`.
+
+For `syslog` (`rsyslog`), the reduction mode can be switched on. This will reduce the number of repeating messages. For instance, multiple bot Heartbeat messages will be reduced to a single message when nothing else happens with the bot. To achieve this, set in `/etc/rsyslog.conf`:
+```
+# Filter duplicated messages
+$RepeatedMsgReduction on
+```
+
+### Logging to journald
+
+This needs the `systemd` python package installed as the dependency, which is not available on Windows. Hence, the whole journald logging functionality is not available for a bot running on Windows.
+
+To send Freqtrade log messages to `journald` system service use the `--logfile` command line option with the value in the following format:
+
+* `--logfile journald` -- send log messages to `journald`.
+
+Log messages are send to `journald` with the `user` facility. So you can see them with the following commands:
+
+* `journalctl -f` -- shows Freqtrade log messages sent to `journald` along with other log messages fetched by `journald`.
+* `journalctl -f -u freqtrade.service` -- this command can be used when the bot is run as a `systemd` service.
+
+There are many other options in the `journalctl` utility to filter the messages, see manual pages for this utility.
+
+On many systems `syslog` (`rsyslog`) fetches data from `journald` (and vice versa), so both `--logfile syslog` or `--logfile journald` can be used and the messages be viewed with both `journalctl` and a syslog viewer utility. You can combine this in any way which suites you better.

docs/backtesting.md

@@ -1,68 +1,72 @@
 # Backtesting
 
-This page explains how to validate your strategy performance by using
+This page explains how to validate your strategy performance by using Backtesting.
-Backtesting.
+
+Backtesting requires historic data to be available.
+To learn how to get data for the pairs and exchange you're interested in, head over to the [Data Downloading](data-download.md) section of the documentation.
 
 ## Test your strategy with Backtesting
 
-Now you have good Buy and Sell strategies, you want to test it against
+Now you have good Buy and Sell strategies and some historic data, you want to test it against
 real data. This is what we call
 [backtesting](https://en.wikipedia.org/wiki/Backtesting).
 
-Backtesting will use the crypto-currencies (pair) from your config file
+Backtesting will use the crypto-currencies (pairs) from your config file and load historical candle (OHCLV) data from `user_data/data/<exchange>` by default.
-and load static tickers located in
+If no data is available for the exchange / pair / timeframe combination, backtesting will ask you to download them first using `freqtrade download-data`.
-[/freqtrade/tests/testdata](https://github.com/freqtrade/freqtrade/tree/develop/freqtrade/tests/testdata).
+For details on downloading, please refer to the [Data Downloading](data-download.md) section in the documentation.
-If the 5 min and 1 min ticker for the crypto-currencies to test is not
-already in the `testdata` directory, backtesting will download them
-automatically. Testdata files will not be updated until you specify it.
 
-The result of backtesting will confirm you if your bot has better odds of making a profit than a loss.
+The result of backtesting will confirm if your bot has better odds of making a profit than a loss.
 
-The backtesting is very easy with freqtrade.
+!!! Warning "Using dynamic pairlists for backtesting"
+    Using dynamic pairlists is possible, however it relies on the current market conditions - which will not reflect the historic status of the pairlist.
+    Also, when using pairlists other than StaticPairlist, reproducability of backtesting-results cannot be guaranteed.
+    Please read the [pairlists documentation](configuration.md#pairlists) for more information.
+
+    To achieve reproducible results, best generate a pairlist via the [`test-pairlist`](utils.md#test-pairlist) command and use that as static pairlist.
 
 ### Run a backtesting against the currencies listed in your config file
-#### With 5 min tickers (Per default)
+
+#### With 5 min candle (OHLCV) data (per default)
 
 ```bash
 freqtrade backtesting
 ```
 
-#### With 1 min tickers
+#### With 1 min candle (OHLCV) data
 
 ```bash
-freqtrade backtesting --ticker-interval 1m
+freqtrade backtesting --timeframe 1m
 ```
 
-#### Update cached pairs with the latest data
+#### Using a different on-disk historical candle (OHLCV) data source
+
+Assume you downloaded the history data from the Bittrex exchange and kept it in the `user_data/data/bittrex-20180101` directory. 
+You can then use this data for backtesting as follows:
 
 ```bash
-freqtrade backtesting --refresh-pairs-cached
+freqtrade --datadir user_data/data/bittrex-20180101 backtesting
-```
-
-#### With live data (do not alter your testdata files)
-
-```bash
-freqtrade backtesting --live
-```
-
-#### Using a different on-disk ticker-data source
-
-```bash
-freqtrade backtesting --datadir freqtrade/tests/testdata-20180101
 ```
 
 #### With a (custom) strategy file
 
 ```bash
-freqtrade -s TestStrategy backtesting
+freqtrade backtesting -s SampleStrategy
 ```
 
-Where `-s TestStrategy` refers to the class name within the strategy file `test_strategy.py` found in the `freqtrade/user_data/strategies` directory
+Where `-s SampleStrategy` refers to the class name within the strategy file `sample_strategy.py` found in the `freqtrade/user_data/strategies` directory.
+
+#### Comparing multiple Strategies
+
+```bash
+freqtrade backtesting --strategy-list SampleStrategy1 AwesomeStrategy --timeframe 5m
+```
+
+Where `SampleStrategy1` and `AwesomeStrategy` refer to class names of strategies.
 
 #### Exporting trades to file
 
 ```bash
-freqtrade backtesting --export trades
+freqtrade backtesting --export trades --config config.json --strategy SampleStrategy
 ```
 
 The exported trades can be used for [further analysis](#further-backtest-result-analysis), or can be used by the plotting script `plot_dataframe.py` in the scripts directory.
@@ -70,68 +74,47 @@ The exported trades can be used for [further analysis](#further-backtest-result-
 #### Exporting trades to file specifying a custom filename
 
 ```bash
-freqtrade backtesting --export trades --export-filename=backtest_teststrategy.json
+freqtrade backtesting --export trades --export-filename=backtest_samplestrategy.json
 ```
 
-#### Running backtest with smaller testset
+Please also read about the [strategy startup period](strategy-customization.md#strategy-startup-period).
 
-Use the `--timerange` argument to change how much of the testset
+#### Supplying custom fee value
-you want to use. The last N ticks/timeframes will be used.
 
-Example:
+Sometimes your account has certain fee rebates (fee reductions starting with a certain account size or monthly volume), which are not visible to ccxt.
+To account for this in backtesting, you can use the `--fee` command line option to supply this value to backtesting.
+This fee must be a ratio, and will be applied twice (once for trade entry, and once for trade exit).
+
+For example, if the buying and selling commission fee is 0.1% (i.e., 0.001 written as ratio), then you would run backtesting as the following:
 
 ```bash
-freqtrade backtesting --timerange=-200
+freqtrade backtesting --fee 0.001
 ```
 
-#### Advanced use of timerange
+!!! Note
+    Only supply this option (or the corresponding configuration parameter) if you want to experiment with different fee values. By default, Backtesting fetches the default fee from the exchange pair/market info.
 
-Doing `--timerange=-200` will get the last 200 timeframes
+#### Running backtest with smaller testset by using timerange
-from your inputdata. You can also specify specific dates,
+
-or a range span indexed by start and stop.
+Use the `--timerange` argument to change how much of the testset you want to use.
+
+
+For example, running backtesting with the `--timerange=20190501-` option will use all available data starting with May 1st, 2019 from your inputdata.
+
+```bash
+freqtrade backtesting --timerange=20190501-
+```
+
+You can also specify particular dates or a range span indexed by start and stop.
 
 The full timerange specification:
 
-- Use last 123 tickframes of data: `--timerange=-123`
-- Use first 123 tickframes of data: `--timerange=123-`
-- Use tickframes from line 123 through 456: `--timerange=123-456`
 - Use tickframes till 2018/01/31: `--timerange=-20180131`
 - Use tickframes since 2018/01/31: `--timerange=20180131-`
 - Use tickframes since 2018/01/31 till 2018/03/01 : `--timerange=20180131-20180301`
 - Use tickframes between POSIX timestamps 1527595200 1527618600:
                                                 `--timerange=1527595200-1527618600`
 
-#### Downloading new set of ticker data
-
-To download new set of backtesting ticker data, you can use a download script.
-
-If you are using Binance for example:
-
-- create a directory `user_data/data/binance` and copy `pairs.json` in that directory.
-- update the `pairs.json` to contain the currency pairs you are interested in.
-
-```bash
-mkdir -p user_data/data/binance
-cp freqtrade/tests/testdata/pairs.json user_data/data/binance
-```
-
-Then run:
-
-```bash
-python scripts/download_backtest_data.py --exchange binance
-```
-
-This will download ticker data for all the currency pairs you defined in `pairs.json`.
-
-- To use a different directory than the exchange specific default, use `--datadir user_data/data/some_directory`.
-- To change the exchange used to download the tickers, use `--exchange`. Default is `bittrex`.
-- To use `pairs.json` from some other directory, use `--pairs-file some_other_dir/pairs.json`.
-- To download ticker data for only 10 days, use `--days 10`.
-- Use `--timeframes` to specify which tickers to download. Default is `--timeframes 1m 5m` which will download 1-minute and 5-minute tickers.
-- To use exchange, timeframe and list of pairs as defined in your configuration file, use the `-c/--config` option. With this, the script uses the whitelist defined in the config as the list of currency pairs to download data for and does not require the pairs.json file. You can combine `-c/--config` with other options.
-
-For help about backtesting usage, please refer to [Backtesting commands](#backtesting-commands).
-
 ## Understand the backtesting result
 
 The most important in the backtesting is to understand the result.
@@ -140,48 +123,65 @@ A backtesting result will look like that:
 
 ```
 ========================================================= BACKTESTING REPORT ========================================================
-| pair     |   buy count |   avg profit % |   cum profit % |   tot profit BTC |   tot profit % | avg duration   |   profit |   loss |
+| Pair     |   Buys |   Avg Profit % |   Cum Profit % |   Tot Profit BTC |   Tot Profit % | Avg Duration   |  Wins |  Draws |  Losses |
-|:---------|------------:|---------------:|---------------:|-----------------:|---------------:|:---------------|---------:|-------:|
+|:---------|-------:|---------------:|---------------:|-----------------:|---------------:|:---------------|------:|-------:|--------:|
-| ADA/BTC  |          35 |          -0.11 |          -3.88 |      -0.00019428 |          -1.94 | 4:35:00        |       14 |     21 |
+| ADA/BTC  |     35 |          -0.11 |          -3.88 |      -0.00019428 |          -1.94 | 4:35:00        |    14 |      0 |      21 |
-| ARK/BTC  |          11 |          -0.41 |          -4.52 |      -0.00022647 |          -2.26 | 2:03:00        |        3 |      8 |
+| ARK/BTC  |     11 |          -0.41 |          -4.52 |      -0.00022647 |          -2.26 | 2:03:00        |     3 |      0 |       8 |
-| BTS/BTC  |          32 |           0.31 |           9.78 |       0.00048938 |           4.89 | 5:05:00        |       18 |     14 |
+| BTS/BTC  |     32 |           0.31 |           9.78 |       0.00048938 |           4.89 | 5:05:00        |    18 |      0 |      14 |
-| DASH/BTC |          13 |          -0.08 |          -1.07 |      -0.00005343 |          -0.53 | 4:39:00        |        6 |      7 |
+| DASH/BTC |     13 |          -0.08 |          -1.07 |      -0.00005343 |          -0.53 | 4:39:00        |     6 |      0 |       7 |
-| ENG/BTC  |          18 |           1.36 |          24.54 |       0.00122807 |          12.27 | 2:50:00        |        8 |     10 |
+| ENG/BTC  |     18 |           1.36 |          24.54 |       0.00122807 |          12.27 | 2:50:00        |     8 |      0 |      10 |
-| EOS/BTC  |          36 |           0.08 |           3.06 |       0.00015304 |           1.53 | 3:34:00        |       16 |     20 |
+| EOS/BTC  |     36 |           0.08 |           3.06 |       0.00015304 |           1.53 | 3:34:00        |    16 |      0 |      20 |
-| ETC/BTC  |          26 |           0.37 |           9.51 |       0.00047576 |           4.75 | 6:14:00        |       11 |     15 |
+| ETC/BTC  |     26 |           0.37 |           9.51 |       0.00047576 |           4.75 | 6:14:00        |    11 |      0 |      15 |
-| ETH/BTC  |          33 |           0.30 |           9.96 |       0.00049856 |           4.98 | 7:31:00        |       16 |     17 |
+| ETH/BTC  |     33 |           0.30 |           9.96 |       0.00049856 |           4.98 | 7:31:00        |    16 |      0 |      17 |
-| IOTA/BTC |          32 |           0.03 |           1.09 |       0.00005444 |           0.54 | 3:12:00        |       14 |     18 |
+| IOTA/BTC |     32 |           0.03 |           1.09 |       0.00005444 |           0.54 | 3:12:00        |    14 |      0 |      18 |
-| LSK/BTC  |          15 |           1.75 |          26.26 |       0.00131413 |          13.13 | 2:58:00        |        6 |      9 |
+| LSK/BTC  |     15 |           1.75 |          26.26 |       0.00131413 |          13.13 | 2:58:00        |     6 |      0 |       9 |
-| LTC/BTC  |          32 |          -0.04 |          -1.38 |      -0.00006886 |          -0.69 | 4:49:00        |       11 |     21 |
+| LTC/BTC  |     32 |          -0.04 |          -1.38 |      -0.00006886 |          -0.69 | 4:49:00        |    11 |      0 |      21 |
-| NANO/BTC |          17 |           1.26 |          21.39 |       0.00107058 |          10.70 | 1:55:00        |       10 |      7 |
+| NANO/BTC |     17 |           1.26 |          21.39 |       0.00107058 |          10.70 | 1:55:00        |    10 |      0 |       7 |
-| NEO/BTC  |          23 |           0.82 |          18.97 |       0.00094936 |           9.48 | 2:59:00        |       10 |     13 |
+| NEO/BTC  |     23 |           0.82 |          18.97 |       0.00094936 |           9.48 | 2:59:00        |    10 |      0 |      13 |
-| REQ/BTC  |           9 |           1.17 |          10.54 |       0.00052734 |           5.27 | 3:47:00        |        4 |      5 |
+| REQ/BTC  |      9 |           1.17 |          10.54 |       0.00052734 |           5.27 | 3:47:00        |     4 |      0 |       5 |
-| XLM/BTC  |          16 |           1.22 |          19.54 |       0.00097800 |           9.77 | 3:15:00        |        7 |      9 |
+| XLM/BTC  |     16 |           1.22 |          19.54 |       0.00097800 |           9.77 | 3:15:00        |     7 |      0 |       9 |
-| XMR/BTC  |          23 |          -0.18 |          -4.13 |      -0.00020696 |          -2.07 | 5:30:00        |       12 |     11 |
+| XMR/BTC  |     23 |          -0.18 |          -4.13 |      -0.00020696 |          -2.07 | 5:30:00        |    12 |      0 |      11 |
-| XRP/BTC  |          35 |           0.66 |          22.96 |       0.00114897 |          11.48 | 3:49:00        |       12 |     23 |
+| XRP/BTC  |     35 |           0.66 |          22.96 |       0.00114897 |          11.48 | 3:49:00        |    12 |      0 |      23 |
-| ZEC/BTC  |          22 |          -0.46 |         -10.18 |      -0.00050971 |          -5.09 | 2:22:00        |        7 |     15 |
+| ZEC/BTC  |     22 |          -0.46 |         -10.18 |      -0.00050971 |          -5.09 | 2:22:00        |     7 |      0 |      15 |
-| TOTAL    |         429 |           0.36 |         152.41 |       0.00762792 |          76.20 | 4:12:00        |      186 |    243 |
+| TOTAL    |    429 |           0.36 |         152.41 |       0.00762792 |          76.20 | 4:12:00        |   186 |      0 |     243 |
 ========================================================= SELL REASON STATS =========================================================
-| Sell Reason        |   Count |
+| Sell Reason        |   Sells |  Wins |  Draws |  Losses |
-|:-------------------|--------:|
+|:-------------------|--------:|------:|-------:|--------:|
-| trailing_stop_loss |     205 |
+| trailing_stop_loss |     205 |   150 |      0 |      55 |
-| stop_loss          |     166 |
+| stop_loss          |     166 |     0 |      0 |     166 |
-| sell_signal        |      56 |
+| sell_signal        |      56 |    36 |      0 |      20 |
-| force_sell         |       2 |
+| force_sell         |       2 |     0 |      0 |       2 |
 ====================================================== LEFT OPEN TRADES REPORT ======================================================
-| pair     |   buy count |   avg profit % |   cum profit % |   tot profit BTC |   tot profit % | avg duration   |   profit |   loss |
+| Pair     |   Buys |   Avg Profit % |   Cum Profit % |   Tot Profit BTC |   Tot Profit % | Avg Duration   |  Wins |  Draws |  Losses |
-|:---------|------------:|---------------:|---------------:|-----------------:|---------------:|:---------------|---------:|-------:|
+|:---------|-------:|---------------:|---------------:|-----------------:|---------------:|:---------------|------:|-------:|--------:|
-| ADA/BTC  |           1 |           0.89 |           0.89 |       0.00004434 |           0.44 | 6:00:00        |        1 |      0 |
+| ADA/BTC  |      1 |           0.89 |           0.89 |       0.00004434 |           0.44 | 6:00:00        |     1 |      0 |       0 |
-| LTC/BTC  |           1 |           0.68 |           0.68 |       0.00003421 |           0.34 | 2:00:00        |        1 |      0 |
+| LTC/BTC  |      1 |           0.68 |           0.68 |       0.00003421 |           0.34 | 2:00:00        |     1 |      0 |       0 |
-| TOTAL    |           2 |           0.78 |           1.57 |       0.00007855 |           0.78 | 4:00:00        |        2 |      0 |
+| TOTAL    |      2 |           0.78 |           1.57 |       0.00007855 |           0.78 | 4:00:00        |     2 |      0 |       0 |
+=============== SUMMARY METRICS ===============
+| Metric                | Value               |
+|-----------------------+---------------------|
+| Backtesting from      | 2019-01-01 00:00:00 |
+| Backtesting to        | 2019-05-01 00:00:00 |
+| Total trades          | 429                 |
+| First trade           | 2019-01-01 18:30:00 |
+| First trade Pair      | EOS/USDT            |
+| Total Profit %        | 152.41%             |
+| Trades per day        | 3.575               |
+| Best day              | 25.27%              |
+| Worst day             | -30.67%             |
+| Avg. Duration Winners | 4:23:00             |
+| Avg. Duration Loser   | 6:55:00             |
+|                       |                     |
+| Max Drawdown          | 50.63%              |
+| Drawdown Start        | 2019-02-15 14:10:00 |
+| Drawdown End          | 2019-04-11 18:15:00 |
+| Market change         | -5.88%              |
+===============================================
 ```
 
-The 1st table will contain all trades the bot made.
+### Backtesting report table
 
-The 2nd table will contain a recap of sell reasons.
+The 1st table contains all trades the bot made, including "left open trades".
-
-The 3rd table will contain all trades the bot had to `forcesell` at the end of the backtest period to present a full picture.
-These trades are also included in the first table, but are extracted separately for clarity.
 
 The last line will give you the overall performance of your strategy,
 here:
@@ -190,22 +190,16 @@ here:
 | TOTAL    |         429 |           0.36 |         152.41 |       0.00762792 |          76.20 | 4:12:00        |      186 |    243 |
 ```
 
-We understand the bot has made `429` trades for an average duration of
+The bot has made `429` trades for an average duration of `4:12:00`, with a performance of `76.20%` (profit), that means it has
-`4:12:00`, with a performance of `76.20%` (profit), that means it has
 earned a total of `0.00762792 BTC` starting with a capital of 0.01 BTC.
 
-The column `avg profit %` shows the average profit for all trades made while the column `cum profit %` sums all the profits/losses. 
+The column `avg profit %` shows the average profit for all trades made while the column `cum profit %` sums up all the profits/losses.
-The column `tot profit %` shows instead the total profit % in relation to allocated capital 
+The column `tot profit %` shows instead the total profit % in relation to allocated capital (`max_open_trades * stake_amount`).
-(`max_open_trades * stake_amount`). In the above results we have `max_open_trades=2 stake_amount=0.005` in config 
+In the above results we have `max_open_trades=2` and `stake_amount=0.005` in config  so `tot_profit %` will be `(76.20/100) * (0.005 * 2) =~ 0.00762792 BTC`.
-so `(76.20/100) * (0.005 * 2) =~ 0.00762792 BTC`.
 
-As you will see your strategy performance will be influenced by your buy
+Your strategy performance is influenced by your buy strategy, your sell strategy, and also by the `minimal_roi` and `stop_loss` you have set.
-strategy, your sell strategy, and also by the `minimal_roi` and
-`stop_loss` you have set.
 
-As for an example if your minimal_roi is only `"0":  0.01`. You cannot
+For example, if your `minimal_roi` is only `"0":  0.01` you cannot expect the bot to make more profit than 1% (because it will sell every time a trade reaches 1%).
-expect the bot to make more profit than 1% (because it will sell every
-time a trade will reach 1%).
 
 ```json
 "minimal_roi": {
@@ -214,39 +208,112 @@ time a trade will reach 1%).
 ```
 
 On the other hand, if you set a too high `minimal_roi` like `"0":  0.55`
-(55%), there is a lot of chance that the bot will never reach this
+(55%), there is almost no chance that the bot will ever reach this profit.
-profit. Hence, keep in mind that your performance is a mix of your
+Hence, keep in mind that your performance is an integral mix of all different elements of the strategy, your configuration, and the crypto-currency pairs you have set up.
-strategies, your configuration, and the crypto-currency you have set up.
+
+### Sell reasons table
+
+The 2nd table contains a recap of sell reasons.
+This table can tell you which area needs some additional work (e.g. all or many of the `sell_signal` trades are losses, so you should work on improving the sell signal, or consider disabling it).
+
+### Left open trades table
+
+The 3rd table contains all trades the bot had to `forcesell` at the end of the backtesting period to present you the full picture.
+This is necessary to simulate realistic behavior, since the backtest period has to end at some point, while realistically, you could leave the bot running forever.
+These trades are also included in the first table, but are also shown separately in this table for clarity.
+
+### Summary metrics
+
+The last element of the backtest report is the summary metrics table.
+It contains some useful key metrics about performance of your strategy on backtesting data.
+
+```
+=============== SUMMARY METRICS ===============
+| Metric                | Value               |
+|-----------------------+---------------------|
+| Backtesting from      | 2019-01-01 00:00:00 |
+| Backtesting to        | 2019-05-01 00:00:00 |
+| Total trades          | 429                 |
+| First trade           | 2019-01-01 18:30:00 |
+| First trade Pair      | EOS/USDT            |
+| Total Profit %        | 152.41%             |
+| Trades per day        | 3.575               |
+| Best day              | 25.27%              |
+| Worst day             | -30.67%             |
+| Avg. Duration Winners | 4:23:00             |
+| Avg. Duration Loser   | 6:55:00             |
+|                       |                     |
+| Max Drawdown          | 50.63%              |
+| Drawdown Start        | 2019-02-15 14:10:00 |
+| Drawdown End          | 2019-04-11 18:15:00 |
+| Market change         | -5.88%              |
+===============================================
+
+```
+
+- `Total trades`: Identical to the total trades of the backtest output table.
+- `First trade`: First trade entered.
+- `First trade pair`: Which pair was part of the first trade.
+- `Backtesting from` / `Backtesting to`: Backtesting range (usually defined with the `--timerange` option).
+- `Total Profit %`: Total profit per stake amount. Aligned to the TOTAL column of the first table.
+- `Trades per day`: Total trades divided by the backtesting duration in days (this will give you information about how many trades to expect from the strategy).
+- `Best day` / `Worst day`: Best and worst day based on daily profit.
+- `Avg. Duration Winners` / `Avg. Duration Loser`: Average durations for winning and losing trades.
+- `Max Drawdown`: Maximum drawdown experienced. For example, the value of 50% means that from highest to subsequent lowest point, a 50% drop was experienced).
+- `Drawdown Start` / `Drawdown End`: Start and end datetimes for this largest drawdown (can also be visualized via the `plot-dataframe` sub-command).
+- `Market change`: Change of the market during the backtest period. Calculated as average of all pairs changes from the first to the last candle using the "close" column.
+
+### Assumptions made by backtesting
+
+Since backtesting lacks some detailed information about what happens within a candle, it needs to take a few assumptions:
+
+- Buys happen at open-price
+- Sell signal sells happen at open-price of the following candle
+- Low happens before high for stoploss, protecting capital first
+- ROI
+  - sells are compared to high - but the ROI value is used (e.g. ROI = 2%, high=5% - so the sell will be at 2%)
+  - sells are never "below the candle", so a ROI of 2% may result in a sell at 2.4% if low was at 2.4% profit
+  - Forcesells caused by `<N>=-1` ROI entries use low as sell value, unless N falls on the candle open (e.g. `120: -1` for 1h candles)
+- Stoploss sells happen exactly at stoploss price, even if low was lower
+- Trailing stoploss
+  - High happens first - adjusting stoploss
+  - Low uses the adjusted stoploss (so sells with large high-low difference are backtested correctly)
+- Sell-reason does not explain if a trade was positive or negative, just what triggered the sell (this can look odd if negative ROI values are used)
+- Stoploss (and trailing stoploss) is evaluated before ROI within one candle. So you can often see more trades with the `stoploss` and/or `trailing_stop` sell reason comparing to the results obtained with the same strategy in the Dry Run/Live Trade modes.
+
+Taking these assumptions, backtesting tries to mirror real trading as closely as possible. However, backtesting will **never** replace running a strategy in dry-run mode.
+Also, keep in mind that past results don't guarantee future success.
+
+In addition to the above assumptions, strategy authors should carefully read the [Common Mistakes](strategy-customization.md#common-mistakes-when-developing-strategies) section, to avoid using data in backtesting which is not available in real market conditions.
 
 ### Further backtest-result analysis
 
 To further analyze your backtest results, you can [export the trades](#exporting-trades-to-file).
 You can then load the trades to perform further analysis as shown in our [data analysis](data-analysis.md#backtesting) backtesting section.
 
-
 ## Backtesting multiple strategies
 
-To backtest multiple strategies, a list of Strategies can be provided.
+To compare multiple strategies, a list of Strategies can be provided to backtesting.
 
-This is limited to 1 ticker-interval per run, however, data is only loaded once from disk so if you have multiple
+This is limited to 1 timeframe value per run. However, data is only loaded once from disk so if you have multiple
-strategies you'd like to compare, this should give a nice runtime boost.
+strategies you'd like to compare, this will give a nice runtime boost.
 
 All listed Strategies need to be in the same directory.
 
 ``` bash
-freqtrade backtesting --timerange 20180401-20180410 --ticker-interval 5m --strategy-list Strategy001 Strategy002 --export trades
+freqtrade backtesting --timerange 20180401-20180410 --timeframe 5m --strategy-list Strategy001 Strategy002 --export trades
 ```
 
-This will save the results to `user_data/backtest_data/backtest-result-<strategy>.json`, injecting the strategy-name into the target filename.
+This will save the results to `user_data/backtest_results/backtest-result-<strategy>.json`, injecting the strategy-name into the target filename.
 There will be an additional table comparing win/losses of the different strategies (identical to the "Total" row in the first table).
-Detailed output for all strategies one after the other will be available, so make sure to scroll up.
+Detailed output for all strategies one after the other will be available, so make sure to scroll up to see the details per strategy.
 
 ```
-=========================================================== Strategy Summary ===========================================================
+=========================================================== STRATEGY SUMMARY ===========================================================
-| Strategy    |   buy count |   avg profit % |   cum profit % |   tot profit BTC |   tot profit % | avg duration   |   profit |   loss |
+| Strategy    |   Buys |   Avg Profit % |   Cum Profit % |   Tot Profit BTC |   Tot Profit % | Avg Duration   |  Wins |  Draws | Losses |
-|:------------|------------:|---------------:|---------------:|-----------------:|---------------:|:---------------|---------:|-------:|
+|:------------|-------:|---------------:|---------------:|-----------------:|---------------:|:---------------|------:|-------:|-------:|
-| Strategy1   |         429 |           0.36 |         152.41 |       0.00762792 |          76.20 | 4:12:00        |      186 |    243 |
+| Strategy1   |    429 |           0.36 |         152.41 |       0.00762792 |          76.20 | 4:12:00        |   186 |      0 |    243 |
-| Strategy2   |        1487 |          -0.13 |        -197.58 |      -0.00988917 |         -98.79 | 4:43:00        |      662 |    825 |
+| Strategy2   |   1487 |          -0.13 |        -197.58 |      -0.00988917 |         -98.79 | 4:43:00        |   662 |      0 |    825 |
 ```
 
 ## Next step

docs/bot-basics.md

@@ -0,0 +1,58 @@
+# Freqtrade basics
+
+This page provides you some basic concepts on how Freqtrade works and operates.
+
+## Freqtrade terminology
+
+* Trade: Open position.
+* Open Order: Order which is currently placed on the exchange, and is not yet complete.
+* Pair: Tradable pair, usually in the format of Quote/Base (e.g. XRP/USDT).
+* Timeframe: Candle length to use (e.g. `"5m"`, `"1h"`, ...).
+* Indicators: Technical indicators (SMA, EMA, RSI, ...).
+* Limit order: Limit orders which execute at the defined limit price or better.
+* Market order: Guaranteed to fill, may move price depending on the order size.
+
+## Fee handling
+
+All profit calculations of Freqtrade include fees. For Backtesting / Hyperopt / Dry-run modes, the exchange default fee is used (lowest tier on the exchange). For live operations, fees are used as applied by the exchange (this includes BNB rebates etc.).
+
+## Bot execution logic
+
+Starting freqtrade in dry-run or live mode (using `freqtrade trade`) will start the bot and start the bot iteration loop.
+By default, loop runs every few seconds (`internals.process_throttle_secs`) and does roughly the following in the following sequence:
+
+* Fetch open trades from persistence.
+* Calculate current list of tradable pairs.
+* Download ohlcv data for the pairlist including all [informative pairs](strategy-customization.md#get-data-for-non-tradeable-pairs)  
+  This step is only executed once per Candle to avoid unnecessary network traffic.
+* Call `bot_loop_start()` strategy callback.
+* Analyze strategy per pair.
+  * Call `populate_indicators()`
+  * Call `populate_buy_trend()`
+  * Call `populate_sell_trend()`
+* Check timeouts for open orders.
+  * Calls `check_buy_timeout()` strategy callback for open buy orders.
+  * Calls `check_sell_timeout()` strategy callback for open sell orders.
+* Verifies existing positions and eventually places sell orders.
+  * Considers stoploss, ROI and sell-signal.
+  * Determine sell-price based on `ask_strategy` configuration setting.
+  * Before a sell order is placed, `confirm_trade_exit()` strategy callback is called.
+* Check if trade-slots are still available (if `max_open_trades` is reached).
+* Verifies buy signal trying to enter new positions.
+  * Determine buy-price based on `bid_strategy` configuration setting.
+  * Before a buy order is placed, `confirm_trade_entry()` strategy callback is called.
+
+This loop will be repeated again and again until the bot is stopped.
+
+## Backtesting / Hyperopt execution logic
+
+[backtesting](backtesting.md) or [hyperopt](hyperopt.md) do only part of the above logic, since most of the trading operations are fully simulated.
+
+* Load historic data for configured pairlist.
+* Calculate indicators (calls `populate_indicators()`).
+* Calls `populate_buy_trend()` and `populate_sell_trend()`
+* Loops per candle simulating entry and exit points.
+* Generate backtest report output
+
+!!! Note
+    Both Backtesting and Hyperopt include exchange default Fees in the calculation. Custom fees can be passed to backtesting / hyperopt by specifying the `--fee` argument.

docs/bot-usage.md

@@ -2,76 +2,130 @@
 
 This page explains the different parameters of the bot and how to run it.
 
+!!! Note
+    If you've used `setup.sh`, don't forget to activate your virtual environment (`source .env/bin/activate`) before running freqtrade commands.
+
+!!! Warning "Up-to-date clock"
+    The clock on the system running the bot must be accurate, synchronized to a NTP server frequently enough to avoid problems with communication to the exchanges.
 
 ## Bot commands
 
 ```
-usage: freqtrade [-h] [-v] [--logfile FILE] [--version] [-c PATH] [-d PATH]
+usage: freqtrade [-h] [-V]
-                 [-s NAME] [--strategy-path PATH] [--db-url PATH]
+                 {trade,create-userdir,new-config,new-hyperopt,new-strategy,download-data,convert-data,convert-trade-data,backtesting,edge,hyperopt,hyperopt-list,hyperopt-show,list-exchanges,list-hyperopts,list-markets,list-pairs,list-strategies,list-timeframes,show-trades,test-pairlist,plot-dataframe,plot-profit}
-                 [--sd-notify]
+                 ...
-                 {backtesting,edge,hyperopt} ...
 
 Free, open source crypto trading bot
 
 positional arguments:
-  {backtesting,edge,hyperopt}
+  {trade,create-userdir,new-config,new-hyperopt,new-strategy,download-data,convert-data,convert-trade-data,backtesting,edge,hyperopt,hyperopt-list,hyperopt-show,list-exchanges,list-hyperopts,list-markets,list-pairs,list-strategies,list-timeframes,show-trades,test-pairlist,plot-dataframe,plot-profit}
+    trade               Trade module.
+    create-userdir      Create user-data directory.
+    new-config          Create new config
+    new-hyperopt        Create new hyperopt
+    new-strategy        Create new strategy
+    download-data       Download backtesting data.
+    convert-data        Convert candle (OHLCV) data from one format to
+                        another.
+    convert-trade-data  Convert trade data from one format to another.
     backtesting         Backtesting module.
     edge                Edge module.
     hyperopt            Hyperopt module.
+    hyperopt-list       List Hyperopt results
+    hyperopt-show       Show details of Hyperopt results
+    list-exchanges      Print available exchanges.
+    list-hyperopts      Print available hyperopt classes.
+    list-markets        Print markets on exchange.
+    list-pairs          Print pairs on exchange.
+    list-strategies     Print available strategies.
+    list-timeframes     Print available timeframes for the exchange.
+    show-trades         Show trades.
+    test-pairlist       Test your pairlist configuration.
+    plot-dataframe      Plot candles with indicators.
+    plot-profit         Generate plot showing profits.
 
 optional arguments:
   -h, --help            show this help message and exit
+  -V, --version         show program's version number and exit
+
+```
+
+### Bot trading commands
+
+```
+usage: freqtrade trade [-h] [-v] [--logfile FILE] [-V] [-c PATH] [-d PATH]
+                       [--userdir PATH] [-s NAME] [--strategy-path PATH]
+                       [--db-url PATH] [--sd-notify] [--dry-run]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --db-url PATH         Override trades database URL, this is useful in custom
+                        deployments (default: `sqlite:///tradesv3.sqlite` for
+                        Live Run mode, `sqlite:///tradesv3.dryrun.sqlite` for
+                        Dry Run).
+  --sd-notify           Notify systemd service manager.
+  --dry-run             Enforce dry-run for trading (removes Exchange secrets
+                        and simulates trades).
+
+Common arguments:
   -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
-  --logfile FILE        Log to the file specified
+  --logfile FILE        Log to the file specified. Special values are:
+                        'syslog', 'journald'. See the documentation for more
+                        details.
   -V, --version         show program's version number and exit
   -c PATH, --config PATH
-                        Specify configuration file (default: None). Multiple
+                        Specify configuration file (default:
-                        --config options may be used. Can be set to '-' to
+                        `userdir/config.json` or `config.json` whichever
-                        read config from stdin.
+                        exists). Multiple --config options may be used. Can be
+                        set to `-` to read config from stdin.
   -d PATH, --datadir PATH
-                        Path to backtest data.
+                        Path to directory with historical backtesting data.
+  --userdir PATH, --user-data-dir PATH
+                        Path to userdata directory.
+
+Strategy arguments:
   -s NAME, --strategy NAME
-                        Specify strategy class name (default:
+                        Specify strategy class name which will be used by the
-                        DefaultStrategy).
+                        bot.
   --strategy-path PATH  Specify additional strategy lookup path.
-  --db-url PATH         Override trades database URL, this is useful if
+
-                        dry_run is enabled or in custom deployments (default:
-                        None).
-  --sd-notify           Notify systemd service manager.
 ```
 
-### How to use a different configuration file?
+### How to specify which configuration file be used?
 
-The bot allows you to select which configuration file you want to use. Per
+The bot allows you to select which configuration file you want to use by means of
-default, the bot will load the file `./config.json`
+the `-c/--config` command line option:
 
 ```bash
-freqtrade -c path/far/far/away/config.json
+freqtrade trade -c path/far/far/away/config.json
 ```
 
+Per default, the bot loads the `config.json` configuration file from the current
+working directory.
+
 ### How to use multiple configuration files?
 
 The bot allows you to use multiple configuration files by specifying multiple
-`-c/--config` configuration options in the command line. Configuration parameters
+`-c/--config` options in the command line. Configuration parameters
-defined in the last configuration file override parameters with the same name
+defined in the latter configuration files override parameters with the same name
-defined in the previous configuration file specified in the command line.
+defined in the previous configuration files specified in the command line earlier.
 
-For example, you can make a separate configuration file with your key and secrete
+For example, you can make a separate configuration file with your key and secret
 for the Exchange you use for trading, specify default configuration file with
-empty key and secrete values while running in the Dry Mode (which does not actually
+empty key and secret values while running in the Dry Mode (which does not actually
 require them):
 
 ```bash
-freqtrade -c ./config.json
+freqtrade trade -c ./config.json
 ```
 
 and specify both configuration files when running in the normal Live Trade Mode:
 
 ```bash
-freqtrade -c ./config.json -c path/to/secrets/keys.config.json
+freqtrade trade -c ./config.json -c path/to/secrets/keys.config.json
 ```
 
-This could help you hide your private Exchange key and Exchange secrete on you local machine
+This could help you hide your private Exchange key and Exchange secret on you local machine
 by setting appropriate file permissions for the file which contains actual secrets and, additionally,
 prevent unintended disclosure of sensitive private data when you publish examples
 of your configuration in the project issues or in the Internet.
@@ -79,13 +133,36 @@ of your configuration in the project issues or in the Internet.
 See more details on this technique with examples in the documentation page on
 [configuration](configuration.md).
 
+### Where to store custom data
+
+Freqtrade allows the creation of a user-data directory using `freqtrade create-userdir --userdir someDirectory`.
+This directory will look as follows:
+
+```
+user_data/
+├── backtest_results
+├── data
+├── hyperopts
+├── hyperopt_results
+├── plot
+└── strategies
+```
+
+You can add the entry "user_data_dir" setting to your configuration, to always point your bot to this directory.
+Alternatively, pass in `--userdir` to every command.
+The bot will fail to start if the directory does not exist, but will create necessary subdirectories.
+
+This directory should contain your custom strategies, custom hyperopts and hyperopt loss functions, backtesting historical data (downloaded using either backtesting command or the download script) and plot outputs.
+
+It is recommended to use version control to keep track of changes to your strategies.
+
 ### How to use **--strategy**?
 
 This parameter will allow you to load your custom strategy class.
-Per default without `--strategy` or `-s` the bot will load the
+To test the bot installation, you can use the `SampleStrategy` installed by the `create-userdir` subcommand (usually `user_data/strategy/sample_strategy.py`).
-`DefaultStrategy` included with the bot (`freqtrade/strategy/default_strategy.py`).
 
-The bot will search your strategy file within `user_data/strategies` and `freqtrade/strategy`.
+The bot will search your strategy file within `user_data/strategies`.
+To use other directories, please read the next section about `--strategy-path`.
 
 To load a strategy, simply pass the class name (e.g.: `CustomStrategy`) in this parameter.
 
@@ -94,7 +171,7 @@ In `user_data/strategies` you have a file `my_awesome_strategy.py` which has
 a strategy class called `AwesomeStrategy` to load it:
 
 ```bash
-freqtrade --strategy AwesomeStrategy
+freqtrade trade --strategy AwesomeStrategy
 ```
 
 If the bot does not find your strategy file, it will display in an error
@@ -107,8 +184,9 @@ Learn more about strategy file in
 
 This parameter allows you to add an additional strategy lookup path, which gets
 checked before the default locations (The passed path must be a directory!):
+
 ```bash
-freqtrade --strategy AwesomeStrategy --strategy-path /some/directory
+freqtrade trade --strategy AwesomeStrategy --strategy-path /some/directory
 ```
 
 #### How to install a strategy?
@@ -124,7 +202,7 @@ using `--db-url`. This can also be used to specify a custom database
 in production mode. Example command:
 
 ```bash
-freqtrade -c config.json --db-url sqlite:///tradesv3.dry_run.sqlite
+freqtrade trade -c config.json --db-url sqlite:///tradesv3.dry_run.sqlite
 ```
 
 ## Backtesting commands
@@ -132,27 +210,30 @@ freqtrade -c config.json --db-url sqlite:///tradesv3.dry_run.sqlite
 Backtesting also uses the config specified via `-c/--config`.
 
 ```
-usage: freqtrade backtesting [-h] [-i TICKER_INTERVAL] [--timerange TIMERANGE]
+usage: freqtrade backtesting [-h] [-v] [--logfile FILE] [-V] [-c PATH]
-                           [--max_open_trades MAX_OPEN_TRADES]
+                             [-d PATH] [--userdir PATH] [-s NAME]
-                           [--stake_amount STAKE_AMOUNT] [-r] [--eps] [--dmmp]
+                             [--strategy-path PATH] [-i TIMEFRAME]
-                           [-l]
+                             [--timerange TIMERANGE] [--max-open-trades INT]
+                             [--stake-amount STAKE_AMOUNT] [--fee FLOAT]
+                             [--eps] [--dmmp]
                              [--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]]
                              [--export EXPORT] [--export-filename PATH]
 
 optional arguments:
   -h, --help            show this help message and exit
-  -i TICKER_INTERVAL, --ticker-interval TICKER_INTERVAL
+  -i TIMEFRAME, --timeframe TIMEFRAME, --ticker-interval TIMEFRAME
-                        Specify ticker interval (1m, 5m, 30m, 1h, 1d).
+                        Specify ticker interval (`1m`, `5m`, `30m`, `1h`,
+                        `1d`).
   --timerange TIMERANGE
                         Specify what timerange of data to use.
-  --max_open_trades MAX_OPEN_TRADES
+  --max-open-trades INT
-                        Specify max_open_trades to use.
+                        Override the value of the `max_open_trades`
-  --stake_amount STAKE_AMOUNT
+                        configuration setting.
-                        Specify stake_amount.
+  --stake-amount STAKE_AMOUNT
-  -r, --refresh-pairs-cached
+                        Override the value of the `stake_amount` configuration
-                        Refresh the pairs files in tests/testdata with the
+                        setting.
-                        latest data from the exchange. Use it if you want to
+  --fee FLOAT           Specify fee ratio. Will be applied twice (on trade
-                        run your optimization commands with up-to-date data.
+                        entry and exit).
   --eps, --enable-position-stacking
                         Allow buying the same pair multiple times (position
                         stacking).
@@ -160,83 +241,104 @@ optional arguments:
                         Disable applying `max_open_trades` during backtest
                         (same as setting `max_open_trades` to a very high
                         number).
-  -l, --live            Use live data.
   --strategy-list STRATEGY_LIST [STRATEGY_LIST ...]
-                        Provide a commaseparated list of strategies to
+                        Provide a space-separated list of strategies to
-                        backtest Please note that ticker-interval needs to be
+                        backtest. Please note that ticker-interval needs to be
                         set either in config or via command line. When using
-                        this together with --export trades, the strategy-name
+                        this together with `--export trades`, the strategy-
-                        is injected into the filename (so backtest-data.json
+                        name is injected into the filename (so `backtest-
-                        becomes backtest-data-DefaultStrategy.json
+                        data.json` becomes `backtest-data-
-  --export EXPORT       Export backtest results, argument are: trades. Example
+                        DefaultStrategy.json`
-                        --export=trades
+  --export EXPORT       Export backtest results, argument are: trades.
+                        Example: `--export=trades`
   --export-filename PATH
-                        Save backtest results to this filename requires
+                        Save backtest results to the file with this filename.
-                        --export to be set as well Example --export-
+                        Requires `--export` to be set as well. Example:
-                        filename=user_data/backtest_data/backtest_today.json
+                        `--export-filename=user_data/backtest_results/backtest
-                        (default: user_data/backtest_data/backtest-
+                        _today.json`
-                        result.json)
+
+Common arguments:
+  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
+  --logfile FILE        Log to the file specified. Special values are:
+                        'syslog', 'journald'. See the documentation for more
+                        details.
+  -V, --version         show program's version number and exit
+  -c PATH, --config PATH
+                        Specify configuration file (default:
+                        `userdir/config.json` or `config.json` whichever
+                        exists). Multiple --config options may be used. Can be
+                        set to `-` to read config from stdin.
+  -d PATH, --datadir PATH
+                        Path to directory with historical backtesting data.
+  --userdir PATH, --user-data-dir PATH
+                        Path to userdata directory.
+
+Strategy arguments:
+  -s NAME, --strategy NAME
+                        Specify strategy class name which will be used by the
+                        bot.
+  --strategy-path PATH  Specify additional strategy lookup path.
+
 ```
 
-### How to use **--refresh-pairs-cached** parameter?
+### Getting historic data for backtesting
 
-The first time your run Backtesting, it will take the pairs you have
+The first time your run Backtesting, you will need to download some historic data first.
-set in your config file and download data from the Exchange.
+This can be accomplished by using `freqtrade download-data`.  
-
+Check the corresponding [Data Downloading](data-download.md) section for more details
-If for any reason you want to update your data set, you use
-`--refresh-pairs-cached` to force Backtesting to update the data it has.
-
-!!! Note
-    Use it only if you want to update your data set. You will not be able to come back to the previous version.
-
-To test your strategy with latest data, we recommend continuing using
-the parameter `-l` or `--live`.
 
 ## Hyperopt commands
 
 To optimize your strategy, you can use hyperopt parameter hyperoptimization
-to find optimal parameter values for your stategy.
+to find optimal parameter values for your strategy.
 
 ```
-usage: freqtrade hyperopt [-h] [-i TICKER_INTERVAL] [--timerange TIMERANGE]
+usage: freqtrade hyperopt [-h] [-v] [--logfile FILE] [-V] [-c PATH] [-d PATH]
-                          [--max_open_trades INT]
+                          [--userdir PATH] [-s NAME] [--strategy-path PATH]
-                          [--stake_amount STAKE_AMOUNT] [-r]
+                          [-i TIMEFRAME] [--timerange TIMERANGE]
-                          [--customhyperopt NAME] [--eps] [-e INT]
+                          [--max-open-trades INT]
-                          [-s {all,buy,sell,roi,stoploss} [{all,buy,sell,roi,stoploss} ...]]
+                          [--stake-amount STAKE_AMOUNT] [--fee FLOAT]
-                          [--dmmp] [--print-all] [-j JOBS]
+                          [--hyperopt NAME] [--hyperopt-path PATH] [--eps]
-                          [--random-state INT] [--min-trades INT] [--continue]
+                          [-e INT]
+                          [--spaces {all,buy,sell,roi,stoploss,trailing,default} [{all,buy,sell,roi,stoploss,trailing,default} ...]]
+                          [--dmmp] [--print-all] [--no-color] [--print-json]
+                          [-j JOBS] [--random-state INT] [--min-trades INT]
                           [--hyperopt-loss NAME]
 
 optional arguments:
   -h, --help            show this help message and exit
-  -i TICKER_INTERVAL, --ticker-interval TICKER_INTERVAL
+  -i TIMEFRAME, --timeframe TIMEFRAME, --ticker-interval TIMEFRAME
                         Specify ticker interval (`1m`, `5m`, `30m`, `1h`,
                         `1d`).
   --timerange TIMERANGE
                         Specify what timerange of data to use.
-  --max_open_trades INT
+  --max-open-trades INT
-                        Specify max_open_trades to use.
+                        Override the value of the `max_open_trades`
-  --stake_amount STAKE_AMOUNT
+                        configuration setting.
-                        Specify stake_amount.
+  --stake-amount STAKE_AMOUNT
-  -r, --refresh-pairs-cached
+                        Override the value of the `stake_amount` configuration
-                        Refresh the pairs files in tests/testdata with the
+                        setting.
-                        latest data from the exchange. Use it if you want to
+  --fee FLOAT           Specify fee ratio. Will be applied twice (on trade
-                        run your optimization commands with up-to-date data.
+                        entry and exit).
-  --customhyperopt NAME
+  --hyperopt NAME       Specify hyperopt class name which will be used by the
-                        Specify hyperopt class name (default:
+                        bot.
-                        `DefaultHyperOpts`).
+  --hyperopt-path PATH  Specify additional lookup path for Hyperopt and
+                        Hyperopt Loss functions.
   --eps, --enable-position-stacking
                         Allow buying the same pair multiple times (position
                         stacking).
   -e INT, --epochs INT  Specify number of epochs (default: 100).
-  -s {all,buy,sell,roi,stoploss} [{all,buy,sell,roi,stoploss} ...], --spaces {all,buy,sell,roi,stoploss} [{all,buy,sell,roi,stoploss} ...]
+  --spaces {all,buy,sell,roi,stoploss,trailing,default} [{all,buy,sell,roi,stoploss,trailing,default} ...]
                         Specify which parameters to hyperopt. Space-separated
-                        list. Default: `all`.
+                        list.
   --dmmp, --disable-max-market-positions
                         Disable applying `max_open_trades` during backtest
                         (same as setting `max_open_trades` to a very high
                         number).
   --print-all           Print all results, not only the best ones.
+  --no-color            Disable colorization of hyperopt results. May be
+                        useful if you are redirecting output to a file.
+  --print-json          Print output in JSON format.
   -j JOBS, --job-workers JOBS
                         The number of concurrently running jobs for
                         hyperoptimization (hyperopt worker processes). If -1
@@ -247,55 +349,97 @@ optional arguments:
                         reproducible hyperopt results.
   --min-trades INT      Set minimal desired number of trades for evaluations
                         in the hyperopt optimization path (default: 1).
-  --continue            Continue hyperopt from previous runs. By default,
+  --hyperopt-loss NAME  Specify the class name of the hyperopt loss function
-                        temporary files will be removed and hyperopt will
-                        start from scratch.
-  --hyperopt-loss       NAME
-                        Specify the class name of the hyperopt loss function
                         class (IHyperOptLoss). Different functions can
                         generate completely different results, since the
-                        target for optimization is different. (default:
+                        target for optimization is different. Built-in
-                        `DefaultHyperOptLoss`).
+                        Hyperopt-loss-functions are: ShortTradeDurHyperOptLoss,
+                        OnlyProfitHyperOptLoss, SharpeHyperOptLoss,
+                        SharpeHyperOptLossDaily, SortinoHyperOptLoss,
+                        SortinoHyperOptLossDaily.
+
+Common arguments:
+  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
+  --logfile FILE        Log to the file specified. Special values are:
+                        'syslog', 'journald'. See the documentation for more
+                        details.
+  -V, --version         show program's version number and exit
+  -c PATH, --config PATH
+                        Specify configuration file (default:
+                        `userdir/config.json` or `config.json` whichever
+                        exists). Multiple --config options may be used. Can be
+                        set to `-` to read config from stdin.
+  -d PATH, --datadir PATH
+                        Path to directory with historical backtesting data.
+  --userdir PATH, --user-data-dir PATH
+                        Path to userdata directory.
+
+Strategy arguments:
+  -s NAME, --strategy NAME
+                        Specify strategy class name which will be used by the
+                        bot.
+  --strategy-path PATH  Specify additional strategy lookup path.
+
 ```
 
 ## Edge commands
 
-To know your trade expectacny and winrate against historical data, you can use Edge.
+To know your trade expectancy and winrate against historical data, you can use Edge.
 
 ```
-usage: freqtrade edge [-h] [-i TICKER_INTERVAL] [--timerange TIMERANGE]
+usage: freqtrade edge [-h] [-v] [--logfile FILE] [-V] [-c PATH] [-d PATH]
-                    [--max_open_trades MAX_OPEN_TRADES]
+                      [--userdir PATH] [-s NAME] [--strategy-path PATH]
-                    [--stake_amount STAKE_AMOUNT] [-r]
+                      [-i TIMEFRAME] [--timerange TIMERANGE]
-                    [--stoplosses STOPLOSS_RANGE]
+                      [--max-open-trades INT] [--stake-amount STAKE_AMOUNT]
+                      [--fee FLOAT] [--stoplosses STOPLOSS_RANGE]
 
 optional arguments:
   -h, --help            show this help message and exit
-  -i TICKER_INTERVAL, --ticker-interval TICKER_INTERVAL
+  -i TIMEFRAME, --timeframe TIMEFRAME, --ticker-interval TIMEFRAME
-                        Specify ticker interval (1m, 5m, 30m, 1h, 1d).
+                        Specify ticker interval (`1m`, `5m`, `30m`, `1h`,
+                        `1d`).
   --timerange TIMERANGE
                         Specify what timerange of data to use.
-  --max_open_trades MAX_OPEN_TRADES
+  --max-open-trades INT
-                        Specify max_open_trades to use.
+                        Override the value of the `max_open_trades`
-  --stake_amount STAKE_AMOUNT
+                        configuration setting.
-                        Specify stake_amount.
+  --stake-amount STAKE_AMOUNT
-  -r, --refresh-pairs-cached
+                        Override the value of the `stake_amount` configuration
-                        Refresh the pairs files in tests/testdata with the
+                        setting.
-                        latest data from the exchange. Use it if you want to
+  --fee FLOAT           Specify fee ratio. Will be applied twice (on trade
-                        run your optimization commands with up-to-date data.
+                        entry and exit).
   --stoplosses STOPLOSS_RANGE
-                        Defines a range of stoploss against which edge will
+                        Defines a range of stoploss values against which edge
-                        assess the strategy the format is "min,max,step"
+                        will assess the strategy. The format is "min,max,step"
-                        (without any space).example:
+                        (without any space). Example:
-                        --stoplosses=-0.01,-0.1,-0.001
+                        `--stoplosses=-0.01,-0.1,-0.001`
+
+Common arguments:
+  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
+  --logfile FILE        Log to the file specified. Special values are:
+                        'syslog', 'journald'. See the documentation for more
+                        details.
+  -V, --version         show program's version number and exit
+  -c PATH, --config PATH
+                        Specify configuration file (default:
+                        `userdir/config.json` or `config.json` whichever
+                        exists). Multiple --config options may be used. Can be
+                        set to `-` to read config from stdin.
+  -d PATH, --datadir PATH
+                        Path to directory with historical backtesting data.
+  --userdir PATH, --user-data-dir PATH
+                        Path to userdata directory.
+
+Strategy arguments:
+  -s NAME, --strategy NAME
+                        Specify strategy class name which will be used by the
+                        bot.
+  --strategy-path PATH  Specify additional strategy lookup path.
+
 ```
 
 To understand edge and how to read the results, please read the [edge documentation](edge.md).
 
-## A parameter missing in the configuration?
-
-All parameters for `main.py`, `backtesting`, `hyperopt` are referenced
-in [misc.py](https://github.com/freqtrade/freqtrade/blob/develop/freqtrade/misc.py#L84)
-
 ## Next step
 
 The optimal strategy of the bot will change with time depending of the market trends. The next step is to

docs/configuration.md

@@ -1,118 +1,225 @@
 # Configure the bot
 
-This page explains how to configure your `config.json` file.
+Freqtrade has many configurable features and possibilities.
+By default, these settings are configured via the configuration file (see below).
 
-## Setup config.json
+## The Freqtrade configuration file
 
-We recommend to copy and use the `config.json.example` as a template
+The bot uses a set of configuration parameters during its operation that all together conform the bot configuration. It normally reads its configuration from a file (Freqtrade configuration file).
+
+Per default, the bot loads the configuration from the `config.json` file, located in the current working directory.
+
+You can specify a different configuration file used by the bot with the `-c/--config` command line option.
+
+In some advanced use cases, multiple configuration files can be specified and used by the bot or the bot can read its configuration parameters from the process standard input stream.
+
+If you used the [Quick start](installation.md/#quick-start) method for installing 
+the bot, the installation script should have already created the default configuration file (`config.json`) for you.
+
+If default configuration file is not created we recommend you to copy and use the `config.json.example` as a template
 for your bot configuration.
 
-The table below will list all configuration parameters.
+The Freqtrade configuration file is to be written in the JSON format.
 
-Mandatory Parameters are marked as **Required**.
+Additionally to the standard JSON syntax, you may use one-line `// ...` and multi-line `/* ... */` comments in your configuration files and trailing commas in the lists of parameters.
 
-|  Command | Default | Description |
+Do not worry if you are not familiar with JSON format -- simply open the configuration file with an editor of your choice, make some changes to the parameters you need, save your changes and, finally, restart the bot or, if it was previously stopped, run it again with the changes you made to the configuration. The bot validates syntax of the configuration file at startup and will warn you if you made any errors editing it, pointing out problematic lines.
-|----------|---------|-------------|
+
-| `max_open_trades` | 3 | **Required.** Number of trades open your bot will have. If -1 then it is ignored (i.e. potentially unlimited open trades)
+## Configuration parameters
-| `stake_currency` | BTC | **Required.** Crypto-currency used for trading. [Strategy Override](#parameters-in-the-strategy).
+
-| `stake_amount` | 0.05 | **Required.** Amount of crypto-currency your bot will use for each trade. Per default, the bot will use (0.05 BTC x 3) = 0.15 BTC in total will be always engaged. Set it to `"unlimited"` to allow the bot to use all available balance. [Strategy Override](#parameters-in-the-strategy).
+The table below will list all configuration parameters available.
-| `amount_reserve_percent` | 0.05 | Reserve some amount in min pair stake amount. Default is 5%. The bot will reserve `amount_reserve_percent` + stop-loss value when calculating min pair stake amount in order to avoid possible trade refusals.
+
-| `ticker_interval` | [1m, 5m, 15m, 30m, 1h, 1d, ...] | The ticker interval to use (1min, 5 min, 15 min, 30 min, 1 hour or 1 day). Default is 5 minutes. [Strategy Override](#parameters-in-the-strategy).
+Freqtrade can also load many options via command line (CLI) arguments (check out the commands `--help` output for details).
-| `fiat_display_currency` | USD | **Required.** Fiat currency used to show your profits. More information below.
+The prevelance for all Options is as follows:
-| `dry_run` | true | **Required.** Define if the bot must be in Dry-run or production mode.
+
-| `dry_run_wallet` | 999.9 | Overrides the default amount of 999.9 stake currency units in the wallet used by the bot running in the Dry Run mode if you need it for any reason.
+- CLI arguments override any other option
-| `process_only_new_candles` | false | If set to true indicators are processed only once a new candle arrives. If false each loop populates the indicators, this will mean the same candle is processed many times creating system load but can be useful of your strategy depends on tick data not only candle. [Strategy Override](#parameters-in-the-strategy).
+- Configuration files are used in sequence (last file wins), and override Strategy configurations.
-| `minimal_roi` | See below | Set the threshold in percent the bot will use to sell a trade. More information below. [Strategy Override](#parameters-in-the-strategy).
+- Strategy configurations are only used if they are not set via configuration or via command line arguments. These options are marked with [Strategy Override](#parameters-in-the-strategy) in the below table.
-| `stoploss` | -0.10 | Value of the stoploss in percent used by the bot. More information below. More details in the [stoploss documentation](stoploss.md). [Strategy Override](#parameters-in-the-strategy).
+
-| `trailing_stop` | false | Enables trailing stop-loss (based on `stoploss` in either configuration or strategy file). More details in the [stoploss documentation](stoploss.md). [Strategy Override](#parameters-in-the-strategy).
+Mandatory parameters are marked as **Required**, which means that they are required to be set in one of the possible ways.
-| `trailing_stop_positive` | 0 | Changes stop-loss once profit has been reached. More details in the [stoploss documentation](stoploss.md). [Strategy Override](#parameters-in-the-strategy).
+
-| `trailing_stop_positive_offset` | 0 | Offset on when to apply `trailing_stop_positive`. Percentage value which should be positive. More details in the [stoploss documentation](stoploss.md). [Strategy Override](#parameters-in-the-strategy).
+|  Parameter | Description |
-| `trailing_only_offset_is_reached` | false | Only apply trailing stoploss when the offset is reached. [stoploss documentation](stoploss.md). [Strategy Override](#parameters-in-the-strategy).
+|------------|-------------|
-| `unfilledtimeout.buy` | 10 | **Required.** How long (in minutes) the bot will wait for an unfilled buy order to complete, after which the order will be cancelled.
+| `max_open_trades` | **Required.** Number of open trades your bot is allowed to have. Only one open trade per pair is possible, so the length of your pairlist is another limitation which can apply. If -1 then it is ignored (i.e. potentially unlimited open trades, limited by the pairlist). [More information below](#configuring-amount-per-trade).<br> **Datatype:** Positive integer or -1.
-| `unfilledtimeout.sell` | 10 | **Required.** How long (in minutes) the bot will wait for an unfilled sell order to complete, after which the order will be cancelled.
+| `stake_currency` | **Required.** Crypto-currency used for trading. [Strategy Override](#parameters-in-the-strategy). <br> **Datatype:** String
-| `bid_strategy.ask_last_balance` | 0.0 | **Required.** Set the bidding price. More information [below](#understand-ask_last_balance).
+| `stake_amount` | **Required.** Amount of crypto-currency your bot will use for each trade. Set it to `"unlimited"` to allow the bot to use all available balance. [More information below](#configuring-amount-per-trade). [Strategy Override](#parameters-in-the-strategy). <br> **Datatype:** Positive float or `"unlimited"`.
-| `bid_strategy.use_order_book` | false | Allows buying of pair using the rates in Order Book Bids.
+| `tradable_balance_ratio` | Ratio of the total account balance the bot is allowed to trade. [More information below](#configuring-amount-per-trade). <br>*Defaults to `0.99` 99%).*<br> **Datatype:** Positive float between `0.1` and `1.0`.
-| `bid_strategy.order_book_top` | 0 | Bot will use the top N rate in Order Book Bids. Ie. a value of 2 will allow the bot to pick the 2nd bid rate in Order Book Bids.
+| `amend_last_stake_amount` | Use reduced last stake amount if necessary. [More information below](#configuring-amount-per-trade). <br>*Defaults to `false`.* <br> **Datatype:** Boolean
-| `bid_strategy. check_depth_of_market.enabled` | false | Does not buy if the % difference of buy orders and sell orders is met in Order Book.
+| `last_stake_amount_min_ratio` | Defines minimum stake amount that has to be left and executed. Applies only to the last stake amount when it's amended to a reduced value (i.e. if `amend_last_stake_amount` is set to `true`). [More information below](#configuring-amount-per-trade). <br>*Defaults to `0.5`.* <br> **Datatype:** Float (as ratio)
-| `bid_strategy. check_depth_of_market.bids_to_ask_delta` | 0 | The % difference of buy orders and sell orders found in Order Book. A value lesser than 1 means sell orders is greater, while value greater than 1 means buy orders is higher.
+| `amount_reserve_percent` | Reserve some amount in min pair stake amount. The bot will reserve `amount_reserve_percent` + stoploss value when calculating min pair stake amount in order to avoid possible trade refusals. <br>*Defaults to `0.05` (5%).* <br> **Datatype:** Positive Float as ratio.
-| `ask_strategy.use_order_book` | false | Allows selling of open traded pair using the rates in Order Book Asks.
+| `timeframe` | The timeframe (former ticker interval) to use (e.g `1m`, `5m`, `15m`, `30m`, `1h` ...). [Strategy Override](#parameters-in-the-strategy). <br> **Datatype:** String
-| `ask_strategy.order_book_min` | 0 | Bot will scan from the top min to max Order Book Asks searching for a profitable rate.
+| `fiat_display_currency` | Fiat currency used to show your profits. [More information below](#what-values-can-be-used-for-fiat_display_currency). <br> **Datatype:** String
-| `ask_strategy.order_book_max` | 0 | Bot will scan from the top min to max Order Book Asks searching for a profitable rate.
+| `dry_run` | **Required.** Define if the bot must be in Dry Run or production mode. <br>*Defaults to `true`.* <br> **Datatype:** Boolean
-| `order_types` | None | Configure order-types depending on the action (`"buy"`, `"sell"`, `"stoploss"`, `"stoploss_on_exchange"`). [More information below](#understand-order_types). [Strategy Override](#parameters-in-the-strategy).
+| `dry_run_wallet` | Define the starting amount in stake currency for the simulated wallet used by the bot running in the Dry Run mode.<br>*Defaults to `1000`.* <br> **Datatype:** Float
-| `order_time_in_force` | None | Configure time in force for buy and sell orders. [More information below](#understand-order_time_in_force). [Strategy Override](#parameters-in-the-strategy).
+| `cancel_open_orders_on_exit` | Cancel open orders when the `/stop` RPC command is issued, `Ctrl+C` is pressed or the bot dies unexpectedly. When set to `true`, this allows you to use `/stop` to cancel unfilled and partially filled orders in the event of a market crash. It does not impact open positions. <br>*Defaults to `false`.* <br> **Datatype:** Boolean
-| `exchange.name` |  | **Required.** Name of the exchange class to use. [List below](#user-content-what-values-for-exchangename).
+| `process_only_new_candles` | Enable processing of indicators only when new candles arrive. If false each loop populates the indicators, this will mean the same candle is processed many times creating system load but can be useful of your strategy depends on tick data not only candle. [Strategy Override](#parameters-in-the-strategy). <br>*Defaults to `false`.*  <br> **Datatype:** Boolean
-| `exchange.sandbox` | false | Use the 'sandbox' version of the exchange, where the exchange provides a sandbox for risk-free integration. See [here](sandbox-testing.md) in more details.
+| `minimal_roi` | **Required.** Set the threshold as ratio the bot will use to sell a trade. [More information below](#understand-minimal_roi). [Strategy Override](#parameters-in-the-strategy). <br> **Datatype:** Dict
-| `exchange.key` | '' | API key to use for the exchange. Only required when you are in production mode.
+| `stoploss` |  **Required.** Value as ratio of the stoploss used by the bot. More details in the [stoploss documentation](stoploss.md). [Strategy Override](#parameters-in-the-strategy).  <br> **Datatype:** Float (as ratio)
-| `exchange.secret` | '' | API secret to use for the exchange. Only required when you are in production mode.
+| `trailing_stop` | Enables trailing stoploss (based on `stoploss` in either configuration or strategy file). More details in the [stoploss documentation](stoploss.md#trailing-stop-loss). [Strategy Override](#parameters-in-the-strategy). <br> **Datatype:** Boolean
-| `exchange.pair_whitelist` | [] | List of pairs to use by the bot for trading and to check for potential trades during backtesting. Can be overriden by dynamic pairlists (see [below](#dynamic-pairlists)).
+| `trailing_stop_positive` | Changes stoploss once profit has been reached. More details in the [stoploss documentation](stoploss.md#trailing-stop-loss-custom-positive-loss). [Strategy Override](#parameters-in-the-strategy). <br> **Datatype:** Float
-| `exchange.pair_blacklist` | [] | List of pairs the bot must absolutely avoid for trading and backtesting. Can be overriden by dynamic pairlists (see [below](#dynamic-pairlists)).
+| `trailing_stop_positive_offset` | Offset on when to apply `trailing_stop_positive`. Percentage value which should be positive. More details in the [stoploss documentation](stoploss.md#trailing-stop-loss-only-once-the-trade-has-reached-a-certain-offset). [Strategy Override](#parameters-in-the-strategy). <br>*Defaults to `0.0` (no offset).* <br> **Datatype:** Float
-| `exchange.ccxt_config` | None | Additional CCXT parameters passed to the regular ccxt instance. Parameters may differ from exchange to exchange and are documented in the [ccxt documentation](https://ccxt.readthedocs.io/en/latest/manual.html#instantiation)
+| `trailing_only_offset_is_reached` | Only apply trailing stoploss when the offset is reached. [stoploss documentation](stoploss.md). [Strategy Override](#parameters-in-the-strategy). <br>*Defaults to `false`.*  <br> **Datatype:** Boolean
-| `exchange.ccxt_async_config` | None | Additional CCXT parameters passed to the async ccxt instance. Parameters may differ from exchange to exchange  and are documented in the [ccxt documentation](https://ccxt.readthedocs.io/en/latest/manual.html#instantiation)
+| `unfilledtimeout.buy` | **Required.** How long (in minutes) the bot will wait for an unfilled buy order to complete, after which the order will be cancelled and repeated at current (new) price, as long as there is a signal. [Strategy Override](#parameters-in-the-strategy).<br> **Datatype:** Integer
-| `exchange.markets_refresh_interval` | 60 | The interval in minutes in which markets are reloaded.
+| `unfilledtimeout.sell` | **Required.** How long (in minutes) the bot will wait for an unfilled sell order to complete, after which the order will be cancelled and repeated at current (new) price, as long as there is a signal. [Strategy Override](#parameters-in-the-strategy).<br> **Datatype:** Integer
-| `edge` | false | Please refer to [edge configuration document](edge.md) for detailed explanation.
+| `bid_strategy.price_side` | Select the side of the spread the bot should look at to get the buy rate. [More information below](#buy-price-side).<br> *Defaults to `bid`.* <br> **Datatype:** String (either `ask` or `bid`).
-| `experimental.use_sell_signal` | false | Use your sell strategy in addition of the `minimal_roi`. [Strategy Override](#parameters-in-the-strategy).
+| `bid_strategy.ask_last_balance` | **Required.** Set the bidding price. More information [below](#buy-price-without-orderbook-enabled).
-| `experimental.sell_profit_only` | false | Waits until you have made a positive profit before taking a sell decision. [Strategy Override](#parameters-in-the-strategy).
+| `bid_strategy.use_order_book` | Enable buying using the rates in [Order Book Bids](#buy-price-with-orderbook-enabled). <br> **Datatype:** Boolean
-| `experimental.ignore_roi_if_buy_signal` | false | Does not sell if the buy-signal is still active. Takes preference over `minimal_roi` and `use_sell_signal`. [Strategy Override](#parameters-in-the-strategy).
+| `bid_strategy.order_book_top` | Bot will use the top N rate in Order Book Bids to buy. I.e. a value of 2 will allow the bot to pick the 2nd bid rate in [Order Book Bids](#buy-price-with-orderbook-enabled). <br>*Defaults to `1`.*  <br> **Datatype:** Positive Integer
-| `pairlist.method` | StaticPairList | Use static or dynamic volume-based pairlist. [More information below](#dynamic-pairlists).
+| `bid_strategy. check_depth_of_market.enabled` | Do not buy if the difference of buy orders and sell orders is met in Order Book. [Check market depth](#check-depth-of-market). <br>*Defaults to `false`.* <br> **Datatype:** Boolean
-| `pairlist.config` | None | Additional configuration for dynamic pairlists. [More information below](#dynamic-pairlists).
+| `bid_strategy. check_depth_of_market.bids_to_ask_delta` | The difference ratio of buy orders and sell orders found in Order Book. A value below 1 means sell order size is greater, while value greater than 1 means buy order size is higher. [Check market depth](#check-depth-of-market) <br> *Defaults to `0`.*  <br> **Datatype:** Float (as ratio)
-| `telegram.enabled` | true | **Required.** Enable or not the usage of Telegram.
+| `ask_strategy.price_side` | Select the side of the spread the bot should look at to get the sell rate. [More information below](#sell-price-side).<br> *Defaults to `ask`.* <br> **Datatype:** String (either `ask` or `bid`).
-| `telegram.token` | token | Your Telegram bot token. Only required if `telegram.enabled` is `true`.
+| `ask_strategy.use_order_book` | Enable selling of open trades using [Order Book Asks](#sell-price-with-orderbook-enabled). <br> **Datatype:** Boolean
-| `telegram.chat_id` | chat_id | Your personal Telegram account id. Only required if `telegram.enabled` is `true`.
+| `ask_strategy.order_book_min` | Bot will scan from the top min to max Order Book Asks searching for a profitable rate. <br>*Defaults to `1`.* <br> **Datatype:** Positive Integer
-| `webhook.enabled` | false | Enable usage of Webhook notifications
+| `ask_strategy.order_book_max` | Bot will scan from the top min to max Order Book Asks searching for a profitable rate. <br>*Defaults to `1`.* <br> **Datatype:** Positive Integer
-| `webhook.url` | false | URL for the webhook. Only required if `webhook.enabled` is `true`. See the [webhook documentation](webhook-config.md) for more details.
+| `ask_strategy.use_sell_signal` | Use sell signals produced by the strategy in addition to the `minimal_roi`. [Strategy Override](#parameters-in-the-strategy). <br>*Defaults to `true`.* <br> **Datatype:** Boolean
-| `webhook.webhookbuy` | false | Payload to send on buy. Only required if `webhook.enabled` is `true`. See the [webhook documentationV](webhook-config.md) for more details.
+| `ask_strategy.sell_profit_only` | Wait until the bot makes a positive profit before taking a sell decision. [Strategy Override](#parameters-in-the-strategy). <br>*Defaults to `false`.* <br> **Datatype:** Boolean
-| `webhook.webhooksell` | false | Payload to send on sell. Only required if `webhook.enabled` is `true`. See the [webhook documentationV](webhook-config.md) for more details.
+| `ask_strategy.ignore_roi_if_buy_signal` | Do not sell if the buy signal is still active. This setting takes preference over `minimal_roi` and `use_sell_signal`. [Strategy Override](#parameters-in-the-strategy). <br>*Defaults to `false`.* <br> **Datatype:** Boolean
-| `webhook.webhookstatus` | false | Payload to send on status calls. Only required if `webhook.enabled` is `true`. See the [webhook documentationV](webhook-config.md) for more details.
+| `order_types` | Configure order-types depending on the action (`"buy"`, `"sell"`, `"stoploss"`, `"stoploss_on_exchange"`). [More information below](#understand-order_types). [Strategy Override](#parameters-in-the-strategy).<br> **Datatype:** Dict
-| `db_url` | `sqlite:///tradesv3.sqlite`| Declares database URL to use. NOTE: This defaults to `sqlite://` if `dry_run` is `True`.
+| `order_time_in_force` | Configure time in force for buy and sell orders. [More information below](#understand-order_time_in_force). [Strategy Override](#parameters-in-the-strategy). <br> **Datatype:** Dict
-| `initial_state` | running | Defines the initial application state. More information below.
+| `exchange.name` | **Required.** Name of the exchange class to use. [List below](#user-content-what-values-for-exchangename). <br> **Datatype:** String
-| `forcebuy_enable` | false | Enables the RPC Commands to force a buy. More information below.
+| `exchange.sandbox` | Use the 'sandbox' version of the exchange, where the exchange provides a sandbox for risk-free integration. See [here](sandbox-testing.md) in more details.<br> **Datatype:** Boolean
-| `strategy` | DefaultStrategy | Defines Strategy class to use.
+| `exchange.key` | API key to use for the exchange. Only required when you are in production mode.<br>**Keep it in secret, do not disclose publicly.** <br> **Datatype:** String
-| `strategy_path` | null | Adds an additional strategy lookup path (must be a directory).
+| `exchange.secret` | API secret to use for the exchange. Only required when you are in production mode.<br>**Keep it in secret, do not disclose publicly.** <br> **Datatype:** String
-| `internals.process_throttle_secs` | 5 | **Required.** Set the process throttle. Value in second.
+| `exchange.password` | API password to use for the exchange. Only required when you are in production mode and for exchanges that use password for API requests.<br>**Keep it in secret, do not disclose publicly.** <br> **Datatype:** String
-| `internals.sd_notify` | false | Enables use of the sd_notify protocol to tell systemd service manager about changes in the bot state and issue keep-alive pings. See [here](installation.md#7-optional-configure-freqtrade-as-a-systemd-service) for more details.
+| `exchange.pair_whitelist` | List of pairs to use by the bot for trading and to check for potential trades during backtesting. Not used by VolumePairList (see [below](#pairlists-and-pairlist-handlers)). <br> **Datatype:** List
-| `logfile` | | Specify Logfile. Uses a rolling strategy of 10 files, with 1Mb per file.
+| `exchange.pair_blacklist` | List of pairs the bot must absolutely avoid for trading and backtesting (see [below](#pairlists-and-pairlist-handlers)). <br> **Datatype:** List
+| `exchange.ccxt_config` | Additional CCXT parameters passed to both ccxt instances (sync and async). This is usually the correct place for ccxt configurations. Parameters may differ from exchange to exchange and are documented in the [ccxt documentation](https://ccxt.readthedocs.io/en/latest/manual.html#instantiation) <br> **Datatype:** Dict
+| `exchange.ccxt_sync_config` | Additional CCXT parameters passed to the regular (sync) ccxt instance. Parameters may differ from exchange to exchange and are documented in the [ccxt documentation](https://ccxt.readthedocs.io/en/latest/manual.html#instantiation) <br> **Datatype:** Dict
+| `exchange.ccxt_async_config` | Additional CCXT parameters passed to the async ccxt instance. Parameters may differ from exchange to exchange  and are documented in the [ccxt documentation](https://ccxt.readthedocs.io/en/latest/manual.html#instantiation) <br> **Datatype:** Dict
+| `exchange.markets_refresh_interval` | The interval in minutes in which markets are reloaded. <br>*Defaults to `60` minutes.* <br> **Datatype:** Positive Integer
+| `exchange.skip_pair_validation` | Skip pairlist validation on startup.<br>*Defaults to `false`<br> **Datatype:** Boolean
+| `edge.*` | Please refer to [edge configuration document](edge.md) for detailed explanation.
+| `experimental.block_bad_exchanges` | Block exchanges known to not work with freqtrade. Leave on default unless you want to test if that exchange works now. <br>*Defaults to `true`.* <br> **Datatype:** Boolean
+| `pairlists` | Define one or more pairlists to be used. [More information below](#pairlists-and-pairlist-handlers). <br>*Defaults to `StaticPairList`.*  <br> **Datatype:** List of Dicts
+| `telegram.enabled` | Enable the usage of Telegram. <br> **Datatype:** Boolean
+| `telegram.token` | Your Telegram bot token. Only required if `telegram.enabled` is `true`. <br>**Keep it in secret, do not disclose publicly.** <br> **Datatype:** String
+| `telegram.chat_id` | Your personal Telegram account id. Only required if `telegram.enabled` is `true`. <br>**Keep it in secret, do not disclose publicly.** <br> **Datatype:** String
+| `webhook.enabled` | Enable usage of Webhook notifications <br> **Datatype:** Boolean
+| `webhook.url` | URL for the webhook. Only required if `webhook.enabled` is `true`. See the [webhook documentation](webhook-config.md) for more details. <br> **Datatype:** String
+| `webhook.webhookbuy` | Payload to send on buy. Only required if `webhook.enabled` is `true`. See the [webhook documentation](webhook-config.md) for more details. <br> **Datatype:** String
+| `webhook.webhookbuycancel` | Payload to send on buy order cancel. Only required if `webhook.enabled` is `true`. See the [webhook documentation](webhook-config.md) for more details. <br> **Datatype:** String
+| `webhook.webhooksell` | Payload to send on sell. Only required if `webhook.enabled` is `true`. See the [webhook documentation](webhook-config.md) for more details. <br> **Datatype:** String
+| `webhook.webhooksellcancel` | Payload to send on sell order cancel. Only required if `webhook.enabled` is `true`. See the [webhook documentation](webhook-config.md) for more details. <br> **Datatype:** String
+| `webhook.webhookstatus` | Payload to send on status calls. Only required if `webhook.enabled` is `true`. See the [webhook documentation](webhook-config.md) for more details. <br> **Datatype:** String
+| `api_server.enabled` | Enable usage of API Server. See the [API Server documentation](rest-api.md) for more details. <br> **Datatype:** Boolean
+| `api_server.listen_ip_address` | Bind IP address. See the [API Server documentation](rest-api.md) for more details. <br> **Datatype:** IPv4
+| `api_server.listen_port` | Bind Port. See the [API Server documentation](rest-api.md) for more details. <br>**Datatype:** Integer between 1024 and 65535
+| `api_server.verbosity` | Logging verbosity. `info` will print all RPC Calls, while "error" will only display errors. <br>**Datatype:** Enum, either `info` or `error`. Defaults to `info`.
+| `api_server.username` | Username for API server. See the [API Server documentation](rest-api.md) for more details. <br>**Keep it in secret, do not disclose publicly.**<br> **Datatype:** String
+| `api_server.password` | Password for API server. See the [API Server documentation](rest-api.md) for more details. <br>**Keep it in secret, do not disclose publicly.**<br> **Datatype:** String
+| `db_url` | Declares database URL to use. NOTE: This defaults to `sqlite:///tradesv3.dryrun.sqlite` if `dry_run` is `true`, and to `sqlite:///tradesv3.sqlite` for production instances. <br> **Datatype:** String, SQLAlchemy connect string
+| `initial_state` | Defines the initial application state. More information below. <br>*Defaults to `stopped`.* <br> **Datatype:** Enum, either `stopped` or `running`
+| `forcebuy_enable` | Enables the RPC Commands to force a buy. More information below. <br> **Datatype:** Boolean
+| `disable_dataframe_checks` | Disable checking the OHLCV dataframe returned from the strategy methods for correctness. Only use when intentionally changing the dataframe and understand what you are doing. [Strategy Override](#parameters-in-the-strategy).<br> *Defaults to `False`*. <br> **Datatype:** Boolean
+| `strategy` | **Required** Defines Strategy class to use. Recommended to be set via `--strategy NAME`. <br> **Datatype:** ClassName
+| `strategy_path` | Adds an additional strategy lookup path (must be a directory). <br> **Datatype:** String
+| `internals.process_throttle_secs` | Set the process throttle. Value in second. <br>*Defaults to `5` seconds.* <br> **Datatype:** Positive Integer
+| `internals.heartbeat_interval` | Print heartbeat message every N seconds. Set to 0 to disable heartbeat messages. <br>*Defaults to `60` seconds.* <br> **Datatype:** Positive Integer or 0
+| `internals.sd_notify` | Enables use of the sd_notify protocol to tell systemd service manager about changes in the bot state and issue keep-alive pings. See [here](installation.md#7-optional-configure-freqtrade-as-a-systemd-service) for more details. <br> **Datatype:** Boolean
+| `logfile` | Specifies logfile name. Uses a rolling strategy for log file rotation for 10 files with the 1MB limit per file. <br> **Datatype:** String
+| `user_data_dir` | Directory containing user data. <br> *Defaults to `./user_data/`*. <br> **Datatype:** String
+| `dataformat_ohlcv` | Data format to use to store historical candle (OHLCV) data. <br> *Defaults to `json`*. <br> **Datatype:** String
+| `dataformat_trades` | Data format to use to store historical trades data. <br> *Defaults to `jsongz`*. <br> **Datatype:** String
 
 ### Parameters in the strategy
 
 The following parameters can be set in either configuration file or strategy.
 Values set in the configuration file always overwrite values set in the strategy.
 
-* `stake_currency`
-* `stake_amount`
-* `ticker_interval`
 * `minimal_roi`
+* `timeframe`
 * `stoploss`
 * `trailing_stop`
 * `trailing_stop_positive`
 * `trailing_stop_positive_offset`
+* `trailing_only_offset_is_reached`
 * `process_only_new_candles`
 * `order_types`
 * `order_time_in_force`
-* `use_sell_signal` (experimental)
+* `stake_currency`
-* `sell_profit_only` (experimental)
+* `stake_amount`
-* `ignore_roi_if_buy_signal` (experimental)
+* `unfilledtimeout`
+* `disable_dataframe_checks`
+* `use_sell_signal` (ask_strategy)
+* `sell_profit_only` (ask_strategy)
+* `ignore_roi_if_buy_signal` (ask_strategy)
 
-### Understand stake_amount
+### Configuring amount per trade
 
-The `stake_amount` configuration parameter is an amount of crypto-currency your bot will use for each trade.
+There are several methods to configure how much of the stake currency the bot will use to enter a trade. All methods respect the [available balance configuration](#available-balance) as explained below.
-The minimal value is 0.0005. If there is not enough crypto-currency in
+
-the account an exception is generated.
+#### Available balance
-To allow the bot to trade all the available `stake_currency` in your account set
+
+By default, the bot assumes that the `complete amount - 1%` is at it's disposal, and when using [dynamic stake amount](#dynamic-stake-amount), it will split the complete balance into `max_open_trades` buckets per trade.
+Freqtrade will reserve 1% for eventual fees when entering a trade and will therefore not touch that by default.
+
+You can configure the "untouched" amount by using the `tradable_balance_ratio` setting.
+
+For example, if you have 10 ETH available in your wallet on the exchange and `tradable_balance_ratio=0.5` (which is 50%), then the bot will use a maximum amount of 5 ETH for trading and considers this as available balance. The rest of the wallet is untouched by the trades.
+
+!!! Warning
+    The `tradable_balance_ratio` setting applies to the current balance (free balance + tied up in trades). Therefore, assuming the starting balance of 1000, a configuration with `tradable_balance_ratio=0.99` will not guarantee that 10 currency units will always remain available on the exchange. For example, the free amount may reduce to 5 units if the total balance is reduced to 500 (either by a losing streak, or by withdrawing balance).
+
+#### Amend last stake amount
+
+Assuming we have the tradable balance of 1000 USDT, `stake_amount=400`, and `max_open_trades=3`.
+The bot would open 2 trades, and will be unable to fill the last trading slot, since the requested 400 USDT are no longer available, since 800 USDT are already tied in other trades.
+
+To overcome this, the option `amend_last_stake_amount` can be set to `True`, which will enable the bot to reduce stake_amount to the available balance in order to fill the last trade slot.
+
+In the example above this would mean:
+
+- Trade1: 400 USDT
+- Trade2: 400 USDT
+- Trade3: 200 USDT
+
+!!! Note
+    This option only applies with [Static stake amount](#static-stake-amount) - since [Dynamic stake amount](#dynamic-stake-amount) divides the balances evenly.
+
+!!! Note
+    The minimum last stake amount can be configured using `amend_last_stake_amount` - which defaults to 0.5 (50%). This means that the minimum stake amount that's ever used is `stake_amount * 0.5`. This avoids very low stake amounts, that are close to the minimum tradable amount for the pair and can be refused by the exchange.
+
+#### Static stake amount
+
+The `stake_amount` configuration statically configures the amount of stake-currency your bot will use for each trade.
+
+The minimal configuration value is 0.0001, however, please check your exchange's trading minimums for the stake currency you're using to avoid problems.
+
+This setting works in combination with `max_open_trades`. The maximum capital engaged in trades is `stake_amount * max_open_trades`.
+For example, the bot will at most use (0.05 BTC x 3) = 0.15 BTC, assuming a configuration of `max_open_trades=3` and `stake_amount=0.05`.
+
+!!! Note
+    This setting respects the [available balance configuration](#available-balance).
+
+#### Dynamic stake amount
+
+Alternatively, you can use a dynamic stake amount, which will use the available balance on the exchange, and divide that equally by the amount of allowed trades (`max_open_trades`).
+
+To configure this, set `stake_amount="unlimited"`. We also recommend to set `tradable_balance_ratio=0.99` (99%) - to keep a minimum balance for eventual fees.
+
+In this case a trade amount is calculated as:
+
+```python
+currency_balance / (max_open_trades - current_open_trades)
+```
+
+To allow the bot to trade all the available `stake_currency` in your account (minus `tradable_balance_ratio`) set
 
 ```json
 "stake_amount" : "unlimited",
+"tradable_balance_ratio": 0.99,
 ```
 
-In this case a trade amount is calclulated as:
+!!! Note
+    This configuration will allow increasing / decreasing stakes depending on the performance of the bot (lower stake if bot is loosing, higher stakes if the bot has a winning record, since higher balances are available).
 
-```python
+!!! Note "When using Dry-Run Mode"
-currency_balanse / (max_open_trades - current_open_trades)
+    When using `"stake_amount" : "unlimited",` in combination with Dry-Run, the balance will be simulated starting with a stake of `dry_run_wallet` which will evolve over time. It is therefore important to set `dry_run_wallet` to a sensible value (like 0.05 or 0.01 for BTC and 1000 or 100 for USDT, for example), otherwise it may simulate trades with 100 BTC (or more) or 0.05 USDT (or less) at once - which may not correspond to your real available balance or is less than the exchange minimal limit for the order amount for the stake currency.
-```
 
 ### Understand minimal_roi
 
 The `minimal_roi` configuration parameter is a JSON object where the key is a duration
-in minutes and the value is the minimum ROI in percent.
+in minutes and the value is the minimum ROI as ratio.
 See the example below:
 
 ```json
@@ -129,6 +236,9 @@ This parameter can be set in either Strategy or Configuration file. If you use i
 `minimal_roi` value from the strategy file.
 If it is not set in either Strategy or Configuration, a default of 1000% `{"0": 10}` is used, and minimal roi is disabled unless your trade generates 1000% profit.
 
+!!! Note "Special case to forcesell after a specific time"
+    A special case presents using `"<N>": -1` as ROI. This forces the bot to sell a trade after N Minutes, no matter if it's positive or negative, so represents a time-limited force-sell.
+
 ### Understand stoploss
 
 Go to the [stoploss documentation](stoploss.md) for more details.
@@ -161,29 +271,21 @@ before asking the strategy if we should buy or a sell an asset. After each wait
 every opened trade wether or not we should sell, and for all the remaining pairs (either the dynamic list of pairs or
 the static list of pairs) if we should buy.
 
-### Understand ask_last_balance
-
-The `ask_last_balance` configuration parameter sets the bidding price. Value `0.0` will use `ask` price, `1.0` will
-use the `last` price and values between those interpolate between ask and last
-price. Using `ask` price will guarantee quick success in bid, but bot will also
-end up paying more then would probably have been necessary.
-
 ### Understand order_types
 
-The `order_types` configuration parameter contains a dict mapping order-types to
+The `order_types` configuration parameter maps actions (`buy`, `sell`, `stoploss`, `emergencysell`) to order-types (`market`, `limit`, ...) as well as configures stoploss to be on the exchange and defines stoploss on exchange update interval in seconds.
-market-types as well as stoploss on or off exchange type and stoploss on exchange
-update interval in seconds. This allows to buy using limit orders, sell using
-limit-orders, and create stoploss orders using market. It also allows to set the
-stoploss "on exchange" which means stoploss order would be placed immediately once
-the buy order is fulfilled. In case stoploss on exchange and `trailing_stop` are
-both set, then the bot will use `stoploss_on_exchange_interval` to check it periodically
-and update it if necessary (e.x. in case of trailing stoploss).
-This can be set in the configuration file or in the strategy.
-Values set in the configuration file  overwrites values set in the strategy.
 
-If this is configured, all 4 values (`buy`, `sell`, `stoploss` and
+This allows to buy using limit orders, sell using
-`stoploss_on_exchange`) need to be present, otherwise the bot will warn about it and fail to start.
+limit-orders, and create stoplosses using market orders. It also allows to set the
-The below is the default which is used if this is not configured in either strategy or configuration file.
+stoploss "on exchange" which means stoploss order would be placed immediately once
+the buy order is fulfilled.
+    
+`order_types` set in the configuration file overwrites values set in the strategy as a whole, so you need to configure the whole `order_types` dictionary in one place.
+
+If this is configured, the following 4 values (`buy`, `sell`, `stoploss` and
+`stoploss_on_exchange`) need to be present, otherwise the bot will fail to start.
+
+For information on (`emergencysell`,`stoploss_on_exchange`,`stoploss_on_exchange_interval`,`stoploss_on_exchange_limit_ratio`) please see stop loss documentation [stop loss on exchange](stoploss.md)
 
 Syntax for Strategy:
 
@@ -191,9 +293,11 @@ Syntax for Strategy:
 order_types = {
     "buy": "limit",
     "sell": "limit",
+    "emergencysell": "market",
     "stoploss": "market",
     "stoploss_on_exchange": False,
-    "stoploss_on_exchange_interval": 60
+    "stoploss_on_exchange_interval": 60,
+    "stoploss_on_exchange_limit_ratio": 0.99,
 }
 ```
 
@@ -203,25 +307,30 @@ Configuration:
 "order_types": {
     "buy": "limit",
     "sell": "limit",
+    "emergencysell": "market",
     "stoploss": "market",
     "stoploss_on_exchange": false,
     "stoploss_on_exchange_interval": 60
 }
 ```
 
-!!! Note
+!!! Note "Market order support"
     Not all exchanges support "market" orders.
     The following message will be shown if your exchange does not support market orders:
-    `"Exchange <yourexchange>  does not support market orders."`
+    `"Exchange <yourexchange> does not support market orders."` and the bot will refuse to start.
 
-!!! Note
+!!! Warning "Using market orders"
-    Stoploss on exchange interval is not mandatory. Do not change its value if you are
+    Please carefully read the section [Market order pricing](#market-order-pricing) section when using market orders.
+
+!!! Note "Stoploss on exchange"
+    `stoploss_on_exchange_interval` is not mandatory. Do not change its value if you are
     unsure of what you are doing. For more information about how stoploss works please
-    read [the stoploss documentation](stoploss.md).
+    refer to [the stoploss documentation](stoploss.md).
 
-!!! Note
+    If `stoploss_on_exchange` is enabled and the stoploss is cancelled manually on the exchange, then the bot will create a new stoploss order.
-    In case of stoploss on exchange if the stoploss is cancelled manually then
+
-    the bot would recreate one.
+!!! Warning "Warning: stoploss_on_exchange failures"
+    If stoploss on exchange creation fails for some reason, then an "emergency sell" is initiated. By default, this will sell the asset using a market order. The order-type for the emergency-sell can be changed by setting the `emergencysell` value in the `order_types` dictionary - however this is not advised.
 
 ### Understand order_time_in_force
 
@@ -234,7 +343,7 @@ This is most of the time the default time in force. It means the order will rema
 on exchange till it is canceled by user. It can be fully or partially fulfilled.
 If partially fulfilled, the remaining will stay on the exchange till cancelled.
 
-**FOK (Full Or Kill):**
+**FOK (Fill Or Kill):**
 
 It means if the order is not executed immediately AND fully then it is canceled by the exchange.
 
@@ -264,16 +373,18 @@ The possible values are: `gtc` (default), `fok` or `ioc`.
 
 Freqtrade is based on [CCXT library](https://github.com/ccxt/ccxt) that supports over 100 cryptocurrency
 exchange markets and trading APIs. The complete up-to-date list can be found in the
-[CCXT repo homepage](https://github.com/ccxt/ccxt/tree/master/python). However, the bot was tested
+[CCXT repo homepage](https://github.com/ccxt/ccxt/tree/master/python).
-with only Bittrex and Binance.
+ However, the bot was tested by the development team with only Bittrex, Binance and Kraken,
-
+ so the these are the only officially supported exchanges:
-The bot was tested with the following exchanges:
 
 - [Bittrex](https://bittrex.com/): "bittrex"
 - [Binance](https://www.binance.com/): "binance"
+- [Kraken](https://kraken.com/): "kraken"
 
 Feel free to test other exchanges and submit your PR to improve the bot.
 
+Some exchanges require special configuration, which can be found on the [Exchange-specific Notes](exchanges.md) documentation page.
+
 #### Sample exchange configuration
 
 A exchange configuration for "binance" would look as follows:
@@ -297,13 +408,13 @@ This configuration enables binance, as well as rate limiting to avoid bans from
     Optimal settings for rate limiting depend on the exchange and the size of the whitelist, so an ideal parameter will vary on many other settings.
     We try to provide sensible defaults per exchange where possible, if you encounter bans please make sure that `"enableRateLimit"` is enabled and increase the `"rateLimit"` parameter step by step.
 
-#### Advanced FreqTrade Exchange configuration
+#### Advanced Freqtrade Exchange configuration
 
 Advanced options can be configured using the `_ft_has_params` setting, which will override Defaults and exchange-specific behaviours.
 
 Available options are listed in the exchange-class as `_ft_has_default`.
 
-For example, to test the order type `FOK` with Kraken, and modify candle_limit to 200 (so you only get 200 candles per call):
+For example, to test the order type `FOK` with Kraken, and modify candle limit to 200 (so you only get 200 candles per API call):
 
 ```json
 "exchange": {
@@ -336,6 +447,135 @@ The valid values are:
 "BTC", "ETH", "XRP", "LTC", "BCH", "USDT"
 ```
 
+## Prices used for orders
+
+Prices for regular orders can be controlled via the parameter structures `bid_strategy` for buying and `ask_strategy` for selling.
+Prices are always retrieved right before an order is placed, either by querying the exchange tickers or by using the orderbook data.
+
+!!! Note
+    Orderbook data used by Freqtrade are the data retrieved from exchange by the ccxt's function `fetch_order_book()`, i.e. are usually data from the L2-aggregated orderbook, while the ticker data are the structures returned by the ccxt's `fetch_ticker()`/`fetch_tickers()` functions. Refer to the ccxt library [documentation](https://github.com/ccxt/ccxt/wiki/Manual#market-data) for more details.
+
+!!! Warning "Using market orders"
+    Please read the section [Market order pricing](#market-order-pricing) section when using market orders.
+
+### Buy price
+
+#### Check depth of market
+
+When check depth of market is enabled (`bid_strategy.check_depth_of_market.enabled=True`), the buy signals are filtered based on the orderbook depth (sum of all amounts) for each orderbook side.
+
+Orderbook `bid` (buy) side depth is then divided by the orderbook `ask` (sell) side depth and the resulting delta is compared to the value of the `bid_strategy.check_depth_of_market.bids_to_ask_delta` parameter. The buy order is only executed if the orderbook delta is greater than or equal to the configured delta value.
+
+!!! Note
+    A delta value below 1 means that `ask` (sell) orderbook side depth is greater than the depth of the `bid` (buy) orderbook side, while a value greater than 1 means opposite (depth of the buy side is higher than the depth of the sell side).
+
+#### Buy price side
+
+The configuration setting `bid_strategy.price_side` defines the side of the spread the bot looks for when buying.
+
+The following displays an orderbook.
+
+``` explanation
+...
+103
+102
+101  # ask
+-------------Current spread
+99   # bid
+98
+97
+...
+```
+
+If `bid_strategy.price_side` is set to `"bid"`, then the bot will use 99 as buying price.  
+In line with that, if `bid_strategy.price_side` is set to `"ask"`, then the bot will use 101 as buying price.
+
+Using `ask` price often guarantees quicker filled orders, but the bot can also end up paying more than what would have been necessary.
+Taker fees instead of maker fees will most likely apply even when using limit buy orders.
+Also, prices at the "ask" side of the spread are higher than prices at the "bid" side in the orderbook, so the order behaves similar to a market order (however with a maximum price).
+
+#### Buy price with Orderbook enabled
+
+When buying with the orderbook enabled (`bid_strategy.use_order_book=True`), Freqtrade fetches the `bid_strategy.order_book_top` entries from the orderbook and then uses the entry specified as `bid_strategy.order_book_top` on the configured side (`bid_strategy.price_side`) of the orderbook. 1 specifies the topmost entry in the orderbook, while 2 would use the 2nd entry in the orderbook, and so on.
+
+#### Buy price without Orderbook enabled
+
+The following section uses `side` as the configured `bid_strategy.price_side`.
+
+When not using orderbook (`bid_strategy.use_order_book=False`), Freqtrade uses the best `side` price from the ticker if it's below the `last` traded price from the ticker. Otherwise (when the `side` price is above the `last` price), it calculates a rate between `side` and `last` price.
+
+The `bid_strategy.ask_last_balance` configuration parameter controls this. A value of `0.0` will use `side` price, while `1.0` will use the `last` price and values between those interpolate between ask and last price.
+
+### Sell price
+
+#### Sell price side
+
+The configuration setting `ask_strategy.price_side` defines the side of the spread the bot looks for when selling.
+
+The following displays an orderbook:
+
+``` explanation
+...
+103
+102
+101  # ask
+-------------Current spread
+99   # bid
+98
+97
+...
+```
+
+If `ask_strategy.price_side` is set to `"ask"`, then the bot will use 101 as selling price.  
+In line with that, if `ask_strategy.price_side` is set to `"bid"`, then the bot will use 99 as selling price.
+
+#### Sell price with Orderbook enabled
+
+When selling with the orderbook enabled (`ask_strategy.use_order_book=True`), Freqtrade fetches the `ask_strategy.order_book_max` entries in the orderbook. Then each of the orderbook steps between `ask_strategy.order_book_min` and `ask_strategy.order_book_max` on the configured orderbook side are validated for a profitable sell-possibility based on the strategy configuration (`minimal_roi` conditions) and the sell order is placed at the first profitable spot.
+
+!!! Note
+    Using `order_book_max` higher than `order_book_min` only makes sense when ask_strategy.price_side is set to `"ask"`.
+
+The idea here is to place the sell order early, to be ahead in the queue.
+
+A fixed slot (mirroring `bid_strategy.order_book_top`) can be defined by setting `ask_strategy.order_book_min` and `ask_strategy.order_book_max` to the same number.
+
+!!! Warning "Order_book_max > 1 - increased risks for stoplosses!"
+    Using `ask_strategy.order_book_max` higher than 1 will increase the risk the stoploss on exchange is cancelled too early, since an eventual [stoploss on exchange](#understand-order_types) will be cancelled as soon as the order is placed.
+    Also, the sell order will remain on the exchange for `unfilledtimeout.sell` (or until it's filled) - which can lead to missed stoplosses (with or without using stoploss on exchange).
+
+!!! Warning "Order_book_max > 1 in dry-run"
+    Using `ask_strategy.order_book_max` higher than 1 will result in improper dry-run results (significantly better than real orders executed on exchange), since dry-run assumes orders to be filled almost instantly.
+    It is therefore advised to not use this setting for dry-runs.
+
+#### Sell price without Orderbook enabled
+
+When not using orderbook (`ask_strategy.use_order_book=False`), the price at the `ask_strategy.price_side` side (defaults to `"ask"`) from the ticker will be used as the sell price.
+
+### Market order pricing
+
+When using market orders, prices should be configured to use the "correct" side of the orderbook to allow realistic pricing detection.
+Assuming both buy and sell are using market orders, a configuration similar to the following might be used
+
+``` jsonc
+  "order_types": {
+    "buy": "market",
+    "sell": "market"
+    // ...
+  },
+  "bid_strategy": {
+    "price_side": "ask",
+    // ...
+  },
+  "ask_strategy":{
+    "price_side": "bid",
+    // ...
+  },
+```
+
+Obviously, if only one side is using limit orders, different pricing combinations can be used.
+--8<-- "includes/pairlists.md"
+
 ## Switch to Dry-run mode
 
 We recommend starting the bot in the Dry-run mode to see how your bot will
@@ -351,7 +591,7 @@ creating trades on the exchange.
 "db_url": "sqlite:///tradesv3.dryrun.sqlite",
 ```
 
-3. Remove your Exchange API key and secrete (change them by empty values or fake credentials):
+3. Remove your Exchange API key and secret (change them by empty values or fake credentials):
 
 ```json
 "exchange": {
@@ -362,41 +602,18 @@ creating trades on the exchange.
 }
 ```
 
-Once you will be happy with your bot performance running in the Dry-run mode,
+Once you will be happy with your bot performance running in the Dry-run mode, you can switch it to production mode.
-you can switch it to production mode.
 
-### Dynamic Pairlists
+!!! Note
+    A simulated wallet is available during dry-run mode, and will assume a starting capital of `dry_run_wallet` (defaults to 1000).
 
-Dynamic pairlists select pairs for you based on the logic configured.
+### Considerations for dry-run
-The bot runs against all pairs (with that stake) on the exchange, and a number of assets
-(`number_assets`) is selected based on the selected criteria.
 
-By default, the `StaticPairList` method is used.
+* API-keys may or may not be provided. Only Read-Only operations (i.e. operations that do not alter account state) on the exchange are performed in the dry-run mode.
-The Pairlist method is configured as `pair_whitelist` parameter under the `exchange`
+* Wallets (`/balance`) are simulated.
-section of the configuration.
+* Orders are simulated, and will not be posted to the exchange.
-
+* In combination with `stoploss_on_exchange`, the stop_loss price is assumed to be filled.
-**Available Pairlist methods:**
+* Open orders (not trades, which are stored in the database) are reset on bot restart.
-
-* `StaticPairList`
-  * It uses configuration from `exchange.pair_whitelist` and `exchange.pair_blacklist`.
-* `VolumePairList`
-  * It selects `number_assets` top pairs based on `sort_key`, which can be one of
-`askVolume`, `bidVolume` and `quoteVolume`, defaults to `quoteVolume`.
-  * There is a possibility to filter low-value coins that would not allow setting a stop loss
-(set `precision_filter` parameter to `true` for this).
-
-Example:
-
-```json
-"pairlist": {
-        "method": "VolumePairList",
-        "config": {
-            "number_assets": 20,
-            "sort_key": "quoteVolume",
-            "precision_filter": false
-        }
-    },
-```
 
 ## Switch to production mode
 
@@ -404,6 +621,11 @@ In production mode, the bot will engage your money. Be careful, since a wrong
 strategy can lose all your money. Be aware of what you are doing when
 you run it in production mode.
 
+### Setup your exchange account
+
+You will need to create API Keys (usually you get `key` and `secret`, some exchanges require an additional `password`) from the Exchange website and you'll need to insert this into the appropriate fields in the configuration or when asked by the `freqtrade new-config` command.
+API Keys are usually only required for live trading (trading for real money, bot running in "production mode", executing real orders on the exchange) and are not required for the bot running in dry-run (trade simulation) mode. When you setup the bot in dry-run mode, you may fill these fields with empty values.
+
 ### To switch your bot in production mode
 
 **Edit your `config.json`  file.**
@@ -423,12 +645,11 @@ you run it in production mode.
         "secret": "08a9dc6db3d7b53e1acebd9275677f4b0a04f1a5",
         ...
 }
-
 ```
-!!! Note
-    If you have an exchange API key yet, [see our tutorial](/pre-requisite).
 
-### Using proxy with FreqTrade
+You should also make sure to read the [Exchanges](exchanges.md) section of the documentation to be aware of potential configuration details specific to your exchange.
+
+### Using proxy with Freqtrade
 
 To use a proxy with freqtrade, add the kwarg `"aiohttp_trust_env"=true` to the `"ccxt_async_kwargs"` dict in the exchange section of the configuration.
 
@@ -448,14 +669,13 @@ export HTTPS_PROXY="http://addr:port"
 freqtrade
 ```
 
+## Embedding Strategies
 
-### Embedding Strategies
+Freqtrade provides you with with an easy way to embed the strategy into your configuration file.
-
-FreqTrade provides you with with an easy way to embed the strategy into your configuration file.
 This is done by utilizing BASE64 encoding and providing this string at the strategy configuration field,
 in your chosen config file.
 
-#### Encoding a string as BASE64
+### Encoding a string as BASE64
 
 This is a quick example, how to generate the BASE64 string in python
 

docs/data-analysis.md

@@ -1,42 +1,123 @@
-# Analyzing bot data
+# Analyzing bot data with Jupyter notebooks  
 
-After performing backtests, or after running the bot for some time, it will be interesting to analyze the results your bot generated.
+You can analyze the results of backtests and trading history easily using Jupyter notebooks. Sample notebooks are located at `user_data/notebooks/` after initializing the user directory with `freqtrade create-userdir --userdir user_data`.  
 
-A good way for this is using Jupyter (notebook or lab) - which provides an interactive environment to analyze the data.
+## Quick start with docker
 
-The following helpers will help you loading the data into Pandas DataFrames, and may also give you some starting points in analyzing the results.
+Freqtrade provides a docker-compose file which starts up a jupyter lab server.
+You can run this server using the following command: `docker-compose -f docker/docker-compose-jupyter.yml up`
 
-## Backtesting
+This will create a dockercontainer running jupyter lab, which will be accessible using `https://127.0.0.1:8888/lab`.
+Please use the link that's printed in the console after startup for simplified login.
 
-To analyze your backtest results, you can [export the trades](#exporting-trades-to-file).
+For more information, Please visit the [Data analysis with Docker](docker_quickstart.md#data-analayis-using-docker-compose) section.
-You can then load the trades to perform further analysis.
 
-Freqtrade provides the `load_backtest_data()` helper function to easily load the backtest results, which takes the path to the the backtest-results file as parameter.
+### Pro tips
 
-``` python
+* See [jupyter.org](https://jupyter.org/documentation) for usage instructions.
-from freqtrade.data.btanalysis import load_backtest_data
+* Don't forget to start a Jupyter notebook server from within your conda or venv environment or use [nb_conda_kernels](https://github.com/Anaconda-Platform/nb_conda_kernels)*
-df = load_backtest_data("user_data/backtest-result.json")
+* Copy the example notebook before use so your changes don't get overwritten with the next freqtrade update.
 
-# Show value-counts per pair
+### Using virtual environment with system-wide Jupyter installation
-df.groupby("pair")["sell_reason"].value_counts()
 
+Sometimes it can be desired to use a system-wide installation of Jupyter notebook, and use a jupyter kernel from the virtual environment.
+This prevents you from installing the full jupyter suite multiple times per system, and provides an easy way to switch between tasks (freqtrade / other analytics tasks).
+
+For this to work, first activate your virtual environment and run the following commands:
+
+``` bash
+# Activate virtual environment
+source .env/bin/activate
+
+pip install ipykernel
+ipython kernel install --user --name=freqtrade
+# Restart jupyter (lab / notebook)
+# select kernel "freqtrade" in the notebook
 ```
 
-This will allow you to drill deeper into your backtest results, and perform analysis which otherwise would make the regular backtest-output very difficult to digest due to information overload.
+!!! Note
+    This section is provided for completeness, the Freqtrade Team won't provide full support for problems with this setup and will recommend to install Jupyter in the virtual environment directly, as that is the easiest way to get jupyter notebooks up and running. For help with this setup please refer to the [Project Jupyter](https://jupyter.org/) [documentation](https://jupyter.org/documentation) or [help channels](https://jupyter.org/community).
 
-If you have some ideas for interesting / helpful backtest data analysis ideas, please submit a Pull Request so the community can benefit from it.
+!!! Warning
+    Some tasks don't work especially well in notebooks. For example, anything using asynchronous execution is a problem for Jupyter. Also, freqtrade's primary entry point is the shell cli, so using pure python in a notebook bypasses arguments that provide required objects and parameters to helper functions. You may need to set those values or create expected objects manually.
 
-## Live data
+## Recommended workflow  
 
-To analyze the trades your bot generated, you can load them to a DataFrame as follows:
+| Task | Tool |  
+  --- | ---  
+Bot operations | CLI  
+Repetitive tasks | Shell scripts
+Data analysis & visualization | Notebook  
+
+1. Use the CLI to
+    * download historical data
+    * run a backtest
+    * run with real-time data
+    * export results  
+
+1. Collect these actions in shell scripts
+    * save complicated commands with arguments
+    * execute multi-step operations  
+    * automate testing strategies and preparing data for analysis
+
+1. Use a notebook to
+    * visualize data
+    * munge and plot to generate insights
+
+## Example utility snippets  
+
+### Change directory to root  
+
+Jupyter notebooks execute from the notebook directory. The following snippet searches for the project root, so relative paths remain consistent.
 
 ```python
-from freqtrade.data.btanalysis import load_trades_from_db
+import os
-
+from pathlib import Path
-df = load_trades_from_db("sqlite:///tradesv3.sqlite")
-
-df.groupby("pair")["sell_reason"].value_counts()
 
+# Change directory
+# Modify this cell to insure that the output shows the correct path.
+# Define all paths relative to the project root shown in the cell output
+project_root = "somedir/freqtrade"
+i=0
+try:
+    os.chdirdir(project_root)
+    assert Path('LICENSE').is_file()
+except:
+    while i<4 and (not Path('LICENSE').is_file()):
+        os.chdir(Path(Path.cwd(), '../'))
+        i+=1
+    project_root = Path.cwd()
+print(Path.cwd())
 ```
 
+### Load multiple configuration files
+
+This option can be useful to inspect the results of passing in multiple configs.
+This will also run through the whole Configuration initialization, so the configuration is completely initialized to be passed to other methods.
+
+``` python
+import json
+from freqtrade.configuration import Configuration
+
+# Load config from multiple files
+config = Configuration.from_files(["config1.json", "config2.json"])
+
+# Show the config in memory
+print(json.dumps(config['original_config'], indent=2))
+```
+
+For Interactive environments, have an additional configuration specifying `user_data_dir` and pass this in last, so you don't have to change directories while running the bot.
+Best avoid relative paths, since this starts at the storage location of the jupyter notebook, unless the directory is changed.
+
+``` json
+{
+    "user_data_dir": "~/.freqtrade/"
+}
+```
+
+### Further Data analysis documentation
+
+* [Strategy debugging](strategy_analysis_example.md) - also available as Jupyter notebook (`user_data/notebooks/strategy_analysis_example.ipynb`)
+* [Plotting](plotting.md)
+
 Feel free to submit an issue or Pull Request enhancing this document if you would like to share ideas on how to best analyze the data.

docs/data-download.md

@@ -0,0 +1,328 @@
+# Data Downloading
+
+## Getting data for backtesting and hyperopt
+
+To download data (candles / OHLCV) needed for backtesting and hyperoptimization use the `freqtrade download-data` command.
+
+If no additional parameter is specified, freqtrade will download data for `"1m"` and `"5m"` timeframes for the last 30 days.
+Exchange and pairs will come from `config.json` (if specified using `-c/--config`).
+Otherwise `--exchange` becomes mandatory.
+
+You can use a relative timerange (`--days 20`) or an absolute starting point (`--timerange 20200101`). For incremental downloads, the relative approach should be used.
+
+!!! Tip "Tip: Updating existing data"
+    If you already have backtesting data available in your data-directory and would like to refresh this data up to today, use `--days xx` with a number slightly higher than the missing number of days. Freqtrade will keep the available data and only download the missing data.
+    Be careful though: If the number is too small (which would result in a few missing days), the whole dataset will be removed and only xx days will be downloaded.
+
+### Usage
+
+```
+usage: freqtrade download-data [-h] [-v] [--logfile FILE] [-V] [-c PATH]
+                               [-d PATH] [--userdir PATH]
+                               [-p PAIRS [PAIRS ...]] [--pairs-file FILE]
+                               [--days INT] [--timerange TIMERANGE]
+                               [--dl-trades] [--exchange EXCHANGE]
+                               [-t {1m,3m,5m,15m,30m,1h,2h,4h,6h,8h,12h,1d,3d,1w,2w,1M,1y} [{1m,3m,5m,15m,30m,1h,2h,4h,6h,8h,12h,1d,3d,1w,2w,1M,1y} ...]]
+                               [--erase]
+                               [--data-format-ohlcv {json,jsongz,hdf5}]
+                               [--data-format-trades {json,jsongz,hdf5}]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
+                        Show profits for only these pairs. Pairs are space-
+                        separated.
+  --pairs-file FILE     File containing a list of pairs to download.
+  --days INT            Download data for given number of days.
+  --timerange TIMERANGE
+                        Specify what timerange of data to use.
+  --dl-trades           Download trades instead of OHLCV data. The bot will
+                        resample trades to the desired timeframe as specified
+                        as --timeframes/-t.
+  --exchange EXCHANGE   Exchange name (default: `bittrex`). Only valid if no
+                        config is provided.
+  -t {1m,3m,5m,15m,30m,1h,2h,4h,6h,8h,12h,1d,3d,1w,2w,1M,1y} [{1m,3m,5m,15m,30m,1h,2h,4h,6h,8h,12h,1d,3d,1w,2w,1M,1y} ...], --timeframes {1m,3m,5m,15m,30m,1h,2h,4h,6h,8h,12h,1d,3d,1w,2w,1M,1y} [{1m,3m,5m,15m,30m,1h,2h,4h,6h,8h,12h,1d,3d,1w,2w,1M,1y} ...]
+                        Specify which tickers to download. Space-separated
+                        list. Default: `1m 5m`.
+  --erase               Clean all existing data for the selected
+                        exchange/pairs/timeframes.
+  --data-format-ohlcv {json,jsongz,hdf5}
+                        Storage format for downloaded candle (OHLCV) data.
+                        (default: `json`).
+  --data-format-trades {json,jsongz,hdf5}
+                        Storage format for downloaded trades data. (default:
+                        `jsongz`).
+
+Common arguments:
+  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
+  --logfile FILE        Log to the file specified. Special values are:
+                        'syslog', 'journald'. See the documentation for more
+                        details.
+  -V, --version         show program's version number and exit
+  -c PATH, --config PATH
+                        Specify configuration file (default:
+                        `userdir/config.json` or `config.json` whichever
+                        exists). Multiple --config options may be used. Can be
+                        set to `-` to read config from stdin.
+  -d PATH, --datadir PATH
+                        Path to directory with historical backtesting data.
+  --userdir PATH, --user-data-dir PATH
+                        Path to userdata directory.
+
+```
+
+!!! Note "Startup period"
+    `download-data` is a strategy-independent command. The idea is to download a big chunk of data once, and then iteratively increase the amount of data stored.
+
+    For that reason, `download-data` does not care about the "startup-period" defined in a strategy. It's up to the user to download additional days if the backtest should start at a specific point in time (while respecting startup period).
+
+### Data format
+
+Freqtrade currently supports 3 data-formats for both OHLCV and trades data:
+
+* `json` (plain "text" json files)
+* `jsongz` (a gzip-zipped version of json files)
+* `hdf5` (a high performance datastore)
+
+By default, OHLCV data is stored as `json` data, while trades data is stored as `jsongz` data.
+
+This can be changed via the `--data-format-ohlcv` and `--data-format-trades` command line arguments respectively.
+To persist this change, you can should also add the following snippet to your configuration, so you don't have to insert the above arguments each time:
+
+``` jsonc
+    // ...
+    "dataformat_ohlcv": "hdf5",
+    "dataformat_trades": "hdf5",
+    // ...
+```
+
+If the default data-format has been changed during download, then the keys `dataformat_ohlcv` and `dataformat_trades` in the configuration file need to be adjusted to the selected dataformat as well.
+
+!!! Note
+    You can convert between data-formats using the [convert-data](#sub-command-convert-data) and [convert-trade-data](#sub-command-convert-trade-data) methods.
+
+#### Sub-command convert data
+
+```
+usage: freqtrade convert-data [-h] [-v] [--logfile FILE] [-V] [-c PATH]
+                              [-d PATH] [--userdir PATH]
+                              [-p PAIRS [PAIRS ...]] --format-from
+                              {json,jsongz,hdf5} --format-to
+                              {json,jsongz,hdf5} [--erase]
+                              [-t {1m,3m,5m,15m,30m,1h,2h,4h,6h,8h,12h,1d,3d,1w,2w,1M,1y} [{1m,3m,5m,15m,30m,1h,2h,4h,6h,8h,12h,1d,3d,1w,2w,1M,1y} ...]]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
+                        Show profits for only these pairs. Pairs are space-
+                        separated.
+  --format-from {json,jsongz,hdf5}
+                        Source format for data conversion.
+  --format-to {json,jsongz,hdf5}
+                        Destination format for data conversion.
+  --erase               Clean all existing data for the selected
+                        exchange/pairs/timeframes.
+  -t {1m,3m,5m,15m,30m,1h,2h,4h,6h,8h,12h,1d,3d,1w,2w,1M,1y} [{1m,3m,5m,15m,30m,1h,2h,4h,6h,8h,12h,1d,3d,1w,2w,1M,1y} ...], --timeframes {1m,3m,5m,15m,30m,1h,2h,4h,6h,8h,12h,1d,3d,1w,2w,1M,1y} [{1m,3m,5m,15m,30m,1h,2h,4h,6h,8h,12h,1d,3d,1w,2w,1M,1y} ...]
+                        Specify which tickers to download. Space-separated
+                        list. Default: `1m 5m`.
+
+Common arguments:
+  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
+  --logfile FILE        Log to the file specified. Special values are:
+                        'syslog', 'journald'. See the documentation for more
+                        details.
+  -V, --version         show program's version number and exit
+  -c PATH, --config PATH
+                        Specify configuration file (default:
+                        `userdir/config.json` or `config.json` whichever
+                        exists). Multiple --config options may be used. Can be
+                        set to `-` to read config from stdin.
+  -d PATH, --datadir PATH
+                        Path to directory with historical backtesting data.
+  --userdir PATH, --user-data-dir PATH
+                        Path to userdata directory.
+```
+
+##### Example converting data
+
+The following command will convert all candle (OHLCV) data available in `~/.freqtrade/data/binance` from json to jsongz, saving diskspace in the process.
+It'll also remove original json data files (`--erase` parameter).
+
+``` bash
+freqtrade convert-data --format-from json --format-to jsongz --datadir ~/.freqtrade/data/binance -t 5m 15m --erase
+```
+
+#### Sub-command convert trade data
+
+```
+usage: freqtrade convert-trade-data [-h] [-v] [--logfile FILE] [-V] [-c PATH]
+                                    [-d PATH] [--userdir PATH]
+                                    [-p PAIRS [PAIRS ...]] --format-from
+                                    {json,jsongz,hdf5} --format-to
+                                    {json,jsongz,hdf5} [--erase]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
+                        Show profits for only these pairs. Pairs are space-
+                        separated.
+  --format-from {json,jsongz,hdf5}
+                        Source format for data conversion.
+  --format-to {json,jsongz,hdf5}
+                        Destination format for data conversion.
+  --erase               Clean all existing data for the selected
+                        exchange/pairs/timeframes.
+
+Common arguments:
+  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
+  --logfile FILE        Log to the file specified. Special values are:
+                        'syslog', 'journald'. See the documentation for more
+                        details.
+  -V, --version         show program's version number and exit
+  -c PATH, --config PATH
+                        Specify configuration file (default:
+                        `userdir/config.json` or `config.json` whichever
+                        exists). Multiple --config options may be used. Can be
+                        set to `-` to read config from stdin.
+  -d PATH, --datadir PATH
+                        Path to directory with historical backtesting data.
+  --userdir PATH, --user-data-dir PATH
+                        Path to userdata directory.
+
+```
+
+##### Example converting trades
+
+The following command will convert all available trade-data in `~/.freqtrade/data/kraken` from jsongz to json.
+It'll also remove original jsongz data files (`--erase` parameter).
+
+``` bash
+freqtrade convert-trade-data --format-from jsongz --format-to json --datadir ~/.freqtrade/data/kraken --erase
+```
+
+### Sub-command list-data
+
+You can get a list of downloaded data using the `list-data` sub-command.
+
+```
+usage: freqtrade list-data [-h] [-v] [--logfile FILE] [-V] [-c PATH] [-d PATH]
+                           [--userdir PATH] [--exchange EXCHANGE]
+                           [--data-format-ohlcv {json,jsongz,hdf5}]
+                           [-p PAIRS [PAIRS ...]]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --exchange EXCHANGE   Exchange name (default: `bittrex`). Only valid if no
+                        config is provided.
+  --data-format-ohlcv {json,jsongz,hdf5}
+                        Storage format for downloaded candle (OHLCV) data.
+                        (default: `json`).
+  -p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
+                        Show profits for only these pairs. Pairs are space-
+                        separated.
+
+Common arguments:
+  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
+  --logfile FILE        Log to the file specified. Special values are:
+                        'syslog', 'journald'. See the documentation for more
+                        details.
+  -V, --version         show program's version number and exit
+  -c PATH, --config PATH
+                        Specify configuration file (default:
+                        `userdir/config.json` or `config.json` whichever
+                        exists). Multiple --config options may be used. Can be
+                        set to `-` to read config from stdin.
+  -d PATH, --datadir PATH
+                        Path to directory with historical backtesting data.
+  --userdir PATH, --user-data-dir PATH
+                        Path to userdata directory.
+
+```
+
+#### Example list-data
+
+```bash
+> freqtrade list-data --userdir ~/.freqtrade/user_data/
+
+Found 33 pair / timeframe combinations.
+pairs       timeframe
+----------  -----------------------------------------
+ADA/BTC     5m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d
+ADA/ETH     5m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d
+ETH/BTC     5m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d
+ETH/USDT    5m, 15m, 30m, 1h, 2h, 4h
+```
+
+### Pairs file
+
+In alternative to the whitelist from `config.json`, a `pairs.json` file can be used.
+
+If you are using Binance for example:
+
+- create a directory `user_data/data/binance` and copy or create the `pairs.json` file in that directory.
+- update the `pairs.json` file to contain the currency pairs you are interested in.
+
+```bash
+mkdir -p user_data/data/binance
+cp freqtrade/tests/testdata/pairs.json user_data/data/binance
+```
+
+The format of the `pairs.json` file is a simple json list.
+Mixing different stake-currencies is allowed for this file, since it's only used for downloading.
+
+``` json
+[
+    "ETH/BTC",
+    "ETH/USDT",
+    "BTC/USDT",
+    "XRP/ETH"
+]
+```
+
+### Start download
+
+Then run:
+
+```bash
+freqtrade download-data --exchange binance
+```
+
+This will download historical candle (OHLCV) data for all the currency pairs you defined in `pairs.json`.
+
+### Other Notes
+
+- To use a different directory than the exchange specific default, use `--datadir user_data/data/some_directory`.
+- To change the exchange used to download the historical data from, please use a different configuration file (you'll probably need to adjust rate limits etc.)
+- To use `pairs.json` from some other directory, use `--pairs-file some_other_dir/pairs.json`.
+- To download historical candle (OHLCV) data for only 10 days, use `--days 10` (defaults to 30 days).
+- To download historical candle (OHLCV) data from a fixed starting point, use `--timerange 20200101-` - which will download all data from January 1st, 2020. Eventually set end dates are ignored.
+- Use `--timeframes` to specify what timeframe download the historical candle (OHLCV) data for. Default is `--timeframes 1m 5m` which will download 1-minute and 5-minute data.
+- To use exchange, timeframe and list of pairs as defined in your configuration file, use the `-c/--config` option. With this, the script uses the whitelist defined in the config as the list of currency pairs to download data for and does not require the pairs.json file. You can combine `-c/--config` with most other options.
+
+### Trades (tick) data
+
+By default, `download-data` sub-command downloads Candles (OHLCV) data. Some exchanges also provide historic trade-data via their API.
+This data can be useful if you need many different timeframes, since it is only downloaded once, and then resampled locally to the desired timeframes.
+
+Since this data is large by default, the files use gzip by default. They are stored in your data-directory with the naming convention of `<pair>-trades.json.gz` (`ETH_BTC-trades.json.gz`). Incremental mode is also supported, as for historic OHLCV data, so downloading the data once per week with `--days 8` will create an incremental data-repository.
+
+To use this mode, simply add `--dl-trades` to your call. This will swap the download method to download trades, and resamples the data locally.
+
+Example call:
+
+```bash
+freqtrade download-data --exchange binance --pairs XRP/ETH ETH/BTC --days 20 --dl-trades
+```
+
+!!! Note
+    While this method uses async calls, it will be slow, since it requires the result of the previous call to generate the next request to the exchange.
+
+!!! Warning
+    The historic trades are not available during Freqtrade dry-run and live trade modes because all exchanges tested provide this data with a delay of few 100 candles, so it's not suitable for real-time trading.
+
+!!! Note "Kraken user"
+    Kraken users should read [this](exchanges.md#historic-kraken-data) before starting to download data.
+
+## Next step
+
+Great, you now have backtest data downloaded, so you can now start [backtesting](backtesting.md) your strategy.

docs/deprecated.md

@@ -4,31 +4,32 @@ This page contains description of the command line arguments, configuration para
 and the bot features that were declared as DEPRECATED by the bot development team
 and are no longer supported. Please avoid their usage in your configuration.
 
+## Removed features
+
+### the `--refresh-pairs-cached` command line option
+
+`--refresh-pairs-cached` in the context of backtesting, hyperopt and edge allows to refresh candle data for backtesting.
+Since this leads to much confusion, and slows down backtesting (while not being part of backtesting) this has been singled out as a separate freqtrade sub-command `freqtrade download-data`.
+
+This command line option was deprecated in 2019.7-dev (develop branch) and removed in 2019.9.
+
 ### The **--dynamic-whitelist** command line option
 
 This command line option was deprecated in 2018 and removed freqtrade 2019.6-dev (develop branch)
-and in freqtrade 2019.7 (master branch).
+and in freqtrade 2019.7.
 
-Per default `--dynamic-whitelist` will retrieve the 20 currencies based
+### the `--live` command line option
-on BaseVolume. This value can be changed when you run the script.
 
-**By Default**
+`--live` in the context of backtesting allowed to download the latest tick data for backtesting.
-Get the 20 currencies based on BaseVolume.
+Did only download the latest 500 candles, so was ineffective in getting good backtest data.
+Removed in 2019-7-dev (develop branch) and in freqtrade 2019.8.
 
-```bash
+### Allow running multiple pairlists in sequence
-freqtrade --dynamic-whitelist
-```
 
-**Customize the number of currencies to retrieve**
+The former `"pairlist"` section in the configuration has been removed, and is replaced by `"pairlists"` - being a list to specify a sequence of pairlists.
-Get the 30 currencies based on BaseVolume.
 
-```bash
+The old section of configuration parameters (`"pairlist"`) has been deprecated in 2019.11 and has been removed in 2020.4.
-freqtrade --dynamic-whitelist 30
-```
-
-**Exception**
-`--dynamic-whitelist` must be greater than 0. If you enter 0 or a
-negative value (e.g -2), `--dynamic-whitelist` will use the default
-value (20).
 
+### deprecation of bidVolume and askVolume from volume-pairlist
 
+Since only quoteVolume can be compared between assets, the other options (bidVolume, askVolume) have been deprecated in 2020.4, and have been removed in 2020.9.

docs/developer.md

@@ -1,8 +1,8 @@
 # Development Help
 
-This page is intended for developers of FreqTrade, people who want to contribute to the FreqTrade codebase or documentation, or people who want to understand the source code of the application they're running.
+This page is intended for developers of Freqtrade, people who want to contribute to the Freqtrade codebase or documentation, or people who want to understand the source code of the application they're running.
 
-All contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome. We [track issues](https://github.com/freqtrade/freqtrade/issues) on [GitHub](https://github.com) and also have a dev channel in [slack](https://join.slack.com/t/highfrequencybot/shared_invite/enQtNjU5ODcwNjI1MDU3LWEyODBiNzkzNzcyNzU0MWYyYzE5NjIyOTQxMzBmMGUxOTIzM2YyN2Y4NWY1YTEwZDgwYTRmMzE2NmM5ZmY2MTg) where you can ask questions.
+All contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome. We [track issues](https://github.com/freqtrade/freqtrade/issues) on [GitHub](https://github.com) and also have a dev channel on [discord](https://discord.gg/MA9v74M) or [slack](https://join.slack.com/t/highfrequencybot/shared_invite/zt-jaut7r4m-Y17k4x5mcQES9a9swKuxbg) where you can ask questions.
 
 ## Documentation
 
@@ -10,81 +10,170 @@ Documentation is available at [https://freqtrade.io](https://www.freqtrade.io/)
 
 Special fields for the documentation (like Note boxes, ...) can be found [here](https://squidfunk.github.io/mkdocs-material/extensions/admonition/).
 
+To test the documentation locally use the following commands.
+
+``` bash
+pip install -r docs/requirements-docs.txt
+mkdocs serve
+```
+
+This will spin up a local server (usually on port 8000) so you can see if everything looks as you'd like it to.
+
 ## Developer setup
 
-To configure a development environment, use best use the `setup.sh` script and answer "y" when asked "Do you want to install dependencies for dev [y/N]? ".
+To configure a development environment, you can either use the provided [DevContainer](#devcontainer-setup), or use the `setup.sh` script and answer "y" when asked "Do you want to install dependencies for dev [y/N]? ".
-Alternatively (if your system is not supported by the setup.sh script), follow the manual installation process and run `pip3 install -r requirements-dev.txt`.
+Alternatively (e.g. if your system is not supported by the setup.sh script), follow the manual installation process and run `pip3 install -e .[all]`.
 
 This will install all required tools for development, including `pytest`, `flake8`, `mypy`, and `coveralls`.
 
+### Devcontainer setup
+
+The fastest and easiest way to get started is to use [VSCode](https://code.visualstudio.com/) with the Remote container extension.
+This gives developers the ability to start the bot with all required dependencies *without* needing to install any freqtrade specific dependencies on your local machine.
+
+#### Devcontainer dependencies
+
+* [VSCode](https://code.visualstudio.com/)
+* [docker](https://docs.docker.com/install/)
+* [Remote container extension documentation](https://code.visualstudio.com/docs/remote)
+
+For more information about the [Remote container extension](https://code.visualstudio.com/docs/remote), best consult the documentation.
+
+### Tests
+
+New code should be covered by basic unittests. Depending on the complexity of the feature, Reviewers may request more in-depth unittests.
+If necessary, the Freqtrade team can assist and give guidance with writing good tests (however please don't expect anyone to write the tests for you).
+
+#### Checking log content in tests
+
+Freqtrade uses 2 main methods to check log content in tests, `log_has()` and `log_has_re()` (to check using regex, in case of dynamic log-messages).
+These are available from `conftest.py` and can be imported in any test module.
+
+A sample check looks as follows:
+
+``` python
+from tests.conftest import log_has, log_has_re
+
+def test_method_to_test(caplog):
+    method_to_test()
+
+    assert log_has("This event happened", caplog)
+    # Check regex with trailing number ...
+    assert log_has_re(r"This dynamic event happened and produced \d+", caplog)
+
+```
+
+## ErrorHandling
+
+Freqtrade Exceptions all inherit from `FreqtradeException`.
+This general class of error should however not be used directly. Instead, multiple specialized sub-Exceptions exist.
+
+Below is an outline of exception inheritance hierarchy:
+
+```
++ FreqtradeException
+|
++---+ OperationalException
+|
++---+ DependencyException
+|   |
+|   +---+ PricingError
+|   |
+|   +---+ ExchangeError
+|       |
+|       +---+ TemporaryError
+|       |
+|       +---+ DDosProtection
+|       |
+|       +---+ InvalidOrderException
+|           |
+|           +---+ RetryableOrderError
+|           |
+|           +---+ InsufficientFundsError
+|
++---+ StrategyError
+```
+
 ## Modules
 
-### Dynamic Pairlist
+### Pairlists
 
 You have a great idea for a new pair selection algorithm you would like to try out? Great.
 Hopefully you also want to contribute this back upstream.
 
-Whatever your motivations are - This should get you off the ground in trying to develop a new Pairlist provider.
+Whatever your motivations are - This should get you off the ground in trying to develop a new Pairlist Handler.
 
-First of all, have a look at the [VolumePairList](https://github.com/freqtrade/freqtrade/blob/develop/freqtrade/pairlist/VolumePairList.py) provider, and best copy this file with a name of your new Pairlist Provider.
+First of all, have a look at the [VolumePairList](https://github.com/freqtrade/freqtrade/blob/develop/freqtrade/pairlist/VolumePairList.py) Handler, and best copy this file with a name of your new Pairlist Handler.
 
-This is a simple provider, which however serves as a good example on how to start developing.
+This is a simple Handler, which however serves as a good example on how to start developing.
 
-Next, modify the classname of the provider (ideally align this with the Filename).
+Next, modify the class-name of the Handler (ideally align this with the module filename).
 
-The base-class provides the an instance of the bot (`self._freqtrade`), as well as the configuration (`self._config`), and initiates both `_blacklist` and `_whitelist`.
+The base-class provides an instance of the exchange (`self._exchange`) the pairlist manager (`self._pairlistmanager`), as well as the main configuration (`self._config`), the pairlist dedicated configuration (`self._pairlistconfig`) and the absolute position within the list of pairlists.
 
 ```python
-        self._freqtrade = freqtrade
+        self._exchange = exchange
+        self._pairlistmanager = pairlistmanager
         self._config = config
-        self._whitelist = self._config['exchange']['pair_whitelist']
+        self._pairlistconfig = pairlistconfig
-        self._blacklist = self._config['exchange'].get('pair_blacklist', [])
+        self._pairlist_pos = pairlist_pos
 ```
 
-
 Now, let's step through the methods which require actions:
 
-#### configuration
+#### Pairlist configuration
 
-Configuration for PairListProvider is done in the bot configuration file in the element `"pairlist"`.
+Configuration for the chain of Pairlist Handlers is done in the bot configuration file in the element `"pairlists"`, an array of configuration parameters for each Pairlist Handlers in the chain.
-This Pairlist-object may contain a `"config"` dict with additional configurations for the configured pairlist.
-By convention, `"number_assets"` is used to specify the maximum number of pairs to keep in the whitelist. Please follow this to ensure a consistent user experience.
 
-Additional elements can be configured as needed. `VolumePairList` uses `"sort_key"` to specify the sorting value - however feel free to specify whatever is necessary for your great algorithm to be successfull and dynamic.
+By convention, `"number_assets"` is used to specify the maximum number of pairs to keep in the pairlist. Please follow this to ensure a consistent user experience.
+
+Additional parameters can be configured as needed. For instance, `VolumePairList` uses `"sort_key"` to specify the sorting value - however feel free to specify whatever is necessary for your great algorithm to be successful and dynamic.
 
 #### short_desc
 
 Returns a description used for Telegram messages.
-This should contain the name of the Provider, as well as a short description containing the number of assets. Please follow the format `"PairlistName - top/bottom X pairs"`.
 
-#### refresh_pairlist
+This should contain the name of the Pairlist Handler, as well as a short description containing the number of assets. Please follow the format `"PairlistName - top/bottom X pairs"`.
+
+#### gen_pairlist
+
+Override this method if the Pairlist Handler can be used as the leading Pairlist Handler in the chain, defining the initial pairlist which is then handled by all Pairlist Handlers in the chain. Examples are `StaticPairList` and `VolumePairList`.
+
+This is called with each iteration of the bot (only if the Pairlist Handler is at the first location) - so consider implementing caching for compute/network heavy calculations.
+
+It must return the resulting pairlist (which may then be passed into the chain of Pairlist Handlers).
+
+Validations are optional, the parent class exposes a `_verify_blacklist(pairlist)` and `_whitelist_for_active_markets(pairlist)` to do default filtering. Use this if you limit your result to a certain number of pairs - so the end-result is not shorter than expected.
+
+#### filter_pairlist
+
+This method is called for each Pairlist Handler in the chain by the pairlist manager.
 
-Override this method and run all calculations needed in this method.
 This is called with each iteration of the bot - so consider implementing caching for compute/network heavy calculations.
 
-Assign the resulting whiteslist to `self._whitelist` and `self._blacklist` respectively. These will then be used to run the bot in this iteration. Pairs with open trades will be added to the whitelist to have the sell-methods run correctly.
+It gets passed a pairlist (which can be the result of previous pairlists) as well as `tickers`, a pre-fetched version of `get_tickers()`.
 
-Please also run `self._validate_whitelist(pairs)` and to check and remove pairs with inactive markets. This function is available in the Parent class (`StaticPairList`) and should ideally not be overwritten.
+The default implementation in the base class simply calls the `_validate_pair()` method for each pair in the pairlist, but you may override it. So you should either implement the `_validate_pair()` in your Pairlist Handler or override `filter_pairlist()` to do something else.
+
+If overridden, it must return the resulting pairlist (which may then be passed into the next Pairlist Handler in the chain).
+
+Validations are optional, the parent class exposes a `_verify_blacklist(pairlist)` and `_whitelist_for_active_markets(pairlist)` to do default filters. Use this if you limit your result to a certain number of pairs - so the end result is not shorter than expected.
+
+In `VolumePairList`, this implements different methods of sorting, does early validation so only the expected number of pairs is returned.
 
 ##### sample
 
 ``` python
-    def refresh_pairlist(self) -> None:
+    def filter_pairlist(self, pairlist: List[str], tickers: Dict) -> List[str]:
         # Generate dynamic whitelist
-        pairs = self._gen_pair_whitelist(self._config['stake_currency'], self._sort_key)
+        pairs = self._calculate_pairlist(pairlist, tickers)
-        # Validate whitelist to only have active market pairs
+        return pairs
-        self._whitelist = self._validate_whitelist(pairs)[:self._number_pairs]
 ```
 
-#### _gen_pair_whitelist
-
-This is a simple method used by `VolumePairList` - however serves as a good example.
-It implements caching (`@cached(TTLCache(maxsize=1, ttl=1800))`) as well as a configuration option to allow different (but similar) strategies to work with the same PairListProvider.
-
 ## Implement a new Exchange (WIP)
 
 !!! Note
-    This section is a Work in Progress and is not a complete guide on how to test a new exchange with FreqTrade.
+    This section is a Work in Progress and is not a complete guide on how to test a new exchange with Freqtrade.
 
 Most exchanges supported by CCXT should work out of the box.
 
@@ -92,11 +181,11 @@ Most exchanges supported by CCXT should work out of the box.
 
 Check if the new exchange supports Stoploss on Exchange orders through their API.
 
-Since CCXT does not provide unification for Stoploss On Exchange yet, we'll need to implement the exchange-specific parameters ourselfs. Best look at `binance.py` for an example implementation of this. You'll need to dig through the documentation of the Exchange's API on how exactly this can be done. [CCXT Issues](https://github.com/ccxt/ccxt/issues) may also provide great help, since others may have implemented something similar for their projects.
+Since CCXT does not provide unification for Stoploss On Exchange yet, we'll need to implement the exchange-specific parameters ourselves. Best look at `binance.py` for an example implementation of this. You'll need to dig through the documentation of the Exchange's API on how exactly this can be done. [CCXT Issues](https://github.com/ccxt/ccxt/issues) may also provide great help, since others may have implemented something similar for their projects.
 
 ### Incomplete candles
 
-While fetching OHLCV data, we're may end up getting incomplete candles (Depending on the exchange).
+While fetching candle (OHLCV) data, we may end up getting incomplete candles (depending on the exchange).
 To demonstrate this, we'll use daily candles (`"1d"`) to keep things simple.
 We query the api (`ct.fetch_ohlcv()`) for the timeframe and look at the date of the last entry. If this entry changes or shows the date of a "incomplete" candle, then we should drop this since having incomplete candles is problematic because indicators assume that only complete candles are passed to them, and will generate a lot of false buy signals. By default, we're therefore removing the last candle assuming it's incomplete.
 
@@ -105,26 +194,51 @@ To check how the new exchange behaves, you can use the following snippet:
 ``` python
 import ccxt
 from datetime import datetime
-from freqtrade.data.converter import parse_ticker_dataframe
+from freqtrade.data.converter import ohlcv_to_dataframe
 ct = ccxt.binance()
 timeframe = "1d"
 pair = "XLM/BTC"  # Make sure to use a pair that exists on that exchange!
 raw = ct.fetch_ohlcv(pair, timeframe=timeframe)
 
 # convert to dataframe
-df1 = parse_ticker_dataframe(raw, timeframe, pair=pair, drop_incomplete=False)
+df1 = ohlcv_to_dataframe(raw, timeframe, pair=pair, drop_incomplete=False)
 
-print(df1["date"].tail(1))
+print(df1.tail(1))
 print(datetime.utcnow())
 ```
 
 ``` output
-19   2019-06-08 00:00:00+00:00
+                         date      open      high       low     close  volume  
+499 2019-06-08 00:00:00+00:00  0.000007  0.000007  0.000007  0.000007   26264344.0  
 2019-06-09 12:30:27.873327
 ```
 
 The output will show the last entry from the Exchange as well as the current UTC date.
 If the day shows the same day, then the last candle can be assumed as incomplete and should be dropped (leave the setting `"ohlcv_partial_candle"` from the exchange-class untouched / True). Otherwise, set `"ohlcv_partial_candle"` to `False` to not drop Candles (shown in the example above).
+Another way is to run this command multiple times in a row and observe if the volume is changing (while the date remains the same).
+
+## Updating example notebooks
+
+To keep the jupyter notebooks aligned with the documentation, the following should be ran after updating a example notebook.
+
+``` bash
+jupyter nbconvert --ClearOutputPreprocessor.enabled=True --inplace freqtrade/templates/strategy_analysis_example.ipynb
+jupyter nbconvert --ClearOutputPreprocessor.enabled=True --to markdown freqtrade/templates/strategy_analysis_example.ipynb --stdout > docs/strategy_analysis_example.md
+```
+
+## Continuous integration
+
+This documents some decisions taken for the CI Pipeline.
+
+* CI runs on all OS variants, Linux (ubuntu), macOS and Windows.
+* Docker images are build for the branches `stable` and `develop`.
+* Docker images containing Plot dependencies are also available as `stable_plot` and `develop_plot`.
+* Raspberry PI Docker images are postfixed with `_pi` - so tags will be `:stable_pi` and `develop_pi`.
+* Docker images contain a file, `/freqtrade/freqtrade_commit` containing the commit this image is based of.
+* Full docker image rebuilds are run once a week via schedule.
+* Deployments run on ubuntu.
+* ta-lib binaries are contained in the build_helpers directory to avoid fails related to external unavailability.
+* All tests must pass for a PR to be merged to `stable` or `develop`.
 
 ## Creating a release
 
@@ -132,36 +246,69 @@ This part of the documentation is aimed at maintainers, and shows how to create
 
 ### Create release branch
 
-``` bash
+First, pick a commit that's about one week old (to not include latest additions to releases).
-# make sure you're in develop branch
-git checkout develop
 
+``` bash
 # create new branch
-git checkout -b new_release
+git checkout -b new_release <commitid>
 ```
 
-* Edit `freqtrade/__init__.py` and add the version matching the current date (for example `2019.7` for July 2019). Minor versions can be `2019.7-1` should we need to do a second release that month.
+Determine if crucial bugfixes have been made between this commit and the current state, and eventually cherry-pick these.
+
+* Merge the release branch (stable) into this branch.
+* Edit `freqtrade/__init__.py` and add the version matching the current date (for example `2019.7` for July 2019). Minor versions can be `2019.7.1` should we need to do a second release that month. Version numbers must follow allowed versions from PEP0440 to avoid failures pushing to pypi.
 * Commit this part
-* push that branch to the remote and create a PR against the master branch
+* push that branch to the remote and create a PR against the stable branch
 
 ### Create changelog from git commits
 
 !!! Note
-    Make sure that both master and develop are up-todate!.
+    Make sure that the `stable` branch is up-to-date!
 
 ``` bash
 # Needs to be done before merging / pulling that branch.
-git log --oneline --no-decorate --no-merges master..develop
+git log --oneline --no-decorate --no-merges stable..new_release
+```
+
+To keep the release-log short, best wrap the full git changelog into a collapsible details section.
+
+```markdown
+<details>
+<summary>Expand full changelog</summary>
+
+... Full git changelog
+
+</details>
 ```
 
 ### Create github release / tag
 
-* Use the button "Draft a new release" in the Github UI (subsection releases)
+Once the PR against stable is merged (best right after merging):
+
+* Use the button "Draft a new release" in the Github UI (subsection releases).
 * Use the version-number specified as tag.
-* Use "master" as reference (this step comes after the above PR is merged).
+* Use "stable" as reference (this step comes after the above PR is merged).
 * Use the above changelog as release comment (as codeblock)
 
-### After-release
+## Releases
 
-* Update version in develop by postfixing that with `-dev` (`2019.6 -> 2019.6-dev`).
+### pypi
-* Create a PR against develop to update that branch.
+
+!!! Note
+    This process is now automated as part of Github Actions.
+
+To create a pypi release, please run the following commands:
+
+Additional requirement: `wheel`, `twine` (for uploading), account on pypi with proper permissions.
+
+``` bash
+python setup.py sdist bdist_wheel
+
+# For pypi test (to check if some change to the installation did work)
+twine upload --repository-url https://test.pypi.org/legacy/ dist/*
+
+# For production:
+twine upload dist/*
+```
+
+Please don't push non-releases to the productive / real pypi instance.

docs/docker.md

@@ -1,31 +1,28 @@
-# Using FreqTrade with Docker
+## Freqtrade with docker without docker-compose
 
-## Install Docker
+!!! Warning
+    The below documentation is provided for completeness and assumes that you are familiar with running docker containers. If you're just starting out with Docker, we recommend to follow the [Quickstart](docker.md) instructions.
 
-Start by downloading and installing Docker CE for your platform:
+### Download the official Freqtrade docker image
-
-* [Mac](https://docs.docker.com/docker-for-mac/install/)
-* [Windows](https://docs.docker.com/docker-for-windows/install/)
-* [Linux](https://docs.docker.com/install/)
-
-Once you have Docker installed, simply prepare the config file (e.g. `config.json`) and run the image for `freqtrade` as explained below.
-
-## Download the official FreqTrade docker image
 
 Pull the image from docker hub.
 
-Branches / tags available can be checked out on [Dockerhub](https://hub.docker.com/r/freqtradeorg/freqtrade/tags/).
+Branches / tags available can be checked out on [Dockerhub tags page](https://hub.docker.com/r/freqtradeorg/freqtrade/tags/).
 
 ```bash
-docker pull freqtradeorg/freqtrade:develop
+docker pull freqtradeorg/freqtrade:stable
 # Optionally tag the repository so the run-commands remain shorter
-docker tag freqtradeorg/freqtrade:develop freqtrade
+docker tag freqtradeorg/freqtrade:stable freqtrade
 ```
 
 To update the image, simply run the above commands again and restart your running container.
 
 Should you require additional libraries, please [build the image yourself](#build-your-own-docker-image).
 
+!!! Note "Docker image update frequency"
+    The official docker images with tags `stable`, `develop` and `latest` are automatically rebuild once a week to keep the base image up-to-date.
+    In addition to that, every merge to `develop` will trigger a rebuild for `develop` and `latest`.
+
 ### Prepare the configuration files
 
 Even though you will use docker, you'll still need some files from the github repository.
@@ -55,39 +52,38 @@ cp -n config.json.example config.json
 
 #### Create your database file
 
-Production
+=== "Dry-Run"
-
-```bash
-touch tradesv3.sqlite
-````
-
-Dry-Run
-
     ``` bash
     touch tradesv3.dryrun.sqlite
     ```
 
-!!! Note
+=== "Production"
-    Make sure to use the path to this file when starting the bot in docker.
+    ``` bash
+    touch tradesv3.sqlite
+    ```
+
+
+!!! Warning "Database File Path"
+    Make sure to use the path to the correct database file when starting the bot in Docker.
 
 ### Build your own Docker image
 
 Best start by pulling the official docker image from dockerhub as explained [here](#download-the-official-docker-image) to speed up building.
 
-To add additional libraries to your docker image, best check out [Dockerfile.technical](https://github.com/freqtrade/freqtrade/blob/develop/Dockerfile.technical) which adds the [technical](https://github.com/freqtrade/technical) module to the image.
+To add additional libraries to your docker image, best check out [Dockerfile.technical](https://github.com/freqtrade/freqtrade/blob/develop/docker/Dockerfile.technical) which adds the [technical](https://github.com/freqtrade/technical) module to the image.
 
 ```bash
-docker build -t freqtrade -f Dockerfile.technical .
+docker build -t freqtrade -f docker/Dockerfile.technical .
 ```
 
-If you are developing using Docker, use `Dockerfile.develop` to build a dev Docker image, which will also set up develop dependencies:
+If you are developing using Docker, use `docker/Dockerfile.develop` to build a dev Docker image, which will also set up develop dependencies:
 
 ```bash
-docker build -f Dockerfile.develop -t freqtrade-dev .
+docker build -f docker/Dockerfile.develop -t freqtrade-dev .
 ```
 
-!!! Note
+!!! Warning "Include your config file manually"
-    For security reasons, your configuration file will not be included in the image, you will need to bind mount it. It is also advised to bind mount an SQLite database file (see the "5. Run a restartable docker image" section) to keep it between  updates.
+    For security reasons, your configuration file will not be included in the image, you will need to bind mount it. It is also advised to bind mount an SQLite database file (see [5. Run a restartable docker image](#run-a-restartable-docker-image)") to keep it between  updates.
 
 #### Verify the Docker image
 
@@ -108,15 +104,14 @@ docker run --rm -v `pwd`/config.json:/freqtrade/config.json -it freqtrade
 ```
 
 !!! Warning
-    In this example, the database will be created inside the docker instance and will be lost when you will refresh your image.
+    In this example, the database will be created inside the docker instance and will be lost when you refresh your image.
 
 #### Adjust timezone
 
 By default, the container will use UTC timezone.
-Should you find this irritating please add the following to your docker commands:
+If you would like to change the timezone use the following commands:
-
-##### Linux
 
+=== "Linux"
     ``` bash
     -v /etc/timezone:/etc/timezone:ro
 
@@ -124,21 +119,21 @@ Should you find this irritating please add the following to your docker commands
     docker run --rm -v /etc/timezone:/etc/timezone:ro -v `pwd`/config.json:/freqtrade/config.json -it freqtrade
     ```
 
-##### MacOS
+=== "MacOS"
-
-There is known issue in OSX Docker versions after 17.09.1, whereby `/etc/localtime` cannot be shared causing Docker to not start. A work-around for this is to start with the following cmd.
-
     ```bash
     docker run --rm -e TZ=`ls -la /etc/localtime | cut -d/ -f8-9` -v `pwd`/config.json:/freqtrade/config.json -it freqtrade
     ```
 
+!!! Note "MacOS Issues"
+    The OSX Docker versions after 17.09.1 have a known issue whereby `/etc/localtime` cannot be shared causing Docker to not start.<br>
+    A work-around for this is to start with the MacOS command above
     More information on this docker issue and work-around can be read [here](https://github.com/docker/for-mac/issues/2396).
 
 ### Run a restartable docker image
 
 To run a restartable instance in the background (feel free to place your configuration and database files wherever it feels comfortable on your filesystem).
 
-#### Move your config file and database
+#### 1. Move your config file and database
 
 The following will assume that you place your configuration / database files to `~/.freqtrade`, which is a hidden directory in your home directory. Feel free to use a different directory and replace the directory in the upcomming commands.
 
@@ -148,7 +143,7 @@ mv config.json ~/.freqtrade
 mv tradesv3.sqlite ~/.freqtrade
 ```
 
-#### Run the docker image
+#### 2. Run the docker image
 
 ```bash
 docker run -d \
@@ -156,16 +151,18 @@ docker run -d \
   -v ~/.freqtrade/config.json:/freqtrade/config.json \
   -v ~/.freqtrade/user_data/:/freqtrade/user_data \
   -v ~/.freqtrade/tradesv3.sqlite:/freqtrade/tradesv3.sqlite \
-  freqtrade --db-url sqlite:///tradesv3.sqlite --strategy MyAwesomeStrategy
+  freqtrade trade --db-url sqlite:///tradesv3.sqlite --strategy MyAwesomeStrategy
 ```
 
 !!! Note
-    db-url defaults to `sqlite:///tradesv3.sqlite` but it defaults to `sqlite://` if `dry_run=True` is being used.
+    When using docker, it's best to specify `--db-url` explicitly to ensure that the database URL and the mounted database file match.
-    To override this behaviour use a custom db-url value: i.e.: `--db-url sqlite:///tradesv3.dryrun.sqlite`
 
 !!! Note
     All available bot command line parameters can be added to the end of the `docker run` command.
 
+!!! Note
+    You can define a [restart policy](https://docs.docker.com/config/containers/start-containers-automatically/) in docker. It can be useful in some cases to use the `--restart unless-stopped` flag (crash of freqtrade or reboot of your system).
+
 ### Monitor your Docker instance
 
 You can use the following commands to monitor and manage your container:
@@ -195,7 +192,7 @@ docker run -d \
   -v ~/.freqtrade/config.json:/freqtrade/config.json \
   -v ~/.freqtrade/tradesv3.sqlite:/freqtrade/tradesv3.sqlite \
   -v ~/.freqtrade/user_data/:/freqtrade/user_data/ \
-  freqtrade --strategy AwsomelyProfitableStrategy backtesting
+  freqtrade backtesting --strategy AwsomelyProfitableStrategy
 ```
 
 Head over to the [Backtesting Documentation](backtesting.md) for more details.

docs/docker_quickstart.md

@@ -0,0 +1,191 @@
+# Using Freqtrade with Docker
+
+## Install Docker
+
+Start by downloading and installing Docker CE for your platform:
+
+* [Mac](https://docs.docker.com/docker-for-mac/install/)
+* [Windows](https://docs.docker.com/docker-for-windows/install/)
+* [Linux](https://docs.docker.com/install/)
+
+Optionally, [`docker-compose`](https://docs.docker.com/compose/install/) should be installed and available to follow the [docker quick start guide](#docker-quick-start).
+
+Once you have Docker installed, simply prepare the config file (e.g. `config.json`) and run the image for `freqtrade` as explained below.
+
+## Freqtrade with docker-compose
+
+Freqtrade provides an official Docker image on [Dockerhub](https://hub.docker.com/r/freqtradeorg/freqtrade/), as well as a [docker-compose file](https://github.com/freqtrade/freqtrade/blob/develop/docker-compose.yml) ready for usage.
+
+!!! Note
+    - The following section assumes that `docker` and `docker-compose` are installed and available to the logged in user.
+    - All below commands use relative directories and will have to be executed from the directory containing the `docker-compose.yml` file.
+
+### Docker quick start
+
+Create a new directory and place the [docker-compose file](https://github.com/freqtrade/freqtrade/blob/develop/docker-compose.yml) in this directory.
+
+=== "PC/MAC/Linux"
+    ``` bash
+    mkdir ft_userdata
+    cd ft_userdata/
+    # Download the docker-compose file from the repository
+    curl https://raw.githubusercontent.com/freqtrade/freqtrade/stable/docker-compose.yml -o docker-compose.yml
+
+    # Pull the freqtrade image
+    docker-compose pull
+
+    # Create user directory structure
+    docker-compose run --rm freqtrade create-userdir --userdir user_data
+
+    # Create configuration - Requires answering interactive questions
+    docker-compose run --rm freqtrade new-config --config user_data/config.json
+    ```
+
+=== "RaspberryPi"
+    ``` bash
+    mkdir ft_userdata
+    cd ft_userdata/
+    # Download the docker-compose file from the repository
+    curl https://raw.githubusercontent.com/freqtrade/freqtrade/stable/docker-compose.yml -o docker-compose.yml
+
+    # Pull the freqtrade image
+    docker-compose pull
+
+    # Create user directory structure
+    docker-compose run --rm freqtrade create-userdir --userdir user_data
+
+    # Create configuration - Requires answering interactive questions
+    docker-compose run --rm freqtrade new-config --config user_data/config.json
+    ```
+
+    !!! Note "Change your docker Image"
+        You have to change the docker image in the docker-compose file for your Raspberry build to work properly.
+        ``` yml
+        image: freqtradeorg/freqtrade:stable_pi
+        # image: freqtradeorg/freqtrade:develop_pi
+        ```
+
+The above snippet creates a new directory called `ft_userdata`, downloads the latest compose file and pulls the freqtrade image.
+The last 2 steps in the snippet create the directory with `user_data`, as well as (interactively) the default configuration based on your selections.
+
+!!! Question "How to edit the bot configuration?"
+    You can edit the configuration at any time, which is available as `user_data/config.json` (within the directory `ft_userdata`) when using the above configuration.
+
+    You can also change the both Strategy and commands by editing the `docker-compose.yml` file.
+
+#### Adding a custom strategy
+
+1. The configuration is now available as `user_data/config.json`
+2. Copy a custom strategy to the directory `user_data/strategies/`
+3. add the Strategy' class name to the `docker-compose.yml` file
+
+The `SampleStrategy` is run by default.
+
+!!! Warning "`SampleStrategy` is just a demo!"
+    The `SampleStrategy` is there for your reference and give you ideas for your own strategy.
+    Please always backtest the strategy and use dry-run for some time before risking real money!
+
+Once this is done, you're ready to launch the bot in trading mode (Dry-run or Live-trading, depending on your answer to the corresponding question you made above).
+
+``` bash
+docker-compose up -d
+```
+
+#### Docker-compose logs
+
+Logs will be located at: `user_data/logs/freqtrade.log`. 
+You can check the latest log with the command `docker-compose logs -f`.
+
+#### Database
+
+The database will be at: `user_data/tradesv3.sqlite`
+
+#### Updating freqtrade with docker-compose
+
+To update freqtrade when using `docker-compose` is as simple as running the following 2 commands:
+
+``` bash
+# Download the latest image
+docker-compose pull
+# Restart the image
+docker-compose up -d
+```
+
+This will first pull the latest image, and will then restart the container with the just pulled version.
+
+!!! Warning "Check the Changelog"
+    You should always check the changelog for breaking changes / manual interventions required and make sure the bot starts correctly after the update.
+
+### Editing the docker-compose file
+
+Advanced users may edit the docker-compose file further to include all possible options or arguments.
+
+All possible freqtrade arguments will be available by running `docker-compose run --rm freqtrade <command> <optional arguments>`.
+
+!!! Note "`docker-compose run --rm`"
+    Including `--rm` will clean up the container after completion, and is highly recommended for all modes except trading mode (running with `freqtrade trade` command).
+
+#### Example: Download data with docker-compose
+
+Download backtesting data for 5 days for the pair ETH/BTC and 1h timeframe from Binance. The data will be stored in the directory `user_data/data/` on the host.
+
+``` bash
+docker-compose run --rm freqtrade download-data --pairs ETH/BTC --exchange binance --days 5 -t 1h
+```
+
+Head over to the [Data Downloading Documentation](data-download.md) for more details on downloading data.
+
+#### Example: Backtest with docker-compose
+
+Run backtesting in docker-containers for SampleStrategy and specified timerange of historical data, on 5m timeframe:
+
+``` bash
+docker-compose run --rm freqtrade backtesting --config user_data/config.json --strategy SampleStrategy --timerange 20190801-20191001 -i 5m
+```
+
+Head over to the [Backtesting Documentation](backtesting.md) to learn more.
+
+### Additional dependencies with docker-compose
+
+If your strategy requires dependencies not included in the default image (like [technical](https://github.com/freqtrade/technical)) - it will be necessary to build the image on your host.
+For this, please create a Dockerfile containing installation steps for the additional dependencies (have a look at [docker/Dockerfile.technical](https://github.com/freqtrade/freqtrade/blob/develop/docker/Dockerfile.technical) for an example).
+
+You'll then also need to modify the `docker-compose.yml` file and uncomment the build step, as well as rename the image to avoid naming collisions.
+
+``` yaml
+    image: freqtrade_custom
+    build:
+      context: .
+      dockerfile: "./Dockerfile.<yourextension>"
+```
+
+You can then run `docker-compose build` to build the docker image, and run it using the commands described above.
+
+## Plotting with docker-compose
+
+Commands `freqtrade plot-profit` and `freqtrade plot-dataframe` ([Documentation](plotting.md)) are available by changing the image to `*_plot` in your docker-compose.yml file.
+You can then use these commands as follows:
+
+``` bash
+docker-compose run --rm freqtrade plot-dataframe --strategy AwesomeStrategy -p BTC/ETH --timerange=20180801-20180805
+```
+
+The output will be stored in the `user_data/plot` directory, and can be opened with any modern browser.
+
+## Data analayis using docker compose
+
+Freqtrade provides a docker-compose file which starts up a jupyter lab server.
+You can run this server using the following command:
+
+``` bash
+docker-compose --rm -f docker/docker-compose-jupyter.yml up
+```
+
+This will create a dockercontainer running jupyter lab, which will be accessible using `https://127.0.0.1:8888/lab`.
+Please use the link that's printed in the console after startup for simplified login.
+
+Since part of this image is built on your machine, it is recommended to rebuild the image from time to time to keep freqtrade (and dependencies) uptodate.
+
+``` bash
+docker-compose -f docker/docker-compose-jupyter.yml build --no-cache
+```

docs/edge.md

@@ -1,75 +1,160 @@
 # Edge positioning
 
-This page explains how to use Edge Positioning module in your bot in order to enter into a trade only if the trade has a reasonable win rate and risk reward ratio, and consequently adjust your position size and stoploss.
+The `Edge Positioning` module uses probability to calculate your win rate and risk reward ration. It will use these statistics to control your strategy trade entry points, position side and, stoploss. 
 
 !!! Warning
-    Edge positioning is not compatible with dynamic (volume-based) whitelist.
+    `Edge positioning` is not compatible with dynamic (volume-based) whitelist.
 
 !!! Note
-    Edge does not consider anything else than buy/sell/stoploss signals. So trailing stoploss, ROI, and everything else are ignored in its calculation.
+    `Edge Positioning` only considers *its own* buy/sell/stoploss signals. It ignores the stoploss, trailing stoploss, and ROI settings in the strategy configuration file.
+    `Edge Positioning` improves the performance of some trading strategies and *decreases* the performance of others.
 
 ## Introduction
-Trading is all about probability. No one can claim that he has a strategy working all the time. You have to assume that sometimes you lose.
 
-But it doesn't mean there is no rule, it only means rules should work "most of the time". Let's play a game: we toss a coin, heads: I give you 10$, tails: you give me 10$. Is it an interesting game? No, it's quite boring, isn't it?
+Trading strategies are not perfect. They are frameworks that are susceptible to the market and its indicators. Because the market is not at all predictable, sometimes a strategy will win and sometimes the same strategy will lose.
 
-But let's say the probability that we have heads is 80% (because our coin has the displaced distribution of mass or other defect), and the probability that we have tails is 20%. Now it is becoming interesting...
+To obtain an edge in the market, a strategy has to make more money than it loses. Making money in trading is not only about *how often* the strategy makes or loses money. 
 
-That means 10$ X 80% versus 10$ X 20%. 8$ versus 2$. That means over time you will win 8$ risking only 2$ on each toss of coin.
+!!! tip "It doesn't matter how often, but how much!"
+    A bad strategy might make 1 penny in *ten* transactions but lose 1 dollar in *one* transaction. If one only checks the number of winning trades, it would be misleading to think that the strategy is actually making a profit.
 
-Let's complicate it more: you win 80% of the time but only 2$, I win 20% of the time but 8$. The calculation is: 80% X 2$ versus 20% X 8$. It is becoming boring again because overtime you win $1.6$ (80% X 2$) and me $1.6 (20% X 8$) too.
+The Edge Positioning module seeks to improve a strategy's winning probability and the money that the strategy will make *on the long run*. 
 
-The question is: How do you calculate that? How do you know if you wanna play?
+We raise the following question[^1]:
 
-The answer comes to two factors:
+!!! Question "Which trade is a better option?"
-- Win Rate
+    a) A trade with 80% of chance of losing $100 and 20% chance of winning $200<br/>
-- Risk Reward Ratio
+    b) A trade with 100% of chance of losing $30
 
-### Win Rate
+???+ Info "Answer"
-Win Rate (*W*) is is the mean over some amount of trades (*N*) what is the percentage of winning trades to total number of trades (note that we don't consider how much you gained but only if you won or not).
+    The expected value of *a)* is smaller than the expected value of *b)*.<br/>
+    Hence, *b*) represents a smaller loss in the long run.<br/>
+    However, the answer is: *it depends*
 
-    W = (Number of winning trades) / (Total number of trades) = (Number of winning trades) / N
+Another way to look at it is to ask a similar question:
 
-Complementary Loss Rate (*L*) is defined as
+!!! Question "Which trade is a better option?"
+    a) A trade with 80% of chance of winning 100 and 20% chance of losing $200<br/>
+    b) A trade with 100% of chance of winning $30
 
-    L = (Number of losing trades) / (Total number of trades) = (Number of losing trades) / N
+Edge positioning tries to answer the hard questions about risk/reward and position size automatically, seeking to minimizes the chances of losing of a given strategy.
 
-or, which is the same, as
+### Trading, winning and losing
 
-    L = 1 – W
+Let's call $o$ the return of a single transaction $o$ where $o \in \mathbb{R}$. The collection $O = \{o_1, o_2, ..., o_N\}$ is the set of all returns of transactions made during a trading session. We say that $N$ is the cardinality of $O$, or, in lay terms, it is the number of transactions made in a trading session.
+
+!!! Example
+    In a session where a strategy made three transactions we can say that $O = \{3.5, -1, 15\}$. That means that $N = 3$ and $o_1 = 3.5$, $o_2 = -1$, $o_3 = 15$.
+
+A winning trade is a trade where a strategy *made* money. Making money means that the strategy closed the position in a value that returned a profit, after all deducted fees. Formally, a winning trade will have a return $o_i > 0$. Similarly, a losing trade will have a return $o_j \leq 0$. With that, we can discover the set of all winning trades, $T_{win}$, as follows:
+
+$$ T_{win} = \{ o \in O | o > 0 \} $$
+
+Similarly, we can discover the set of losing trades $T_{lose}$ as follows:
+
+$$ T_{lose} = \{o \in O | o \leq 0\} $$
+
+!!! Example
+    In a section where a strategy made three transactions $O = \{3.5, -1, 15, 0\}$:<br>
+    $T_{win} = \{3.5, 15\}$<br>
+    $T_{lose} = \{-1, 0\}$<br>
+
+### Win Rate and Lose Rate
+
+The win rate $W$ is the proportion of winning trades with respect to all the trades made by a strategy. We use the following function to compute the win rate:
+
+$$W = \frac{|T_{win}|}{N}$$
+
+Where $W$ is the win rate, $N$ is the number of trades and, $T_{win}$ is the set of all trades where the strategy made money.
+
+Similarly, we can compute the rate of losing trades:
+
+$$ 
+    L = \frac{|T_{lose}|}{N} 
+$$
+
+Where $L$ is the lose rate, $N$ is the amount of trades made and, $T_{lose}$ is the set of all trades where the strategy lost money. Note that the above formula is the same as calculating $L = 1 – W$ or $W = 1 – L$
 
 ### Risk Reward Ratio
-Risk Reward Ratio (*R*) is a formula used to measure the expected gains of a given investment against the risk of loss. It is basically what you potentially win divided by what you potentially lose:
 
-    R = Profit / Loss
+Risk Reward Ratio ($R$) is a formula used to measure the expected gains of a given investment against the risk of loss. It is basically what you potentially win divided by what you potentially lose. Formally:
 
-Over time, on many trades, you can calculate your risk reward by dividing your average profit on winning trades by your average loss on losing trades:
+$$ R = \frac{\text{potential_profit}}{\text{potential_loss}} $$
 
-    Average profit = (Sum of profits) / (Number of winning trades)
+???+ Example "Worked example of $R$ calculation"
+    Let's say that you think that the price of *stonecoin* today is $10.0. You believe that, because they will start mining stonecoin, it will go up to $15.0 tomorrow. There is the risk that the stone is too hard, and the GPUs can't mine it, so the price might go to $0 tomorrow. You are planning to invest $100, which will give you 10 shares (100 / 10).
 
-    Average loss = (Sum of losses) / (Number of losing trades)
+    Your potential profit is calculated as:
+
+    $\begin{aligned} 
+        \text{potential_profit} &= (\text{potential_price} - \text{entry_price}) * \frac{\text{investment}}{\text{entry_price}} \\
+                                &= (15 - 10) * (100 / 10) \\
+                                &= 50
+    \end{aligned}$
+
+    Since the price might go to $0, the $100 dollars invested could turn into 0.
+
+    We do however use a stoploss of 15% - so in the worst case, we'll sell 15% below entry price (or at 8.5$).
+
+    $\begin{aligned}
+        \text{potential_loss} &= (\text{entry_price} - \text{stoploss}) * \frac{\text{investment}}{\text{entry_price}} \\
+                                &= (10 - 8.5) * (100 / 10)\\
+                                &= 15
+    \end{aligned}$
+
+    We can compute the Risk Reward Ratio as follows:
+
+    $\begin{aligned}
+        R   &= \frac{\text{potential_profit}}{\text{potential_loss}}\\
+            &= \frac{50}{15}\\
+            &= 3.33
+    \end{aligned}$<br>
+    What it effectively means is that the strategy have the potential to make 3.33$ for each $1 invested.
+
+On a long horizon, that is, on many trades, we can calculate the risk reward by dividing the strategy' average profit on winning trades by the strategy' average loss on losing trades. We can calculate the average profit, $\mu_{win}$, as follows:
+
+$$ \text{average_profit} = \mu_{win} = \frac{\text{sum_of_profits}}{\text{count_winning_trades}} = \frac{\sum^{o \in T_{win}} o}{|T_{win}|} $$
+
+Similarly, we can calculate the average loss, $\mu_{lose}$, as follows:
+
+$$ \text{average_loss} = \mu_{lose} = \frac{\text{sum_of_losses}}{\text{count_losing_trades}} = \frac{\sum^{o \in T_{lose}} o}{|T_{lose}|} $$
+
+Finally, we can calculate the Risk Reward ratio, $R$, as follows:
+
+$$ R = \frac{\text{average_profit}}{\text{average_loss}} = \frac{\mu_{win}}{\mu_{lose}}\\ $$
+
+
+???+ Example "Worked example of $R$ calculation using mean profit/loss"
+    Let's say the strategy that we are using makes an average win $\mu_{win} = 2.06$ and an average loss $\mu_{loss} = 4.11$.<br>
+    We calculate the risk reward ratio as follows:<br>
+    $R = \frac{\mu_{win}}{\mu_{loss}} = \frac{2.06}{4.11} = 0.5012...$
     
-    R = (Average profit) / (Average loss)
 
 ### Expectancy
-At this point we can combine *W* and *R* to create an expectancy ratio. This is a simple process of multiplying the risk reward ratio by the percentage of winning trades and subtracting the percentage of losing trades, which is calculated as follows:
 
-    Expectancy Ratio = (Risk Reward Ratio X Win Rate) – Loss Rate = (R X W) – L
+By combining the Win Rate $W$ and and the Risk Reward ratio $R$ to create an expectancy ratio $E$. A expectance ratio is the expected return of the investment made in a trade. We can compute the value of $E$ as follows:
 
-So lets say your Win rate is 28% and your Risk Reward Ratio is 5:
+$$E = R * W - L$$
 
-    Expectancy = (5 X 0.28) – 0.72 = 0.68
+!!! Example "Calculating $E$"
+    Let's say that a strategy has a win rate $W = 0.28$ and a risk reward ratio $R = 5$. What this means is that the strategy is expected to make 5 times the investment around on 28% of the trades it makes. Working out the example:<br>
+    $E = R * W - L = 5 * 0.28 - 0.72 = 0.68$
+    <br>
 
-Superficially, this means that on average you expect this strategy’s trades to return .68 times the size of your loses. This is important for two reasons: First, it may seem obvious, but you know right away that you have a positive return. Second, you now have a number you can compare to other candidate systems to make decisions about which ones you employ.
+The expectancy worked out in the example above means that, on average, this strategy' trades will return 1.68 times the size of its losses. Said another way, the strategy makes $1.68 for every $1 it loses, on average. 
+
+This is important for two reasons: First, it may seem obvious, but you know right away that you have a positive return. Second, you now have a number you can compare to other candidate systems to make decisions about which ones you employ.
 
 It is important to remember that any system with an expectancy greater than 0 is profitable using past data. The key is finding one that will be profitable in the future.
 
 You can also use this value to evaluate the effectiveness of modifications to this system.
 
-**NOTICE:** It's important to keep in mind that Edge is testing your expectancy using historical data, there's no guarantee that you will have a similar edge in the future. It's still vital to do this testing in order to build confidence in your methodology, but be wary of "curve-fitting" your approach to the historical data as things are unlikely to play out the exact same way for future trades.
+!!! Note
+    It's important to keep in mind that Edge is testing your expectancy using historical data, there's no guarantee that you will have a similar edge in the future. It's still vital to do this testing in order to build confidence in your methodology but be wary of "curve-fitting" your approach to the historical data as things are unlikely to play out the exact same way for future trades.
 
 ## How does it work?
-If enabled in config, Edge will go through historical data with a range of stoplosses in order to find buy and sell/stoploss signals. It then calculates win rate and expectancy over *N* trades for each stoploss. Here is an example:
+
+Edge combines dynamic stoploss, dynamic positions, and whitelist generation into one isolated module which is then applied to the trading strategy. If enabled in config, Edge will go through historical data with a range of stoplosses in order to find buy and sell/stoploss signals. It then calculates win rate and expectancy over *N* trades for each stoploss. Here is an example:
 
 | Pair   |      Stoploss      |  Win Rate | Risk Reward Ratio | Expectancy |
 |----------|:-------------:|-------------:|------------------:|-----------:|
@@ -78,131 +163,69 @@ If enabled in config, Edge will go through historical data with a range of stopl
 | XZC/ETH  |  -0.03        |   0.52       |1.359670           | 0.228      |
 | XZC/ETH  |  -0.04        |   0.51       |1.234539           | 0.117      |
 
-The goal here is to find the best stoploss for the strategy in order to have the maximum expectancy. In the above example stoploss at 3% leads to the maximum expectancy according to historical data.
+The goal here is to find the best stoploss for the strategy in order to have the maximum expectancy. In the above example stoploss at $3%$ leads to the maximum expectancy according to historical data.
 
 Edge module then forces stoploss value it evaluated to your strategy dynamically.
 
 ### Position size
-Edge also dictates the stake amount for each trade to the bot according to the following factors:
+
+Edge dictates the amount at stake for each trade to the bot according to the following factors:
 
 - Allowed capital at risk
 - Stoploss
 
 Allowed capital at risk is calculated as follows:
 
+```
 Allowed capital at risk = (Capital available_percentage) X (Allowed risk per trade)
+```
 
-Stoploss is calculated as described above against historical data.
+Stoploss is calculated as described above with respect to historical data.
 
-Your position size then will be:
+The position size is calculated as follows:
 
+```
 Position size = (Allowed capital at risk) / Stoploss
+```
 
 Example:
 
-Let's say the stake currency is ETH and you have 10 ETH on the exchange, your capital available percentage is 50% and you would allow 1% of risk for each trade. thus your available capital for trading is **10 x 0.5 = 5 ETH** and allowed capital at risk would be **5 x 0.01 = 0.05 ETH**.
+Let's say the stake currency is **ETH** and there is $10$ **ETH** on the wallet. The capital available percentage is $50%$ and the allowed risk per trade is $1\%$. Thus, the available capital for trading is $10 * 0.5 = 5$ **ETH** and the allowed capital at risk would be $5 * 0.01 = 0.05$ **ETH**.
 
-Let's assume Edge has calculated that for **XLM/ETH** market your stoploss should be at 2%. So your position size will be **0.05 / 0.02 = 2.5 ETH**.
+-   **Trade 1:** The strategy detects a new buy signal in the **XLM/ETH** market. `Edge Positioning` calculates a stoploss of $2\%$ and a position of $0.05 / 0.02 = 2.5$ **ETH**. The bot takes a position of $2.5$ **ETH** in the **XLM/ETH** market.
 
-Bot takes a position of 2.5 ETH on XLM/ETH (call it trade 1). Up next, you receive another buy signal while trade 1 is still open. This time on **BTC/ETH** market. Edge calculated stoploss for this market at 4%. So your position size would be 0.05 / 0.04 = 1.25 ETH (call it trade 2).
+-   **Trade 2:** The strategy detects a buy signal on the **BTC/ETH** market while **Trade 1** is still open. `Edge Positioning` calculates the stoploss of $4\%$ on this market. Thus, **Trade 2** position size is $0.05 / 0.04 = 1.25$ **ETH**.
 
-Note that available capital for trading didn’t change for trade 2 even if you had already trade 1. The available capital doesn’t mean the free amount on your wallet.
+!!! Tip "Available Capital $\neq$ Available in wallet"
+    The available capital for trading didn't change in **Trade 2** even with **Trade 1** still open. The available capital **is not** the free amount in the wallet.
 
-Now you have two trades open. The bot receives yet another buy signal for another market: **ADA/ETH**. This time the stoploss is calculated at 1%. So your position size is **0.05 / 0.01 = 5 ETH**. But there are already 3.75 ETH blocked in two previous trades. So the position size for this third trade would be **5 – 3.75 = 1.25 ETH**.
+-   **Trade 3:** The strategy detects a buy signal in the **ADA/ETH** market. `Edge Positioning` calculates a stoploss of $1\%$ and a position of $0.05 / 0.01 = 5$ **ETH**. Since **Trade 1** has $2.5$ **ETH** blocked and **Trade 2** has $1.25$ **ETH** blocked, there is only $5 - 1.25 - 2.5 = 1.25$ **ETH** available. Hence, the position size of **Trade 3** is $1.25$ **ETH**. 
 
-Available capital doesn’t change before a position is sold. Let’s assume that trade 1 receives a sell signal and it is sold with a profit of 1 ETH. Your total capital on exchange would be 11 ETH and the available capital for trading becomes 5.5 ETH.
+!!! Tip "Available Capital Updates"
+    The available capital does not change before a position is sold. After a trade is closed the Available Capital goes up if the trade was profitable or goes down if the trade was a loss.
 
-So the Bot receives another buy signal for trade 4 with a stoploss at 2% then your position size would be **0.055 / 0.02 = 2.75 ETH**.
+-   The strategy detects a sell signal in the **XLM/ETH** market. The bot exits **Trade 1** for a profit of $1$ **ETH**. The total capital in the wallet becomes $11$ **ETH** and the available capital for trading becomes $5.5$ **ETH**.
+
+-   **Trade 4** The strategy detects a new buy signal int the **XLM/ETH** market. `Edge Positioning` calculates the stoploss of $2%$, and the position size of $0.055 / 0.02 = 2.75$ **ETH**.
 
 ## Configurations
+
 Edge module has following configuration options:
 
-#### enabled
+|  Parameter | Description |
-If true, then Edge will run periodically.
+|------------|-------------|
-
+| `enabled` | If true, then Edge will run periodically. <br>*Defaults to `false`.* <br> **Datatype:** Boolean
-(defaults to false)
+| `process_throttle_secs` | How often should Edge run in seconds. <br>*Defaults to `3600` (once per hour).* <br> **Datatype:** Integer
-
+| `calculate_since_number_of_days` | Number of days of data against which Edge calculates Win Rate, Risk Reward and Expectancy. <br> **Note** that it downloads historical data so increasing this number would lead to slowing down the bot. <br>*Defaults to `7`.* <br> **Datatype:** Integer
-#### process_throttle_secs
+| `allowed_risk` | Ratio of allowed risk per trade. <br>*Defaults to `0.01` (1%)).* <br> **Datatype:** Float
-How often should Edge run in seconds?
+| `stoploss_range_min` | Minimum stoploss. <br>*Defaults to `-0.01`.* <br> **Datatype:** Float
-
+| `stoploss_range_max` | Maximum stoploss. <br>*Defaults to `-0.10`.* <br> **Datatype:** Float
-(defaults to 3600 so one hour)
+| `stoploss_range_step` | As an example if this is set to -0.01 then Edge will test the strategy for `[-0.01, -0,02, -0,03 ..., -0.09, -0.10]` ranges. <br> **Note** than having a smaller step means having a bigger range which could lead to slow calculation. <br> If you set this parameter to -0.001, you then slow down the Edge calculation by a factor of 10. <br>*Defaults to `-0.001`.* <br> **Datatype:** Float
-
+| `minimum_winrate` | It filters out pairs which don't have at least minimum_winrate. <br>This comes handy if you want to be conservative and don't comprise win rate in favour of risk reward ratio. <br>*Defaults to `0.60`.* <br> **Datatype:** Float
-#### calculate_since_number_of_days
+| `minimum_expectancy` | It filters out pairs which have the expectancy lower than this number. <br>Having an expectancy of 0.20 means if you put 10$ on a trade you expect a 12$ return. <br>*Defaults to `0.20`.* <br> **Datatype:** Float
-Number of days of data against which Edge calculates Win Rate, Risk Reward and Expectancy
+| `min_trade_number` | When calculating *W*, *R* and *E* (expectancy) against historical data, you always want to have a minimum number of trades. The more this number is the more Edge is reliable. <br>Having a win rate of 100% on a single trade doesn't mean anything at all. But having a win rate of 70% over past 100 trades means clearly something. <br>*Defaults to `10` (it is highly recommended not to decrease this number).* <br> **Datatype:** Integer
-Note that it downloads historical data so increasing this number would lead to slowing down the bot.
+| `max_trade_duration_minute` | Edge will filter out trades with long duration. If a trade is profitable after 1 month, it is hard to evaluate the strategy based on it. But if most of trades are profitable and they have maximum duration of 30 minutes, then it is clearly a good sign.<br>**NOTICE:** While configuring this value, you should take into consideration your timeframe. As an example filtering out trades having duration less than one day for a strategy which has 4h interval does not make sense. Default value is set assuming your strategy interval is relatively small (1m or 5m, etc.).<br>*Defaults to `1440` (one day).* <br> **Datatype:** Integer
-
+| `remove_pumps` | Edge will remove sudden pumps in a given market while going through historical data. However, given that pumps happen very often in crypto markets, we recommend you keep this off.<br>*Defaults to `false`.* <br> **Datatype:** Boolean
-(defaults to 7)
-
-#### capital_available_percentage
-This is the percentage of the total capital on exchange in stake currency.
-
-As an example if you have 10 ETH available in your wallet on the exchange and this value is 0.5 (which is 50%), then the bot will use a maximum amount of 5 ETH for trading and considers it as available capital.
-
-(defaults to 0.5)
-
-#### allowed_risk
-Percentage of allowed risk per trade.
-
-(defaults to 0.01 so 1%)
-
-#### stoploss_range_min
-
-Minimum stoploss.
-
-(defaults to -0.01)
-
-#### stoploss_range_max
-
-Maximum stoploss.
-
-(defaults to -0.10)
-
-#### stoploss_range_step
-
-As an example if this is set to -0.01 then Edge will test the strategy for \[-0.01, -0,02, -0,03 ..., -0.09, -0.10\] ranges.
-Note than having a smaller step means having a bigger range which could lead to slow calculation.
-
-If you set this parameter to -0.001, you then slow down the Edge calculation by a factor of 10.
-
-(defaults to -0.01)
-
-#### minimum_winrate
-
-It filters out pairs which don't have at least minimum_winrate.
-
-This comes handy if you want to be conservative and don't comprise win rate in favour of risk reward ratio.
-
-(defaults to 0.60)
-
-#### minimum_expectancy
-
-It filters out pairs which have the expectancy lower than this number.
-
-Having an expectancy of 0.20 means if you put 10$ on a trade you expect a 12$ return.
-
-(defaults to 0.20)
-
-#### min_trade_number
-
-When calculating *W*, *R* and *E* (expectancy) against historical data, you always want to have a minimum number of trades. The more this number is the more Edge is reliable.
-
-Having a win rate of 100% on a single trade doesn't mean anything at all. But having a win rate of 70% over past 100 trades means clearly something.
-
-(defaults to 10, it is highly recommended not to decrease this number)
-
-#### max_trade_duration_minute
-
-Edge will filter out trades with long duration. If a trade is profitable after 1 month, it is hard to evaluate the strategy based on it. But if most of trades are profitable and they have maximum duration of 30 minutes, then it is clearly a good sign.
-
-**NOTICE:** While configuring this value, you should take into consideration your ticker interval. As an example filtering out trades having duration less than one day for a strategy which has 4h interval does not make sense. Default value is set assuming your strategy interval is relatively small (1m or 5m, etc.).
-
-(defaults to 1 day, i.e. to 60 * 24 = 1440 minutes)
-
-#### remove_pumps
-
-Edge will remove sudden pumps in a given market while going through historical data. However, given that pumps happen very often in crypto markets, we recommend you keep this off.
-
-(defaults to false)
 
 ## Running Edge independently
 
@@ -214,29 +237,34 @@ freqtrade edge
 
 An example of its output:
 
-| pair      |   stoploss |   win rate |   risk reward ratio |   required risk reward |   expectancy |   total number of trades |   average duration (min) |
+| **pair**     |   **stoploss** |   **win rate** |   **risk reward ratio** |   **required risk reward** |   **expectancy** |   **total number of trades** |   **average duration (min)** |
-|:----------|-----------:|-----------:|--------------------:|-----------------------:|-------------:|-------------------------:|-------------------------:|
+|:----------|-----------:|-----------:|--------------------:|-----------------------:|-------------:|-----------------:|---------------:|
-| AGI/BTC   |      -0.02 |       0.64 |                5.86 |                   0.56 |         3.41 |                       14 |                       54 |
+| **AGI/BTC**   |      -0.02 |       0.64 |                5.86 |                   0.56 |         3.41 |                       14 |                       54 |
-| NXS/BTC   |      -0.03 |       0.64 |                2.99 |                   0.57 |         1.54 |                       11 |                       26 |
+| **NXS/BTC**   |      -0.03 |       0.64 |                2.99 |                   0.57 |         1.54 |                       11 |                       26 |
-| LEND/BTC  |      -0.02 |       0.82 |                2.05 |                   0.22 |         1.50 |                       11 |                       36 |
+| **LEND/BTC**  |      -0.02 |       0.82 |                2.05 |                   0.22 |         1.50 |                       11 |                       36 |
-| VIA/BTC   |      -0.01 |       0.55 |                3.01 |                   0.83 |         1.19 |                       11 |                       48 |
+| **VIA/BTC**   |      -0.01 |       0.55 |                3.01 |                   0.83 |         1.19 |                       11 |                       48 |
-| MTH/BTC   |      -0.09 |       0.56 |                2.82 |                   0.80 |         1.12 |                       18 |                       52 |
+| **MTH/BTC**   |      -0.09 |       0.56 |                2.82 |                   0.80 |         1.12 |                       18 |                       52 |
-| ARDR/BTC  |      -0.04 |       0.42 |                3.14 |                   1.40 |         0.73 |                       12 |                       42 |
+| **ARDR/BTC**  |      -0.04 |       0.42 |                3.14 |                   1.40 |         0.73 |                       12 |                       42 |
-| BCPT/BTC  |      -0.01 |       0.71 |                1.34 |                   0.40 |         0.67 |                       14 |                       30 |
+| **BCPT/BTC**  |      -0.01 |       0.71 |                1.34 |                   0.40 |         0.67 |                       14 |                       30 |
-| WINGS/BTC |      -0.02 |       0.56 |                1.97 |                   0.80 |         0.65 |                       27 |                       42 |
+| **WINGS/BTC** |      -0.02 |       0.56 |                1.97 |                   0.80 |         0.65 |                       27 |                       42 |
-| VIBE/BTC  |      -0.02 |       0.83 |                0.91 |                   0.20 |         0.59 |                       12 |                       35 |
+| **VIBE/BTC**  |      -0.02 |       0.83 |                0.91 |                   0.20 |         0.59 |                       12 |                       35 |
-| MCO/BTC   |      -0.02 |       0.79 |                0.97 |                   0.27 |         0.55 |                       14 |                       31 |
+| **MCO/BTC**   |      -0.02 |       0.79 |                0.97 |                   0.27 |         0.55 |                       14 |                       31 |
-| GNT/BTC   |      -0.02 |       0.50 |                2.06 |                   1.00 |         0.53 |                       18 |                       24 |
+| **GNT/BTC**   |      -0.02 |       0.50 |                2.06 |                   1.00 |         0.53 |                       18 |                       24 |
-| HOT/BTC   |      -0.01 |       0.17 |                7.72 |                   4.81 |         0.50 |                      209 |                        7 |
+| **HOT/BTC**   |      -0.01 |       0.17 |                7.72 |                   4.81 |         0.50 |                      209 |                        7 |
-| SNM/BTC   |      -0.03 |       0.71 |                1.06 |                   0.42 |         0.45 |                       17 |                       38 |
+| **SNM/BTC**   |      -0.03 |       0.71 |                1.06 |                   0.42 |         0.45 |                       17 |                       38 |
-| APPC/BTC  |      -0.02 |       0.44 |                2.28 |                   1.27 |         0.44 |                       25 |                       43 |
+| **APPC/BTC**  |      -0.02 |       0.44 |                2.28 |                   1.27 |         0.44 |                       25 |                       43 |
-| NEBL/BTC  |      -0.03 |       0.63 |                1.29 |                   0.58 |         0.44 |                       19 |                       59 |
+| **NEBL/BTC**  |      -0.03 |       0.63 |                1.29 |                   0.58 |         0.44 |                       19 |                       59 |
+
+Edge produced the above table by comparing `calculate_since_number_of_days` to `minimum_expectancy` to find `min_trade_number` historical information based on the config file. The timerange Edge uses for its comparisons can be further limited by using the `--timerange` switch.
+
+In live and dry-run modes, after the `process_throttle_secs` has passed, Edge will again process `calculate_since_number_of_days` against `minimum_expectancy` to find `min_trade_number`. If no `min_trade_number` is found, the bot will return "whitelist empty". Depending on the trade strategy being deployed, "whitelist empty" may be return much of the time - or *all* of the time. The use of Edge may also cause trading to occur in bursts, though this is rare.
+
+If you encounter "whitelist empty" a lot, condsider tuning `calculate_since_number_of_days`, `minimum_expectancy`  and `min_trade_number` to align to the trading frequency of your strategy.
 
 ### Update cached pairs with the latest data
 
-```bash
+Edge requires historic data the same way as backtesting does.
-freqtrade edge --refresh-pairs-cached
+Please refer to the [Data Downloading](data-download.md) section of the documentation for details.
-```
 
 ### Precising stoploss range
 
@@ -250,14 +278,14 @@ freqtrade edge --stoplosses=-0.01,-0.1,-0.001 #min,max,step
 freqtrade edge --timerange=20181110-20181113
 ```
 
-Doing `--timerange=-200` will get the last 200 timeframes from your inputdata. You can also specify specific dates, or a range span indexed by start and stop.
+Doing `--timerange=-20190901` will get all available data until September 1st (excluding September 1st 2019).
 
 The full timerange specification:
 
-* Use last 123 tickframes of data: `--timerange=-123`
-* Use first 123 tickframes of data: `--timerange=123-`
-* Use tickframes from line 123 through 456: `--timerange=123-456`
 * Use tickframes till 2018/01/31: `--timerange=-20180131`
 * Use tickframes since 2018/01/31: `--timerange=20180131-`
 * Use tickframes since 2018/01/31 till 2018/03/01 : `--timerange=20180131-20180301`
 * Use tickframes between POSIX timestamps 1527595200 1527618600: `--timerange=1527595200-1527618600`
+
+
+[^1]: Question extracted from MIT Opencourseware S096 - Mathematics with applications in Finance: https://ocw.mit.edu/courses/mathematics/18-s096-topics-in-mathematics-with-applications-in-finance-fall-2013/

docs/exchanges.md

@@ -0,0 +1,119 @@
+# Exchange-specific Notes
+
+This page combines common gotchas and informations which are exchange-specific and most likely don't apply to other exchanges.
+
+## Binance
+
+!!! Tip "Stoploss on Exchange"
+    Binance supports `stoploss_on_exchange` and uses stop-loss-limit orders. It provides great advantages, so we recommend to benefit from it.
+
+### Blacklists
+
+For Binance, please add `"BNB/<STAKE>"` to your blacklist to avoid issues.
+Accounts having BNB accounts use this to pay for fees - if your first trade happens to be on `BNB`, further trades will consume this position and make the initial BNB order unsellable as the expected amount is not there anymore.
+
+### Binance sites
+
+Binance has been split into 3, and users must use the correct ccxt exchange ID for their exchange, otherwise API keys are not recognized.
+
+* [binance.com](https://www.binance.com/) - International users. Use exchange id: `binance`.
+* [binance.us](https://www.binance.us/) - US based users. Use exchange id: `binanceus`.
+* [binance.je](https://www.binance.je/) - Binance Jersey, trading fiat currencies. Use exchange id: `binanceje`.
+
+## Kraken
+
+!!! Tip "Stoploss on Exchange"
+    Kraken supports `stoploss_on_exchange` and uses stop-loss-market orders. It provides great advantages, so we recommend to benefit from it, however since the resulting order is a stoploss-market order, sell-rates are not guaranteed, which makes this feature less secure than on other exchanges. This limitation is based on kraken's policy [source](https://blog.kraken.com/post/1234/announcement-delisting-pairs-and-temporary-suspension-of-advanced-order-types/) and [source2](https://blog.kraken.com/post/1494/kraken-enables-advanced-orders-and-adds-10-currency-pairs/) - which has stoploss-limit orders disabled.
+
+### Historic Kraken data
+
+The Kraken API does only provide 720 historic candles, which is sufficient for Freqtrade dry-run and live trade modes, but is a problem for backtesting.
+To download data for the Kraken exchange, using `--dl-trades` is mandatory, otherwise the bot will download the same 720 candles over and over, and you'll not have enough backtest data.
+
+Due to the heavy rate-limiting applied by Kraken, the following configuration section should be used to download data:
+
+``` json
+    "ccxt_async_config": {
+        "enableRateLimit": true,
+        "rateLimit": 3100
+    },
+```
+
+## Bittrex
+
+### Order types
+
+Bittrex does not support market orders. If you have a message at the bot startup about this, you should change order type values set in your configuration and/or in the strategy from `"market"` to `"limit"`. See some more details on this [here in the FAQ](faq.md#im-getting-the-exchange-bittrex-does-not-support-market-orders-message-and-cannot-run-my-strategy).
+
+### Restricted markets
+
+Bittrex split its exchange into US and International versions.
+The International version has more pairs available, however the API always returns all pairs, so there is currently no automated way to detect if you're affected by the restriction.
+
+If you have restricted pairs in your whitelist, you'll get a warning message in the log on Freqtrade startup for each restricted pair.
+
+The warning message will look similar to the following:
+
+``` output
+[...] Message: bittrex {"success":false,"message":"RESTRICTED_MARKET","result":null,"explanation":null}"
+```
+
+If you're an "International" customer on the Bittrex exchange, then this warning will probably not impact you.
+If you're a US customer, the bot will fail to create orders for these pairs, and you should remove them from your whitelist.
+
+You can get a list of restricted markets by using the following snippet:
+
+``` python
+import ccxt
+ct = ccxt.bittrex()
+_ = ct.load_markets()
+res = [ f"{x['MarketCurrency']}/{x['BaseCurrency']}" for x in ct.publicGetMarkets()['result'] if x['IsRestricted']]
+print(res)
+```
+
+## FTX
+
+!!! Tip "Stoploss on Exchange"
+    FTX supports `stoploss_on_exchange` and can use both stop-loss-market and stop-loss-limit orders. It provides great advantages, so we recommend to benefit from it.
+    You can use either `"limit"` or `"market"` in the `order_types.stoploss` configuration setting to decide.
+
+
+### Using subaccounts
+
+To use subaccounts with FTX, you need to edit the configuration and add the following:
+
+``` json
+"exchange": {
+    "ccxt_config": {
+        "headers": {
+            "FTX-SUBACCOUNT": "name"
+        }
+    },
+}
+```
+
+!!! Note
+    Older versions of freqtrade may require this key to be added to `"ccxt_async_config"` as well.
+
+## All exchanges
+
+Should you experience constant errors with Nonce (like `InvalidNonce`), it is best to regenerate the API keys. Resetting Nonce is difficult and it's usually easier to regenerate the API keys.
+
+
+## Random notes for other exchanges
+
+* The Ocean (exchange id: `theocean`) exchange uses Web3 functionality and requires `web3` python package to be installed:
+```shell
+$ pip3 install web3
+```
+
+### Getting latest price / Incomplete candles
+
+Most exchanges return current incomplete candle via their OHLCV/klines API interface.
+By default, Freqtrade assumes that incomplete candle is fetched from the exchange and removes the last candle assuming it's the incomplete candle.
+
+Whether your exchange returns incomplete candles or not can be checked using [the helper script](developer.md#Incomplete-candles) from the Contributor documentation.
+
+Due to the danger of repainting, Freqtrade does not allow you to use this incomplete candle.
+
+However, if it is based on the need for the latest price for your strategy - then this requirement can be acquired using the [data provider](strategy-customization.md#possible-options-for-dataprovider) from within the strategy.

docs/faq.md

@@ -1,10 +1,14 @@
 # Freqtrade FAQ
 
+## Beginner Tips & Tricks
+
+* When you work with your strategy & hyperopt file you should use a proper code editor like vscode or Pycharm. A good code editor will provide syntax highlighting as well as line numbers, making it easy to find syntax errors (most likely, pointed out by Freqtrade during startup).
+
 ## Freqtrade common issues
 
 ### The bot does not start
 
-Running the bot with `freqtrade --config config.json` does show the output `freqtrade: command not found`.
+Running the bot with `freqtrade trade --config config.json` does show the output `freqtrade: command not found`.
 
 This could have the following reasons:
 
@@ -15,10 +19,12 @@ This could have the following reasons:
 
 ### I have waited 5 minutes, why hasn't the bot made any trades yet?!
 
-Depending on the buy strategy, the amount of whitelisted coins, the
+* Depending on the buy strategy, the amount of whitelisted coins, the
 situation of the market etc, it can take up to hours to find good entry
 position for a trade. Be patient!
 
+* Or it may because of a configuration error? Best check the logs, it's usually telling you if the bot is simply not getting buy signals (only heartbeat messages), or if there is something wrong (errors / exceptions in the log).
+
 ### I have made 12 trades already, why is my total profit negative?!
 
 I understand your disappointment but unfortunately 12 trades is just
@@ -38,42 +44,112 @@ like pauses. You can stop your bot, adjust settings and start it again.
 
 ### I want to improve the bot with a new strategy
 
-That's great. We have a nice backtesting and hyperoptimizing setup. See
+That's great. We have a nice backtesting and hyperoptimization setup. See
 the tutorial [here|Testing-new-strategies-with-Hyperopt](bot-usage.md#hyperopt-commands).
 
 ### Is there a setting to only SELL the coins being held and not perform anymore BUYS?
 
 You can use the `/forcesell all` command from Telegram.
 
+### I want to run multiple bots on the same machine
+
+Please look at the [advanced setup documentation Page](advanced-setup.md#running-multiple-instances-of-freqtrade).
+
+### I'm getting "Missing data fillup" messages in the log
+
+This message is just a warning that the latest candles had missing candles in them.
+Depending on the exchange, this can indicate that the pair didn't have a trade for the timeframe you are using - and the exchange does only return candles with volume.
+On low volume pairs, this is a rather common occurance.
+
+If this happens for all pairs in the pairlist, this might indicate a recent exchange downtime. Please check your exchange's public channels for details.
+
+Irrespectively of the reason, Freqtrade will fill up these candles with "empty" candles, where open, high, low and close are set to the previous candle close - and volume is empty. In a chart, this will look like a `_` - and is aligned with how exchanges usually represent 0 volume candles.
+
+### I'm getting the "RESTRICTED_MARKET" message in the log
+
+Currently known to happen for US Bittrex users.  
+
+Read [the Bittrex section about restricted markets](exchanges.md#restricted-markets) for more information.
+
+### I'm getting the "Exchange Bittrex does not support market orders." message and cannot run my strategy
+
+As the message says, Bittrex does not support market orders and you have one of the [order types](configuration.md/#understand-order_types) set to "market". Probably your strategy was written with other exchanges in mind and sets "market" orders for "stoploss" orders, which is correct and preferable for most of the exchanges supporting market orders (but not for Bittrex).
+
+To fix it for Bittrex, redefine order types in the strategy to use "limit" instead of "market":
+
+```
+    order_types = {
+        ...
+        'stoploss': 'limit',
+        ...
+    }
+```
+
+Same fix should be done in the configuration file, if order types are defined in your custom config rather than in the strategy.
+
+### How do I search the bot logs for something?
+
+By default, the bot writes its log into stderr stream. This is implemented this way so that you can easily separate the bot's diagnostics messages from Backtesting, Edge and Hyperopt results, output from other various Freqtrade utility sub-commands, as well as from the output of your custom `print()`'s you may have inserted into your strategy. So if you need to search the log messages with the grep utility, you need to redirect stderr to stdout and disregard stdout.
+
+* In unix shells, this normally can be done as simple as:
+```shell
+$ freqtrade --some-options 2>&1 >/dev/null | grep 'something'
+```
+(note, `2>&1` and `>/dev/null` should be written in this order)
+
+* Bash interpreter also supports so called process substitution syntax, you can grep the log for a string with it as:
+```shell
+$ freqtrade --some-options 2> >(grep 'something') >/dev/null
+```
+or
+```shell
+$ freqtrade --some-options 2> >(grep -v 'something' 1>&2)
+```
+
+* You can also write the copy of Freqtrade log messages to a file with the `--logfile` option:
+```shell
+$ freqtrade --logfile /path/to/mylogfile.log --some-options
+```
+and then grep it as:
+```shell
+$ cat /path/to/mylogfile.log | grep 'something'
+```
+or even on the fly, as the bot works and the log file grows:
+```shell
+$ tail -f /path/to/mylogfile.log | grep 'something'
+```
+from a separate terminal window.
+
+On Windows, the `--logfile` option is also supported by Freqtrade and you can use the `findstr` command to search the log for the string of interest:
+```
+> type \path\to\mylogfile.log | findstr "something"
+```
+
 ## Hyperopt module
 
 ### How many epoch do I need to get a good Hyperopt result?
 
-Per default Hyperopts without `-e` or `--epochs` parameter will only
+Per default Hyperopt called without the `-e`/`--epochs` command line option will only
 run 100 epochs, means 100 evals of your triggers, guards, ... Too few
 to find a great result (unless if you are very lucky), so you probably
 have to run it for 10.000 or more. But it will take an eternity to
 compute.
 
-We recommend you to run it at least 10.000 epochs:
+Since hyperopt uses Bayesian search, running for too many epochs may not produce greater results.
+
+It's therefore recommended to run between 500-1000 epochs over and over until you hit at least 10.000 epochs in total (or are satisfied with the result). You can best judge by looking at the results - if the bot keeps discovering better strategies, it's best to keep on going.
 
 ```bash
-freqtrade hyperopt -e 10000
+freqtrade hyperopt --hyperop SampleHyperopt --hyperopt-loss SharpeHyperOptLossDaily --strategy SampleStrategy -e 1000
 ```
 
-or if you want intermediate result to see
+### Why does it take a long time to run hyperopt?
 
-```bash
+* Discovering a great strategy with Hyperopt takes time. Study www.freqtrade.io, the Freqtrade Documentation page, join the Freqtrade [Slack community](https://join.slack.com/t/highfrequencybot/shared_invite/zt-jaut7r4m-Y17k4x5mcQES9a9swKuxbg) - or the Freqtrade [discord community](https://discord.gg/X89cVG). While you patiently wait for the most advanced, free crypto bot in the world, to hand you a possible golden strategy specially designed just for you.
-for i in {1..100}; do freqtrade hyperopt -e 100; done
-```
 
-### Why it is so long to run hyperopt?
+* If you wonder why it can take from 20 minutes to days to do 1000 epochs here are some answers:
 
-Finding a great Hyperopt results takes time.
+This answer was written during the release 0.15.1, when we had:
-
-If you wonder why it takes a while to find great hyperopt results
-
-This answer was written during the under the release 0.15.1, when we had:
 
 - 8 triggers
 - 9 guards: let's say we evaluate even 10 values from each
@@ -83,7 +159,14 @@ The following calculation is still very rough and not very precise
 but it will give the idea. With only these triggers and guards there is
 already 8\*10^9\*10 evaluations. A roughly total of 80 billion evals.
 Did you run 100 000 evals? Congrats, you've done roughly 1 / 100 000 th
-of the search space.
+of the search space, assuming that the bot never tests the same parameters more than once.
+
+* The time it takes to run 1000 hyperopt epochs depends on things like: The available cpu, hard-disk, ram, timeframe, timerange, indicator settings, indicator count, amount of coins that hyperopt test strategies on and the resulting trade count - which can be 650 trades in a year or 10.0000 trades depending if the strategy aims for big profits by trading rarely or for many low profit trades. 
+
+Example: 4% profit 650 times vs 0,3% profit a trade 10.000 times in a year. If we assume you set the --timerange to 365 days. 
+
+Example: 
+`freqtrade --config config.json --strategy SampleStrategy --hyperopt SampleHyperopt -e 1000 --timerange 20190601-20200601`
 
 ## Edge module
 

docs/hyperopt.md

@@ -6,59 +6,121 @@ algorithms included in the `scikit-optimize` package to accomplish this. The
 search will burn all your CPU cores, make your laptop sound like a fighter jet
 and still take a long time.
 
+In general, the search for best parameters starts with a few random combinations (see [below](#reproducible-results) for more details) and then uses Bayesian search with a ML regressor algorithm (currently ExtraTreesRegressor) to quickly find a combination of parameters in the search hyperspace that minimizes the value of the [loss function](#loss-functions).
+
+Hyperopt requires historic data to be available, just as backtesting does.
+To learn how to get data for the pairs and exchange you're interested in, head over to the [Data Downloading](data-download.md) section of the documentation.
+
 !!! Bug
-    Hyperopt will crash when used with only 1 CPU Core as found out in [Issue #1133](https://github.com/freqtrade/freqtrade/issues/1133)
+    Hyperopt can crash when used with only 1 CPU Core as found out in [Issue #1133](https://github.com/freqtrade/freqtrade/issues/1133)
+
+## Install hyperopt dependencies
+
+Since Hyperopt dependencies are not needed to run the bot itself, are heavy, can not be easily built on some platforms (like Raspberry PI), they are not installed by default. Before you run Hyperopt, you need to install the corresponding dependencies, as described in this section below.
+
+!!! Note
+    Since Hyperopt is a resource intensive process, running it on a Raspberry Pi is not recommended nor supported.
+
+### Docker
+
+The docker-image includes hyperopt dependencies, no further action needed.
+
+### Easy installation script (setup.sh) / Manual installation
+
+```bash
+source .env/bin/activate
+pip install -r requirements-hyperopt.txt
+```
 
 ## Prepare Hyperopting
 
 Before we start digging into Hyperopt, we recommend you to take a look at
-an example hyperopt file located into [user_data/hyperopts/](https://github.com/freqtrade/freqtrade/blob/develop/user_data/hyperopts/sample_hyperopt.py)
+the sample hyperopt file located in [user_data/hyperopts/](https://github.com/freqtrade/freqtrade/blob/develop/freqtrade/templates/sample_hyperopt.py).
 
-Configuring hyperopt is similar to writing your own strategy, and many tasks will be similar and a lot of code can be copied across from the strategy.
+Configuring hyperopt is similar to writing your own strategy, and many tasks will be similar.
 
-### Checklist on all tasks / possibilities in hyperopt
+!!! Tip "About this page"
+    For this page, we will be using a fictional strategy called `AwesomeStrategy` - which will be optimized using the `AwesomeHyperopt` class.
 
-Depending on the space you want to optimize, only some of the below are required.
+The simplest way to get started is to use the following, command, which will create a new hyperopt file from a template, which will be located under `user_data/hyperopts/AwesomeHyperopt.py`.
+
+``` bash
+freqtrade new-hyperopt --hyperopt AwesomeHyperopt
+```
+
+### Hyperopt checklist
+
+Checklist on all tasks / possibilities in hyperopt
+
+Depending on the space you want to optimize, only some of the below are required:
 
-* fill `populate_indicators` - probably a copy from your strategy
 * fill `buy_strategy_generator` - for buy signal optimization
-* fill `indicator_space` - for buy signal optimzation
+* fill `indicator_space` - for buy signal optimization
 * fill `sell_strategy_generator` - for sell signal optimization
-* fill `sell_indicator_space` - for sell signal optimzation
+* fill `sell_indicator_space` - for sell signal optimization
-* fill `roi_space` - for ROI optimization
+
-* fill `generate_roi_table` - for ROI optimization (if you need more than 3 entries)
+!!! Note
-* fill `stoploss_space` - stoploss optimization
+    `populate_indicators` needs to create all indicators any of thee spaces may use, otherwise hyperopt will not work.
-* Optional but recommended
+
+Optional in hyperopt - can also be loaded from a strategy (recommended):
+
+* copy `populate_indicators` from your strategy - otherwise default-strategy will be used
 * copy `populate_buy_trend` from your strategy - otherwise default-strategy will be used
 * copy `populate_sell_trend` from your strategy - otherwise default-strategy will be used
 
-### 1. Install a Custom Hyperopt File
+!!! Note
+    You always have to provide a strategy to Hyperopt, even if your custom Hyperopt class contains all methods.
+    Assuming the optional methods are not in your hyperopt file, please use `--strategy AweSomeStrategy` which contains these methods so hyperopt can use these methods instead.
 
-Put your hyperopt file into the directory `user_data/hyperopts`.
+Rarely you may also need to override:
 
-Let assume you want a hyperopt file `awesome_hyperopt.py`:  
+* `roi_space` - for custom ROI optimization (if you need the ranges for the ROI parameters in the optimization hyperspace that differ from default)
-Copy the file `user_data/hyperopts/sample_hyperopt.py` into `user_data/hyperopts/awesome_hyperopt.py`
+* `generate_roi_table` - for custom ROI optimization (if you need the ranges for the values in the ROI table that differ from default or the number of entries (steps) in the ROI table which differs from the default 4 steps)
+* `stoploss_space` - for custom stoploss optimization (if you need the range for the stoploss parameter in the optimization hyperspace that differs from default)
+* `trailing_space` - for custom trailing stop optimization (if you need the ranges for the trailing stop parameters in the optimization hyperspace that differ from default)
 
-### 2. Configure your Guards and Triggers
+!!! Tip "Quickly optimize ROI, stoploss and trailing stoploss"
+    You can quickly optimize the spaces `roi`, `stoploss` and `trailing` without changing anything (i.e. without creation of a "complete" Hyperopt class with dimensions, parameters, triggers and guards, as described in this document) from the default hyperopt template by relying on your strategy to do most of the calculations.
+
+    ```python
+    # Have a working strategy at hand.
+    freqtrade new-hyperopt --hyperopt EmptyHyperopt
+
+    freqtrade hyperopt --hyperopt EmptyHyperopt --hyperopt-loss SharpeHyperOptLossDaily --spaces roi stoploss trailing --strategy MyWorkingStrategy --config config.json -e 100
+    ```
+
+### Create a Custom Hyperopt File
+
+Let assume you want a hyperopt file `AwesomeHyperopt.py`:  
+
+``` bash
+freqtrade new-hyperopt --hyperopt AwesomeHyperopt
+```
+
+This command will create a new hyperopt file from a template, allowing you to get started quickly.
+
+### Configure your Guards and Triggers
 
 There are two places you need to change in your hyperopt file to add a new buy hyperopt for testing:
 
-- Inside `indicator_space()` - the parameters hyperopt shall be optimizing.
+* Inside `indicator_space()` - the parameters hyperopt shall be optimizing.
-- Inside `populate_buy_trend()` - applying the parameters.
+* Inside `populate_buy_trend()` - applying the parameters.
 
 There you have two different types of indicators: 1. `guards` and 2. `triggers`.
 
 1. Guards are conditions like "never buy if ADX < 10", or never buy if current price is over EMA10.
-2. Triggers are ones that actually trigger buy in specific moment, like "buy when EMA5 crosses over EMA10" or "buy when close price touches lower bollinger band".
+2. Triggers are ones that actually trigger buy in specific moment, like "buy when EMA5 crosses over EMA10" or "buy when close price touches lower Bollinger band".
 
-Hyperoptimization will, for each eval round, pick one trigger and possibly
+!!! Hint "Guards and Triggers"
-multiple guards. The constructed strategy will be something like
+    Technically, there is no difference between Guards and Triggers.  
-"*buy exactly when close price touches lower bollinger band, BUT only if
+    However, this guide will make this distinction to make it clear that signals should not be "sticking".
+    Sticking signals are signals that are active for multiple candles. This can lead into buying a signal late (right before the signal disappears - which means that the chance of success is a lot lower than right at the beginning).
+
+Hyper-optimization will, for each epoch round, pick one trigger and possibly
+multiple guards. The constructed strategy will be something like "*buy exactly when close price touches lower Bollinger band, BUT only if
 ADX > 10*".
 
-If you have updated the buy strategy, ie. changed the contents of
+If you have updated the buy strategy, i.e. changed the contents of `populate_buy_trend()` method, you have to update the `guards` and `triggers` your hyperopt must use correspondingly.
-`populate_buy_trend()` method you have to update the `guards` and
-`triggers` hyperopts must use.
 
 #### Sell optimization
 
@@ -71,10 +133,11 @@ Place the corresponding settings into the following methods
 The configuration and rules are the same than for buy signals.
 To avoid naming collisions in the search-space, please prefix all sell-spaces with `sell-`.
 
-#### Using ticker-interval as part of the Strategy
+#### Using timeframe as a part of the Strategy
 
-The Strategy exposes the ticker-interval as `self.ticker_interval`. The same value is available as class-attribute `HyperoptName.ticker_interval`.
+The Strategy class exposes the timeframe value as the `self.timeframe` attribute.
-In the case of the linked sample-value this would be `SampleHyperOpts.ticker_interval`.
+The same value is available as class-attribute `HyperoptName.timeframe`.
+In the case of the linked sample-value this would be `AwesomeHyperopt.timeframe`.
 
 ## Solving a Mystery
 
@@ -127,6 +190,9 @@ So let's write the buy strategy using these values:
                         dataframe['macd'], dataframe['macdsignal']
                     ))
 
+            # Check that volume is not 0
+            conditions.append(dataframe['volume'] > 0)
+
             if conditions:
                 dataframe.loc[
                     reduce(lambda x, y: x & y, conditions),
@@ -137,87 +203,32 @@ So let's write the buy strategy using these values:
         return populate_buy_trend
 ```
 
-Hyperopting will now call this `populate_buy_trend` as many times you ask it (`epochs`)
+Hyperopt will now call `populate_buy_trend()` many times (`epochs`) with different value combinations.  
-with different value combinations. It will then use the given historical data and make
+It will use the given historical data and make buys based on the buy signals generated with the above function.  
-buys based on the buy signals generated with the above function and based on the results
+Based on the results, hyperopt will tell you which parameter combination produced the best results (based on the configured [loss function](#loss-functions)).
-it will end with telling you which paramter combination produced the best profits.
-
-The search for best parameters starts with a few random combinations and then uses a
-regressor algorithm (currently ExtraTreesRegressor) to quickly find a parameter combination
-that minimizes the value of the [loss function](#loss-functions).
 
+!!! Note
     The above setup expects to find ADX, RSI and Bollinger Bands in the populated indicators.
     When you want to test an indicator that isn't used by the bot currently, remember to
-add it to the `populate_indicators()` method in `hyperopt.py`.
+    add it to the `populate_indicators()` method in your strategy or hyperopt file.
 
 ## Loss-functions
 
 Each hyperparameter tuning requires a target. This is usually defined as a loss function (sometimes also called objective function), which should decrease for more desirable results, and increase for bad results.
 
-By default, FreqTrade uses a loss function, which has been with freqtrade since the beginning and optimizes mostly for short trade duration and avoiding losses.
+A loss function must be specified via the `--hyperopt-loss <Class-name>` argument (or optionally via the configuration under the `"hyperopt_loss"` key).
+This class should be in its own file within the `user_data/hyperopts/` directory.
 
-A different version this can be used by using the `--hyperopt-loss <Class-name>` argument.
+Currently, the following loss functions are builtin:
-This class should be in it's own file within the `user_data/hyperopts/` directory.
 
-Currently, the following loss functions are builtin: `SharpeHyperOptLoss` and `DefaultHyperOptLoss`.
+* `ShortTradeDurHyperOptLoss` (default legacy Freqtrade hyperoptimization loss function) - Mostly for short trade duration and avoiding losses.
+* `OnlyProfitHyperOptLoss` (which takes only amount of profit into consideration)
+* `SharpeHyperOptLoss` (optimizes Sharpe Ratio calculated on trade returns relative to standard deviation)
+* `SharpeHyperOptLossDaily` (optimizes Sharpe Ratio calculated on **daily** trade returns relative to standard deviation)
+* `SortinoHyperOptLoss` (optimizes Sortino Ratio calculated on trade returns relative to **downside** standard deviation)
+* `SortinoHyperOptLossDaily` (optimizes Sortino Ratio calculated on **daily** trade returns relative to **downside** standard deviation)
 
-### Creating and using a custom loss function
+Creation of a custom loss function is covered in the [Advanced Hyperopt](advanced-hyperopt.md) part of the documentation.
-
-To use a custom loss function class, make sure that the function `hyperopt_loss_function` is defined in your custom hyperopt loss class.
-For the sample below, you then need to add the command line parameter `--hyperopt-loss SuperDuperHyperOptLoss` to your hyperopt call so this fuction is being used.
-
-A sample of this can be found below, which is identical to the Default Hyperopt loss implementation. A full sample can be found [user_data/hyperopts/](https://github.com/freqtrade/freqtrade/blob/develop/user_data/hyperopts/sample_hyperopt_loss.py)
-
-``` python
-from freqtrade.optimize.hyperopt import IHyperOptLoss
-
-TARGET_TRADES = 600
-EXPECTED_MAX_PROFIT = 3.0
-MAX_ACCEPTED_TRADE_DURATION = 300
-
-class SuperDuperHyperOptLoss(IHyperOptLoss):
-    """
-    Defines the default loss function for hyperopt
-    """
-
-    @staticmethod
-    def hyperopt_loss_function(results: DataFrame, trade_count: int,
-                               min_date: datetime, max_date: datetime,
-                               *args, **kwargs) -> float:
-        """
-        Objective function, returns smaller number for better results
-        This is the legacy algorithm (used until now in freqtrade).
-        Weights are distributed as follows:
-        * 0.4 to trade duration
-        * 0.25: Avoiding trade loss
-        * 1.0 to total profit, compared to the expected value (`EXPECTED_MAX_PROFIT`) defined above
-        """
-        total_profit = results.profit_percent.sum()
-        trade_duration = results.trade_duration.mean()
-
-        trade_loss = 1 - 0.25 * exp(-(trade_count - TARGET_TRADES) ** 2 / 10 ** 5.8)
-        profit_loss = max(0, 1 - total_profit / EXPECTED_MAX_PROFIT)
-        duration_loss = 0.4 * min(trade_duration / MAX_ACCEPTED_TRADE_DURATION, 1)
-        result = trade_loss + profit_loss + duration_loss
-        return result
-```
-
-Currently, the arguments are:
-
-* `results`: DataFrame containing the result  
-    The following columns are available in results (corresponds to the output-file of backtesting when used with `--export trades`):  
-    `pair, profit_percent, profit_abs, open_time, close_time, open_index, close_index, trade_duration, open_at_end, open_rate, close_rate, sell_reason`
-* `trade_count`: Amount of trades (identical to `len(results)`)
-* `min_date`: Start date of the hyperopting TimeFrame
-* `min_date`: End date of the hyperopting TimeFrame
-
-This function needs to return a floating point number (`float`). Smaller numbers will be interpreted as better results. The parameters and balancing for this is up to you.
-
-!!! Note
-    This function is called once per iteration - so please make sure to have this as optimized as possible to not slow hyperopt down unnecessarily.
-
-!!! Note
-    Please keep the arguments `*args` and `**kwargs` in the interface to allow us to extend this interface later.
 
 ## Execute Hyperopt
 
@@ -227,44 +238,50 @@ Because hyperopt tries a lot of combinations to find the best parameters it will
 We strongly recommend to use `screen` or `tmux` to prevent any connection loss.
 
 ```bash
-freqtrade -c config.json hyperopt --customhyperopt <hyperoptname> -e 5000 --spaces all
+freqtrade hyperopt --config config.json --hyperopt <hyperoptname> --hyperopt-loss <hyperoptlossname> --strategy <strategyname> -e 500 --spaces all
 ```
 
 Use `<hyperoptname>` as the name of the custom hyperopt used.
 
-The `-e` flag will set how many evaluations hyperopt will do. We recommend
+The `-e` option will set how many evaluations hyperopt will do. Since hyperopt uses Bayesian search, running too many epochs at once may not produce greater results. Experience has shown that best results are usually not improving much after 500-1000 epochs.  
-running at least several thousand evaluations.
+Doing multiple runs (executions) with a few 1000 epochs and different random state will most likely produce different results.
 
-The `--spaces all` flag determines that all possible parameters should be optimized. Possibilities are listed below.
+The `--spaces all` option determines that all possible parameters should be optimized. Possibilities are listed below.
 
 !!! Note
-    By default, hyperopt will erase previous results and start from scratch. Continuation can be archived by using `--continue`.
+    Hyperopt will store hyperopt results with the timestamp of the hyperopt start time.
+    Reading commands (`hyperopt-list`, `hyperopt-show`) can use `--hyperopt-filename <filename>` to read and display older hyperopt results.
+    You can find a list of filenames with `ls -l user_data/hyperopt_results/`.
 
-!!! Warning
+### Execute Hyperopt with different historical data source
-    When switching parameters or changing configuration options, make sure to not use the argument `--continue` so temporary results can be removed.
 
-### Execute Hyperopt with Different Ticker-Data Source
+If you would like to hyperopt parameters using an alternate historical data set that
+you have on-disk, use the `--datadir PATH` option. By default, hyperopt
+uses data from directory `user_data/data`.
 
-If you would like to hyperopt parameters using an alternate ticker data that
+### Running Hyperopt with a smaller test-set
-you have on-disk, use the `--datadir PATH` option. Default hyperopt will
-use data from directory `user_data/data`.
 
-### Running Hyperopt with Smaller Testset
+Use the `--timerange` argument to change how much of the test-set you want to use.
-
-Use the `--timerange` argument to change how much of the testset you want to use.
 For example, to use one month of data, pass the following parameter to the hyperopt call:
 
 ```bash
-freqtrade hyperopt --timerange 20180401-20180501
+freqtrade hyperopt --hyperopt <hyperoptname> --strategy <strategyname> --timerange 20180401-20180501
+```
+
+### Running Hyperopt using methods from a strategy
+
+Hyperopt can reuse `populate_indicators`, `populate_buy_trend`, `populate_sell_trend` from your strategy, assuming these methods are **not** in your custom hyperopt file, and a strategy is provided.
+
+```bash
+freqtrade hyperopt --hyperopt AwesomeHyperopt --hyperopt-loss SharpeHyperOptLossDaily --strategy AwesomeStrategy
 ```
 
 ### Running Hyperopt with Smaller Search Space
 
-Use the `--spaces` argument to limit the search space used by hyperopt.
+Use the `--spaces` option to limit the search space used by hyperopt.
-Letting Hyperopt optimize everything is a huuuuge search space. Often it
+Letting Hyperopt optimize everything is a huuuuge search space. 
-might make more sense to start by just searching for initial buy algorithm.
+Often it might make more sense to start by just searching for initial buy algorithm.
-Or maybe you just want to optimize your stoploss or roi table for that awesome
+Or maybe you just want to optimize your stoploss or roi table for that awesome new buy strategy you have.
-new buy strategy you have.
 
 Legal values are:
 
@@ -273,8 +290,12 @@ Legal values are:
 * `sell`: just search for a new sell strategy
 * `roi`: just optimize the minimal profit table for your strategy
 * `stoploss`: search for the best stoploss value
+* `trailing`: search for the best trailing stop values
+* `default`: `all` except `trailing`
 * space-separated list of any of the above values for example `--spaces roi stoploss`
 
+The default Hyperopt Search Space, used when no `--space` command line option is specified, does not include the `trailing` hyperspace. We recommend you to run optimization for the `trailing` hyperspace separately, when the best parameters for other hyperspaces were found, validated and pasted into your custom strategy.
+
 ### Position stacking and disabling max market positions
 
 In some situations, you may need to run Hyperopt (and Backtesting) with the
@@ -283,7 +304,7 @@ In some situations, you may need to run Hyperopt (and Backtesting) with the
 By default, hyperopt emulates the behavior of the Freqtrade Live Run/Dry Run, where only one
 open trade is allowed for every traded pair. The total number of trades open for all pairs
 is also limited by the `max_open_trades` setting. During Hyperopt/Backtesting this may lead to
-some potential trades to be hidden (or masked) by previosly open trades.
+some potential trades to be hidden (or masked) by previously open trades.
 
 The `--eps`/`--enable-position-stacking` argument allows emulation of buying the same pair multiple times,
 while `--dmmp`/`--disable-max-market-positions` disables applying `max_open_trades`
@@ -296,6 +317,16 @@ number).
 You can also enable position stacking in the configuration file by explicitly setting
 `"position_stacking"=true`.
 
+### Reproducible results
+
+The search for optimal parameters starts with a few (currently 30) random combinations in the hyperspace of parameters, random Hyperopt epochs. These random epochs are marked with an asterisk character (`*`) in the first column in the Hyperopt output.
+
+The initial state for generation of these random values (random state) is controlled by the value of the `--random-state` command line option. You can set it to some arbitrary value of your choice to obtain reproducible results.
+
+If you have not set this value explicitly in the command line options, Hyperopt seeds the random state with some random value for you. The random state value for each Hyperopt run is shown in the log, so you can copy and paste it into the `--random-state` command line option to repeat the set of the initial random epochs used.
+
+If you have not changed anything in the command line options, configuration, timerange, Strategy and Hyperopt classes, historical data and the Loss Function -- you should obtain same hyper-optimization results with same random state value used.
+
 ## Understand the Hyperopt Result
 
 Once Hyperopt is completed you can use the result to create a new strategy.
@@ -303,8 +334,10 @@ Given the following result from hyperopt:
 
 ```
 Best result:
-   135 trades. Avg profit  0.57%. Total profit  0.03871918 BTC (0.7722Σ%). Avg duration 180.4 mins.
+
-with values:
+    44/100:    135 trades. Avg profit  0.57%. Total profit  0.03871918 BTC (0.7722Σ%). Avg duration 180.4 mins. Objective: 1.94367
+
+Buy hyperspace params:
 {    'adx-value': 44,
      'rsi-value': 29,
      'adx-enabled': False,
@@ -327,8 +360,7 @@ So for example you had `rsi-value: 29.0` so we would look at `rsi`-block, that t
 (dataframe['rsi'] < 29.0)
 ```
 
-Translating your whole hyperopt result as the new buy-signal
+Translating your whole hyperopt result as the new buy-signal would then look like:
-would then look like:
 
 ```python
 def populate_buy_trend(self, dataframe: DataFrame) -> DataFrame:
@@ -341,52 +373,144 @@ def populate_buy_trend(self, dataframe: DataFrame) -> DataFrame:
     return dataframe
 ```
 
+By default, hyperopt prints colorized results -- epochs with positive profit are printed in the green color. This highlighting helps you find epochs that can be interesting for later analysis. Epochs with zero total profit or with negative profits (losses) are printed in the normal color. If you do not need colorization of results (for instance, when you are redirecting hyperopt output to a file) you can switch colorization off by specifying the `--no-color` option in the command line.
+
+You can use the `--print-all` command line option if you would like to see all results in the hyperopt output, not only the best ones. When `--print-all` is used, current best results are also colorized by default -- they are printed in bold (bright) style. This can also be switched off with the `--no-color` command line option.
+
+!!! Note "Windows and color output"
+    Windows does not support color-output natively, therefore it is automatically disabled. To have color-output for hyperopt running under windows, please consider using WSL.
+
 ### Understand Hyperopt ROI results
 
-If you are optimizing ROI, you're result will look as follows and include a ROI table.
+If you are optimizing ROI (i.e. if optimization search-space contains 'all', 'default' or 'roi'), your result will look as follows and include a ROI table:
 
 ```
 Best result:
-   135 trades. Avg profit  0.57%. Total profit  0.03871918 BTC (0.7722Σ%). Avg duration 180.4 mins.
+
-with values:
+    44/100:    135 trades. Avg profit  0.57%. Total profit  0.03871918 BTC (0.7722Σ%). Avg duration 180.4 mins. Objective: 1.94367
-{   'adx-value': 44,
+
-    'rsi-value': 29,
-    'adx-enabled': false,
-    'rsi-enabled': True,
-    'trigger': 'bb_lower',
-    'roi_t1': 40,
-    'roi_t2': 57,
-    'roi_t3': 21,
-    'roi_p1': 0.03634636907306948,
-    'roi_p2': 0.055237357937802885,
-    'roi_p3': 0.015163796015548354,
-    'stoploss': -0.37996664668703606
-}
 ROI table:
-{   0: 0.10674752302642071,
+{   0: 0.10674,
-    21: 0.09158372701087236,
+    21: 0.09158,
-    78: 0.03634636907306948,
+    78: 0.03634,
     118: 0}
 ```
 
-This would translate to the following ROI table:
+In order to use this best ROI table found by Hyperopt in backtesting and for live trades/dry-run, copy-paste it as the value of the `minimal_roi` attribute of your custom strategy:
 
-``` python
+```
+    # Minimal ROI designed for the strategy.
+    # This attribute will be overridden if the config file contains "minimal_roi"
     minimal_roi = {
-        "118": 0,
+        0: 0.10674,
-        "78": 0.0363463,
+        21: 0.09158,
-        "21": 0.0915,
+        78: 0.03634,
-        "0": 0.106
+        118: 0
     }
 ```
 
-### Validate backtesting results
+As stated in the comment, you can also use it as the value of the `minimal_roi` setting in the configuration file.
+
+#### Default ROI Search Space
+
+If you are optimizing ROI, Freqtrade creates the 'roi' optimization hyperspace for you -- it's the hyperspace of components for the ROI tables. By default, each ROI table generated by the Freqtrade consists of 4 rows (steps). Hyperopt implements adaptive ranges for ROI tables with ranges for values in the ROI steps that depend on the timeframe used. By default the values vary in the following ranges (for some of the most used timeframes, values are rounded to 5 digits after the decimal point):
+
+| # step | 1m     |                   | 5m       |             | 1h         |                   | 1d           |                   |
+| ------ | ------ | ----------------- | -------- | ----------- | ---------- | ----------------- | ------------ | ----------------- |
+| 1      | 0      | 0.01161...0.11992 | 0        | 0.03...0.31 | 0          | 0.06883...0.71124 | 0            | 0.12178...1.25835 |
+| 2      | 2...8  | 0.00774...0.04255 | 10...40  | 0.02...0.11 | 120...480  | 0.04589...0.25238 | 2880...11520 | 0.08118...0.44651 |
+| 3      | 4...20 | 0.00387...0.01547 | 20...100 | 0.01...0.04 | 240...1200 | 0.02294...0.09177 | 5760...28800 | 0.04059...0.16237 |
+| 4      | 6...44 | 0.0               | 30...220 | 0.0         | 360...2640 | 0.0               | 8640...63360 | 0.0               |
+
+These ranges should be sufficient in most cases. The minutes in the steps (ROI dict keys) are scaled linearly depending on the timeframe used. The ROI values in the steps (ROI dict values) are scaled logarithmically depending on the timeframe used.
+
+If you have the `generate_roi_table()` and `roi_space()` methods in your custom hyperopt file, remove them in order to utilize these adaptive ROI tables and the ROI hyperoptimization space generated by Freqtrade by default.
+
+Override the `roi_space()` method if you need components of the ROI tables to vary in other ranges. Override the `generate_roi_table()` and `roi_space()` methods and implement your own custom approach for generation of the ROI tables during hyperoptimization if you need a different structure of the ROI tables or other amount of rows (steps). 
+
+A sample for these methods can be found in [sample_hyperopt_advanced.py](https://github.com/freqtrade/freqtrade/blob/develop/freqtrade/templates/sample_hyperopt_advanced.py).
+
+### Understand Hyperopt Stoploss results
+
+If you are optimizing stoploss values (i.e. if optimization search-space contains 'all', 'default' or 'stoploss'), your result will look as follows and include stoploss:
+
+```
+Best result:
+
+    44/100:    135 trades. Avg profit  0.57%. Total profit  0.03871918 BTC (0.7722Σ%). Avg duration 180.4 mins. Objective: 1.94367
+
+Buy hyperspace params:
+{   'adx-value': 44,
+    'rsi-value': 29,
+    'adx-enabled': False,
+    'rsi-enabled': True,
+    'trigger': 'bb_lower'}
+Stoploss: -0.27996
+```
+
+In order to use this best stoploss value found by Hyperopt in backtesting and for live trades/dry-run, copy-paste it as the value of the `stoploss` attribute of your custom strategy:
+
+``` python
+    # Optimal stoploss designed for the strategy
+    # This attribute will be overridden if the config file contains "stoploss"
+    stoploss = -0.27996
+```
+
+As stated in the comment, you can also use it as the value of the `stoploss` setting in the configuration file.
+
+#### Default Stoploss Search Space
+
+If you are optimizing stoploss values, Freqtrade creates the 'stoploss' optimization hyperspace for you. By default, the stoploss values in that hyperspace vary in the range -0.35...-0.02, which is sufficient in most cases.
+
+If you have the `stoploss_space()` method in your custom hyperopt file, remove it in order to utilize Stoploss hyperoptimization space generated by Freqtrade by default.
+
+Override the `stoploss_space()` method and define the desired range in it if you need stoploss values to vary in other range during hyperoptimization. A sample for this method can be found in [user_data/hyperopts/sample_hyperopt_advanced.py](https://github.com/freqtrade/freqtrade/blob/develop/freqtrade/templates/sample_hyperopt_advanced.py).
+
+### Understand Hyperopt Trailing Stop results
+
+If you are optimizing trailing stop values (i.e. if optimization search-space contains 'all' or 'trailing'), your result will look as follows and include trailing stop parameters:
+
+```
+Best result:
+
+    45/100:    606 trades. Avg profit  1.04%. Total profit  0.31555614 BTC ( 630.48Σ%). Avg duration 150.3 mins. Objective: -1.10161
+
+Trailing stop:
+{   'trailing_only_offset_is_reached': True,
+    'trailing_stop': True,
+    'trailing_stop_positive': 0.02001,
+    'trailing_stop_positive_offset': 0.06038}
+```
+
+In order to use these best trailing stop parameters found by Hyperopt in backtesting and for live trades/dry-run, copy-paste them as the values of the corresponding attributes of your custom strategy:
+
+``` python
+    # Trailing stop
+    # These attributes will be overridden if the config file contains corresponding values.
+    trailing_stop = True
+    trailing_stop_positive = 0.02001
+    trailing_stop_positive_offset = 0.06038
+    trailing_only_offset_is_reached = True
+```
+
+As stated in the comment, you can also use it as the values of the corresponding settings in the configuration file.
+
+#### Default Trailing Stop Search Space
+
+If you are optimizing trailing stop values, Freqtrade creates the 'trailing' optimization hyperspace for you. By default, the `trailing_stop` parameter is always set to True in that hyperspace, the value of the `trailing_only_offset_is_reached` vary between True and False, the values of the `trailing_stop_positive` and `trailing_stop_positive_offset` parameters vary in the ranges 0.02...0.35 and 0.01...0.1 correspondingly, which is sufficient in most cases.
+
+Override the `trailing_space()` method and define the desired range in it if you need values of the trailing stop parameters to vary in other ranges during hyperoptimization. A sample for this method can be found in [user_data/hyperopts/sample_hyperopt_advanced.py](https://github.com/freqtrade/freqtrade/blob/develop/freqtrade/templates/sample_hyperopt_advanced.py).
+
+## Show details of Hyperopt results
+
+After you run Hyperopt for the desired amount of epochs, you can later list all results for analysis, select only best or profitable once, and show the details for any of the epochs previously evaluated. This can be done with the `hyperopt-list` and `hyperopt-show` sub-commands. The usage of these sub-commands is described in the [Utils](utils.md#list-hyperopt-results) chapter.
+
+## Validate backtesting results
 
 Once the optimized strategy has been implemented into your strategy, you should backtest this strategy to make sure everything is working as expected.
 
-To achieve same results (number of trades, their durations, profit, etc.) than during Hyperopt, please use same set of arguments `--dmmp`/`--disable-max-market-positions` and `--eps`/`--enable-position-stacking` for Backtesting.
+To achieve same results (number of trades, their durations, profit, etc.) than during Hyperopt, please use same configuration and parameters (timerange, timeframe, ...) used for hyperopt `--dmmp`/`--disable-max-market-positions` and `--eps`/`--enable-position-stacking` for Backtesting.
 
-## Next Step
+Should results don't match, please double-check to make sure you transferred all conditions correctly.
-
+Pay special care to the stoploss (and trailing stoploss) parameters, as these are often set in configuration files, which override changes to the strategy.
-Now you have a perfect bot and want to control it from Telegram. Your
+You should also carefully review the log of your backtest to ensure that there were no parameters inadvertently set by the configuration (like `stoploss` or `trailing_stop`).
-next step is to learn the [Telegram usage](telegram-usage.md).

docs/includes/pairlists.md

@@ -0,0 +1,142 @@
+## Pairlists and Pairlist Handlers
+
+Pairlist Handlers define the list of pairs (pairlist) that the bot should trade. They are configured in the `pairlists` section of the configuration settings.
+
+In your configuration, you can use Static Pairlist (defined by the [`StaticPairList`](#static-pair-list) Pairlist Handler) and Dynamic Pairlist (defined by the [`VolumePairList`](#volume-pair-list) Pairlist Handler).
+
+Additionally, [`AgeFilter`](#agefilter), [`PrecisionFilter`](#precisionfilter), [`PriceFilter`](#pricefilter), [`ShuffleFilter`](#shufflefilter) and [`SpreadFilter`](#spreadfilter) act as Pairlist Filters, removing certain pairs and/or moving their positions in the pairlist.
+
+If multiple Pairlist Handlers are used, they are chained and a combination of all Pairlist Handlers forms the resulting pairlist the bot uses for trading and backtesting. Pairlist Handlers are executed in the sequence they are configured. You should always configure either `StaticPairList` or `VolumePairList` as the starting Pairlist Handler.
+
+Inactive markets are always removed from the resulting pairlist. Explicitly blacklisted pairs (those in the `pair_blacklist` configuration setting) are also always removed from the resulting pairlist.
+
+### Available Pairlist Handlers
+
+* [`StaticPairList`](#static-pair-list) (default, if not configured differently)
+* [`VolumePairList`](#volume-pair-list)
+* [`AgeFilter`](#agefilter)
+* [`PrecisionFilter`](#precisionfilter)
+* [`PriceFilter`](#pricefilter)
+* [`ShuffleFilter`](#shufflefilter)
+* [`SpreadFilter`](#spreadfilter)
+
+!!! Tip "Testing pairlists"
+    Pairlist configurations can be quite tricky to get right. Best use the [`test-pairlist`](utils.md#test-pairlist) utility sub-command to test your configuration quickly.
+
+#### Static Pair List
+
+By default, the `StaticPairList` method is used, which uses a statically defined pair whitelist from the configuration.
+
+It uses configuration from `exchange.pair_whitelist` and `exchange.pair_blacklist`.
+
+```json
+"pairlists": [
+    {"method": "StaticPairList"}
+    ],
+```
+
+By default, only currently enabled pairs are allowed.
+To skip pair validation against active markets, set `"allow_inactive": true` within the `StaticPairList` configuration.
+This can be useful for backtesting expired pairs (like quarterly spot-markets).
+This option must be configured along with `exchange.skip_pair_validation` in the exchange configuration.
+
+#### Volume Pair List
+
+`VolumePairList` employs sorting/filtering of pairs by their trading volume. It selects `number_assets` top pairs with sorting based on the `sort_key` (which can only be `quoteVolume`).
+
+When used in the chain of Pairlist Handlers in a non-leading position (after StaticPairList and other Pairlist Filters), `VolumePairList` considers outputs of previous Pairlist Handlers, adding its sorting/selection of the pairs by the trading volume.
+
+When used on the leading position of the chain of Pairlist Handlers, it does not consider `pair_whitelist` configuration setting, but selects the top assets from all available markets (with matching stake-currency) on the exchange.
+
+The `refresh_period` setting allows to define the period (in seconds), at which the pairlist will be refreshed. Defaults to 1800s (30 minutes).
+
+`VolumePairList` is based on the ticker data from exchange, as reported by the ccxt library:
+
+* The `quoteVolume` is the amount of quote (stake) currency traded (bought or sold) in last 24 hours.
+
+```json
+"pairlists": [{
+        "method": "VolumePairList",
+        "number_assets": 20,
+        "sort_key": "quoteVolume",
+        "refresh_period": 1800,
+}],
+```
+
+#### AgeFilter
+
+Removes pairs that have been listed on the exchange for less than `min_days_listed` days (defaults to `10`).
+
+When pairs are first listed on an exchange they can suffer huge price drops and volatility
+in the first few days while the pair goes through its price-discovery period. Bots can often
+be caught out buying before the pair has finished dropping in price.
+
+This filter allows freqtrade to ignore pairs until they have been listed for at least `min_days_listed` days.
+
+#### PrecisionFilter
+
+Filters low-value coins which would not allow setting stoplosses.
+
+#### PriceFilter
+
+The `PriceFilter` allows filtering of pairs by price. Currently the following price filters are supported:
+
+* `min_price`
+* `max_price`
+* `low_price_ratio`
+
+The `min_price` setting removes pairs where the price is below the specified price. This is useful if you wish to avoid trading very low-priced pairs.
+This option is disabled by default, and will only apply if set to > 0.
+
+The `max_price` setting removes pairs where the price is above the specified price. This is useful if you wish to trade only low-priced pairs.
+This option is disabled by default, and will only apply if set to > 0.
+
+The `low_price_ratio` setting removes pairs where a raise of 1 price unit (pip) is above the `low_price_ratio` ratio.
+This option is disabled by default, and will only apply if set to > 0.
+
+For `PriceFiler` at least one of its `min_price`, `max_price` or `low_price_ratio` settings must be applied.
+
+Calculation example:
+
+Min price precision for SHITCOIN/BTC is 8 decimals. If its price is 0.00000011 - one price step above would be 0.00000012, which is ~9% higher than the previous price value. You may filter out this pair by using PriceFilter with `low_price_ratio` set to 0.09 (9%) or with `min_price` set to 0.00000011, correspondingly.
+
+!!! Warning "Low priced pairs"
+    Low priced pairs with high "1 pip movements" are dangerous since they are often illiquid and it may also be impossible to place the desired stoploss, which can often result in high losses since price needs to be rounded to the next tradable price - so instead of having a stoploss of -5%, you could end up with a stoploss of -9% simply due to price rounding.
+
+#### ShuffleFilter
+
+Shuffles (randomizes) pairs in the pairlist. It can be used for preventing the bot from trading some of the pairs more frequently then others when you want all pairs be treated with the same priority.
+
+!!! Tip
+    You may set the `seed` value for this Pairlist to obtain reproducible results, which can be useful for repeated backtesting sessions. If `seed` is not set, the pairs are shuffled in the non-repeatable random order.
+
+#### SpreadFilter
+
+Removes pairs that have a difference between asks and bids above the specified ratio, `max_spread_ratio` (defaults to `0.005`).
+
+Example:
+
+If `DOGE/BTC` maximum bid is 0.00000026 and minimum ask is 0.00000027, the ratio is calculated as: `1 - bid/ask ~= 0.037` which is `> 0.005` and this pair will be filtered out.
+
+### Full example of Pairlist Handlers
+
+The below example blacklists `BNB/BTC`, uses `VolumePairList` with `20` assets, sorting pairs by `quoteVolume` and applies both [`PrecisionFilter`](#precisionfilter) and [`PriceFilter`](#price-filter), filtering all assets where 1 price unit is > 1%. Then the `SpreadFilter` is applied and pairs are finally shuffled with the random seed set to some predefined value.
+
+```json
+"exchange": {
+    "pair_whitelist": [],
+    "pair_blacklist": ["BNB/BTC"]
+},
+"pairlists": [
+    {
+        "method": "VolumePairList",
+        "number_assets": 20,
+        "sort_key": "quoteVolume",
+    },
+    {"method": "AgeFilter", "min_days_listed": 10},
+    {"method": "PrecisionFilter"},
+    {"method": "PriceFilter", "low_price_ratio": 0.01},
+    {"method": "SpreadFilter", "max_spread_ratio": 0.005},
+    {"method": "ShuffleFilter", "seed": 42}
+    ],
+```

docs/index.md

@@ -1,5 +1,5 @@
 # Freqtrade
-[![Build Status](https://travis-ci.org/freqtrade/freqtrade.svg?branch=develop)](https://travis-ci.org/freqtrade/freqtrade)
+[![Freqtrade CI](https://github.com/freqtrade/freqtrade/workflows/Freqtrade%20CI/badge.svg)](https://github.com/freqtrade/freqtrade/actions/)
 [![Coverage Status](https://coveralls.io/repos/github/freqtrade/freqtrade/badge.svg?branch=develop&service=github)](https://coveralls.io/github/freqtrade/freqtrade?branch=develop)
 [![Maintainability](https://api.codeclimate.com/v1/badges/5737e6d668200b7518ff/maintainability)](https://codeclimate.com/github/freqtrade/freqtrade/maintainability)
 
@@ -8,11 +8,13 @@
 <!-- Place this tag where you want the button to render. -->
 <a class="github-button" href="https://github.com/freqtrade/freqtrade/fork" data-icon="octicon-repo-forked" data-size="large" aria-label="Fork freqtrade/freqtrade on GitHub">Fork</a>
 <!-- Place this tag where you want the button to render. -->
-<a class="github-button" href="https://github.com/freqtrade/freqtrade/archive/master.zip" data-icon="octicon-cloud-download" data-size="large" aria-label="Download freqtrade/freqtrade on GitHub">Download</a>
+<a class="github-button" href="https://github.com/freqtrade/freqtrade/archive/stable.zip" data-icon="octicon-cloud-download" data-size="large" aria-label="Download freqtrade/freqtrade on GitHub">Download</a>
 <!-- Place this tag where you want the button to render. -->
 <a class="github-button" href="https://github.com/freqtrade" data-size="large" aria-label="Follow @freqtrade on GitHub">Follow @freqtrade</a>
+
 ## Introduction
-Freqtrade is a cryptocurrency trading bot written in Python.
+
+Freqtrade is a crypto-currency algorithmic trading software developed in python (3.6+) and supported on Windows, macOS and Linux.
 
 !!! Danger "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.
@@ -23,28 +25,21 @@ Freqtrade is a cryptocurrency trading bot written in Python.
 
 ## Features
 
- - Based on Python 3.6+: For botting on any operating system — Windows, macOS and Linux.
+- Develop your Strategy: Write your strategy in python, using [pandas](https://pandas.pydata.org/). Example strategies to inspire you are available in the [strategy repository](https://github.com/freqtrade/freqtrade-strategies).
- - Persistence: Persistence is achieved through sqlite database.
+- Download market data: Download historical data of the exchange and the markets your may want to trade with.
- - Dry-run mode: Run the bot without playing money.
+- Backtest: Test your strategy on downloaded historical data.
- - Backtesting: Run a simulation of your buy/sell strategy with historical data.
+- Optimize: Find the best parameters for your strategy using hyperoptimization which employs machining learning methods. You can optimize buy, sell, take profit (ROI), stop-loss and trailing stop-loss parameters for your strategy.
- - Strategy Optimization by machine learning: Use machine learning to optimize your buy/sell strategy parameters with real exchange data.
+- Select markets: Create your static list or use an automatic one based on top traded volumes and/or prices (not available during backtesting). You can also explicitly blacklist markets you don't want to trade.
- - Edge position sizing: Calculate your win rate, risk reward ratio, the best stoploss and adjust your position size before taking a position for each specific market.
+- Run: Test your strategy with simulated money (Dry-Run mode) or deploy it with real money (Live-Trade mode).
- - Whitelist crypto-currencies: Select which crypto-currency you want to trade or use dynamic whitelists based on market (pair) trade volume.
+- Run using Edge (optional module): The concept is to find the best historical [trade expectancy](edge.md#expectancy) by markets based on variation of the stop-loss and then allow/reject markets to trade. The sizing of the trade is based on a risk of a percentage of your capital.
- - Blacklist crypto-currencies: Select which crypto-currency you want to avoid.
+- Control/Monitor: Use Telegram or a REST API (start/stop the bot, show profit/loss, daily summary, current open trades results, etc.).
- - Manageable via Telegram or REST APi: Manage the bot with Telegram or via the builtin REST API.
+- Analyse: Further analysis can be performed on either Backtesting data or Freqtrade trading history (SQL database), including automated standard plots, and methods to load the data into [interactive environments](data-analysis.md).
- - Display profit/loss in fiat: Display your profit/loss in any of 33 fiat currencies supported.
- - Daily summary of profit/loss: Receive the daily summary of your profit/loss.
- - Performance status report: Receive the performance status of your current trades.
 
 ## Requirements
 
-### Up to date clock
-
-The clock on the system running the bot must be accurate, synchronized to a NTP server frequently enough to avoid problems with communication to the exchanges.
-
 ### Hardware requirements
 
-To run this bot we recommend you a cloud instance with a minimum of:
+To run this bot we recommend you a linux cloud instance with a minimum of:
 
 - 2GB RAM
 - 1GB disk space
@@ -52,20 +47,26 @@ To run this bot we recommend you a cloud instance with a minimum of:
 
 ### Software requirements
 
+- Docker (Recommended)
+
+Alternatively
+
 - Python 3.6.x
 - pip (pip3)
 - git
 - TA-Lib
 - virtualenv (Recommended)
-- Docker (Recommended)
 
 ## Support
 
-Help / Slack
+### Help / Discord / Slack
-For any questions not covered by the documentation or for further information about the bot, we encourage you to join our Slack channel.
 
-Click [here](https://join.slack.com/t/highfrequencybot/shared_invite/enQtNjU5ODcwNjI1MDU3LWEyODBiNzkzNzcyNzU0MWYyYzE5NjIyOTQxMzBmMGUxOTIzM2YyN2Y4NWY1YTEwZDgwYTRmMzE2NmM5ZmY2MTg) to join Slack channel.
+For any questions not covered by the documentation or for further information about the bot, or to simply engage with like-minded individuals, we encourage you to join our slack channel.
+
+Please check out our [discord server](https://discord.gg/MA9v74M).
+
+You can also join our [Slack channel](https://join.slack.com/t/highfrequencybot/shared_invite/zt-jaut7r4m-Y17k4x5mcQES9a9swKuxbg).
 
 ## Ready to try?
 
-Begin by reading our installation guide [here](installation).
+Begin by reading our installation guide [for docker](docker_quickstart.md) (recommended), or for [installation without docker](installation.md).

docs/javascripts/config.js

@@ -0,0 +1,12 @@
+window.MathJax = {
+  tex: {
+    inlineMath: [["\\(", "\\)"]],
+    displayMath: [["\\[", "\\]"]],
+    processEscapes: true,
+    processEnvironments: true
+  },
+  options: {
+    ignoreHtmlClass: ".*|",
+    processHtmlClass: "arithmatex"
+  }
+};

docs/partials/header.html

@@ -49,4 +49,6 @@
     </nav>
     <!-- Place this tag in your head or just before your close body tag. -->
     <script async defer src="https://buttons.github.io/buttons.js"></script>
+    <script src="https://code.jquery.com/jquery-3.4.1.min.js"
+        integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
 </header>

docs/plotting.md

@@ -2,9 +2,9 @@
 
 This page explains how to plot prices, indicators and profits.
 
-## Installation
+## Installation / Setup
 
-Plotting scripts use Plotly library. Install/upgrade it with:
+Plotting modules use the Plotly library. You can install / upgrade this by running the following command:
 
 ``` bash
 pip install -U -r requirements-plot.txt
@@ -12,98 +12,288 @@ pip install -U -r requirements-plot.txt
 
 ## Plot price and indicators
 
-Usage for the price plotter:
+The `freqtrade plot-dataframe` subcommand shows an interactive graph with three subplots:
 
-``` bash
+* Main plot with candlestics and indicators following price (sma/ema)
-python3 script/plot_dataframe.py [-h] [-p pairs] [--live]
+* Volume bars
+* Additional indicators as specified by `--indicators2`
+
+![plot-dataframe](assets/plot-dataframe.png)
+
+Possible arguments:
+
+```
+usage: freqtrade plot-dataframe [-h] [-v] [--logfile FILE] [-V] [-c PATH]
+                                [-d PATH] [--userdir PATH] [-s NAME]
+                                [--strategy-path PATH] [-p PAIRS [PAIRS ...]]
+                                [--indicators1 INDICATORS1 [INDICATORS1 ...]]
+                                [--indicators2 INDICATORS2 [INDICATORS2 ...]]
+                                [--plot-limit INT] [--db-url PATH]
+                                [--trade-source {DB,file}] [--export EXPORT]
+                                [--export-filename PATH]
+                                [--timerange TIMERANGE] [-i TIMEFRAME]
+                                [--no-trades]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
+                        Show profits for only these pairs. Pairs are space-
+                        separated.
+  --indicators1 INDICATORS1 [INDICATORS1 ...]
+                        Set indicators from your strategy you want in the
+                        first row of the graph. Space-separated list. Example:
+                        `ema3 ema5`. Default: `['sma', 'ema3', 'ema5']`.
+  --indicators2 INDICATORS2 [INDICATORS2 ...]
+                        Set indicators from your strategy you want in the
+                        third row of the graph. Space-separated list. Example:
+                        `fastd fastk`. Default: `['macd', 'macdsignal']`.
+  --plot-limit INT      Specify tick limit for plotting. Notice: too high
+                        values cause huge files. Default: 750.
+  --db-url PATH         Override trades database URL, this is useful in custom
+                        deployments (default: `sqlite:///tradesv3.sqlite` for
+                        Live Run mode, `sqlite:///tradesv3.dryrun.sqlite` for
+                        Dry Run).
+  --trade-source {DB,file}
+                        Specify the source for trades (Can be DB or file
+                        (backtest file)) Default: file
+  --export EXPORT       Export backtest results, argument are: trades.
+                        Example: `--export=trades`
+  --export-filename PATH
+                        Save backtest results to the file with this filename.
+                        Requires `--export` to be set as well. Example:
+                        `--export-filename=user_data/backtest_results/backtest
+                        _today.json`
+  --timerange TIMERANGE
+                        Specify what timerange of data to use.
+  -i TIMEFRAME, --timeframe TIMEFRAME, --ticker-interval TIMEFRAME
+                        Specify ticker interval (`1m`, `5m`, `30m`, `1h`,
+                        `1d`).
+  --no-trades           Skip using trades from backtesting file and DB.
+
+Common arguments:
+  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
+  --logfile FILE        Log to the file specified. Special values are:
+                        'syslog', 'journald'. See the documentation for more
+                        details.
+  -V, --version         show program's version number and exit
+  -c PATH, --config PATH
+                        Specify configuration file (default:
+                        `userdir/config.json` or `config.json` whichever
+                        exists). Multiple --config options may be used. Can be
+                        set to `-` to read config from stdin.
+  -d PATH, --datadir PATH
+                        Path to directory with historical backtesting data.
+  --userdir PATH, --user-data-dir PATH
+                        Path to userdata directory.
+
+Strategy arguments:
+  -s NAME, --strategy NAME
+                        Specify strategy class name which will be used by the
+                        bot.
+  --strategy-path PATH  Specify additional strategy lookup path.
 ```
 
-Example
+Example:
 
 ``` bash
-python3 scripts/plot_dataframe.py -p BTC/ETH
+freqtrade plot-dataframe -p BTC/ETH
 ```
 
-The `-p` pairs argument can be used to specify pairs you would like to plot.
+The `-p/--pairs` argument can be used to specify pairs you would like to plot.
+
+!!! Note
+    The `freqtrade plot-dataframe` subcommand generates one plot-file per pair.
 
 Specify custom indicators.
 Use `--indicators1` for the main plot and `--indicators2` for the subplot below (if values are in a different range than prices).
 
+!!! Tip
+    You will almost certainly want to specify a custom strategy! This can be done by adding `-s Classname` / `--strategy ClassName` to the command.
+
 ``` bash
-python3 scripts/plot_dataframe.py -p BTC/ETH --indicators1 sma,ema --indicators2 macd
+freqtrade plot-dataframe --strategy AwesomeStrategy -p BTC/ETH --indicators1 sma ema --indicators2 macd
 ```
 
-### Advanced use
+### Further usage examples
 
-To plot multiple pairs, separate them with a comma:
+To plot multiple pairs, separate them with a space:
 
 ``` bash
-python3 scripts/plot_dataframe.py -p BTC/ETH,XRP/ETH
+freqtrade plot-dataframe --strategy AwesomeStrategy -p BTC/ETH XRP/ETH
 ```
 
-To plot the current live price use the `--live` flag:
+To plot a timerange (to zoom in)
 
 ``` bash
-python3 scripts/plot_dataframe.py -p BTC/ETH --live
+freqtrade plot-dataframe --strategy AwesomeStrategy -p BTC/ETH --timerange=20180801-20180805
 ```
 
-To plot a timerange (to zoom in):
+To plot trades stored in a database use `--db-url` in combination with `--trade-source DB`:
 
 ``` bash
-python3 scripts/plot_dataframe.py -p BTC/ETH --timerange=100-200
+freqtrade plot-dataframe --strategy AwesomeStrategy --db-url sqlite:///tradesv3.dry_run.sqlite -p BTC/ETH --trade-source DB
-```
-
-Timerange doesn't work with live data.
-
-To plot trades stored in a database use `--db-url` argument:
-
-``` bash
-python3 scripts/plot_dataframe.py --db-url sqlite:///tradesv3.dry_run.sqlite -p BTC/ETH --trade-source DB
 ```
 
 To plot trades from a backtesting result, use `--export-filename <filename>`
 
 ``` bash
-python3 scripts/plot_dataframe.py --export-filename user_data/backtest_data/backtest-result.json -p BTC/ETH
+freqtrade plot-dataframe --strategy AwesomeStrategy --export-filename user_data/backtest_results/backtest-result.json -p BTC/ETH
 ```
 
-To plot a custom strategy the strategy should have first be backtested.
+### Plot dataframe basics
-The results may then be plotted with the -s argument:
 
-``` bash
+![plot-dataframe2](assets/plot-dataframe2.png)
-python3 scripts/plot_dataframe.py -s Strategy_Name -p BTC/ETH --datadir user_data/data/<exchange_name>/
+
+The `plot-dataframe` subcommand requires backtesting data, a strategy and either a backtesting-results file or a database, containing trades corresponding to the strategy.
+
+The resulting plot will have the following elements:
+
+* Green triangles: Buy signals from the strategy. (Note: not every buy signal generates a trade, compare to cyan circles.)
+* Red triangles: Sell signals from the strategy. (Also, not every sell signal terminates a trade, compare to red and green squares.)
+* Cyan circles: Trade entry points.
+* Red squares: Trade exit points for trades with loss or 0% profit.
+* Green squares: Trade exit points for profitable trades.
+* Indicators with values corresponding to the candle scale (e.g. SMA/EMA), as specified with `--indicators1`.
+* Volume (bar chart at the bottom of the main chart).
+* Indicators with values in different scales (e.g. MACD, RSI) below the volume bars, as specified with `--indicators2`.
+
+!!! Note "Bollinger Bands"
+    Bollinger bands are automatically added to the plot if the columns `bb_lowerband` and `bb_upperband` exist, and are painted as a light blue area spanning from the lower band to the upper band.
+
+#### Advanced plot configuration
+
+An advanced plot configuration can be specified in the strategy in the `plot_config` parameter.
+
+Additional features when using plot_config include:
+
+* Specify colors per indicator
+* Specify additional subplots
+
+The sample plot configuration below specifies fixed colors for the indicators. Otherwise consecutive plots may produce different colorschemes each time, making comparisons difficult.
+It also allows multiple subplots to display both MACD and RSI at the same time.
+
+Sample configuration with inline comments explaining the process:
+
+``` python
+    plot_config = {
+        'main_plot': {
+            # Configuration for main plot indicators.
+            # Specifies `ema10` to be red, and `ema50` to be a shade of gray
+            'ema10': {'color': 'red'},
+            'ema50': {'color': '#CCCCCC'},
+            # By omitting color, a random color is selected.
+            'sar': {},
+        },
+        'subplots': {
+            # Create subplot MACD
+            "MACD": {
+                'macd': {'color': 'blue'},
+                'macdsignal': {'color': 'orange'},
+            },
+            # Additional subplot RSI
+            "RSI": {
+                'rsi': {'color': 'red'},
+            }
+        }
+    }
 ```
 
+!!! Note
+    The above configuration assumes that `ema10`, `ema50`, `macd`, `macdsignal` and `rsi` are columns in the DataFrame created by the strategy.
+
 ## Plot profit
 
-The profit plotter shows a picture with three plots:
+![plot-profit](assets/plot-profit.png)
 
-1) Average closing price for all pairs
+The `plot-profit` subcommand shows an interactive graph with three plots:
-2) The summarized profit made by backtesting.
-   Note that this is not the real-world profit, but
-   more of an estimate.
-3) Each pair individually profit
 
-The first graph is good to get a grip of how the overall market
+* Average closing price for all pairs.
-progresses.
+* The summarized profit made by backtesting.
+Note that this is not the real-world profit, but more of an estimate.
+* Profit for each individual pair.
 
-The second graph will show how your algorithm works or doesn't.
+The first graph is good to get a grip of how the overall market progresses.
-Perhaps you want an algorithm that steadily makes small profits,
-or one that acts less seldom, but makes big swings.
 
-The third graph can be useful to spot outliers, events in pairs
+The second graph will show if your algorithm works or doesn't.
-that makes profit spikes.
+Perhaps you want an algorithm that steadily makes small profits, or one that acts less often, but makes big swings.
+This graph will also highlight the start (and end) of the Max drawdown period.
 
-Usage for the profit plotter:
+The third graph can be useful to spot outliers, events in pairs that cause profit spikes.
 
-``` bash
+Possible options for the `freqtrade plot-profit` subcommand:
-python3 script/plot_profit.py [-h] [-p pair] [--datadir directory] [--ticker_interval num]
+
+```
+usage: freqtrade plot-profit [-h] [-v] [--logfile FILE] [-V] [-c PATH]
+                             [-d PATH] [--userdir PATH] [-s NAME]
+                             [--strategy-path PATH] [-p PAIRS [PAIRS ...]]
+                             [--timerange TIMERANGE] [--export EXPORT]
+                             [--export-filename PATH] [--db-url PATH]
+                             [--trade-source {DB,file}] [-i TIMEFRAME]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
+                        Show profits for only these pairs. Pairs are space-
+                        separated.
+  --timerange TIMERANGE
+                        Specify what timerange of data to use.
+  --export EXPORT       Export backtest results, argument are: trades.
+                        Example: `--export=trades`
+  --export-filename PATH
+                        Save backtest results to the file with this filename.
+                        Requires `--export` to be set as well. Example:
+                        `--export-filename=user_data/backtest_results/backtest
+                        _today.json`
+  --db-url PATH         Override trades database URL, this is useful in custom
+                        deployments (default: `sqlite:///tradesv3.sqlite` for
+                        Live Run mode, `sqlite:///tradesv3.dryrun.sqlite` for
+                        Dry Run).
+  --trade-source {DB,file}
+                        Specify the source for trades (Can be DB or file
+                        (backtest file)) Default: file
+  -i TIMEFRAME, --timeframe TIMEFRAME, --ticker-interval TIMEFRAME
+                        Specify ticker interval (`1m`, `5m`, `30m`, `1h`,
+                        `1d`).
+
+Common arguments:
+  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
+  --logfile FILE        Log to the file specified. Special values are:
+                        'syslog', 'journald'. See the documentation for more
+                        details.
+  -V, --version         show program's version number and exit
+  -c PATH, --config PATH
+                        Specify configuration file (default:
+                        `userdir/config.json` or `config.json` whichever
+                        exists). Multiple --config options may be used. Can be
+                        set to `-` to read config from stdin.
+  -d PATH, --datadir PATH
+                        Path to directory with historical backtesting data.
+  --userdir PATH, --user-data-dir PATH
+                        Path to userdata directory.
+
+Strategy arguments:
+  -s NAME, --strategy NAME
+                        Specify strategy class name which will be used by the
+                        bot.
+  --strategy-path PATH  Specify additional strategy lookup path.
 ```
 
-The `-p` pair argument, can be used to plot a single pair
+The `-p/--pairs`  argument, can be used to limit the pairs that are considered for this calculation.
 
-Example
+Examples:
+
+Use custom backtest-export file
 
 ``` bash
-python3 scripts/plot_profit.py --datadir ../freqtrade/freqtrade/tests/testdata-20171221/ -p LTC/BTC
+freqtrade plot-profit  -p LTC/BTC --export-filename user_data/backtest_results/backtest-result.json
+```
+
+Use custom database
+
+``` bash
+freqtrade plot-profit  -p LTC/BTC --db-url sqlite:///tradesv3.sqlite --trade-source DB
+```
+
+``` bash
+freqtrade --datadir user_data/data/binance_save/ plot-profit -p LTC/BTC
 ```

docs/requirements-docs.txt

@@ -1 +1,3 @@
-mkdocs-material==3.1.0
+mkdocs-material==6.1.6
+mdx_truly_sane_lists==1.2
+pymdown-extensions==8.0.1

docs/rest-api.md

@@ -11,18 +11,28 @@ Sample configuration:
         "enabled": true,
         "listen_ip_address": "127.0.0.1",
         "listen_port": 8080,
+        "verbosity": "info",
+        "jwt_secret_key": "somethingrandom",
+        "CORS_origins": [],
         "username": "Freqtrader",
         "password": "SuperSecret1!"
     },
 ```
 
-!!! Danger Security warning
+!!! Danger "Security warning"
     By default, the configuration listens on localhost only (so it's not reachable from other systems). We strongly recommend to not expose this API to the internet and choose a strong, unique password, since others will potentially be able to control your bot.
 
-!!! Danger Password selection
+!!! Danger "Password selection"
     Please make sure to select a very strong, unique password to protect your bot from unauthorized access.
 
-You can then access the API by going to `http://127.0.0.1:8080/api/v1/version` to check if the API is running correctly.
+You can then access the API by going to `http://127.0.0.1:8080/api/v1/ping` in a browser to check if the API is running correctly.
+This should return the response:
+
+``` output
+{"status":"pong"}
+```
+
+All other endpoints return sensitive info and require authentication and are therefore not available through a web browser.
 
 To generate a secure password, either use a password manager, or use the below code snipped.
 
@@ -31,9 +41,12 @@ import secrets
 secrets.token_hex()
 ```
 
+!!! Hint
+    Use the same method to also generate a JWT secret key (`jwt_secret_key`).
+
 ### Configuration with docker
 
-If you run your bot using docker, you'll need to have the bot listen to incomming connections. The security is then handled by docker.
+If you run your bot using docker, you'll need to have the bot listen to incoming connections. The security is then handled by docker.
 
 ``` json
     "api_server": {
@@ -58,7 +71,7 @@ docker run -d \
   -v ~/.freqtrade/user_data/:/freqtrade/user_data \
   -v ~/.freqtrade/tradesv3.sqlite:/freqtrade/tradesv3.sqlite \
   -p 127.0.0.1:8080:8080 \
-  freqtrade --db-url sqlite:///tradesv3.sqlite --strategy MyAwesomeStrategy
+  freqtrade trade --db-url sqlite:///tradesv3.sqlite --strategy MyAwesomeStrategy
 ```
 
 !!! Danger "Security warning"
@@ -67,7 +80,7 @@ docker run -d \
 ## Consuming the API
 
 You can consume the API by using the script `scripts/rest_client.py`.
-The client script only requires the `requests` module, so FreqTrade does not need to be installed on the system.
+The client script only requires the `requests` module, so Freqtrade does not need to be installed on the system.
 
 ``` bash
 python3 scripts/rest_client.py <command> [optional parameters]
@@ -91,28 +104,42 @@ By default, the script assumes `127.0.0.1` (localhost) and port `8080` to be use
 python3 scripts/rest_client.py --config rest_config.json <command> [optional parameters]
 ```
 
-## Available commands
+## Available endpoints
 
-|  Command | Default | Description |
+|  Command | Description |
-|----------|---------|-------------|
+|----------|-------------|
-| `start` | | Starts the trader
+| `ping` | Simple command testing the API Readiness - requires no authentication.
-| `stop` | | Stops the trader
+| `start` | Starts the trader.
-| `stopbuy` | | Stops the trader from opening new trades. Gracefully closes open trades according to their rules.
+| `stop` | Stops the trader.
-| `reload_conf` | | Reloads the configuration file
+| `stopbuy` | Stops the trader from opening new trades. Gracefully closes open trades according to their rules.
-| `status` | | Lists all open trades
+| `reload_config` | Reloads the configuration file.
-| `status table` | | List all open trades in a table format
+| `trades` | List last trades.
-| `count` | | Displays number of trades used and available
+| `delete_trade <trade_id>` | Remove trade from the database. Tries to close open orders. Requires manual handling of this trade on the exchange.
-| `profit` | | Display a summary of your profit/loss from close trades and some stats about your performance
+| `show_config` | Shows part of the current configuration with relevant settings to operation.
-| `forcesell <trade_id>` | | Instantly sells the given trade  (Ignoring `minimum_roi`).
+| `logs` | Shows last log messages.
-| `forcesell all` | | Instantly sells all open trades (Ignoring `minimum_roi`).
+| `status` | Lists all open trades.
-| `forcebuy <pair> [rate]` | | Instantly buys the given pair. Rate is optional. (`forcebuy_enable` must be set to True)
+| `count` | Displays number of trades used and available.
-| `performance` | | Show performance of each finished trade grouped by pair
+| `locks` | Displays currently locked pairs.
-| `balance` | | Show account balance per currency
+| `profit` | Display a summary of your profit/loss from close trades and some stats about your performance.
-| `daily <n>` | 7 | Shows profit or loss per day, over the last n days
+| `forcesell <trade_id>` | Instantly sells the given trade  (Ignoring `minimum_roi`).
-| `whitelist` | | Show the current whitelist
+| `forcesell all` | Instantly sells all open trades (Ignoring `minimum_roi`).
-| `blacklist [pair]` | | Show the current blacklist, or adds a pair to the blacklist.
+| `forcebuy <pair> [rate]` | Instantly buys the given pair. Rate is optional. (`forcebuy_enable` must be set to True)
-| `edge` | | Show validated pairs by Edge if it is enabled.
+| `performance` | Show performance of each finished trade grouped by pair.
-| `version` | | Show version
+| `balance` | Show account balance per currency.
+| `daily <n>` | Shows profit or loss per day, over the last n days (n defaults to 7).
+| `whitelist` | Show the current whitelist.
+| `blacklist [pair]` | Show the current blacklist, or adds a pair to the blacklist.
+| `edge` | Show validated pairs by Edge if it is enabled.
+| `pair_candles` | Returns dataframe for a pair / timeframe combination while the bot is running. **Alpha**
+| `pair_history` | Returns an analyzed dataframe for a given timerange, analyzed by a given strategy. **Alpha**
+| `plot_config` | Get plot config from the strategy (or nothing if not configured). **Alpha**
+| `strategies` | List strategies in strategy directory. **Alpha**
+| `strategy <strategy>` | Get specific Strategy content. **Alpha**
+| `available_pairs` | List available backtest data. **Alpha**
+| `version` | Show version.
+
+!!! Warning "Alpha status"
+    Endpoints labeled with *Alpha status* above may change at any time without notice.
 
 Possible commands can be listed from the rest-client script using the `help` command.
 
@@ -122,72 +149,160 @@ python3 scripts/rest_client.py help
 
 ``` output
 Possible commands:
+
+available_pairs
+	Return available pair (backtest data) based on timeframe / stake_currency selection
+
+        :param timeframe: Only pairs with this timeframe available.
+        :param stake_currency: Only pairs that include this timeframe
+
 balance
-        Get the account balance
+	Get the account balance.
-        :returns: json object
 
 blacklist
-        Show the current blacklist
+	Show the current blacklist.
+
         :param add: List of coins to add (example: "BNB/BTC")
-        :returns: json object
 
 count
-        Returns the amount of open trades
+	Return the amount of open trades.
-        :returns: json object
 
 daily
-        Returns the amount of open trades
+	Return the amount of open trades.
-        :returns: json object
+
+delete_trade
+	Delete trade from the database.
+        Tries to close open orders. Requires manual handling of this asset on the exchange.
+
+        :param trade_id: Deletes the trade with this ID from the database.
 
 edge
-        Returns information about edge
+	Return information about edge.
-        :returns: json object
 
 forcebuy
-        Buy an asset
+	Buy an asset.
+
         :param pair: Pair to buy (ETH/BTC)
         :param price: Optional - price to buy
-        :returns: json object of the trade
 
 forcesell
-        Force-sell a trade
+	Force-sell a trade.
+
         :param tradeid: Id of the trade (can be received via status command)
-        :returns: json object
+
+logs
+	Show latest logs.
+
+        :param limit: Limits log messages to the last <limit> logs. No limit to get all the trades.
+
+pair_candles
+	Return live dataframe for <pair><timeframe>.
+
+        :param pair: Pair to get data for
+        :param timeframe: Only pairs with this timeframe available.
+        :param limit: Limit result to the last n candles.
+
+pair_history
+	Return historic, analyzed dataframe
+
+        :param pair: Pair to get data for
+        :param timeframe: Only pairs with this timeframe available.
+        :param strategy: Strategy to analyze and get values for
+        :param timerange: Timerange to get data for (same format than --timerange endpoints)
 
 performance
-        Returns the performance of the different coins
+	Return the performance of the different coins.
-        :returns: json object
+
+plot_config
+	Return plot configuration if the strategy defines one.
 
 profit
-        Returns the profit summary
+	Return the profit summary.
-        :returns: json object
 
-reload_conf
+reload_config
-        Reload configuration
+	Reload configuration.
-        :returns: json object
+
+show_config
+	
+        Returns part of the configuration, relevant for trading operations.
 
 start
-        Start the bot if it's in stopped state.
+	Start the bot if it's in the stopped state.
-        :returns: json object
 
 status
-        Get the status of open trades
+	Get the status of open trades.
-        :returns: json object
 
 stop
-        Stop the bot. Use start to restart
+	Stop the bot. Use `start` to restart.
-        :returns: json object
 
 stopbuy
-        Stop buying (but handle sells gracefully).
+	Stop buying (but handle sells gracefully). Use `reload_config` to reset.
-        use reload_conf to reset
+
-        :returns: json object
+strategies
+	Lists available strategies
+
+strategy
+	Get strategy details
+
+        :param strategy: Strategy class name
+
+trades
+	Return trades history.
+
+        :param limit: Limits trades to the X last trades. No limit to get all the trades.
 
 version
-        Returns the version of the bot
+	Return the version of the bot.
-        :returns: json object containing the version
 
 whitelist
-        Show the current whitelist
+	Show the current whitelist.
-        :returns: json object
+
 ```
+
+## Advanced API usage using JWT tokens
+
+!!! Note
+    The below should be done in an application (a Freqtrade REST API client, which fetches info via API), and is not intended to be used on a regular basis.
+
+Freqtrade's REST API also offers JWT (JSON Web Tokens).
+You can login using the following command, and subsequently use the resulting access_token.
+
+``` bash
+> curl -X POST --user Freqtrader http://localhost:8080/api/v1/token/login
+{"access_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1ODkxMTk2ODEsIm5iZiI6MTU4OTExOTY4MSwianRpIjoiMmEwYmY0NWUtMjhmOS00YTUzLTlmNzItMmM5ZWVlYThkNzc2IiwiZXhwIjoxNTg5MTIwNTgxLCJpZGVudGl0eSI6eyJ1IjoiRnJlcXRyYWRlciJ9LCJmcmVzaCI6ZmFsc2UsInR5cGUiOiJhY2Nlc3MifQ.qt6MAXYIa-l556OM7arBvYJ0SDI9J8bIk3_glDujF5g","refresh_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1ODkxMTk2ODEsIm5iZiI6MTU4OTExOTY4MSwianRpIjoiZWQ1ZWI3YjAtYjMwMy00YzAyLTg2N2MtNWViMjIxNWQ2YTMxIiwiZXhwIjoxNTkxNzExNjgxLCJpZGVudGl0eSI6eyJ1IjoiRnJlcXRyYWRlciJ9LCJ0eXBlIjoicmVmcmVzaCJ9.d1AT_jYICyTAjD0fiQAr52rkRqtxCjUGEMwlNuuzgNQ"}
+
+> access_token="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1ODkxMTk2ODEsIm5iZiI6MTU4OTExOTY4MSwianRpIjoiMmEwYmY0NWUtMjhmOS00YTUzLTlmNzItMmM5ZWVlYThkNzc2IiwiZXhwIjoxNTg5MTIwNTgxLCJpZGVudGl0eSI6eyJ1IjoiRnJlcXRyYWRlciJ9LCJmcmVzaCI6ZmFsc2UsInR5cGUiOiJhY2Nlc3MifQ.qt6MAXYIa-l556OM7arBvYJ0SDI9J8bIk3_glDujF5g"
+# Use access_token for authentication
+> curl -X GET --header "Authorization: Bearer ${access_token}" http://localhost:8080/api/v1/count
+
+```
+
+Since the access token has a short timeout (15 min) - the `token/refresh` request should be used periodically to get a fresh access token:
+
+``` bash
+> curl -X POST --header "Authorization: Bearer ${refresh_token}"http://localhost:8080/api/v1/token/refresh
+{"access_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1ODkxMTk5NzQsIm5iZiI6MTU4OTExOTk3NCwianRpIjoiMDBjNTlhMWUtMjBmYS00ZTk0LTliZjAtNWQwNTg2MTdiZDIyIiwiZXhwIjoxNTg5MTIwODc0LCJpZGVudGl0eSI6eyJ1IjoiRnJlcXRyYWRlciJ9LCJmcmVzaCI6ZmFsc2UsInR5cGUiOiJhY2Nlc3MifQ.1seHlII3WprjjclY6DpRhen0rqdF4j6jbvxIhUFaSbs"}
+```
+
+## CORS
+
+All web-based frontends are subject to [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) - Cross-Origin Resource Sharing.
+Since most of the requests to the Freqtrade API must be authenticated, a proper CORS policy is key to avoid security problems.
+Also, the standard disallows `*` CORS policies for requests with credentials, so this setting must be set appropriately.
+
+Users can configure this themselves via the `CORS_origins` configuration setting.
+It consists of a list of allowed sites that are allowed to consume resources from the bot's API.
+
+Assuming your application is deployed as `https://frequi.freqtrade.io/home/` - this would mean that the following configuration becomes necessary:
+
+```jsonc
+{
+    //...
+    "jwt_secret_key": "somethingrandom",
+    "CORS_origins": ["https://frequi.freqtrade.io"],
+    //...
+}
+```
+
+!!! Note
+    We strongly recommend to also set `jwt_secret_key` to something random and known only to yourself to avoid unauthorized access to your bot.

docs/sandbox-testing.md

@@ -1,104 +1,59 @@
 # Sandbox API testing
 
-Where an exchange provides a sandbox for risk-free integration, or end-to-end, testing CCXT provides access to these.
+Some exchanges provide sandboxes or testbeds for risk-free testing, while running the bot against a real exchange.
+With some configuration, freqtrade (in combination with ccxt) provides access to these.
 
-This document is a *light overview of configuring Freqtrade and GDAX sandbox.
+This document is an overview to configure Freqtrade to be used with sandboxes.
-This can be useful to developers and trader alike as Freqtrade is quite customisable.
+This can be useful to developers and trader alike.
 
-When testing your API connectivity, make sure to use the following URLs.
+## Exchanges known to have a sandbox / testnet
-***Website**
+
-https://public.sandbox.gdax.com
+* [binance](https://testnet.binance.vision/)
-***REST API**
+* [coinbasepro](https://public.sandbox.pro.coinbase.com)
-https://api-public.sandbox.gdax.com
+* [gemini](https://exchange.sandbox.gemini.com/)
+* [huobipro](https://www.testnet.huobi.pro/)
+* [kucoin](https://sandbox.kucoin.com/)
+* [phemex](https://testnet.phemex.com/) 
+
+!!! Note
+    We did not test correct functioning of all of the above testnets. Please report your experiences with each sandbox.
 
 ---
 
-# Configure a Sandbox account on Gdax
+## Configure a Sandbox account
 
-Aim of this document section
+When testing your API connectivity, make sure to use the appropriate sandbox / testnet URL.
 
-- An sanbox account
+In general, you should follow these steps to enable an exchange's sandbox:
-- create 2FA (needed to create an API)
-- Add test 50BTC to account 
-- Create :
-- - API-KEY
-- - API-Secret
-- - API Password
 
-## Acccount
+* Figure out if an exchange has a sandbox (most likely by using google or the exchange's support documents)
+* Create a sandbox account (often the sandbox-account requires separate registration)
+* [Add some test assets to account](#add-test-funds)
+* Create API keys
 
-This link will redirect to the sandbox main page to login / create account dialogues:
+### Add test funds
-https://public.sandbox.pro.coinbase.com/orders/
 
-After registration and Email confimation you wil be redirected into your sanbox account.  It is easy to verify you're in sandbox by checking the URL bar.
+Usually, sandbox exchanges allow depositing funds directly via web-interface.
-> https://public.sandbox.pro.coinbase.com/
+You should make sure to have a realistic amount of funds available to your test-account, so results are representable of your real account funds.
 
-## Enable 2Fa (a prerequisite to creating sandbox API Keys)
+!!! Warning
+    Test exchanges will **NEVER** require your real credit card or banking details!
 
-From within sand box site select your profile, top right.
+## Configure freqtrade to use a exchange's sandbox
->Or as a direct link: https://public.sandbox.pro.coinbase.com/profile
 
-From the menu panel to the left of the screen select
+### Sandbox URLs
-
-> Security: "*View or Update*"
-
-In the new site select "enable authenticator" as typical google Authenticator.
-
-- open Google Authenticator on your phone
-- scan barcode
-- enter your generated 2fa
-
-## Enable API Access
-
-From within sandbox select profile>api>create api-keys
->or as a direct link: https://public.sandbox.pro.coinbase.com/profile/api
-
-Click on "create one" and ensure  **view** and **trade**  are "checked" and sumbit your 2FA
-
-- **Copy and paste the Passphase** into a notepade this will be needed later
-- **Copy and paste the API Secret** popup into a notepad this will needed later
-- **Copy and paste the API Key** into a notepad this will needed later
-
-## Add 50 BTC test funds
-
-To add funds, use the web interface deposit and withdraw buttons.
-
-To begin select 'Wallets' from the top menu.
-> Or as a direct link: https://public.sandbox.pro.coinbase.com/wallets
-
-- Deposits (bottom left of screen)
-- - Deposit Funds Bitcoin
-- - - Coinbase BTC Wallet
-- - - - Max (50 BTC)
-- - - - - Deposit
-
-*This process may be repeated for other currencies, ETH as example*
-
----
-
-# Configure Freqtrade to use Gax Sandbox 
-
-The aim of this document section
-
-- Enable sandbox URLs in Freqtrade
-- Configure API
-- - secret
-- - key
-- - passphrase
- 
-## Sandbox URLs
 
 Freqtrade makes use of CCXT which in turn provides a list of URLs to Freqtrade.
 These include `['test']` and `['api']`.
 
-- `[Test]` if available will point to an Exchanges sandbox. 
+* `[Test]` if available will point to an Exchanges sandbox.
-- `[Api]` normally used, and resolves to live API target on the exchange 
+* `[Api]` normally used, and resolves to live API target on the exchange.
 
 To make use of sandbox / test add "sandbox": true, to your config.json
 
 ```json
   "exchange": {
-        "name": "gdax",
+        "name": "coinbasepro",
         "sandbox": true,
         "key": "5wowfxemogxeowo;heiohgmd",
         "secret": "/ZMH1P62rCVmwefewrgcewX8nh4gob+lywxfwfxwwfxwfNsH1ySgvWCUR/w==",
@@ -106,36 +61,57 @@ To make use of sandbox / test add "sandbox": true, to your config.json
         "outdated_offset": 5
         "pair_whitelist": [
             "BTC/USD"
+        ]
+  },
+  "datadir": "user_data/data/coinbasepro_sandbox"
 ```
 
-Also insert your 
+Also the following information:
 
-- api-key  (noted earlier)
+* api-key (created for the sandbox webpage)
-- api-secret (noted earlier)
+* api-secret (noted earlier)
-- password (the passphrase - noted earlier)
+* password (the passphrase - noted earlier)
+
+!!! Tip "Different data directory"
+    We also recommend to set `datadir` to something identifying downloaded data as sandbox data, to avoid having sandbox data mixed with data from the real exchange.
+    This can be done by adding the `"datadir"` key to the configuration.
+    Now, whenever you use this configuration, your data directory will be set to this directory.
 
 ---
 
 ## You should now be ready to test your sandbox
 
-Ensure Freqtrade logs show the sandbox URL, and trades made are shown in sandbox.
+Ensure Freqtrade logs show the sandbox URL, and trades made are shown in sandbox. Also make sure to select a pair which shows at least some decent value (which very often is BTC/<somestablecoin>).
-** Typically the  BTC/USD has the most activity in sandbox to test against.
 
-## GDAX - Old Candles problem
+## Common problems with sandbox exchanges
 
-It is my experience that GDAX sandbox candles may be 20+- minutes out of date. This can cause trades to fail as one of Freqtrades safety checks.
+Sandbox exchange instances often have very low volume, which can cause some problems which usually are not seen on a real exchange instance.
 
-To disable this check, add / change the `"outdated_offset"` parameter in the exchange section of your configuration to adjust for this delay.
+### Old Candles problem
-Example based on the above configuration:
 
-```json
+Since Sandboxes often have low volume, candles can be quite old and show no volume.
-  "exchange": {
+To disable the error "Outdated history for pair ...", best increase the parameter `"outdated_offset"` to a number that seems realistic for the sandbox you're using.
-        "name": "gdax",
+
-        "sandbox": true,
+### Unfilled orders
-        "key": "5wowfxemogxeowo;heiohgmd",
+
-        "secret": "/ZMH1P62rCVmwefewrgcewX8nh4gob+lywxfwfxwwfxwfNsH1ySgvWCUR/w==",
+Sandboxes often have very low volumes - which means that many trades can go unfilled, or can go unfilled for a very long time.
-        "password": "1bkjfkhfhfu6sr",
+
-        "outdated_offset": 30
+To mitigate this, you can try to match the first order on the opposite orderbook side using the following configuration:
-        "pair_whitelist": [
+
-            "BTC/USD"
+``` jsonc
+  "order_types": {
+    "buy": "limit",
+    "sell": "limit"
+    // ...
+  },
+  "bid_strategy": {
+    "price_side": "ask",
+    // ...
+  },
+  "ask_strategy":{
+    "price_side": "bid",
+    // ...
+  },
   ```
+
+  The configuration is similar to the suggested configuration for market orders - however by using limit-orders you can avoid moving the price too much, and you can set the worst price you might get.

docs/sql_cheatsheet.md

@@ -1,13 +1,29 @@
 # SQL Helper
+
 This page contains some help if you want to edit your sqlite db.
 
 ## Install sqlite3
-**Ubuntu/Debian installation**
+
+Sqlite3 is a terminal based sqlite application.
+Feel free to use a visual Database editor like SqliteBrowser if you feel more comfortable with that.
+
+### Ubuntu/Debian installation
+
 ```bash
 sudo apt-get install sqlite3
 ```
 
+### Using sqlite3 via docker-compose
+
+The freqtrade docker image does contain sqlite3, so you can edit the database without having to install anything on the host system.
+
+``` bash
+docker-compose exec freqtrade /bin/bash
+sqlite3 <databasefile>.sqlite
+```
+
 ## Open the DB
+
 ```bash
 sqlite3
 .open <filepath>
@@ -16,47 +32,17 @@ sqlite3
 ## Table structure
 
 ### List tables
+
 ```bash
 .tables
 ```
 
 ### Display table structure
+
 ```bash
 .schema <table_name>
 ```
 
-### Trade table structure
-```sql
-CREATE TABLE trades (
-	id INTEGER NOT NULL,
-	exchange VARCHAR NOT NULL,
-	pair VARCHAR NOT NULL,
-	is_open BOOLEAN NOT NULL,
-	fee_open FLOAT NOT NULL,
-	fee_close FLOAT NOT NULL,
-	open_rate FLOAT,
-	open_rate_requested FLOAT,
-	close_rate FLOAT,
-	close_rate_requested FLOAT,
-	close_profit FLOAT,
-	stake_amount FLOAT NOT NULL,
-	amount FLOAT,
-	open_date DATETIME NOT NULL,
-	close_date DATETIME,
-	open_order_id VARCHAR,
-	stop_loss FLOAT,
-	initial_stop_loss FLOAT,
-	stoploss_order_id VARCHAR,
-	stoploss_last_update DATETIME,
-	max_rate FLOAT,
-	sell_reason VARCHAR,
-	strategy VARCHAR,
-	ticker_interval INTEGER,
-	PRIMARY KEY (id),
-	CHECK (is_open IN (0, 1))
-);
-```
-
 ## Get all trades in the table
 
 ```sql
@@ -74,35 +60,42 @@ SELECT * FROM trades;
 
 ```sql
 UPDATE trades
-SET is_open=0, close_date=<close_date>, close_rate=<close_rate>, close_profit=close_rate/open_rate-1, sell_reason=<sell_reason>  
+SET is_open=0,
+  close_date=<close_date>,
+  close_rate=<close_rate>,
+  close_profit = close_rate / open_rate - 1,
+  close_profit_abs = (amount * <close_rate> * (1 - fee_close) - (amount * (open_rate * (1 - fee_open)))),
+  sell_reason=<sell_reason>
 WHERE id=<trade_ID_to_update>;
 ```
 
-##### Example
+### Example
 
 ```sql
 UPDATE trades
-SET is_open=0, close_date='2017-12-20 03:08:45.103418', close_rate=0.19638016, close_profit=0.0496, sell_reason='force_sell'  
+SET is_open=0,
+  close_date='2020-06-20 03:08:45.103418',
+  close_rate=0.19638016,
+  close_profit=0.0496,
+  close_profit_abs = (amount * 0.19638016 * (1 - fee_close) - (amount * (open_rate * (1 - fee_open)))),
+  sell_reason='force_sell'  
 WHERE id=31;
 ```
 
-## Insert manually a new trade
+## Remove trade from the database
+
+!!! Tip "Use RPC Methods to delete trades"
+    Consider using `/delete <tradeid>` via telegram or rest API. That's the recommended way to deleting trades.
+
+If you'd still like to remove a trade from the database directly, you can use the below query.
 
 ```sql
-INSERT INTO trades (exchange, pair, is_open, fee_open, fee_close, open_rate, stake_amount, amount, open_date)
+DELETE FROM trades WHERE id = <tradeid>;
-VALUES ('bittrex', 'ETH/BTC', 1, 0.0025, 0.0025, <open_rate>, <stake_amount>, <amount>, '<datetime>')
 ```
 
-##### Example:
-
 ```sql
-INSERT INTO trades (exchange, pair, is_open, fee_open, fee_close, open_rate, stake_amount, amount, open_date)
+DELETE FROM trades WHERE id = 31;
-VALUES ('bittrex', 'ETH/BTC', 1, 0.0025, 0.0025, 0.00258580, 0.002, 0.7715262081, '2017-11-28 12:44:24.000000')
 ```
 
-## Fix wrong fees in the table
+!!! Warning
-If your DB was created before [PR#200](https://github.com/freqtrade/freqtrade/pull/200) was merged (before 12/23/17).
+    This will remove this trade from the database. Please make sure you got the correct id and **NEVER** run this query without the `where` clause.
-
-```sql
-UPDATE trades SET fee=0.0025 WHERE fee=0.005;
-```

docs/stoploss.md

@@ -1,80 +1,182 @@
 # Stop Loss
 
-The `stoploss` configuration parameter is loss in percentage that should trigger a sale.
+The `stoploss` configuration parameter is loss as ratio that should trigger a sale.
 For example, value `-0.10` will cause immediate sell if the profit dips below -10% for a given trade. This parameter is optional.
 
-Most of the strategy files already include the optimal `stoploss`
+Most of the strategy files already include the optimal `stoploss` value.
-value. This parameter is optional. If you use it in the configuration file, it will take over the
-`stoploss` value from the strategy file.
 
-## Stop Loss support
+!!! Info
+    All stoploss properties mentioned in this file can be set in the Strategy, or in the configuration.  
+    <ins>Configuration values will override the strategy values.</ins>
+
+## Stop Loss On-Exchange/Freqtrade
+
+Those stoploss modes can be *on exchange* or *off exchange*.
+
+These modes can be configured with these values:
+
+``` python
+    'emergencysell': 'market',
+    'stoploss_on_exchange': False
+    'stoploss_on_exchange_interval': 60,
+    'stoploss_on_exchange_limit_ratio': 0.99
+```
+
+!!! Note
+    Stoploss on exchange is only supported for Binance (stop-loss-limit), Kraken (stop-loss-market) and FTX (stop limit and stop-market) as of now.  
+    <ins>Do not set too low stoploss value if using stop loss on exchange!</ins>  
+    If set to low/tight then you have greater risk of missing fill on the order and stoploss will not work
+
+### stoploss_on_exchange and stoploss_on_exchange_limit_ratio
+Enable or Disable stop loss on exchange.
+If the stoploss is *on exchange* it means a stoploss limit order is placed on the exchange immediately after buy order happens successfully. This will protect you against sudden crashes in market as the order will be in the queue immediately and if market goes down then the order has more chance of being fulfilled.
+
+If `stoploss_on_exchange` uses limit orders, the exchange needs 2 prices, the stoploss_price and the Limit price.  
+`stoploss` defines the stop-price where the limit order is placed - and limit should be slightly below this.  
+If an exchange supports both limit and market stoploss orders, then the value of `stoploss` will be used to determine the stoploss type.  
+
+Calculation example: we bought the asset at 100$.  
+Stop-price is 95$, then limit would be `95 * 0.99 = 94.05$` - so the limit order fill can happen between 95$ and 94.05$.  
+
+For example, assuming the stoploss is on exchange, and trailing stoploss is enabled, and the market is going up, then the bot automatically cancels the previous stoploss order and puts a new one with a stop value higher than the previous stoploss order.
+
+### stoploss_on_exchange_interval
+In case of stoploss on exchange there is another parameter called `stoploss_on_exchange_interval`. This configures the interval in seconds at which the bot will check the stoploss and update it if necessary.  
+The bot cannot do these every 5 seconds (at each iteration), otherwise it would get banned by the exchange.
+So this parameter will tell the bot how often it should update the stoploss order. The default value is 60 (1 minute).
+This same logic will reapply a stoploss order on the exchange should you cancel it accidentally.
+
+### emergencysell
+`emergencysell` is an optional value, which defaults to `market` and is used when creating stop loss on exchange orders fails.
+The below is the default which is used if not changed in strategy or configuration file.
+
+Example from strategy file:
+
+``` python
+order_types = {
+    'buy': 'limit',
+    'sell': 'limit',
+    'emergencysell': 'market',
+    'stoploss': 'market',
+    'stoploss_on_exchange': True,
+    'stoploss_on_exchange_interval': 60,
+    'stoploss_on_exchange_limit_ratio': 0.99
+}
+```
+
+## Stop Loss Types
 
 At this stage the bot contains the following stoploss support modes:
 
-1. static stop loss, defined in either the strategy or configuration.
+1. Static stop loss.
-2. trailing stop loss, defined in the configuration.
+2. Trailing stop loss.
-3. trailing stop loss, custom positive loss, defined in configuration.
+3. Trailing stop loss, custom positive loss.
+4. Trailing stop loss only once the trade has reached a certain offset.
 
-!!! Note
+### Static Stop Loss
-    All stoploss properties can be configured in either Strategy or configuration. Configuration values override strategy values.
 
-Those stoploss modes can be *on exchange* or *off exchange*. If the stoploss is *on exchange* it means a stoploss limit order is placed on the exchange immediately after buy order happens successfuly. This will protect you against sudden crashes in market as the order will be in the queue immediately and if market goes down then the order has more chance of being fulfilled.
+This is very simple, you define a stop loss of x (as a ratio of price, i.e. x * 100% of price). This will try to sell the asset once the loss exceeds the defined loss.
 
-In case of stoploss on exchange there is another parameter called `stoploss_on_exchange_interval`. This configures the interval in seconds at which the bot will check the stoploss and update it if necessary. As an example in case of trailing stoploss if the order is on the exchange and the market is going up then the bot automatically cancels the previous stoploss order and put a new one with a stop value higher than previous one. It is clear that the bot cannot do it every 5 seconds otherwise it gets banned. So this parameter will tell the bot how often it should update the stoploss order. The default value is 60 (1 minute).
+Example of stop loss:
 
-!!! Note
+``` python
-    Stoploss on exchange is only supported for Binance as of now.
+    stoploss = -0.10
-
-## Static Stop Loss
-
-This is very simple, basically you define a stop loss of x in your strategy file or alternative in the configuration, which
-will overwrite the strategy definition. This will basically try to sell your asset, the second the loss exceeds the defined loss.
-
-## Trailing Stop Loss
-
-The initial value for this stop loss, is defined in your strategy or configuration. Just as you would define your Stop Loss normally.
-To enable this Feauture all you have to do is to define the configuration element:
-
-``` json
-"trailing_stop" : True
 ```
 
-This will now activate an algorithm, which automatically moves your stop loss up every time the price of your asset increases.
+For example, simplified math:
+* the bot buys an asset at a price of 100$
+* the stop loss is defined at -10%
+* the stop loss would get triggered once the asset drops below 90$
 
-For example, simplified math,
+### Trailing Stop Loss
 
-* you buy an asset at a price of 100$
+The initial value for this is `stoploss`, just as you would define your static Stop loss.
-* your stop loss is defined at 2%
+To enable trailing stoploss:
-* which means your stop loss, gets triggered once your asset dropped below 98$
-* assuming your asset now increases to 102$
-* your stop loss, will now be 2% of 102$ or 99.96$
-* now your asset drops in value to 101$, your stop loss, will still be 99.96$
 
-basically what this means is that your stop loss will be adjusted to be always be 2% of the highest observed price
+``` python
-
+    stoploss = -0.10
-### Custom positive loss
+    trailing_stop = True
-
-Due to demand, it is possible to have a default stop loss, when you are in the red with your buy, but once your profit surpasses a certain percentage,
-the system will utilize a new stop loss, which can be a different value. For example your default stop loss is 5%, but once you have 1.1% profit,
-it will be changed to be only a 1% stop loss, which trails the green candles until it goes below them.
-
-Both values can be configured in the main configuration file and requires `"trailing_stop": true` to be set to true.
-
-``` json
-    "trailing_stop_positive":  0.01,
-    "trailing_stop_positive_offset":  0.011,
-    "trailing_only_offset_is_reached": false
 ```
 
-The 0.01 would translate to a 1% stop loss, once you hit 1.1% profit.
+This will now activate an algorithm, which automatically moves the stop loss up every time the price of your asset increases.
 
-You should also make sure to have this value (`trailing_stop_positive_offset`) lower than your minimal ROI, otherwise minimal ROI will apply first and sell your trade.
+For example, simplified math:
+
+* the bot buys an asset at a price of 100$
+* the stop loss is defined at -10%
+* the stop loss would get triggered once the asset drops below 90$
+* assuming the asset now increases to 102$
+* the stop loss will now be -10% of 102$ = 91.8$
+* now the asset drops in value to 101$, the stop loss will still be 91.8$ and would trigger at 91.8$.
+
+In summary: The stoploss will be adjusted to be always be -10% of the highest observed price.
+
+### Trailing stop loss, custom positive loss
+
+It is also possible to have a default stop loss, when you are in the red with your buy (buy - fee), but once you hit positive result the system will utilize a new stop loss, which can have a different value.
+For example, your default stop loss is -10%, but once you have more than 0% profit (example 0.1%) a different trailing stoploss will be used.
+
+!!! Note
+    If you want the stoploss to only be changed when you break even of making a profit (what most users want) please refer to next section with [offset enabled](#Trailing-stop-loss-only-once-the-trade-has-reached-a-certain-offset).
+
+Both values require `trailing_stop` to be set to true and `trailing_stop_positive` with a value.
+
+``` python
+    stoploss = -0.10
+    trailing_stop = True
+    trailing_stop_positive = 0.02
+```
+
+For example, simplified math:
+
+* the bot buys an asset at a price of 100$
+* the stop loss is defined at -10%
+* the stop loss would get triggered once the asset drops below 90$
+* assuming the asset now increases to 102$
+* the stop loss will now be -2% of 102$ = 99.96$ (99.96$ stop loss will be locked in and will follow asset price increasements with -2%)
+* now the asset drops in value to 101$, the stop loss will still be 99.96$ and would trigger at 99.96$
+
+The 0.02 would translate to a -2% stop loss.
+Before this, `stoploss` is used for the trailing stoploss.
+
+### Trailing stop loss only once the trade has reached a certain offset
+
+It is also possible to use a static stoploss until the offset is reached, and then trail the trade to take profits once the market turns.
 
 If `"trailing_only_offset_is_reached": true` then the trailing stoploss is only activated once the offset is reached. Until then, the stoploss remains at the configured `stoploss`.
+This option can be used with or without `trailing_stop_positive`, but uses `trailing_stop_positive_offset` as offset.
+
+``` python
+    trailing_stop_positive_offset = 0.011
+    trailing_only_offset_is_reached = True
+```
+
+Configuration (offset is buyprice + 3%):
+
+``` python
+    stoploss = -0.10
+    trailing_stop = True
+    trailing_stop_positive = 0.02
+    trailing_stop_positive_offset = 0.03
+    trailing_only_offset_is_reached = True
+```
+
+For example, simplified math:
+
+* the bot buys an asset at a price of 100$
+* the stop loss is defined at -10%
+* the stop loss would get triggered once the asset drops below 90$
+* stoploss will remain at 90$ unless asset increases to or above our configured offset
+* assuming the asset now increases to 103$ (where we have the offset configured)
+* the stop loss will now be -2% of 103$ = 100.94$
+* now the asset drops in value to 101$, the stop loss will still be 100.94$ and would trigger at 100.94$
+
+!!! Tip
+    Make sure to have this value (`trailing_stop_positive_offset`) lower than minimal ROI, otherwise minimal ROI will apply first and sell the trade.
 
 ## Changing stoploss on open trades
 
-A stoploss on an open trade can be changed by changing the value in the configuration or strategy and use the `/reload_conf` command (alternatively, completely stopping and restarting the bot also works).
+A stoploss on an open trade can be changed by changing the value in the configuration or strategy and use the `/reload_config` command (alternatively, completely stopping and restarting the bot also works).
 
 The new stoploss value will be applied to open trades (and corresponding log-messages will be generated).
 

docs/strategy-advanced.md

@@ -0,0 +1,222 @@
+# Advanced Strategies
+
+This page explains some advanced concepts available for strategies.
+If you're just getting started, please be familiar with the methods described in the [Strategy Customization](strategy-customization.md) documentation and with the [Freqtrade basics](bot-basics.md) first.
+
+[Freqtrade basics](bot-basics.md) describes in which sequence each method described below is called, which can be helpful to understand which method to use for your custom needs.
+
+!!! Note
+    All callback methods described below should only be implemented in a strategy if they are actually used.
+
+## Custom order timeout rules
+
+Simple, timebased order-timeouts can be configured either via strategy or in the configuration in the `unfilledtimeout` section.
+
+However, freqtrade also offers a custom callback for both ordertypes, which allows you to decide based on custom criteria if a order did time out or not.
+
+!!! Note
+    Unfilled order timeouts are not relevant during backtesting or hyperopt, and are only relevant during real (live) trading. Therefore these methods are only called in these circumstances.
+
+### Custom order timeout example
+
+A simple example, which applies different unfilled-timeouts depending on the price of the asset can be seen below.
+It applies a tight timeout for higher priced assets, while allowing more time to fill on cheap coins.
+
+The function must return either `True` (cancel order) or `False` (keep order alive).
+
+``` python
+from datetime import datetime, timedelta
+from freqtrade.persistence import Trade
+
+class Awesomestrategy(IStrategy):
+
+    # ... populate_* methods
+
+    # Set unfilledtimeout to 25 hours, since our maximum timeout from below is 24 hours.
+    unfilledtimeout = {
+        'buy': 60 * 25,
+        'sell': 60 * 25
+    }
+
+    def check_buy_timeout(self, pair: str, trade: 'Trade', order: dict, **kwargs) -> bool:
+        if trade.open_rate > 100 and trade.open_date < datetime.utcnow() - timedelta(minutes=5):
+            return True
+        elif trade.open_rate > 10 and trade.open_date < datetime.utcnow() - timedelta(minutes=3):
+            return True
+        elif trade.open_rate < 1 and trade.open_date < datetime.utcnow() - timedelta(hours=24):
+           return True
+        return False
+
+
+    def check_sell_timeout(self, pair: str, trade: 'Trade', order: dict, **kwargs) -> bool:
+        if trade.open_rate > 100 and trade.open_date < datetime.utcnow() - timedelta(minutes=5):
+            return True
+        elif trade.open_rate > 10 and trade.open_date < datetime.utcnow() - timedelta(minutes=3):
+            return True
+        elif trade.open_rate < 1 and trade.open_date < datetime.utcnow() - timedelta(hours=24):
+           return True
+        return False
+```
+
+!!! Note
+    For the above example, `unfilledtimeout` must be set to something bigger than 24h, otherwise that type of timeout will apply first.
+
+### Custom order timeout example (using additional data)
+
+``` python
+from datetime import datetime
+from freqtrade.persistence import Trade
+
+class Awesomestrategy(IStrategy):
+
+    # ... populate_* methods
+
+    # Set unfilledtimeout to 25 hours, since our maximum timeout from below is 24 hours.
+    unfilledtimeout = {
+        'buy': 60 * 25,
+        'sell': 60 * 25
+    }
+
+    def check_buy_timeout(self, pair: str, trade: Trade, order: dict, **kwargs) -> bool:
+        ob = self.dp.orderbook(pair, 1)
+        current_price = ob['bids'][0][0]
+        # Cancel buy order if price is more than 2% above the order.
+        if current_price > order['price'] * 1.02:
+            return True
+        return False
+
+
+    def check_sell_timeout(self, pair: str, trade: Trade, order: dict, **kwargs) -> bool:
+        ob = self.dp.orderbook(pair, 1)
+        current_price = ob['asks'][0][0]
+        # Cancel sell order if price is more than 2% below the order.
+        if current_price < order['price'] * 0.98:
+            return True
+        return False
+```
+
+## Bot loop start callback
+
+A simple callback which is called once at the start of every bot throttling iteration.
+This can be used to perform calculations which are pair independent (apply to all pairs), loading of external data, etc.
+
+``` python
+import requests
+
+class Awesomestrategy(IStrategy):
+
+    # ... populate_* methods
+
+    def bot_loop_start(self, **kwargs) -> None:
+        """
+        Called at the start of the bot iteration (one loop).
+        Might be used to perform pair-independent tasks
+        (e.g. gather some remote resource for comparison)
+        :param **kwargs: Ensure to keep this here so updates to this won't break your strategy.
+        """
+        if self.config['runmode'].value in ('live', 'dry_run'):
+            # Assign this to the class by using self.*
+            # can then be used by populate_* methods
+            self.remote_data = requests.get('https://some_remote_source.example.com')
+
+```
+
+## Bot order confirmation
+
+### Trade entry (buy order) confirmation
+
+`confirm_trade_entry()` can be used to abort a trade entry at the latest second (maybe because the price is not what we expect).
+
+``` python
+class Awesomestrategy(IStrategy):
+
+    # ... populate_* methods
+
+    def confirm_trade_entry(self, pair: str, order_type: str, amount: float, rate: float,
+                            time_in_force: str, **kwargs) -> bool:
+        """
+        Called right before placing a buy order.
+        Timing for this function is critical, so avoid doing heavy computations or
+        network requests in this method.
+
+        For full documentation please go to https://www.freqtrade.io/en/latest/strategy-advanced/
+
+        When not implemented by a strategy, returns True (always confirming).
+
+        :param pair: Pair that's about to be bought.
+        :param order_type: Order type (as configured in order_types). usually limit or market.
+        :param amount: Amount in target (quote) currency that's going to be traded.
+        :param rate: Rate that's going to be used when using limit orders
+        :param time_in_force: Time in force. Defaults to GTC (Good-til-cancelled).
+        :param **kwargs: Ensure to keep this here so updates to this won't break your strategy.
+        :return bool: When True is returned, then the buy-order is placed on the exchange.
+            False aborts the process
+        """
+        return True
+
+```
+
+### Trade exit (sell order) confirmation
+
+`confirm_trade_exit()` can be used to abort a trade exit (sell) at the latest second (maybe because the price is not what we expect).
+
+``` python
+from freqtrade.persistence import Trade
+
+
+class Awesomestrategy(IStrategy):
+
+    # ... populate_* methods
+
+    def confirm_trade_exit(self, pair: str, trade: Trade, order_type: str, amount: float,
+                           rate: float, time_in_force: str, sell_reason: str, **kwargs) -> bool:
+        """
+        Called right before placing a regular sell order.
+        Timing for this function is critical, so avoid doing heavy computations or
+        network requests in this method.
+
+        For full documentation please go to https://www.freqtrade.io/en/latest/strategy-advanced/
+
+        When not implemented by a strategy, returns True (always confirming).
+
+        :param pair: Pair that's about to be sold.
+        :param order_type: Order type (as configured in order_types). usually limit or market.
+        :param amount: Amount in quote currency.
+        :param rate: Rate that's going to be used when using limit orders
+        :param time_in_force: Time in force. Defaults to GTC (Good-til-cancelled).
+        :param sell_reason: Sell reason.
+            Can be any of ['roi', 'stop_loss', 'stoploss_on_exchange', 'trailing_stop_loss',
+                           'sell_signal', 'force_sell', 'emergency_sell']
+        :param **kwargs: Ensure to keep this here so updates to this won't break your strategy.
+        :return bool: When True is returned, then the sell-order is placed on the exchange.
+            False aborts the process
+        """
+        if sell_reason == 'force_sell' and trade.calc_profit_ratio(rate) < 0:
+            # Reject force-sells with negative profit
+            # This is just a sample, please adjust to your needs
+            # (this does not necessarily make sense, assuming you know when you're force-selling)
+            return False
+        return True
+
+```
+
+## Derived strategies
+
+The strategies can be derived from other strategies. This avoids duplication of your custom strategy code. You can use this technique to override small parts of your main strategy, leaving the rest untouched:
+
+``` python
+class MyAwesomeStrategy(IStrategy):
+    ...
+    stoploss = 0.13
+    trailing_stop = False
+    # All other attributes and methods are here as they
+    # should be in any custom strategy...
+    ...
+
+class MyAwesomeStrategy2(MyAwesomeStrategy):
+    # Override something
+    stoploss = 0.08
+    trailing_stop = True
+```
+
+Both attributes and methods may be overriden, altering behavior of the original strategy in a way you need.

docs/strategy-customization.md

@@ -1,30 +1,35 @@
-# Optimization
+# Strategy Customization
 
-This page explains where to customize your strategies, and add new
+This page explains how to customize your strategies, add new indicators and set up trading rules.
-indicators.
+
+Please familiarize yourself with [Freqtrade basics](bot-basics.md) first, which provides overall info on how the bot operates.
 
 ## Install a custom strategy file
 
 This is very simple. Copy paste your strategy file into the directory `user_data/strategies`.
 
-Let assume you have a class called `AwesomeStrategy` in the file `awesome-strategy.py`:
+Let assume you have a class called `AwesomeStrategy` in the file `AwesomeStrategy.py`:
 
-1. Move your file into `user_data/strategies` (you should have `user_data/strategies/awesome-strategy.py`
+1. Move your file into `user_data/strategies` (you should have `user_data/strategies/AwesomeStrategy.py`
 2. Start the bot with the param `--strategy AwesomeStrategy` (the parameter is the class name)
 
 ```bash
-freqtrade --strategy AwesomeStrategy
+freqtrade trade --strategy AwesomeStrategy
 ```
 
-## Change your strategy
+## Develop your own strategy
 
-The bot includes a default strategy file. However, we recommend you to
+The bot includes a default strategy file.
-use your own file to not have to lose your parameters every time the default
+Also, several other strategies are available in the [strategy repository](https://github.com/freqtrade/freqtrade-strategies).
-strategy file will be updated on Github. Put your custom strategy file
-into the directory `user_data/strategies`.
 
-Best copy the test-strategy and modify this copy to avoid having bot-updates override your changes.
+You will however most likely have your own idea for a strategy.
-`cp  user_data/strategies/test_strategy.py user_data/strategies/awesome-strategy.py`
+This document intends to help you develop one for yourself.
+
+To get started, use `freqtrade new-strategy --strategy AwesomeStrategy`.
+This will create a new strategy file from a template, which will be located under `user_data/strategies/AwesomeStrategy.py`.
+
+!!! Note
+    This is just a template file, which will most likely not be profitable out of the box.
 
 ### Anatomy of a strategy
 
@@ -36,27 +41,31 @@ A strategy file contains all the information needed to build a good strategy:
 - Minimal ROI recommended
 - Stoploss strongly recommended
 
-The bot also include a sample strategy called `TestStrategy` you can update: `user_data/strategies/test_strategy.py`.
+The bot also include a sample strategy called `SampleStrategy` you can update: `user_data/strategies/sample_strategy.py`.
-You can test it with the parameter: `--strategy TestStrategy`
+You can test it with the parameter: `--strategy SampleStrategy`
+
+Additionally, there is an attribute called `INTERFACE_VERSION`, which defines the version of the strategy interface the bot should use.
+The current version is 2 - which is also the default when it's not set explicitly in the strategy.
+
+Future versions will require this to be set.
 
 ```bash
-freqtrade --strategy AwesomeStrategy
+freqtrade trade --strategy AwesomeStrategy
 ```
 
-**For the following section we will use the [user_data/strategies/test_strategy.py](https://github.com/freqtrade/freqtrade/blob/develop/user_data/strategies/test_strategy.py)
+**For the following section we will use the [user_data/strategies/sample_strategy.py](https://github.com/freqtrade/freqtrade/blob/develop/freqtrade/templates/sample_strategy.py)
 file as reference.**
 
-!!! Note Strategies and Backtesting
+!!! Note "Strategies and Backtesting"
     To avoid problems and unexpected differences between Backtesting and dry/live modes, please be aware
-    that during backtesting the full time-interval is passed to the `populate_*()` methods at once.
+    that during backtesting the full time range is passed to the `populate_*()` methods at once.
     It is therefore best to use vectorized operations (across the whole dataframe, not loops) and
     avoid index referencing (`df.iloc[-1]`), but instead use `df.shift()` to get to the previous candle.
 
-!!! Warning Using future data
+!!! Warning "Warning: Using future data"
-    Since backtesting passes the full time interval to the `populate_*()` methods, the strategy author
+    Since backtesting passes the full time range to the `populate_*()` methods, the strategy author
     needs to take care to avoid having the strategy utilize data from the future.
-    Samples for usage of future data are `dataframe.shift(-1)`, `dataframe.resample("1h")` (this uses the left border of the interval, so moves data from an hour to the start of the hour).
+    Some common patterns for this are listed in the [Common Mistakes](#common-mistakes-when-developing-strategies) section of this document.
-    They all use data which is not available during regular operations, so these strategies will perform well during backtesting, but will fail / perform badly in dry-runs.
 
 ### Customize Indicators
 
@@ -76,7 +85,7 @@ def populate_indicators(self, dataframe: DataFrame, metadata: dict) -> DataFrame
     Performance Note: For the best performance be frugal on the number of indicators
     you are using. Let uncomment only the indicator you are using in your strategies
     or your hyperopt configuration, otherwise you will waste your memory and CPU usage.
-    :param dataframe: Raw data from the exchange and parsed by parse_ticker_dataframe()
+    :param dataframe: Dataframe with data from the exchange
     :param metadata: Additional information, like the currently traded pair
     :return: a Dataframe with all mandatory indicators for the strategies
     """
@@ -109,11 +118,41 @@ def populate_indicators(self, dataframe: DataFrame, metadata: dict) -> DataFrame
     return dataframe
 ```
 
-
 !!! Note "Want more indicator examples?"
-    Look into the [user_data/strategies/test_strategy.py](https://github.com/freqtrade/freqtrade/blob/develop/user_data/strategies/test_strategy.py).<br/>
+    Look into the [user_data/strategies/sample_strategy.py](https://github.com/freqtrade/freqtrade/blob/develop/freqtrade/templates/sample_strategy.py).
     Then uncomment indicators you need.
 
+### Strategy startup period
+
+Most indicators have an instable startup period, in which they are either not available, or the calculation is incorrect. This can lead to inconsistencies, since Freqtrade does not know how long this instable period should be.
+To account for this, the strategy can be assigned the `startup_candle_count` attribute.
+This should be set to the maximum number of candles that the strategy requires to calculate stable indicators.
+
+In this example strategy, this should be set to 100 (`startup_candle_count = 100`), since the longest needed history is 100 candles.
+
+``` python
+    dataframe['ema100'] = ta.EMA(dataframe, timeperiod=100)
+```
+
+By letting the bot know how much history is needed, backtest trades can start at the specified timerange during backtesting and hyperopt.
+
+!!! Warning
+    `startup_candle_count` should be below `ohlcv_candle_limit` (which is 500 for most exchanges) - since only this amount of candles will be available during Dry-Run/Live Trade operations.
+
+#### Example
+
+Let's try to backtest 1 month (January 2019) of 5m candles using an example strategy with EMA100, as above.
+
+``` bash
+freqtrade backtesting --timerange 20190101-20190201 --timeframe 5m
+```
+
+Assuming `startup_candle_count` is set to 100, backtesting knows it needs 100 candles to generate valid buy signals. It will load data from `20190101 - (100 * 5m)` - which is ~2019-12-31 15:30:00.
+If this data is available, indicators will be calculated with this extended timerange. The instable startup period (up to 2019-01-01 00:00:00) will then be removed before starting backtesting.
+
+!!! Note
+    If data for the startup period is not available, then the timerange will be adjusted to account for this startup period - so Backtesting would start at 2019-01-01 08:30:00.
+
 ### Buy signal rules
 
 Edit the method `populate_buy_trend()` in your strategy file to update your buy strategy.
@@ -122,7 +161,7 @@ It's important to always return the dataframe without removing/modifying the col
 
 This will method will also define a new column, `"buy"`, which needs to contain 1 for buys, and 0 for "no action".
 
-Sample from `user_data/strategies/test_strategy.py`:
+Sample from `user_data/strategies/sample_strategy.py`:
 
 ```python
 def populate_buy_trend(self, dataframe: DataFrame, metadata: dict) -> DataFrame:
@@ -134,15 +173,19 @@ def populate_buy_trend(self, dataframe: DataFrame, metadata: dict) -> DataFrame:
     """
     dataframe.loc[
         (
-            (dataframe['adx'] > 30) &
+            (qtpylib.crossed_above(dataframe['rsi'], 30)) &  # Signal: RSI crosses above 30
-            (dataframe['tema'] <= dataframe['bb_middleband']) &
+            (dataframe['tema'] <= dataframe['bb_middleband']) &  # Guard
-            (dataframe['tema'] > dataframe['tema'].shift(1))
+            (dataframe['tema'] > dataframe['tema'].shift(1)) &  # Guard
+            (dataframe['volume'] > 0)  # Make sure Volume is not 0
         ),
         'buy'] = 1
 
     return dataframe
 ```
 
+!!! Note
+    Buying requires sellers to buy from - therefore volume needs to be > 0 (`dataframe['volume'] > 0`) to make sure that the bot does not buy/sell in no-activity periods.
+
 ### Sell signal rules
 
 Edit the method `populate_sell_trend()` into your strategy file to update your sell strategy.
@@ -152,7 +195,7 @@ It's important to always return the dataframe without removing/modifying the col
 
 This will method will also define a new column, `"sell"`, which needs to contain 1 for sells, and 0 for "no action".
 
-Sample from `user_data/strategies/test_strategy.py`:
+Sample from `user_data/strategies/sample_strategy.py`:
 
 ```python
 def populate_sell_trend(self, dataframe: DataFrame, metadata: dict) -> DataFrame:
@@ -164,9 +207,10 @@ def populate_sell_trend(self, dataframe: DataFrame, metadata: dict) -> DataFrame
     """
     dataframe.loc[
         (
-            (dataframe['adx'] > 70) &
+            (qtpylib.crossed_above(dataframe['rsi'], 70)) &  # Signal: RSI crosses above 70
-            (dataframe['tema'] > dataframe['bb_middleband']) &
+            (dataframe['tema'] > dataframe['bb_middleband']) &  # Guard
-            (dataframe['tema'] < dataframe['tema'].shift(1))
+            (dataframe['tema'] < dataframe['tema'].shift(1)) &  # Guard
+            (dataframe['volume'] > 0)  # Make sure Volume is not 0
         ),
         'sell'] = 1
     return dataframe
@@ -206,6 +250,23 @@ minimal_roi = {
 
 While technically not completely disabled, this would sell once the trade reaches 10000% Profit.
 
+To use times based on candle duration (timeframe), the following snippet can be handy.
+This will allow you to change the timeframe for the strategy, and ROI times will still be set as candles (e.g. after 3 candles ...)
+
+``` python
+from freqtrade.exchange import timeframe_to_minutes
+
+class AwesomeStrategy(IStrategy):
+
+    timeframe = "1d"
+    timeframe_mins = timeframe_to_minutes(timeframe)
+    minimal_roi = {
+        "0": 0.05,                             # 5% for the first 3 candles
+        str(timeframe_mins * 3)): 0.02,  # 2% after 3 candles
+        str(timeframe_mins * 6)): 0.01,  # 1% After 6 candles
+    }
+```
+
 ### Stoploss
 
 Setting a stoploss is highly recommended to protect your capital from strong moves against you.
@@ -220,17 +281,18 @@ This would signify a stoploss of -10%.
 
 For the full documentation on stoploss features, look at the dedicated [stoploss page](stoploss.md).
 
-If your exchange supports it, it's recommended to also set `"stoploss_on_exchange"` in the order dict, so your stoploss is on the exchange and cannot be missed for network-problems (or other problems).
+If your exchange supports it, it's recommended to also set `"stoploss_on_exchange"` in the order_types dictionary, so your stoploss is on the exchange and cannot be missed due to network problems, high load or other reasons.
 
 For more information on order_types please look [here](configuration.md#understand-order_types).
 
-### Ticker interval
+### Timeframe (formerly ticker interval)
 
 This is the set of candles the bot should download and use for the analysis.
 Common values are `"1m"`, `"5m"`, `"15m"`, `"1h"`, however all values supported by your exchange should work.
 
-Please note that the same buy/sell signals may work with one interval, but not the other.
+Please note that the same buy/sell signals may work well with one timeframe, but not with the others.
-This setting is accessible within the strategy by using `self.ticker_interval`.
+
+This setting is accessible within the strategy methods as the `self.timeframe` attribute.
 
 ### Metadata dict
 
@@ -242,20 +304,25 @@ Instead, have a look at the section [Storing information](#Storing-information)
 
 ### Storing information
 
-Storing information can be accomplished by crating a new dictionary within the strategy class.
+Storing information can be accomplished by creating a new dictionary within the strategy class.
 
-The name of the variable can be choosen at will, but should be prefixed with `cust_` to avoid naming collisions with predefined strategy variables.
+The name of the variable can be chosen at will, but should be prefixed with `cust_` to avoid naming collisions with predefined strategy variables.
 
 ```python
 class Awesomestrategy(IStrategy):
     # Create custom dictionary
     cust_info = {}
+
     def populate_indicators(self, dataframe: DataFrame, metadata: dict) -> DataFrame:
         # Check if the entry already exists
+        if not metadata["pair"] in self._cust_info:
+            # Create empty entry for this pair
+            self._cust_info[metadata["pair"]] = {}
+
         if "crosstime" in self.cust_info[metadata["pair"]:
-            self.cust_info[metadata["pair"]["crosstime"] += 1
+            self.cust_info[metadata["pair"]]["crosstime"] += 1
         else:
-            self.cust_info[metadata["pair"]["crosstime"] = 1
+            self.cust_info[metadata["pair"]]["crosstime"] = 1
 ```
 
 !!! Warning
@@ -264,70 +331,17 @@ class Awesomestrategy(IStrategy):
 !!! Note
     If the data is pair-specific, make sure to use pair as one of the keys in the dictionary.
 
-### Additional data (DataProvider)
+***
 
-The strategy provides access to the `DataProvider`. This allows you to get additional data to use in your strategy.
+## Additional data (informative_pairs)
 
-All methods return `None` in case of failure (do not raise an exception).
+### Get data for non-tradeable pairs
-
-Please always check the mode of operation to select the correct method to get data (samples see below).
-
-#### Possible options for DataProvider
-
-- `available_pairs` - Property with tuples listing cached pairs with their intervals. (pair, interval)
-- `ohlcv(pair, ticker_interval)` - Currently cached ticker data for all pairs in the whitelist, returns DataFrame or empty DataFrame
-- `historic_ohlcv(pair, ticker_interval)` - Data stored on disk
-- `runmode` - Property containing the current runmode.
-
-#### ohlcv / historic_ohlcv
-
-``` python
-if self.dp:
-    if self.dp.runmode in ('live', 'dry_run'):
-        if (f'{self.stake_currency}/BTC', self.ticker_interval) in self.dp.available_pairs:
-            data_eth = self.dp.ohlcv(pair='{self.stake_currency}/BTC',
-                                     ticker_interval=self.ticker_interval)
-    else:
-        # Get historic ohlcv data (cached on disk).
-        history_eth = self.dp.historic_ohlcv(pair='{self.stake_currency}/BTC',
-                                             ticker_interval='1h')
-```
-
-!!! Warning Warning about backtesting
-    Be carefull when using dataprovider in backtesting. `historic_ohlcv()` provides the full time-range in one go,
-    so please be aware of it and make sure to not "look into the future" to avoid surprises when running in dry/live mode).
-
-!!! Warning Warning in hyperopt
-    This option cannot currently be used during hyperopt.
-
-#### Orderbook
-
-``` python
-if self.dp:
-    if self.dp.runmode in ('live', 'dry_run'):
-        ob = self.dp.orderbook(metadata['pair'], 1)
-        dataframe['best_bid'] = ob['bids'][0][0]
-        dataframe['best_ask'] = ob['asks'][0][0]
-```
-!Warning The order book is not part of the historic data which means backtesting and hyperopt will not work if this
- method is used.
-
-#### Available Pairs
-
-``` python
-if self.dp:
-    for pair, ticker in self.dp.available_pairs:
-        print(f"available {pair}, {ticker}")
-```
-
-
-#### Get data for non-tradeable pairs
 
 Data for additional, informative pairs (reference pairs) can be beneficial for some strategies.
-Ohlcv data for these pairs will be downloaded as part of the regular whitelist refresh process and is available via `DataProvider` just as other pairs (see above).
+OHLCV data for these pairs will be downloaded as part of the regular whitelist refresh process and is available via `DataProvider` just as other pairs (see below).
 These parts will **not** be traded unless they are also specified in the pair whitelist, or have been selected by Dynamic Whitelisting.
 
-The pairs need to be specified as tuples in the format `("pair", "interval")`, with pair as the first and time interval as the second argument.
+The pairs need to be specified as tuples in the format `("pair", "timeframe")`, with pair as the first and timeframe as the second argument.
 
 Sample:
 
@@ -338,13 +352,268 @@ def informative_pairs(self):
             ]
 ```
 
+A full sample can be found [in the DataProvider section](#complete-data-provider-sample).
+
 !!! Warning
     As these pairs will be refreshed as part of the regular whitelist refresh, it's best to keep this list short.
-    All intervals and all pairs can be specified as long as they are available (and active) on the used exchange.
+    All timeframes and all pairs can be specified as long as they are available (and active) on the used exchange.
-    It is however better to use resampling to longer time-intervals when possible
+    It is however better to use resampling to longer timeframes whenever possible
-    to avoid hammering the exchange with too many requests and risk beeing blocked.
+    to avoid hammering the exchange with too many requests and risk being blocked.
 
-### Additional data - Wallets
+***
+
+## Additional data (DataProvider)
+
+The strategy provides access to the `DataProvider`. This allows you to get additional data to use in your strategy.
+
+All methods return `None` in case of failure (do not raise an exception).
+
+Please always check the mode of operation to select the correct method to get data (samples see below).
+
+!!! Warning "Hyperopt"
+    Dataprovider is available during hyperopt, however it can only be used in `populate_indicators()` within a strategy.
+    It is not available in `populate_buy()` and `populate_sell()` methods, nor in `populate_indicators()`, if this method located in the hyperopt file.
+
+### Possible options for DataProvider
+
+- [`available_pairs`](#available_pairs) - Property with tuples listing cached pairs with their timeframe (pair, timeframe).
+- [`current_whitelist()`](#current_whitelist) - Returns a current list of whitelisted pairs. Useful for accessing dynamic whitelists (i.e. VolumePairlist)
+- [`get_pair_dataframe(pair, timeframe)`](#get_pair_dataframepair-timeframe) - This is a universal method, which returns either historical data (for backtesting) or cached live data (for the Dry-Run and Live-Run modes).
+- [`get_analyzed_dataframe(pair, timeframe)`](#get_analyzed_dataframepair-timeframe) - Returns the analyzed dataframe (after calling `populate_indicators()`, `populate_buy()`, `populate_sell()`) and the time of the latest analysis.
+- `historic_ohlcv(pair, timeframe)` - Returns historical data stored on disk.
+- `market(pair)` - Returns market data for the pair: fees, limits, precisions, activity flag, etc. See [ccxt documentation](https://github.com/ccxt/ccxt/wiki/Manual#markets) for more details on the Market data structure.
+- `ohlcv(pair, timeframe)` - Currently cached candle (OHLCV) data for the pair, returns DataFrame or empty DataFrame.
+- [`orderbook(pair, maximum)`](#orderbookpair-maximum) - Returns latest orderbook data for the pair, a dict with bids/asks with a total of `maximum` entries.
+- [`ticker(pair)`](#tickerpair) - Returns current ticker data for the pair. See [ccxt documentation](https://github.com/ccxt/ccxt/wiki/Manual#price-tickers) for more details on the Ticker data structure.
+- `runmode` - Property containing the current runmode.
+
+### Example Usages
+
+### *available_pairs*
+
+``` python
+if self.dp:
+    for pair, timeframe in self.dp.available_pairs:
+        print(f"available {pair}, {timeframe}")
+```
+
+### *current_whitelist()*
+
+Imagine you've developed a strategy that trades the `5m` timeframe using signals generated from a `1d` timeframe on the top 10 volume pairs by volume. 
+
+The strategy might look something like this:
+
+*Scan through the top 10 pairs by volume using the `VolumePairList` every 5 minutes and use a 14 day RSI to buy and sell.*
+
+Due to the limited available data, it's very difficult to resample our `5m` candles into daily candles for use in a 14 day RSI. Most exchanges limit us to just 500 candles which effectively gives us around 1.74 daily candles. We need 14 days at least!
+
+Since we can't resample our data we will have to use an informative pair; and since our whitelist will be dynamic we don't know which pair(s) to use.
+
+This is where calling `self.dp.current_whitelist()` comes in handy.
+
+```python
+    def informative_pairs(self):
+
+        # get access to all pairs available in whitelist.
+        pairs = self.dp.current_whitelist()
+        # Assign tf to each pair so they can be downloaded and cached for strategy.
+        informative_pairs = [(pair, '1d') for pair in pairs]
+        return informative_pairs   
+```
+
+### *get_pair_dataframe(pair, timeframe)*
+
+``` python
+# fetch live / historical candle (OHLCV) data for the first informative pair
+if self.dp:
+    inf_pair, inf_timeframe = self.informative_pairs()[0]
+    informative = self.dp.get_pair_dataframe(pair=inf_pair,
+                                             timeframe=inf_timeframe)
+```
+
+!!! Warning "Warning about backtesting"
+    Be careful when using dataprovider in backtesting. `historic_ohlcv()` (and `get_pair_dataframe()`
+    for the backtesting runmode) provides the full time-range in one go,
+    so please be aware of it and make sure to not "look into the future" to avoid surprises when running in dry/live mode.
+
+### *get_analyzed_dataframe(pair, timeframe)*
+
+This method is used by freqtrade internally to determine the last signal.
+It can also be used in specific callbacks to get the signal that caused the action (see [Advanced Strategy Documentation](strategy-advanced.md) for more details on available callbacks).
+
+``` python
+# fetch current dataframe
+if self.dp:
+    dataframe, last_updated = self.dp.get_analyzed_dataframe(pair=metadata['pair'],
+                                                             timeframe=self.timeframe)
+```
+
+!!! Note "No data available"
+    Returns an empty dataframe if the requested pair was not cached.
+    This should not happen when using whitelisted pairs.
+
+### *orderbook(pair, maximum)*
+
+``` python
+if self.dp:
+    if self.dp.runmode.value in ('live', 'dry_run'):
+        ob = self.dp.orderbook(metadata['pair'], 1)
+        dataframe['best_bid'] = ob['bids'][0][0]
+        dataframe['best_ask'] = ob['asks'][0][0]
+```
+
+!!! Warning
+    The order book is not part of the historic data which means backtesting and hyperopt will not work correctly if this method is used.
+
+### *ticker(pair)*
+
+``` python
+if self.dp:
+    if self.dp.runmode.value in ('live', 'dry_run'):
+        ticker = self.dp.ticker(metadata['pair'])
+        dataframe['last_price'] = ticker['last']
+        dataframe['volume24h'] = ticker['quoteVolume']
+        dataframe['vwap'] = ticker['vwap']
+```
+
+!!! Warning
+    Although the ticker data structure is a part of the ccxt Unified Interface, the values returned by this method can
+    vary for different exchanges. For instance, many exchanges do not return `vwap` values, the FTX exchange
+    does not always fills in the `last` field (so it can be None), etc. So you need to carefully verify the ticker
+    data returned from the exchange and add appropriate error handling / defaults.
+
+!!! Warning "Warning about backtesting"
+    This method will always return up-to-date values - so usage during backtesting / hyperopt will lead to wrong results.
+
+### Complete Data-provider sample
+
+```python
+from freqtrade.strategy import IStrategy, merge_informative_pair
+from pandas import DataFrame
+
+class SampleStrategy(IStrategy):
+    # strategy init stuff...
+
+    timeframe = '5m'
+
+    # more strategy init stuff..
+
+    def informative_pairs(self):
+
+        # get access to all pairs available in whitelist.
+        pairs = self.dp.current_whitelist()
+        # Assign tf to each pair so they can be downloaded and cached for strategy.
+        informative_pairs = [(pair, '1d') for pair in pairs]
+        # Optionally Add additional "static" pairs
+        informative_pairs += [("ETH/USDT", "5m"),
+                              ("BTC/TUSD", "15m"),
+                            ]
+        return informative_pairs
+
+    def populate_indicators(self, dataframe: DataFrame, metadata: dict) -> DataFrame:
+        if not self.dp:
+            # Don't do anything if DataProvider is not available.
+            return dataframe
+
+        inf_tf = '1d'
+        # Get the informative pair
+        informative = self.dp.get_pair_dataframe(pair=metadata['pair'], timeframe=inf_tf)
+        # Get the 14 day rsi
+        informative['rsi'] = ta.RSI(informative, timeperiod=14)
+
+        # Use the helper function merge_informative_pair to safely merge the pair
+        # Automatically renames the columns and merges a shorter timeframe dataframe and a longer timeframe informative pair
+        # use ffill to have the 1d value available in every row throughout the day.
+        # Without this, comparisons between columns of the original and the informative pair would only work once per day.
+        # Full documentation of this method, see below
+        dataframe = merge_informative_pair(dataframe, informative, self.timeframe, inf_tf, ffill=True)
+
+        # Calculate rsi of the original dataframe (5m timeframe)
+        dataframe['rsi'] = ta.RSI(dataframe, timeperiod=14)
+
+        # Do other stuff
+        # ...
+
+        return dataframe
+
+    def populate_buy_trend(self, dataframe: DataFrame, metadata: dict) -> DataFrame:
+
+        dataframe.loc[
+            (
+                (qtpylib.crossed_above(dataframe['rsi'], 30)) &  # Signal: RSI crosses above 30
+                (dataframe['rsi_1d'] < 30) &                     # Ensure daily RSI is < 30
+                (dataframe['volume'] > 0)                        # Ensure this candle had volume (important for backtesting)
+            ),
+            'buy'] = 1
+
+```
+
+***
+
+## Helper functions
+
+### *merge_informative_pair()*
+
+This method helps you merge an informative pair to a regular dataframe without lookahead bias.
+It's there to help you merge the dataframe in a safe and consistent way.
+
+Options:
+
+- Rename the columns for you to create unique columns
+- Merge the dataframe without lookahead bias
+- Forward-fill (optional)
+
+All columns of the informative dataframe will be available on the returning dataframe in a renamed fashion:
+
+!!! Example "Column renaming"
+    Assuming `inf_tf = '1d'` the resulting columns will be:
+
+    ``` python
+    'date', 'open', 'high', 'low', 'close', 'rsi'                     # from the original dataframe
+    'date_1d', 'open_1d', 'high_1d', 'low_1d', 'close_1d', 'rsi_1d'   # from the informative dataframe
+    ```
+
+??? Example "Column renaming - 1h"
+    Assuming `inf_tf = '1h'` the resulting columns will be:
+
+    ``` python
+    'date', 'open', 'high', 'low', 'close', 'rsi'                     # from the original dataframe
+    'date_1h', 'open_1h', 'high_1h', 'low_1h', 'close_1h', 'rsi_1h'   # from the informative dataframe 
+    ```
+
+??? Example "Custom implementation"
+    A custom implementation for this is possible, and can be done as follows:
+
+    ``` python
+
+    # Shift date by 1 candle
+    # This is necessary since the data is always the "open date"
+    # and a 15m candle starting at 12:15 should not know the close of the 1h candle from 12:00 to 13:00
+    minutes = timeframe_to_minutes(inf_tf)
+    # Only do this if the timeframes are different:
+    informative['date_merge'] = informative["date"] + pd.to_timedelta(minutes, 'm')
+
+    # Rename columns to be unique
+    informative.columns = [f"{col}_{inf_tf}" for col in informative.columns]
+    # Assuming inf_tf = '1d' - then the columns will now be:
+    # date_1d, open_1d, high_1d, low_1d, close_1d, rsi_1d
+
+    # Combine the 2 dataframes
+    # all indicators on the informative sample MUST be calculated before this point
+    dataframe = pd.merge(dataframe, informative, left_on='date', right_on=f'date_merge_{inf_tf}', how='left')
+    # FFill to have the 1d value available in every row throughout the day.
+    # Without this, comparisons would only work once per day.
+    dataframe = dataframe.ffill()
+
+    ```
+
+!!! Warning "Informative timeframe < timeframe"
+    Using informative timeframes smaller than the dataframe timeframe is not recommended with this method, as it will not use any of the additional information this would provide.
+    To use the more detailed information properly, more advanced methods should be applied (which are out of scope for freqtrade documentation, as it'll depend on the respective need).
+
+***
+
+## Additional data (Wallets)
 
 The strategy provides access to the `Wallets` object. This contains the current balances on the exchange.
 
@@ -360,13 +629,106 @@ if self.wallets:
     total_eth = self.wallets.get_total('ETH')
 ```
 
-#### Possible options for Wallets
+### Possible options for Wallets
 
 - `get_free(asset)` - currently available balance to trade
 - `get_used(asset)` - currently tied up balance (open orders)
 - `get_total(asset)` - total available balance - sum of the 2 above
 
-### Print created dataframe
+***
+
+## Additional data (Trades)
+
+A history of Trades can be retrieved in the strategy by querying the database.
+
+At the top of the file, import Trade.
+
+```python
+from freqtrade.persistence import Trade
+```
+
+The following example queries for the current pair and trades from today, however other filters can easily be added.
+
+``` python
+if self.config['runmode'].value in ('live', 'dry_run'):
+    trades = Trade.get_trades([Trade.pair == metadata['pair'],
+                               Trade.open_date > datetime.utcnow() - timedelta(days=1),
+                               Trade.is_open == False,
+                ]).order_by(Trade.close_date).all()
+    # Summarize profit for this pair.
+    curdayprofit = sum(trade.close_profit for trade in trades)
+```
+
+Get amount of stake_currency currently invested in Trades:
+
+``` python
+if self.config['runmode'].value in ('live', 'dry_run'):
+    total_stakes = Trade.total_open_trades_stakes()
+```
+
+Retrieve performance per pair.
+Returns a List of dicts per pair.
+
+``` python
+if self.config['runmode'].value in ('live', 'dry_run'):
+    performance = Trade.get_overall_performance()
+```
+
+Sample return value: ETH/BTC had 5 trades, with a total profit of 1.5% (ratio of 0.015).
+
+``` json
+{'pair': "ETH/BTC", 'profit': 0.015, 'count': 5}
+```
+
+!!! Warning
+    Trade history is not available during backtesting or hyperopt.
+
+## Prevent trades from happening for a specific pair
+
+Freqtrade locks pairs automatically for the current candle (until that candle is over) when a pair is sold, preventing an immediate re-buy of that pair.
+
+Locked pairs will show the message `Pair <pair> is currently locked.`.
+
+### Locking pairs from within the strategy
+
+Sometimes it may be desired to lock a pair after certain events happen (e.g. multiple losing trades in a row).
+
+Freqtrade has an easy method to do this from within the strategy, by calling `self.lock_pair(pair, until, [reason])`.
+`until` must be a datetime object in the future, after which trading will be re-enabled for that pair, while `reason` is an optional string detailing why the pair was locked.
+
+Locks can also be lifted manually, by calling `self.unlock_pair(pair)`.
+
+To verify if a pair is currently locked, use `self.is_pair_locked(pair)`.
+
+!!! Note
+    Locked pairs will always be rounded up to the next candle. So assuming a `5m` timeframe, a lock with `until` set to 10:18 will lock the pair until the candle from 10:15-10:20 will be finished.
+
+!!! Warning
+    Locking pairs is not available during backtesting.
+
+#### Pair locking example
+
+``` python
+from freqtrade.persistence import Trade
+from datetime import timedelta, datetime, timezone
+# Put the above lines a the top of the strategy file, next to all the other imports
+# --------
+
+# Within populate indicators (or populate_buy):
+if self.config['runmode'].value in ('live', 'dry_run'):
+   # fetch closed trades for the last 2 days
+    trades = Trade.get_trades([Trade.pair == metadata['pair'],
+                               Trade.open_date > datetime.utcnow() - timedelta(days=2),
+                               Trade.is_open == False,
+                ]).all()
+    # Analyze the conditions you'd like to lock the pair .... will probably be different for every strategy
+    sumprofit = sum(trade.close_profit for trade in trades)
+    if sumprofit < 0:
+        # Lock pair for 12 hours
+        self.lock_pair(metadata['pair'], until=datetime.now(timezone.utc) + timedelta(hours=12))
+```
+
+## Print created dataframe
 
 To inspect the created dataframe, you can issue a print-statement in either `populate_buy_trend()` or `populate_sell_trend()`.
 You may also want to print the pair so it's clear what data is currently shown.
@@ -390,27 +752,24 @@ def populate_buy_trend(self, dataframe: DataFrame, metadata: dict) -> DataFrame:
 
 Printing more than a few rows is also possible (simply use  `print(dataframe)` instead of `print(dataframe.tail())`), however not recommended, as that will be very verbose (~500 lines per pair every 5 seconds).
 
-### Where is the default strategy?
+## Common mistakes when developing strategies
 
-The default buy strategy is located in the file
+Backtesting analyzes the whole time-range at once for performance reasons. Because of this, strategy authors need to make sure that strategies do not look-ahead into the future.
-[freqtrade/default_strategy.py](https://github.com/freqtrade/freqtrade/blob/develop/freqtrade/strategy/default_strategy.py).
+This is a common pain-point, which can cause huge differences between backtesting and dry/live run methods, since they all use data which is not available during dry/live runs, so these strategies will perform well during backtesting, but will fail / perform badly in real conditions.
 
-### Specify custom strategy location
+The following lists some common patterns which should be avoided to prevent frustration:
 
-If you want to use a strategy from a different directory you can pass `--strategy-path`
+- don't use `shift(-1)`. This uses data from the future, which is not available.
+- don't use `.iloc[-1]` or any other absolute position in the dataframe, this will be different between dry-run and backtesting.
+- don't use `dataframe['volume'].mean()`. This uses the full DataFrame for backtesting, including data from the future. Use `dataframe['volume'].rolling(<window>).mean()` instead
+- don't use `.resample('1h')`. This uses the left border of the interval, so moves data from an hour to the start of the hour. Use `.resample('1h', label='right')` instead.
 
-```bash
+## Further strategy ideas
-freqtrade --strategy AwesomeStrategy --strategy-path /some/directory
-```
-
-### Further strategy ideas
 
 To get additional Ideas for strategies, head over to our [strategy repository](https://github.com/freqtrade/freqtrade-strategies). Feel free to use them as they are - but results will depend on the current market situation, pairs used etc. - therefore please backtest the strategy for your exchange/desired pairs first, evaluate carefully, use at your own risk.
 Feel free to use any of them as inspiration for your own strategies.
 We're happy to accept Pull Requests containing new Strategies to that repo.
 
-We also got a *strategy-sharing* channel in our [Slack community](https://join.slack.com/t/highfrequencybot/shared_invite/enQtNjU5ODcwNjI1MDU3LWEyODBiNzkzNzcyNzU0MWYyYzE5NjIyOTQxMzBmMGUxOTIzM2YyN2Y4NWY1YTEwZDgwYTRmMzE2NmM5ZmY2MTg) which is a great place to get and/or share ideas.
-
 ## Next step
 
 Now you have a perfect strategy you probably want to backtest it.

docs/strategy_analysis_example.md

@@ -0,0 +1,196 @@
+# Strategy analysis example
+
+Debugging a strategy can be time-consuming. Freqtrade offers helper functions to visualize raw data.
+The following assumes you work with SampleStrategy, data for 5m timeframe from Binance and have downloaded them into the data directory in the default location.
+
+## Setup
+
+
+```python
+from pathlib import Path
+from freqtrade.configuration import Configuration
+
+# Customize these according to your needs.
+
+# Initialize empty configuration object
+config = Configuration.from_files([])
+# Optionally, use existing configuration file
+# config = Configuration.from_files(["config.json"])
+
+# Define some constants
+config["timeframe"] = "5m"
+# Name of the strategy class
+config["strategy"] = "SampleStrategy"
+# Location of the data
+data_location = Path(config['user_data_dir'], 'data', 'binance')
+# Pair to analyze - Only use one pair here
+pair = "BTC_USDT"
+```
+
+
+```python
+# Load data using values set above
+from freqtrade.data.history import load_pair_history
+
+candles = load_pair_history(datadir=data_location,
+                            timeframe=config["timeframe"],
+                            pair=pair)
+
+# Confirm success
+print("Loaded " + str(len(candles)) + f" rows of data for {pair} from {data_location}")
+candles.head()
+```
+
+## Load and run strategy
+* Rerun each time the strategy file is changed
+
+
+```python
+# Load strategy using values set above
+from freqtrade.resolvers import StrategyResolver
+strategy = StrategyResolver.load_strategy(config)
+
+# Generate buy/sell signals using strategy
+df = strategy.analyze_ticker(candles, {'pair': pair})
+df.tail()
+```
+
+### Display the trade details
+
+* Note that using `data.head()` would also work, however most indicators have some "startup" data at the top of the dataframe.
+* Some possible problems
+    * Columns with NaN values at the end of the dataframe
+    * Columns used in `crossed*()` functions with completely different units
+* Comparison with full backtest
+    * having 200 buy signals as output for one pair from `analyze_ticker()` does not necessarily mean that 200 trades will be made during backtesting.
+    * Assuming you use only one condition such as, `df['rsi'] < 30` as buy condition, this will generate multiple "buy" signals for each pair in sequence (until rsi returns > 29). The bot will only buy on the first of these signals (and also only if a trade-slot ("max_open_trades") is still available), or on one of the middle signals, as soon as a "slot" becomes available.  
+
+
+
+```python
+# Report results
+print(f"Generated {df['buy'].sum()} buy signals")
+data = df.set_index('date', drop=False)
+data.tail()
+```
+
+## Load existing objects into a Jupyter notebook
+
+The following cells assume that you have already generated data using the cli.  
+They will allow you to drill deeper into your results, and perform analysis which otherwise would make the output very difficult to digest due to information overload.
+
+### Load backtest results to pandas dataframe
+
+Analyze a trades dataframe (also used below for plotting)
+
+
+```python
+from freqtrade.data.btanalysis import load_backtest_data, load_backtest_stats
+
+# if backtest_dir points to a directory, it'll automatically load the last backtest file.
+backtest_dir = config["user_data_dir"] / "backtest_results"
+# backtest_dir can also point to a specific file 
+# backtest_dir = config["user_data_dir"] / "backtest_results/backtest-result-2020-07-01_20-04-22.json"
+```
+
+
+```python
+# You can get the full backtest statistics by using the following command.
+# This contains all information used to generate the backtest result.
+stats = load_backtest_stats(backtest_dir)
+
+strategy = 'SampleStrategy'
+# All statistics are available per strategy, so if `--strategy-list` was used during backtest, this will be reflected here as well.
+# Example usages:
+print(stats['strategy'][strategy]['results_per_pair'])
+# Get pairlist used for this backtest
+print(stats['strategy'][strategy]['pairlist'])
+# Get market change (average change of all pairs from start to end of the backtest period)
+print(stats['strategy'][strategy]['market_change'])
+# Maximum drawdown ()
+print(stats['strategy'][strategy]['max_drawdown'])
+# Maximum drawdown start and end
+print(stats['strategy'][strategy]['drawdown_start'])
+print(stats['strategy'][strategy]['drawdown_end'])
+
+
+# Get strategy comparison (only relevant if multiple strategies were compared)
+print(stats['strategy_comparison'])
+
+```
+
+
+```python
+# Load backtested trades as dataframe
+trades = load_backtest_data(backtest_dir)
+
+# Show value-counts per pair
+trades.groupby("pair")["sell_reason"].value_counts()
+```
+
+### Load live trading results into a pandas dataframe
+
+In case you did already some trading and want to analyze your performance
+
+
+```python
+from freqtrade.data.btanalysis import load_trades_from_db
+
+# Fetch trades from database
+trades = load_trades_from_db("sqlite:///tradesv3.sqlite")
+
+# Display results
+trades.groupby("pair")["sell_reason"].value_counts()
+```
+
+## Analyze the loaded trades for trade parallelism
+This can be useful to find the best `max_open_trades` parameter, when used with backtesting in conjunction with `--disable-max-market-positions`.
+
+`analyze_trade_parallelism()` returns a timeseries dataframe with an "open_trades" column, specifying the number of open trades for each candle.
+
+
+```python
+from freqtrade.data.btanalysis import analyze_trade_parallelism
+
+# Analyze the above
+parallel_trades = analyze_trade_parallelism(trades, '5m')
+
+parallel_trades.plot()
+```
+
+## Plot results
+
+Freqtrade offers interactive plotting capabilities based on plotly.
+
+
+```python
+from freqtrade.plot.plotting import  generate_candlestick_graph
+# Limit graph period to keep plotly quick and reactive
+
+# Filter trades to one pair
+trades_red = trades.loc[trades['pair'] == pair]
+
+data_red = data['2019-06-01':'2019-06-10']
+# Generate candlestick graph
+graph = generate_candlestick_graph(pair=pair,
+                                   data=data_red,
+                                   trades=trades_red,
+                                   indicators1=['sma20', 'ema50', 'ema55'],
+                                   indicators2=['rsi', 'macd', 'macdsignal', 'macdhist']
+                                  )
+
+
+
+```
+
+
+```python
+# Show graph inline
+# graph.show()
+
+# Render graph in a seperate window
+graph.show(renderer="browser")
+
+```
+
+Feel free to submit an issue or Pull Request enhancing this document if you would like to share ideas on how to best analyze the data.

docs/stylesheets/ft.extra.css

@@ -0,0 +1,13 @@
+.rst-versions  {
+    font-size: .7rem;
+    color: white;
+}
+
+.rst-versions.rst-badge .rst-current-version {
+    font-size: .7rem;
+    color: white;
+}
+
+.rst-versions .rst-other-versions {
+    color: white;
+}

docs/telegram-usage.md

@@ -35,39 +35,89 @@ Copy the API Token (`22222222:APITOKEN` in the above example) and keep use it fo
 
 Don't forget to start the conversation with your bot, by clicking `/START` button
 
-### 2. Get your user id
+### 2. Telegram user_id
+
+#### Get your user id
 
 Talk to the [userinfobot](https://telegram.me/userinfobot)
 
 Get your "Id", you will use it for the config parameter `chat_id`.
 
+#### Use Group id
+
+You can use bots in telegram groups by just adding them to the group. You can find the group id by first adding a [RawDataBot](https://telegram.me/rawdatabot) to your group. The Group id is shown as id in the `"chat"` section, which the RawDataBot will send to you:
+
+``` json
+"chat":{
+   "id":-1001332619709
+}
+```
+
+For the Freqtrade configuration, you can then use the the full value (including `-` if it's there) as string:
+
+```json
+   "chat_id": "-1001332619709"
+```
+
+## Control telegram noise
+
+Freqtrade provides means to control the verbosity of your telegram bot.
+Each setting has the following possible values:
+
+* `on` - Messages will be sent, and user will be notified.
+* `silent` - Message will be sent, Notification will be without sound / vibration.
+* `off` - Skip sending a message-type all together.
+
+Example configuration showing the different settings:
+
+``` json
+"telegram": {
+      "enabled": true,
+      "token": "your_telegram_token",
+      "chat_id": "your_telegram_chat_id",
+      "notification_settings": {
+         "status": "silent",
+         "warning": "on",
+         "startup": "off",
+         "buy": "silent",
+         "sell": "on",
+         "buy_cancel": "silent",
+         "sell_cancel": "on"
+      }
+   },
+```
+
 ## Telegram commands
 
 Per default, the Telegram bot shows predefined commands. Some commands
 are only available by sending them to the bot. The table below list the
 official commands. You can ask at any moment for help with `/help`.
 
-|  Command | Default | Description |
+|  Command | Description |
-|----------|---------|-------------|
+|----------|-------------|
-| `/start` | | Starts the trader
+| `/start` | Starts the trader
-| `/stop` | | Stops the trader
+| `/stop` | Stops the trader
-| `/stopbuy` | | Stops the trader from opening new trades. Gracefully closes open trades according to their rules.
+| `/stopbuy` | Stops the trader from opening new trades. Gracefully closes open trades according to their rules.
-| `/reload_conf` | | Reloads the configuration file
+| `/reload_config` | Reloads the configuration file
-| `/status` | | Lists all open trades
+| `/show_config` | Shows part of the current configuration with relevant settings to operation
-| `/status table` | | List all open trades in a table format
+| `/logs [limit]` | Show last log messages.
-| `/count` | | Displays number of trades used and available
+| `/status` | Lists all open trades
-| `/profit` | | Display a summary of your profit/loss from close trades and some stats about your performance
+| `/status table` | List all open trades in a table format. Pending buy orders are marked with an asterisk (*) Pending sell orders are marked with a double asterisk (**)
-| `/forcesell <trade_id>` | | Instantly sells the given trade  (Ignoring `minimum_roi`).
+| `/trades [limit]` | List all recently closed trades in a table format.
-| `/forcesell all` | | Instantly sells all open trades (Ignoring `minimum_roi`).
+| `/delete <trade_id>` | Delete a specific trade from the Database. Tries to close open orders. Requires manual handling of this trade on the exchange.
-| `/forcebuy <pair> [rate]` | | Instantly buys the given pair. Rate is optional. (`forcebuy_enable` must be set to True)
+| `/count` | Displays number of trades used and available
-| `/performance` | | Show performance of each finished trade grouped by pair
+| `/profit` | Display a summary of your profit/loss from close trades and some stats about your performance
-| `/balance` | | Show account balance per currency
+| `/forcesell <trade_id>` | Instantly sells the given trade  (Ignoring `minimum_roi`).
-| `/daily <n>` | 7 | Shows profit or loss per day, over the last n days
+| `/forcesell all` | Instantly sells all open trades (Ignoring `minimum_roi`).
-| `/whitelist` | | Show the current whitelist
+| `/forcebuy <pair> [rate]` | Instantly buys the given pair. Rate is optional. (`forcebuy_enable` must be set to True)
-| `/blacklist [pair]` | | Show the current blacklist, or adds a pair to the blacklist.
+| `/performance` | Show performance of each finished trade grouped by pair
-| `/edge` | | Show validated pairs by Edge if it is enabled.
+| `/balance` | Show account balance per currency
-| `/help` | | Show help message
+| `/daily <n>` | Shows profit or loss per day, over the last n days (n defaults to 7)
-| `/version` | | Show version
+| `/whitelist` | Show the current whitelist
+| `/blacklist [pair]` | Show the current blacklist, or adds a pair to the blacklist.
+| `/edge` | Show validated pairs by Edge if it is enabled.
+| `/help` | Show help message
+| `/version` | Show version
 
 ## Telegram commands in action
 
@@ -84,16 +134,16 @@ Below, example of Telegram message you will receive for each command.
 
 ### /stopbuy
 
-> **status:** `Setting max_open_trades to 0. Run /reload_conf to reset.`
+> **status:** `Setting max_open_trades to 0. Run /reload_config to reset.`
 
 Prevents the bot from opening new trades by temporarily setting "max_open_trades" to 0. Open trades will be handled via their regular rules (ROI / Sell-signal, stoploss, ...).
 
 After this, give the bot time to close off open trades (can be checked via `/status table`).
 Once all positions are sold, run `/stop` to completely stop the bot.
 
-`/reload_conf` resets "max_open_trades" to the value set in the configuration and resets this command. 
+`/reload_config` resets "max_open_trades" to the value set in the configuration and resets this command.
 
-!!! warning
+!!! Warning
    The stop-buy signal is ONLY active while the bot is running, and is not persisted anyway, so restarting the bot will cause this to reset.
 
 ### /status
@@ -112,6 +162,7 @@ For each open trade, the bot will send you the following message.
 ### /status table
 
 Return the status of all open trades in a table format.
+
 ```
    ID  Pair      Since    Profit
 ----  --------  -------  --------
@@ -122,6 +173,7 @@ Return the status of all open trades in a table format.
 ### /count
 
 Return the number of trades used and available.
+
 ```
 current    max
 ---------  -----
@@ -207,15 +259,15 @@ Shows the current whitelist
 
 Shows the current blacklist.
 If Pair is set, then this pair will be added to the pairlist.
-Also supports multiple pairs, seperated by a space.
+Also supports multiple pairs, separated by a space.
-Use `/reload_conf` to reset the blacklist.
+Use `/reload_config` to reset the blacklist.
 
 > Using blacklist `StaticPairList` with 2 pairs  
 >`DODGE/BTC`, `HOT/BTC`.
 
 ### /edge
 
-Shows pairs validated by Edge along with their corresponding winrate, expectancy and stoploss values.
+Shows pairs validated by Edge along with their corresponding win-rate, expectancy and stoploss values.
 
 > **Edge only validated following pairs:**
 ```

docs/utils.md

@@ -0,0 +1,604 @@
+# Utility Subcommands
+
+Besides the Live-Trade and Dry-Run run modes, the `backtesting`, `edge` and `hyperopt` optimization subcommands, and the `download-data` subcommand which prepares historical data, the bot contains a number of utility subcommands. They are described in this section.
+
+## Create userdir
+
+Creates the directory structure to hold your files for freqtrade.
+Will also create strategy and hyperopt examples for you to get started.
+Can be used multiple times - using `--reset` will reset the sample strategy and hyperopt files to their default state. 
+
+```
+usage: freqtrade create-userdir [-h] [--userdir PATH] [--reset]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --userdir PATH, --user-data-dir PATH
+                        Path to userdata directory.
+  --reset               Reset sample files to their original state.
+```
+
+!!! Warning
+    Using `--reset` may result in loss of data, since this will overwrite all sample files without asking again.
+
+```
+├── backtest_results
+├── data
+├── hyperopt_results
+├── hyperopts
+│   ├── sample_hyperopt_advanced.py
+│   ├── sample_hyperopt_loss.py
+│   └── sample_hyperopt.py
+├── notebooks
+│   └── strategy_analysis_example.ipynb
+├── plot
+└── strategies
+    └── sample_strategy.py
+```
+
+## Create new config
+
+Creates a new configuration file, asking some questions which are important selections for a configuration.
+
+```
+usage: freqtrade new-config [-h] [-c PATH]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -c PATH, --config PATH
+                        Specify configuration file (default: `config.json`). Multiple --config options may be used. Can be set to `-`
+                        to read config from stdin.
+```
+
+!!! Warning
+    Only vital questions are asked. Freqtrade offers a lot more configuration possibilities, which are listed in the [Configuration documentation](configuration.md#configuration-parameters)
+
+### Create config examples
+
+```
+$ freqtrade new-config --config config_binance.json
+
+? Do you want to enable Dry-run (simulated trades)?  Yes
+? Please insert your stake currency: BTC
+? Please insert your stake amount: 0.05
+? Please insert max_open_trades (Integer or 'unlimited'): 3
+? Please insert your desired timeframe (e.g. 5m): 5m
+? Please insert your display Currency (for reporting): USD
+? Select exchange  binance
+? Do you want to enable Telegram?  No
+```
+
+## Create new strategy
+
+Creates a new strategy from a template similar to SampleStrategy.
+The file will be named inline with your class name, and will not overwrite existing files.
+
+Results will be located in `user_data/strategies/<strategyclassname>.py`.
+
+``` output
+usage: freqtrade new-strategy [-h] [--userdir PATH] [-s NAME]
+                              [--template {full,minimal,advanced}]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --userdir PATH, --user-data-dir PATH
+                        Path to userdata directory.
+  -s NAME, --strategy NAME
+                        Specify strategy class name which will be used by the
+                        bot.
+  --template {full,minimal,advanced}
+                        Use a template which is either `minimal`, `full`
+                        (containing multiple sample indicators) or `advanced`.
+                        Default: `full`.
+
+```
+
+### Sample usage of new-strategy
+
+```bash
+freqtrade new-strategy --strategy AwesomeStrategy
+```
+
+With custom user directory
+
+```bash
+freqtrade new-strategy --userdir ~/.freqtrade/ --strategy AwesomeStrategy
+```
+
+Using the advanced template (populates all optional functions and methods)
+
+```bash
+freqtrade new-strategy --strategy AwesomeStrategy --template advanced
+```
+
+## Create new hyperopt
+
+Creates a new hyperopt from a template similar to SampleHyperopt.
+The file will be named inline with your class name, and will not overwrite existing files.
+
+Results will be located in `user_data/hyperopts/<classname>.py`.
+
+``` output
+usage: freqtrade new-hyperopt [-h] [--userdir PATH] [--hyperopt NAME]
+                              [--template {full,minimal,advanced}]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --userdir PATH, --user-data-dir PATH
+                        Path to userdata directory.
+  --hyperopt NAME       Specify hyperopt class name which will be used by the
+                        bot.
+  --template {full,minimal,advanced}
+                        Use a template which is either `minimal`, `full`
+                        (containing multiple sample indicators) or `advanced`.
+                        Default: `full`.
+```
+
+### Sample usage of new-hyperopt
+
+```bash
+freqtrade new-hyperopt --hyperopt AwesomeHyperopt
+```
+
+With custom user directory
+
+```bash
+freqtrade new-hyperopt --userdir ~/.freqtrade/ --hyperopt AwesomeHyperopt
+```
+
+## List Strategies and List Hyperopts
+
+Use the `list-strategies` subcommand to see all strategies in one particular directory and the `list-hyperopts` subcommand to list custom Hyperopts.
+
+These subcommands are useful for finding problems in your environment with loading strategies or hyperopt classes: modules with strategies or hyperopt classes that contain errors and failed to load are printed in red (LOAD FAILED), while strategies or hyperopt classes with duplicate names are printed in yellow (DUPLICATE NAME).
+
+```
+usage: freqtrade list-strategies [-h] [-v] [--logfile FILE] [-V] [-c PATH]
+                                 [-d PATH] [--userdir PATH]
+                                 [--strategy-path PATH] [-1] [--no-color]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --strategy-path PATH  Specify additional strategy lookup path.
+  -1, --one-column      Print output in one column.
+  --no-color            Disable colorization of hyperopt results. May be
+                        useful if you are redirecting output to a file.
+
+Common arguments:
+  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
+  --logfile FILE        Log to the file specified. Special values are:
+                        'syslog', 'journald'. See the documentation for more
+                        details.
+  -V, --version         show program's version number and exit
+  -c PATH, --config PATH
+                        Specify configuration file (default: `config.json`).
+                        Multiple --config options may be used. Can be set to
+                        `-` to read config from stdin.
+  -d PATH, --datadir PATH
+                        Path to directory with historical backtesting data.
+  --userdir PATH, --user-data-dir PATH
+                        Path to userdata directory.
+```
+```
+usage: freqtrade list-hyperopts [-h] [-v] [--logfile FILE] [-V] [-c PATH]
+                                [-d PATH] [--userdir PATH]
+                                [--hyperopt-path PATH] [-1] [--no-color]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --hyperopt-path PATH  Specify additional lookup path for Hyperopt and
+                        Hyperopt Loss functions.
+  -1, --one-column      Print output in one column.
+  --no-color            Disable colorization of hyperopt results. May be
+                        useful if you are redirecting output to a file.
+
+Common arguments:
+  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
+  --logfile FILE        Log to the file specified. Special values are:
+                        'syslog', 'journald'. See the documentation for more
+                        details.
+  -V, --version         show program's version number and exit
+  -c PATH, --config PATH
+                        Specify configuration file (default: `config.json`).
+                        Multiple --config options may be used. Can be set to
+                        `-` to read config from stdin.
+  -d PATH, --datadir PATH
+                        Path to directory with historical backtesting data.
+  --userdir PATH, --user-data-dir PATH
+                        Path to userdata directory.
+```
+
+!!! Warning
+    Using these commands will try to load all python files from a directory. This can be a security risk if untrusted files reside in this directory, since all module-level code is executed.
+
+Example: Search default strategies and hyperopts directories (within the default userdir).
+
+``` bash
+freqtrade list-strategies
+freqtrade list-hyperopts
+```
+
+Example: Search strategies and hyperopts directory within the userdir.
+
+``` bash
+freqtrade list-strategies --userdir ~/.freqtrade/
+freqtrade list-hyperopts --userdir ~/.freqtrade/
+```
+
+Example: Search dedicated strategy path.
+
+``` bash
+freqtrade list-strategies --strategy-path ~/.freqtrade/strategies/
+```
+
+Example: Search dedicated hyperopt path.
+
+``` bash
+freqtrade list-hyperopt --hyperopt-path ~/.freqtrade/hyperopts/
+```
+
+## List Exchanges
+
+Use the `list-exchanges` subcommand to see the exchanges available for the bot.
+
+```
+usage: freqtrade list-exchanges [-h] [-1] [-a]
+
+optional arguments:
+  -h, --help        show this help message and exit
+  -1, --one-column  Print output in one column.
+  -a, --all         Print all exchanges known to the ccxt library.
+```
+
+* Example: see exchanges available for the bot:
+```
+$ freqtrade list-exchanges
+Exchanges available for Freqtrade: _1btcxe, acx, allcoin, bequant, bibox, binance, binanceje, binanceus, bitbank, bitfinex, bitfinex2, bitkk, bitlish, bitmart, bittrex, bitz, bleutrade, btcalpha, btcmarkets, btcturk, buda, cex, cobinhood, coinbaseprime, coinbasepro, coinex, cointiger, coss, crex24, digifinex, dsx, dx, ethfinex, fcoin, fcoinjp, gateio, gdax, gemini, hitbtc2, huobipro, huobiru, idex, kkex, kraken, kucoin, kucoin2, kuna, lbank, mandala, mercado, oceanex, okcoincny, okcoinusd, okex, okex3, poloniex, rightbtc, theocean, tidebit, upbit, zb
+```
+
+* Example: see all exchanges supported by the ccxt library (including 'bad' ones, i.e. those that are known to not work with Freqtrade):
+```
+$ freqtrade list-exchanges -a
+All exchanges supported by the ccxt library: _1btcxe, acx, adara, allcoin, anxpro, bcex, bequant, bibox, bigone, binance, binanceje, binanceus, bit2c, bitbank, bitbay, bitfinex, bitfinex2, bitflyer, bitforex, bithumb, bitkk, bitlish, bitmart, bitmex, bitso, bitstamp, bitstamp1, bittrex, bitz, bl3p, bleutrade, braziliex, btcalpha, btcbox, btcchina, btcmarkets, btctradeim, btctradeua, btcturk, buda, bxinth, cex, chilebit, cobinhood, coinbase, coinbaseprime, coinbasepro, coincheck, coinegg, coinex, coinexchange, coinfalcon, coinfloor, coingi, coinmarketcap, coinmate, coinone, coinspot, cointiger, coolcoin, coss, crex24, crypton, deribit, digifinex, dsx, dx, ethfinex, exmo, exx, fcoin, fcoinjp, flowbtc, foxbit, fybse, gateio, gdax, gemini, hitbtc, hitbtc2, huobipro, huobiru, ice3x, idex, independentreserve, indodax, itbit, kkex, kraken, kucoin, kucoin2, kuna, lakebtc, latoken, lbank, liquid, livecoin, luno, lykke, mandala, mercado, mixcoins, negociecoins, nova, oceanex, okcoincny, okcoinusd, okex, okex3, paymium, poloniex, rightbtc, southxchange, stronghold, surbitcoin, theocean, therock, tidebit, tidex, upbit, vaultoro, vbtc, virwox, xbtce, yobit, zaif, zb
+```
+
+## List Timeframes
+
+Use the `list-timeframes` subcommand to see the list of timeframes (ticker intervals) available for the exchange.
+
+```
+usage: freqtrade list-timeframes [-h] [-v] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [--exchange EXCHANGE] [-1]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --exchange EXCHANGE   Exchange name (default: `bittrex`). Only valid if no config is provided.
+  -1, --one-column      Print output in one column.
+
+Common arguments:
+  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
+  --logfile FILE        Log to the file specified. Special values are: 'syslog', 'journald'. See the documentation for more details.
+  -V, --version         show program's version number and exit
+  -c PATH, --config PATH
+                        Specify configuration file (default: `config.json`). Multiple --config options may be used. Can be set to `-`
+                        to read config from stdin.
+  -d PATH, --datadir PATH
+                        Path to directory with historical backtesting data.
+  --userdir PATH, --user-data-dir PATH
+                        Path to userdata directory.
+
+```
+
+* Example: see the timeframes for the 'binance' exchange, set in the configuration file:
+
+```
+$ freqtrade list-timeframes -c config_binance.json
+...
+Timeframes available for the exchange `binance`: 1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M
+```
+
+* Example: enumerate exchanges available for Freqtrade and print timeframes supported by each of them:
+```
+$ for i in `freqtrade list-exchanges -1`; do freqtrade list-timeframes --exchange $i; done
+```
+
+## List pairs/list markets
+
+The `list-pairs` and `list-markets` subcommands allow to see the pairs/markets available on exchange.
+
+Pairs are markets with the '/' character between the base currency part and the quote currency part in the market symbol.
+For example, in the 'ETH/BTC' pair 'ETH' is the base currency, while 'BTC' is the quote currency.
+
+For pairs traded by Freqtrade the pair quote currency is defined by the value of the `stake_currency` configuration setting.
+
+You can print info about any pair/market with these subcommands - and you can filter output by quote-currency using `--quote BTC`, or by base-currency using `--base ETH` options correspondingly.
+
+These subcommands have same usage and same set of available options:
+
+```
+usage: freqtrade list-markets [-h] [-v] [--logfile FILE] [-V] [-c PATH]
+                              [-d PATH] [--userdir PATH] [--exchange EXCHANGE]
+                              [--print-list] [--print-json] [-1] [--print-csv]
+                              [--base BASE_CURRENCY [BASE_CURRENCY ...]]
+                              [--quote QUOTE_CURRENCY [QUOTE_CURRENCY ...]]
+                              [-a]
+
+usage: freqtrade list-pairs [-h] [-v] [--logfile FILE] [-V] [-c PATH]
+                            [-d PATH] [--userdir PATH] [--exchange EXCHANGE]
+                            [--print-list] [--print-json] [-1] [--print-csv]
+                            [--base BASE_CURRENCY [BASE_CURRENCY ...]]
+                            [--quote QUOTE_CURRENCY [QUOTE_CURRENCY ...]] [-a]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --exchange EXCHANGE   Exchange name (default: `bittrex`). Only valid if no
+                        config is provided.
+  --print-list          Print list of pairs or market symbols. By default data
+                        is printed in the tabular format.
+  --print-json          Print list of pairs or market symbols in JSON format.
+  -1, --one-column      Print output in one column.
+  --print-csv           Print exchange pair or market data in the csv format.
+  --base BASE_CURRENCY [BASE_CURRENCY ...]
+                        Specify base currency(-ies). Space-separated list.
+  --quote QUOTE_CURRENCY [QUOTE_CURRENCY ...]
+                        Specify quote currency(-ies). Space-separated list.
+  -a, --all             Print all pairs or market symbols. By default only
+                        active ones are shown.
+
+Common arguments:
+  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
+  --logfile FILE        Log to the file specified. Special values are:
+                        'syslog', 'journald'. See the documentation for more
+                        details.
+  -V, --version         show program's version number and exit
+  -c PATH, --config PATH
+                        Specify configuration file (default: `config.json`).
+                        Multiple --config options may be used. Can be set to
+                        `-` to read config from stdin.
+  -d PATH, --datadir PATH
+                        Path to directory with historical backtesting data.
+  --userdir PATH, --user-data-dir PATH
+                        Path to userdata directory.
+
+```
+
+By default, only active pairs/markets are shown. Active pairs/markets are those that can currently be traded
+on the exchange. The see the list of all pairs/markets (not only the active ones), use the `-a`/`-all` option.
+
+Pairs/markets are sorted by its symbol string in the printed output.
+
+### Examples
+
+* Print the list of active pairs with quote currency USD on exchange, specified in the default
+configuration file (i.e. pairs on the "Bittrex" exchange) in JSON format:
+
+```
+$ freqtrade list-pairs --quote USD --print-json
+```
+
+* Print the list of all pairs on the exchange, specified in the `config_binance.json` configuration file
+(i.e. on the "Binance" exchange) with base currencies BTC or ETH and quote currencies USDT or USD, as the
+human-readable list with summary:
+
+```
+$ freqtrade list-pairs -c config_binance.json --all --base BTC ETH --quote USDT USD --print-list
+```
+
+* Print all markets on exchange "Kraken", in the tabular format:
+
+```
+$ freqtrade list-markets --exchange kraken --all
+```
+
+## Test pairlist
+
+Use the `test-pairlist` subcommand to test the configuration of [dynamic pairlists](configuration.md#pairlists).
+
+Requires a configuration with specified `pairlists` attribute.
+Can be used to generate static pairlists to be used during backtesting / hyperopt.
+
+```
+usage: freqtrade test-pairlist [-h] [-c PATH]
+                               [--quote QUOTE_CURRENCY [QUOTE_CURRENCY ...]]
+                               [-1] [--print-json]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -c PATH, --config PATH
+                        Specify configuration file (default: `config.json`).
+                        Multiple --config options may be used. Can be set to
+                        `-` to read config from stdin.
+  --quote QUOTE_CURRENCY [QUOTE_CURRENCY ...]
+                        Specify quote currency(-ies). Space-separated list.
+  -1, --one-column      Print output in one column.
+  --print-json          Print list of pairs or market symbols in JSON format.
+```
+
+### Examples
+
+Show whitelist when using a [dynamic pairlist](configuration.md#pairlists).
+
+```
+freqtrade test-pairlist --config config.json --quote USDT BTC
+```
+
+## List Hyperopt results
+
+You can list the hyperoptimization epochs the Hyperopt module evaluated previously with the `hyperopt-list` sub-command.
+
+```
+usage: freqtrade hyperopt-list [-h] [-v] [--logfile FILE] [-V] [-c PATH]
+                               [-d PATH] [--userdir PATH] [--best]
+                               [--profitable] [--min-trades INT]
+                               [--max-trades INT] [--min-avg-time FLOAT]
+                               [--max-avg-time FLOAT] [--min-avg-profit FLOAT]
+                               [--max-avg-profit FLOAT]
+                               [--min-total-profit FLOAT]
+                               [--max-total-profit FLOAT]
+                               [--min-objective FLOAT] [--max-objective FLOAT]
+                               [--no-color] [--print-json] [--no-details]
+                               [--hyperopt-filename PATH] [--export-csv FILE]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --best                Select only best epochs.
+  --profitable          Select only profitable epochs.
+  --min-trades INT      Select epochs with more than INT trades.
+  --max-trades INT      Select epochs with less than INT trades.
+  --min-avg-time FLOAT  Select epochs above average time.
+  --max-avg-time FLOAT  Select epochs below average time.
+  --min-avg-profit FLOAT
+                        Select epochs above average profit.
+  --max-avg-profit FLOAT
+                        Select epochs below average profit.
+  --min-total-profit FLOAT
+                        Select epochs above total profit.
+  --max-total-profit FLOAT
+                        Select epochs below total profit.
+  --min-objective FLOAT
+                        Select epochs above objective.
+  --max-objective FLOAT
+                        Select epochs below objective.
+  --no-color            Disable colorization of hyperopt results. May be
+                        useful if you are redirecting output to a file.
+  --print-json          Print output in JSON format.
+  --no-details          Do not print best epoch details.
+  --hyperopt-filename FILENAME
+                        Hyperopt result filename.Example: `--hyperopt-
+                        filename=hyperopt_results_2020-09-27_16-20-48.pickle`
+  --export-csv FILE     Export to CSV-File. This will disable table print.
+                        Example: --export-csv hyperopt.csv
+
+Common arguments:
+  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
+  --logfile FILE        Log to the file specified. Special values are:
+                        'syslog', 'journald'. See the documentation for more
+                        details.
+  -V, --version         show program's version number and exit
+  -c PATH, --config PATH
+                        Specify configuration file (default:
+                        `userdir/config.json` or `config.json` whichever
+                        exists). Multiple --config options may be used. Can be
+                        set to `-` to read config from stdin.
+  -d PATH, --datadir PATH
+                        Path to directory with historical backtesting data.
+  --userdir PATH, --user-data-dir PATH
+                        Path to userdata directory.
+```
+
+!!! Note
+    `hyperopt-list` will automatically use the latest available hyperopt results file.
+    You can override this using the `--hyperopt-filename` argument, and specify another, available filename (without path!).
+
+### Examples
+
+List all results, print details of the best result at the end:
+```
+freqtrade hyperopt-list
+```
+
+List only epochs with positive profit. Do not print the details of the best epoch, so that the list can be iterated in a script:
+```
+freqtrade hyperopt-list --profitable --no-details
+```
+
+## Show details of Hyperopt results
+
+You can show the details of any hyperoptimization epoch previously evaluated by the Hyperopt module with the `hyperopt-show` subcommand.
+
+```
+usage: freqtrade hyperopt-show [-h] [-v] [--logfile FILE] [-V] [-c PATH]
+                               [-d PATH] [--userdir PATH] [--best]
+                               [--profitable] [-n INT] [--print-json]
+                               [--hyperopt-filename PATH] [--no-header]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --best                Select only best epochs.
+  --profitable          Select only profitable epochs.
+  -n INT, --index INT   Specify the index of the epoch to print details for.
+  --print-json          Print output in JSON format.
+  --hyperopt-filename FILENAME
+                        Hyperopt result filename.Example: `--hyperopt-
+                        filename=hyperopt_results_2020-09-27_16-20-48.pickle`
+  --no-header           Do not print epoch details header.
+
+Common arguments:
+  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
+  --logfile FILE        Log to the file specified. Special values are:
+                        'syslog', 'journald'. See the documentation for more
+                        details.
+  -V, --version         show program's version number and exit
+  -c PATH, --config PATH
+                        Specify configuration file (default:
+                        `userdir/config.json` or `config.json` whichever
+                        exists). Multiple --config options may be used. Can be
+                        set to `-` to read config from stdin.
+  -d PATH, --datadir PATH
+                        Path to directory with historical backtesting data.
+  --userdir PATH, --user-data-dir PATH
+                        Path to userdata directory.
+
+```
+
+!!! Note
+    `hyperopt-show` will automatically use the latest available hyperopt results file.
+    You can override this using the `--hyperopt-filename` argument, and specify another, available filename (without path!).
+
+### Examples
+
+Print details for the epoch 168 (the number of the epoch is shown by the `hyperopt-list` subcommand or by Hyperopt itself during hyperoptimization run):
+
+```
+freqtrade hyperopt-show -n 168
+```
+
+Prints JSON data with details for the last best epoch (i.e., the best of all epochs):
+
+```
+freqtrade hyperopt-show --best -n -1 --print-json --no-header
+```
+
+## Show trades
+
+Print selected (or all) trades from database to screen.
+
+```
+usage: freqtrade show-trades [-h] [-v] [--logfile FILE] [-V] [-c PATH]
+                             [-d PATH] [--userdir PATH] [--db-url PATH]
+                             [--trade-ids TRADE_IDS [TRADE_IDS ...]]
+                             [--print-json]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --db-url PATH         Override trades database URL, this is useful in custom
+                        deployments (default: `sqlite:///tradesv3.sqlite` for
+                        Live Run mode, `sqlite:///tradesv3.dryrun.sqlite` for
+                        Dry Run).
+  --trade-ids TRADE_IDS [TRADE_IDS ...]
+                        Specify the list of trade ids.
+  --print-json          Print output in JSON format.
+
+Common arguments:
+  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
+  --logfile FILE        Log to the file specified. Special values are:
+                        'syslog', 'journald'. See the documentation for more
+                        details.
+  -V, --version         show program's version number and exit
+  -c PATH, --config PATH
+                        Specify configuration file (default:
+                        `userdir/config.json` or `config.json` whichever
+                        exists). Multiple --config options may be used. Can be
+                        set to `-` to read config from stdin.
+  -d PATH, --datadir PATH
+                        Path to directory with historical backtesting data.
+  --userdir PATH, --user-data-dir PATH
+                        Path to userdata directory.
+```
+
+### Examples
+
+Print trades with id 2 and 3 as json
+
+``` bash
+freqtrade show-trades --db-url sqlite:///tradesv3.sqlite --trade-ids 2 3 --print-json
+```

docs/webhook-config.md

@@ -15,10 +15,20 @@ Sample configuration (tested using IFTTT).
             "value2": "limit {limit:8f}",
             "value3": "{stake_amount:8f} {stake_currency}"
         },
+        "webhookbuycancel": {
+            "value1": "Cancelling Open Buy Order for {pair}",
+            "value2": "limit {limit:8f}",
+            "value3": "{stake_amount:8f} {stake_currency}"
+        },
         "webhooksell": {
             "value1": "Selling {pair}",
             "value2": "limit {limit:8f}",
-            "value3": "profit: {profit_amount:8f} {stake_currency}"
+            "value3": "profit: {profit_amount:8f} {stake_currency} ({profit_ratio})"
+        },
+        "webhooksellcancel": {
+            "value1": "Cancelling Open Sell Order for {pair}",
+            "value2": "limit {limit:8f}",
+            "value3": "profit: {profit_amount:8f} {stake_currency} ({profit_ratio})"
         },
         "webhookstatus": {
             "value1": "Status: {status}",
@@ -37,19 +47,41 @@ Different payloads can be configured for different events. Not all fields are ne
 The fields in `webhook.webhookbuy` are filled when the bot executes a buy. Parameters are filled using string.format.
 Possible parameters are:
 
+* `trade_id`
 * `exchange`
 * `pair`
 * `limit`
+* `amount`
+* `open_date`
 * `stake_amount`
 * `stake_currency`
 * `fiat_currency`
 * `order_type`
+* `current_rate`
+
+### Webhookbuycancel
+
+The fields in `webhook.webhookbuycancel` are filled when the bot cancels a buy order. Parameters are filled using string.format.
+Possible parameters are:
+
+* `trade_id`
+* `exchange`
+* `pair`
+* `limit`
+* `amount`
+* `open_date`
+* `stake_amount`
+* `stake_currency`
+* `fiat_currency`
+* `order_type`
+* `current_rate`
 
 ### Webhooksell
 
 The fields in `webhook.webhooksell` are filled when the bot sells a trade. Parameters are filled using string.format.
 Possible parameters are:
 
+* `trade_id`
 * `exchange`
 * `pair`
 * `gain`
@@ -58,11 +90,35 @@ Possible parameters are:
 * `open_rate`
 * `current_rate`
 * `profit_amount`
-* `profit_percent`
+* `profit_ratio`
 * `stake_currency`
 * `fiat_currency`
 * `sell_reason`
 * `order_type`
+* `open_date`
+* `close_date`
+
+### Webhooksellcancel
+
+The fields in `webhook.webhooksellcancel` are filled when the bot cancels a sell order. Parameters are filled using string.format.
+Possible parameters are:
+
+* `trade_id`
+* `exchange`
+* `pair`
+* `gain`
+* `limit`
+* `amount`
+* `open_rate`
+* `current_rate`
+* `profit_amount`
+* `profit_ratio`
+* `stake_currency`
+* `fiat_currency`
+* `sell_reason`
+* `order_type`
+* `open_date`
+* `close_date`
 
 ### Webhookstatus
 

docs/windows_installation.md

@@ -0,0 +1,57 @@
+We **strongly** recommend that Windows users use [Docker](docker.md) as this will work much easier and smoother (also more secure).
+
+If that is not possible, try using the Windows Linux subsystem (WSL) - for which the Ubuntu instructions should work.
+Otherwise, try the instructions below.
+
+## Install freqtrade manually
+
+!!! Note
+    Make sure to use 64bit Windows and 64bit Python to avoid problems with backtesting or hyperopt due to the memory constraints 32bit applications have under Windows.
+
+!!! Hint
+    Using the [Anaconda Distribution](https://www.anaconda.com/distribution/) under Windows can greatly help with installation problems. Check out the [Anaconda installation section](installation.md#Anaconda) in this document for more information.
+
+### 1. Clone the git repository
+
+```bash
+git clone https://github.com/freqtrade/freqtrade.git
+```
+
+### 2. Install ta-lib
+
+Install ta-lib according to the [ta-lib documentation](https://github.com/mrjbq7/ta-lib#windows).
+
+As compiling from source on windows has heavy dependencies (requires a partial visual studio installation), there is also a repository of unofficial precompiled windows Wheels [here](https://www.lfd.uci.edu/~gohlke/pythonlibs/#ta-lib), which needs to be downloaded and installed using `pip install TA_Lib‑0.4.19‑cp38‑cp38‑win_amd64.whl` (make sure to use the version matching your python version)
+
+Freqtrade provides these dependencies for the latest 2 Python versions (3.7 and 3.8) and for 64bit Windows.
+Other versions must be downloaded from the above link.
+
+``` powershell
+cd \path\freqtrade
+python -m venv .env
+.env\Scripts\activate.ps1
+# optionally install ta-lib from wheel
+# Eventually adjust the below filename to match the downloaded wheel
+pip install build_helpers/TA_Lib-0.4.19-cp38-cp38-win_amd64.whl
+pip install -r requirements.txt
+pip install -e .
+freqtrade
+```
+
+!!! Note "Use Powershell"
+    The above installation script assumes you're using powershell on a 64bit windows.
+    Commands for the legacy CMD windows console may differ.
+
+> Thanks [Owdr](https://github.com/Owdr) for the commands. Source: [Issue #222](https://github.com/freqtrade/freqtrade/issues/222)
+
+### Error during installation on Windows
+
+``` bash
+error: Microsoft Visual C++ 14.0 is required. Get it with "Microsoft Visual C++ Build Tools": http://landinghub.visualstudio.com/visual-cpp-build-tools
+```
+
+Unfortunately, many packages requiring compilation don't provide a pre-built wheel. It is therefore mandatory to have a C/C++ compiler installed and available for your python environment to use.
+
+The easiest way is to download install Microsoft Visual Studio Community [here](https://visualstudio.microsoft.com/downloads/) and make sure to install "Common Tools for Visual C++" to enable building C code on Windows. Unfortunately, this is a heavy download / dependency (~4Gb) so you might want to consider WSL or [docker](docker.md) first.
+
+---

environment.yml

@@ -0,0 +1,60 @@
+name: freqtrade
+channels:
+  - defaults
+  - conda-forge
+dependencies:
+  # Required for app
+  - python>=3.6
+  - pip
+  - wheel
+  - numpy
+  - pandas
+  - SQLAlchemy
+  - arrow
+  - requests
+  - urllib3
+  - wrapt
+  - jsonschema
+  - tabulate
+  - python-rapidjson
+  - flask
+  - python-dotenv
+  - cachetools
+  - python-telegram-bot
+  # Optional for plotting
+  - plotly
+  # Optional for hyperopt
+  - scipy
+  - scikit-optimize
+  - scikit-learn
+  - filelock
+  - joblib
+  # Optional for development
+  - flake8
+  - pytest
+  - pytest-mock
+  - pytest-asyncio
+  - pytest-cov
+  - coveralls
+  - mypy
+  # Useful for jupyter
+  - jupyter
+  - ipykernel
+  - isort
+  - yapf
+  - pip:
+    # Required for app
+    - cython
+    - pycoingecko
+    - ccxt
+    - TA-Lib
+    - py_find_1st
+    - sdnotify
+    # Optional for develpment
+    - flake8-tidy-imports
+    - flake8-type-annotations
+    - pytest-random-order
+    - -e .
+
+
+

freqtrade.service

@@ -6,7 +6,7 @@ After=network.target
 # Set WorkingDirectory and ExecStart to your file paths accordingly
 # NOTE: %h will be resolved to /home/<username>
 WorkingDirectory=%h/freqtrade
-ExecStart=/usr/bin/freqtrade
+ExecStart=/usr/bin/freqtrade trade
 Restart=on-failure
 
 [Install]

freqtrade.service.watchdog

@@ -6,7 +6,7 @@ After=network.target
 # Set WorkingDirectory and ExecStart to your file paths accordingly
 # NOTE: %h will be resolved to /home/<username>
 WorkingDirectory=%h/freqtrade
-ExecStart=/usr/bin/freqtrade --sd-notify
+ExecStart=/usr/bin/freqtrade trade --sd-notify
 
 Restart=always
 #Restart=on-failure

freqtrade/__init__.py

@@ -1,33 +1,34 @@
-""" FreqTrade bot """
+""" Freqtrade bot """
-__version__ = '2019.6-dev'
+__version__ = 'develop'
 
+if __version__ == 'develop':
 
-class DependencyException(Exception):
+    try:
-    """
+        import subprocess
-    Indicates that an assumed dependency is not met.
-    This could happen when there is currently not enough money on the account.
-    """
 
+        __version__ = 'develop-' + subprocess.check_output(
+            ['git', 'log', '--format="%h"', '-n 1'],
+            stderr=subprocess.DEVNULL).decode("utf-8").rstrip().strip('"')
 
-class OperationalException(Exception):
+        # from datetime import datetime
-    """
+        # last_release = subprocess.check_output(
-    Requires manual intervention.
+        #     ['git', 'tag']
-    This happens when an exchange returns an unexpected error during runtime
+        # ).decode('utf-8').split()[-1].split(".")
-    or given configuration is invalid.
+        # # Releases are in the format "2020.1" - we increment the latest version for dev.
-    """
+        # prefix = f"{last_release[0]}.{int(last_release[1]) + 1}"
+        # dev_version = int(datetime.now().timestamp() // 1000)
+        # __version__ = f"{prefix}.dev{dev_version}"
 
-
+        #  subprocess.check_output(
-class InvalidOrderException(Exception):
+        #     ['git', 'log', '--format="%h"', '-n 1'],
-    """
+        #     stderr=subprocess.DEVNULL).decode("utf-8").rstrip().strip('"')
-    This is returned when the order is not valid. Example:
+    except Exception:
-    If stoploss on exchange order is hit, then trying to cancel the order
+        # git not available, ignore
-    should return this exception.
+        try:
-    """
+            # Try Fallback to freqtrade_commit file (created by CI while building docker image)
-
+            from pathlib import Path
-
+            versionfile = Path('./freqtrade_commit')
-class TemporaryError(Exception):
+            if versionfile.is_file():
-    """
+                __version__ = f"docker-{versionfile.read_text()[:8]}"
-    Temporary network or exchange related error.
+        except Exception:
-    This could happen when an exchange is congested, unavailable, or the user
+            pass
-    has networking problems. Usually resolves itself after a time.
-    """

freqtrade/__main__.py

@@ -8,5 +8,6 @@ To launch Freqtrade as a module
 
 from freqtrade import main
 
+
 if __name__ == '__main__':
     main.main()

freqtrade/commands/__init__.py

@@ -0,0 +1,22 @@
+# flake8: noqa: F401
+"""
+Commands module.
+Contains all start-commands, subcommands and CLI Interface creation.
+
+Note: Be careful with file-scoped imports in these subfiles.
+    as they are parsed on startup, nothing containing optional modules should be loaded.
+"""
+from freqtrade.commands.arguments import Arguments
+from freqtrade.commands.build_config_commands import start_new_config
+from freqtrade.commands.data_commands import (start_convert_data, start_download_data,
+                                              start_list_data)
+from freqtrade.commands.deploy_commands import (start_create_userdir, start_new_hyperopt,
+                                                start_new_strategy)
+from freqtrade.commands.hyperopt_commands import start_hyperopt_list, start_hyperopt_show
+from freqtrade.commands.list_commands import (start_list_exchanges, start_list_hyperopts,
+                                              start_list_markets, start_list_strategies,
+                                              start_list_timeframes, start_show_trades)
+from freqtrade.commands.optimize_commands import start_backtesting, start_edge, start_hyperopt
+from freqtrade.commands.pairlist_commands import start_test_pairlist
+from freqtrade.commands.plot_commands import start_plot_dataframe, start_plot_profit
+from freqtrade.commands.trade_commands import start_trading

freqtrade/commands/arguments.py

@@ -0,0 +1,371 @@
+"""
+This module contains the argument manager class
+"""
+import argparse
+from functools import partial
+from pathlib import Path
+from typing import Any, Dict, List, Optional
+
+from freqtrade.commands.cli_options import AVAILABLE_CLI_OPTIONS
+from freqtrade.constants import DEFAULT_CONFIG
+
+
+ARGS_COMMON = ["verbosity", "logfile", "version", "config", "datadir", "user_data_dir"]
+
+ARGS_STRATEGY = ["strategy", "strategy_path"]
+
+ARGS_TRADE = ["db_url", "sd_notify", "dry_run"]
+
+ARGS_COMMON_OPTIMIZE = ["timeframe", "timerange", "dataformat_ohlcv",
+                        "max_open_trades", "stake_amount", "fee"]
+
+ARGS_BACKTEST = ARGS_COMMON_OPTIMIZE + ["position_stacking", "use_max_market_positions",
+                                        "strategy_list", "export", "exportfilename"]
+
+ARGS_HYPEROPT = ARGS_COMMON_OPTIMIZE + ["hyperopt", "hyperopt_path",
+                                        "position_stacking", "epochs", "spaces",
+                                        "use_max_market_positions", "print_all",
+                                        "print_colorized", "print_json", "hyperopt_jobs",
+                                        "hyperopt_random_state", "hyperopt_min_trades",
+                                        "hyperopt_loss"]
+
+ARGS_EDGE = ARGS_COMMON_OPTIMIZE + ["stoploss_range"]
+
+ARGS_LIST_STRATEGIES = ["strategy_path", "print_one_column", "print_colorized"]
+
+ARGS_LIST_HYPEROPTS = ["hyperopt_path", "print_one_column", "print_colorized"]
+
+ARGS_LIST_EXCHANGES = ["print_one_column", "list_exchanges_all"]
+
+ARGS_LIST_TIMEFRAMES = ["exchange", "print_one_column"]
+
+ARGS_LIST_PAIRS = ["exchange", "print_list", "list_pairs_print_json", "print_one_column",
+                   "print_csv", "base_currencies", "quote_currencies", "list_pairs_all"]
+
+ARGS_TEST_PAIRLIST = ["config", "quote_currencies", "print_one_column", "list_pairs_print_json"]
+
+ARGS_CREATE_USERDIR = ["user_data_dir", "reset"]
+
+ARGS_BUILD_CONFIG = ["config"]
+
+ARGS_BUILD_STRATEGY = ["user_data_dir", "strategy", "template"]
+
+ARGS_BUILD_HYPEROPT = ["user_data_dir", "hyperopt", "template"]
+
+ARGS_CONVERT_DATA = ["pairs", "format_from", "format_to", "erase"]
+ARGS_CONVERT_DATA_OHLCV = ARGS_CONVERT_DATA + ["timeframes"]
+
+ARGS_LIST_DATA = ["exchange", "dataformat_ohlcv", "pairs"]
+
+ARGS_DOWNLOAD_DATA = ["pairs", "pairs_file", "days", "timerange", "download_trades", "exchange",
+                      "timeframes", "erase", "dataformat_ohlcv", "dataformat_trades"]
+
+ARGS_PLOT_DATAFRAME = ["pairs", "indicators1", "indicators2", "plot_limit",
+                       "db_url", "trade_source", "export", "exportfilename",
+                       "timerange", "timeframe", "no_trades"]
+
+ARGS_PLOT_PROFIT = ["pairs", "timerange", "export", "exportfilename", "db_url",
+                    "trade_source", "timeframe"]
+
+ARGS_SHOW_TRADES = ["db_url", "trade_ids", "print_json"]
+
+ARGS_HYPEROPT_LIST = ["hyperopt_list_best", "hyperopt_list_profitable",
+                      "hyperopt_list_min_trades", "hyperopt_list_max_trades",
+                      "hyperopt_list_min_avg_time", "hyperopt_list_max_avg_time",
+                      "hyperopt_list_min_avg_profit", "hyperopt_list_max_avg_profit",
+                      "hyperopt_list_min_total_profit", "hyperopt_list_max_total_profit",
+                      "hyperopt_list_min_objective", "hyperopt_list_max_objective",
+                      "print_colorized", "print_json", "hyperopt_list_no_details",
+                      "hyperoptexportfilename", "export_csv"]
+
+ARGS_HYPEROPT_SHOW = ["hyperopt_list_best", "hyperopt_list_profitable", "hyperopt_show_index",
+                      "print_json", "hyperoptexportfilename", "hyperopt_show_no_header"]
+
+NO_CONF_REQURIED = ["convert-data", "convert-trade-data", "download-data", "list-timeframes",
+                    "list-markets", "list-pairs", "list-strategies", "list-data",
+                    "list-hyperopts", "hyperopt-list", "hyperopt-show",
+                    "plot-dataframe", "plot-profit", "show-trades"]
+
+NO_CONF_ALLOWED = ["create-userdir", "list-exchanges", "new-hyperopt", "new-strategy"]
+
+
+class Arguments:
+    """
+    Arguments Class. Manage the arguments received by the cli
+    """
+
+    def __init__(self, args: Optional[List[str]]) -> None:
+        self.args = args
+        self._parsed_arg: Optional[argparse.Namespace] = None
+
+    def get_parsed_arg(self) -> Dict[str, Any]:
+        """
+        Return the list of arguments
+        :return: List[str] List of arguments
+        """
+        if self._parsed_arg is None:
+            self._build_subcommands()
+            self._parsed_arg = self._parse_args()
+
+        return vars(self._parsed_arg)
+
+    def _parse_args(self) -> argparse.Namespace:
+        """
+        Parses given arguments and returns an argparse Namespace instance.
+        """
+        parsed_arg = self.parser.parse_args(self.args)
+
+        # Workaround issue in argparse with action='append' and default value
+        # (see https://bugs.python.org/issue16399)
+        # Allow no-config for certain commands (like downloading / plotting)
+        if ('config' in parsed_arg and parsed_arg.config is None):
+            conf_required = ('command' in parsed_arg and parsed_arg.command in NO_CONF_REQURIED)
+
+            if 'user_data_dir' in parsed_arg and parsed_arg.user_data_dir is not None:
+                user_dir = parsed_arg.user_data_dir
+            else:
+                # Default case
+                user_dir = 'user_data'
+                # Try loading from "user_data/config.json"
+            cfgfile = Path(user_dir) / DEFAULT_CONFIG
+            if cfgfile.is_file():
+                parsed_arg.config = [str(cfgfile)]
+            else:
+                # Else use "config.json".
+                cfgfile = Path.cwd() / DEFAULT_CONFIG
+                if cfgfile.is_file() or not conf_required:
+                    parsed_arg.config = [DEFAULT_CONFIG]
+
+        return parsed_arg
+
+    def _build_args(self, optionlist, parser):
+
+        for val in optionlist:
+            opt = AVAILABLE_CLI_OPTIONS[val]
+            parser.add_argument(*opt.cli, dest=val, **opt.kwargs)
+
+    def _build_subcommands(self) -> None:
+        """
+        Builds and attaches all subcommands.
+        :return: None
+        """
+        # Build shared arguments (as group Common Options)
+        _common_parser = argparse.ArgumentParser(add_help=False)
+        group = _common_parser.add_argument_group("Common arguments")
+        self._build_args(optionlist=ARGS_COMMON, parser=group)
+
+        _strategy_parser = argparse.ArgumentParser(add_help=False)
+        strategy_group = _strategy_parser.add_argument_group("Strategy arguments")
+        self._build_args(optionlist=ARGS_STRATEGY, parser=strategy_group)
+
+        # Build main command
+        self.parser = argparse.ArgumentParser(description='Free, open source crypto trading bot')
+        self._build_args(optionlist=['version'], parser=self.parser)
+
+        from freqtrade.commands import (start_backtesting, start_convert_data, start_create_userdir,
+                                        start_download_data, start_edge, start_hyperopt,
+                                        start_hyperopt_list, start_hyperopt_show, start_list_data,
+                                        start_list_exchanges, start_list_hyperopts,
+                                        start_list_markets, start_list_strategies,
+                                        start_list_timeframes, start_new_config, start_new_hyperopt,
+                                        start_new_strategy, start_plot_dataframe, start_plot_profit,
+                                        start_show_trades, start_test_pairlist, start_trading)
+
+        subparsers = self.parser.add_subparsers(dest='command',
+                                                # Use custom message when no subhandler is added
+                                                # shown from `main.py`
+                                                # required=True
+                                                )
+
+        # Add trade subcommand
+        trade_cmd = subparsers.add_parser('trade', help='Trade module.',
+                                          parents=[_common_parser, _strategy_parser])
+        trade_cmd.set_defaults(func=start_trading)
+        self._build_args(optionlist=ARGS_TRADE, parser=trade_cmd)
+
+        # add create-userdir subcommand
+        create_userdir_cmd = subparsers.add_parser('create-userdir',
+                                                   help="Create user-data directory.",
+                                                   )
+        create_userdir_cmd.set_defaults(func=start_create_userdir)
+        self._build_args(optionlist=ARGS_CREATE_USERDIR, parser=create_userdir_cmd)
+
+        # add new-config subcommand
+        build_config_cmd = subparsers.add_parser('new-config',
+                                                 help="Create new config")
+        build_config_cmd.set_defaults(func=start_new_config)
+        self._build_args(optionlist=ARGS_BUILD_CONFIG, parser=build_config_cmd)
+
+        # add new-hyperopt subcommand
+        build_hyperopt_cmd = subparsers.add_parser('new-hyperopt',
+                                                   help="Create new hyperopt")
+        build_hyperopt_cmd.set_defaults(func=start_new_hyperopt)
+        self._build_args(optionlist=ARGS_BUILD_HYPEROPT, parser=build_hyperopt_cmd)
+
+        # add new-strategy subcommand
+        build_strategy_cmd = subparsers.add_parser('new-strategy',
+                                                   help="Create new strategy")
+        build_strategy_cmd.set_defaults(func=start_new_strategy)
+        self._build_args(optionlist=ARGS_BUILD_STRATEGY, parser=build_strategy_cmd)
+
+        # Add download-data subcommand
+        download_data_cmd = subparsers.add_parser(
+            'download-data',
+            help='Download backtesting data.',
+            parents=[_common_parser],
+        )
+        download_data_cmd.set_defaults(func=start_download_data)
+        self._build_args(optionlist=ARGS_DOWNLOAD_DATA, parser=download_data_cmd)
+
+        # Add convert-data subcommand
+        convert_data_cmd = subparsers.add_parser(
+            'convert-data',
+            help='Convert candle (OHLCV) data from one format to another.',
+            parents=[_common_parser],
+        )
+        convert_data_cmd.set_defaults(func=partial(start_convert_data, ohlcv=True))
+        self._build_args(optionlist=ARGS_CONVERT_DATA_OHLCV, parser=convert_data_cmd)
+
+        # Add convert-trade-data subcommand
+        convert_trade_data_cmd = subparsers.add_parser(
+            'convert-trade-data',
+            help='Convert trade data from one format to another.',
+            parents=[_common_parser],
+        )
+        convert_trade_data_cmd.set_defaults(func=partial(start_convert_data, ohlcv=False))
+        self._build_args(optionlist=ARGS_CONVERT_DATA, parser=convert_trade_data_cmd)
+
+        # Add list-data subcommand
+        list_data_cmd = subparsers.add_parser(
+            'list-data',
+            help='List downloaded data.',
+            parents=[_common_parser],
+        )
+        list_data_cmd.set_defaults(func=start_list_data)
+        self._build_args(optionlist=ARGS_LIST_DATA, parser=list_data_cmd)
+
+        # Add backtesting subcommand
+        backtesting_cmd = subparsers.add_parser('backtesting', help='Backtesting module.',
+                                                parents=[_common_parser, _strategy_parser])
+        backtesting_cmd.set_defaults(func=start_backtesting)
+        self._build_args(optionlist=ARGS_BACKTEST, parser=backtesting_cmd)
+
+        # Add edge subcommand
+        edge_cmd = subparsers.add_parser('edge', help='Edge module.',
+                                         parents=[_common_parser, _strategy_parser])
+        edge_cmd.set_defaults(func=start_edge)
+        self._build_args(optionlist=ARGS_EDGE, parser=edge_cmd)
+
+        # Add hyperopt subcommand
+        hyperopt_cmd = subparsers.add_parser('hyperopt', help='Hyperopt module.',
+                                             parents=[_common_parser, _strategy_parser],
+                                             )
+        hyperopt_cmd.set_defaults(func=start_hyperopt)
+        self._build_args(optionlist=ARGS_HYPEROPT, parser=hyperopt_cmd)
+
+        # Add hyperopt-list subcommand
+        hyperopt_list_cmd = subparsers.add_parser(
+            'hyperopt-list',
+            help='List Hyperopt results',
+            parents=[_common_parser],
+        )
+        hyperopt_list_cmd.set_defaults(func=start_hyperopt_list)
+        self._build_args(optionlist=ARGS_HYPEROPT_LIST, parser=hyperopt_list_cmd)
+
+        # Add hyperopt-show subcommand
+        hyperopt_show_cmd = subparsers.add_parser(
+            'hyperopt-show',
+            help='Show details of Hyperopt results',
+            parents=[_common_parser],
+        )
+        hyperopt_show_cmd.set_defaults(func=start_hyperopt_show)
+        self._build_args(optionlist=ARGS_HYPEROPT_SHOW, parser=hyperopt_show_cmd)
+
+        # Add list-exchanges subcommand
+        list_exchanges_cmd = subparsers.add_parser(
+            'list-exchanges',
+            help='Print available exchanges.',
+            parents=[_common_parser],
+        )
+        list_exchanges_cmd.set_defaults(func=start_list_exchanges)
+        self._build_args(optionlist=ARGS_LIST_EXCHANGES, parser=list_exchanges_cmd)
+
+        # Add list-hyperopts subcommand
+        list_hyperopts_cmd = subparsers.add_parser(
+            'list-hyperopts',
+            help='Print available hyperopt classes.',
+            parents=[_common_parser],
+        )
+        list_hyperopts_cmd.set_defaults(func=start_list_hyperopts)
+        self._build_args(optionlist=ARGS_LIST_HYPEROPTS, parser=list_hyperopts_cmd)
+
+        # Add list-markets subcommand
+        list_markets_cmd = subparsers.add_parser(
+            'list-markets',
+            help='Print markets on exchange.',
+            parents=[_common_parser],
+        )
+        list_markets_cmd.set_defaults(func=partial(start_list_markets, pairs_only=False))
+        self._build_args(optionlist=ARGS_LIST_PAIRS, parser=list_markets_cmd)
+
+        # Add list-pairs subcommand
+        list_pairs_cmd = subparsers.add_parser(
+            'list-pairs',
+            help='Print pairs on exchange.',
+            parents=[_common_parser],
+        )
+        list_pairs_cmd.set_defaults(func=partial(start_list_markets, pairs_only=True))
+        self._build_args(optionlist=ARGS_LIST_PAIRS, parser=list_pairs_cmd)
+
+        # Add list-strategies subcommand
+        list_strategies_cmd = subparsers.add_parser(
+            'list-strategies',
+            help='Print available strategies.',
+            parents=[_common_parser],
+        )
+        list_strategies_cmd.set_defaults(func=start_list_strategies)
+        self._build_args(optionlist=ARGS_LIST_STRATEGIES, parser=list_strategies_cmd)
+
+        # Add list-timeframes subcommand
+        list_timeframes_cmd = subparsers.add_parser(
+            'list-timeframes',
+            help='Print available timeframes for the exchange.',
+            parents=[_common_parser],
+        )
+        list_timeframes_cmd.set_defaults(func=start_list_timeframes)
+        self._build_args(optionlist=ARGS_LIST_TIMEFRAMES, parser=list_timeframes_cmd)
+
+        # Add show-trades subcommand
+        show_trades = subparsers.add_parser(
+            'show-trades',
+            help='Show trades.',
+            parents=[_common_parser],
+        )
+        show_trades.set_defaults(func=start_show_trades)
+        self._build_args(optionlist=ARGS_SHOW_TRADES, parser=show_trades)
+
+        # Add test-pairlist subcommand
+        test_pairlist_cmd = subparsers.add_parser(
+            'test-pairlist',
+            help='Test your pairlist configuration.',
+        )
+        test_pairlist_cmd.set_defaults(func=start_test_pairlist)
+        self._build_args(optionlist=ARGS_TEST_PAIRLIST, parser=test_pairlist_cmd)
+
+        # Add Plotting subcommand
+        plot_dataframe_cmd = subparsers.add_parser(
+            'plot-dataframe',
+            help='Plot candles with indicators.',
+            parents=[_common_parser, _strategy_parser],
+        )
+        plot_dataframe_cmd.set_defaults(func=start_plot_dataframe)
+        self._build_args(optionlist=ARGS_PLOT_DATAFRAME, parser=plot_dataframe_cmd)
+
+        # Plot profit
+        plot_profit_cmd = subparsers.add_parser(
+            'plot-profit',
+            help='Generate plot showing profits.',
+            parents=[_common_parser, _strategy_parser],
+        )
+        plot_profit_cmd.set_defaults(func=start_plot_profit)
+        self._build_args(optionlist=ARGS_PLOT_PROFIT, parser=plot_profit_cmd)

freqtrade/commands/build_config_commands.py

@@ -0,0 +1,195 @@
+import logging
+from pathlib import Path
+from typing import Any, Dict, List
+
+from questionary import Separator, prompt
+
+from freqtrade.constants import UNLIMITED_STAKE_AMOUNT
+from freqtrade.exceptions import OperationalException
+from freqtrade.exchange import MAP_EXCHANGE_CHILDCLASS, available_exchanges
+from freqtrade.misc import render_template
+
+
+logger = logging.getLogger(__name__)
+
+
+def validate_is_int(val):
+    try:
+        _ = int(val)
+        return True
+    except Exception:
+        return False
+
+
+def validate_is_float(val):
+    try:
+        _ = float(val)
+        return True
+    except Exception:
+        return False
+
+
+def ask_user_overwrite(config_path: Path) -> bool:
+    questions = [
+        {
+            "type": "confirm",
+            "name": "overwrite",
+            "message": f"File {config_path} already exists. Overwrite?",
+            "default": False,
+        },
+    ]
+    answers = prompt(questions)
+    return answers['overwrite']
+
+
+def ask_user_config() -> Dict[str, Any]:
+    """
+    Ask user a few questions to build the configuration.
+    Interactive questions built using https://github.com/tmbo/questionary
+    :returns: Dict with keys to put into template
+    """
+    questions: List[Dict[str, Any]] = [
+        {
+            "type": "confirm",
+            "name": "dry_run",
+            "message": "Do you want to enable Dry-run (simulated trades)?",
+            "default": True,
+        },
+        {
+            "type": "text",
+            "name": "stake_currency",
+            "message": "Please insert your stake currency:",
+            "default": 'BTC',
+        },
+        {
+            "type": "text",
+            "name": "stake_amount",
+            "message": "Please insert your stake amount:",
+            "default": "0.01",
+            "validate": lambda val: val == UNLIMITED_STAKE_AMOUNT or validate_is_float(val),
+        },
+        {
+            "type": "text",
+            "name": "max_open_trades",
+            "message": f"Please insert max_open_trades (Integer or '{UNLIMITED_STAKE_AMOUNT}'):",
+            "default": "3",
+            "validate": lambda val: val == UNLIMITED_STAKE_AMOUNT or validate_is_int(val)
+        },
+        {
+            "type": "text",
+            "name": "timeframe",
+            "message": "Please insert your desired timeframe (e.g. 5m):",
+            "default": "5m",
+        },
+        {
+            "type": "text",
+            "name": "fiat_display_currency",
+            "message": "Please insert your display Currency (for reporting):",
+            "default": 'USD',
+        },
+        {
+            "type": "select",
+            "name": "exchange_name",
+            "message": "Select exchange",
+            "choices": [
+                "binance",
+                "binanceje",
+                "binanceus",
+                "bittrex",
+                "kraken",
+                Separator(),
+                "other",
+            ],
+        },
+        {
+            "type": "autocomplete",
+            "name": "exchange_name",
+            "message": "Type your exchange name (Must be supported by ccxt)",
+            "choices": available_exchanges(),
+            "when": lambda x: x["exchange_name"] == 'other'
+        },
+        {
+            "type": "password",
+            "name": "exchange_key",
+            "message": "Insert Exchange Key",
+            "when": lambda x: not x['dry_run']
+        },
+        {
+            "type": "password",
+            "name": "exchange_secret",
+            "message": "Insert Exchange Secret",
+            "when": lambda x: not x['dry_run']
+        },
+        {
+            "type": "confirm",
+            "name": "telegram",
+            "message": "Do you want to enable Telegram?",
+            "default": False,
+        },
+        {
+            "type": "password",
+            "name": "telegram_token",
+            "message": "Insert Telegram token",
+            "when": lambda x: x['telegram']
+        },
+        {
+            "type": "text",
+            "name": "telegram_chat_id",
+            "message": "Insert Telegram chat id",
+            "when": lambda x: x['telegram']
+        },
+    ]
+    answers = prompt(questions)
+
+    if not answers:
+        # Interrupted questionary sessions return an empty dict.
+        raise OperationalException("User interrupted interactive questions.")
+
+    return answers
+
+
+def deploy_new_config(config_path: Path, selections: Dict[str, Any]) -> None:
+    """
+    Applies selections to the template and writes the result to config_path
+    :param config_path: Path object for new config file. Should not exist yet
+    :param selecions: Dict containing selections taken by the user.
+    """
+    from jinja2.exceptions import TemplateNotFound
+    try:
+        exchange_template = MAP_EXCHANGE_CHILDCLASS.get(
+            selections['exchange_name'], selections['exchange_name'])
+
+        selections['exchange'] = render_template(
+            templatefile=f"subtemplates/exchange_{exchange_template}.j2",
+            arguments=selections
+            )
+    except TemplateNotFound:
+        selections['exchange'] = render_template(
+            templatefile="subtemplates/exchange_generic.j2",
+            arguments=selections
+        )
+
+    config_text = render_template(templatefile='base_config.json.j2',
+                                  arguments=selections)
+
+    logger.info(f"Writing config to `{config_path}`.")
+    config_path.write_text(config_text)
+
+
+def start_new_config(args: Dict[str, Any]) -> None:
+    """
+    Create a new strategy from a template
+    Asking the user questions to fill out the templateaccordingly.
+    """
+
+    config_path = Path(args['config'][0])
+    if config_path.exists():
+        overwrite = ask_user_overwrite(config_path)
+        if overwrite:
+            config_path.unlink()
+        else:
+            raise OperationalException(
+                f"Configuration file `{config_path}` already exists. "
+                "Please delete it or use a different configuration file name.")
+    selections = ask_user_config()
+    deploy_new_config(config_path, selections)

freqtrade/commands/cli_options.py

@@ -0,0 +1,515 @@
+"""
+Definition of cli arguments used in arguments.py
+"""
+from argparse import ArgumentTypeError
+
+from freqtrade import __version__, constants
+from freqtrade.constants import HYPEROPT_LOSS_BUILTIN
+
+
+def check_int_positive(value: str) -> int:
+    try:
+        uint = int(value)
+        if uint <= 0:
+            raise ValueError
+    except ValueError:
+        raise ArgumentTypeError(
+            f"{value} is invalid for this parameter, should be a positive integer value"
+        )
+    return uint
+
+
+def check_int_nonzero(value: str) -> int:
+    try:
+        uint = int(value)
+        if uint == 0:
+            raise ValueError
+    except ValueError:
+        raise ArgumentTypeError(
+            f"{value} is invalid for this parameter, should be a non-zero integer value"
+        )
+    return uint
+
+
+class Arg:
+    # Optional CLI arguments
+    def __init__(self, *args, **kwargs):
+        self.cli = args
+        self.kwargs = kwargs
+
+
+# List of available command line options
+AVAILABLE_CLI_OPTIONS = {
+    # Common options
+    "verbosity": Arg(
+        '-v', '--verbose',
+        help='Verbose mode (-vv for more, -vvv to get all messages).',
+        action='count',
+        default=0,
+    ),
+    "logfile": Arg(
+        '--logfile',
+        help="Log to the file specified. Special values are: 'syslog', 'journald'. "
+             "See the documentation for more details.",
+        metavar='FILE',
+    ),
+    "version": Arg(
+        '-V', '--version',
+        action='version',
+        version=f'%(prog)s {__version__}',
+    ),
+    "config": Arg(
+        '-c', '--config',
+        help=f'Specify configuration file (default: `userdir/{constants.DEFAULT_CONFIG}` '
+        f'or `config.json` whichever exists). '
+        f'Multiple --config options may be used. '
+        f'Can be set to `-` to read config from stdin.',
+        action='append',
+        metavar='PATH',
+    ),
+    "datadir": Arg(
+        '-d', '--datadir',
+        help='Path to directory with historical backtesting data.',
+        metavar='PATH',
+    ),
+    "user_data_dir": Arg(
+        '--userdir', '--user-data-dir',
+        help='Path to userdata directory.',
+        metavar='PATH',
+    ),
+    "reset": Arg(
+        '--reset',
+        help='Reset sample files to their original state.',
+        action='store_true',
+    ),
+    # Main options
+    "strategy": Arg(
+        '-s', '--strategy',
+        help='Specify strategy class name which will be used by the bot.',
+        metavar='NAME',
+    ),
+    "strategy_path": Arg(
+        '--strategy-path',
+        help='Specify additional strategy lookup path.',
+        metavar='PATH',
+    ),
+    "db_url": Arg(
+        '--db-url',
+        help=f'Override trades database URL, this is useful in custom deployments '
+        f'(default: `{constants.DEFAULT_DB_PROD_URL}` for Live Run mode, '
+        f'`{constants.DEFAULT_DB_DRYRUN_URL}` for Dry Run).',
+        metavar='PATH',
+    ),
+    "sd_notify": Arg(
+        '--sd-notify',
+        help='Notify systemd service manager.',
+        action='store_true',
+    ),
+    "dry_run": Arg(
+        '--dry-run',
+        help='Enforce dry-run for trading (removes Exchange secrets and simulates trades).',
+        action='store_true',
+    ),
+    # Optimize common
+    "timeframe": Arg(
+        '-i', '--timeframe', '--ticker-interval',
+        help='Specify ticker interval (`1m`, `5m`, `30m`, `1h`, `1d`).',
+    ),
+    "timerange": Arg(
+        '--timerange',
+        help='Specify what timerange of data to use.',
+    ),
+    "max_open_trades": Arg(
+        '--max-open-trades',
+        help='Override the value of the `max_open_trades` configuration setting.',
+        type=int,
+        metavar='INT',
+    ),
+    "stake_amount": Arg(
+        '--stake-amount',
+        help='Override the value of the `stake_amount` configuration setting.',
+        type=float,
+    ),
+    # Backtesting
+    "position_stacking": Arg(
+        '--eps', '--enable-position-stacking',
+        help='Allow buying the same pair multiple times (position stacking).',
+        action='store_true',
+        default=False,
+    ),
+    "use_max_market_positions": Arg(
+        '--dmmp', '--disable-max-market-positions',
+        help='Disable applying `max_open_trades` during backtest '
+        '(same as setting `max_open_trades` to a very high number).',
+        action='store_false',
+        default=True,
+    ),
+    "strategy_list": Arg(
+        '--strategy-list',
+        help='Provide a space-separated list of strategies to backtest. '
+        'Please note that ticker-interval needs to be set either in config '
+        'or via command line. When using this together with `--export trades`, '
+        'the strategy-name is injected into the filename '
+        '(so `backtest-data.json` becomes `backtest-data-DefaultStrategy.json`',
+        nargs='+',
+    ),
+    "export": Arg(
+        '--export',
+        help='Export backtest results, argument are: trades. '
+        'Example: `--export=trades`',
+    ),
+    "exportfilename": Arg(
+        '--export-filename',
+        help='Save backtest results to the file with this filename. '
+        'Requires `--export` to be set as well. '
+        'Example: `--export-filename=user_data/backtest_results/backtest_today.json`',
+        metavar='PATH',
+    ),
+    "fee": Arg(
+        '--fee',
+        help='Specify fee ratio. Will be applied twice (on trade entry and exit).',
+        type=float,
+        metavar='FLOAT',
+    ),
+    # Edge
+    "stoploss_range": Arg(
+        '--stoplosses',
+        help='Defines a range of stoploss values against which edge will assess the strategy. '
+        'The format is "min,max,step" (without any space). '
+        'Example: `--stoplosses=-0.01,-0.1,-0.001`',
+    ),
+    # Hyperopt
+    "hyperopt": Arg(
+        '--hyperopt',
+        help='Specify hyperopt class name which will be used by the bot.',
+        metavar='NAME',
+    ),
+    "hyperopt_path": Arg(
+        '--hyperopt-path',
+        help='Specify additional lookup path for Hyperopt and Hyperopt Loss functions.',
+        metavar='PATH',
+    ),
+    "epochs": Arg(
+        '-e', '--epochs',
+        help='Specify number of epochs (default: %(default)d).',
+        type=check_int_positive,
+        metavar='INT',
+        default=constants.HYPEROPT_EPOCH,
+    ),
+    "spaces": Arg(
+        '--spaces',
+        help='Specify which parameters to hyperopt. Space-separated list.',
+        choices=['all', 'buy', 'sell', 'roi', 'stoploss', 'trailing', 'default'],
+        nargs='+',
+        default='default',
+    ),
+    "print_all": Arg(
+        '--print-all',
+        help='Print all results, not only the best ones.',
+        action='store_true',
+        default=False,
+    ),
+    "print_colorized": Arg(
+        '--no-color',
+        help='Disable colorization of hyperopt results. May be useful if you are '
+        'redirecting output to a file.',
+        action='store_false',
+        default=True,
+    ),
+    "print_json": Arg(
+        '--print-json',
+        help='Print output in JSON format.',
+        action='store_true',
+        default=False,
+    ),
+    "export_csv": Arg(
+        '--export-csv',
+        help='Export to CSV-File.'
+        ' This will disable table print.'
+        ' Example: --export-csv hyperopt.csv',
+        metavar='FILE',
+    ),
+    "hyperopt_jobs": Arg(
+        '-j', '--job-workers',
+        help='The number of concurrently running jobs for hyperoptimization '
+        '(hyperopt worker processes). '
+        'If -1 (default), all CPUs are used, for -2, all CPUs but one are used, etc. '
+        'If 1 is given, no parallel computing code is used at all.',
+        type=int,
+        metavar='JOBS',
+        default=-1,
+    ),
+    "hyperopt_random_state": Arg(
+        '--random-state',
+        help='Set random state to some positive integer for reproducible hyperopt results.',
+        type=check_int_positive,
+        metavar='INT',
+    ),
+    "hyperopt_min_trades": Arg(
+        '--min-trades',
+        help="Set minimal desired number of trades for evaluations in the hyperopt "
+        "optimization path (default: 1).",
+        type=check_int_positive,
+        metavar='INT',
+        default=1,
+    ),
+    "hyperopt_loss": Arg(
+        '--hyperopt-loss',
+        help='Specify the class name of the hyperopt loss function class (IHyperOptLoss). '
+        'Different functions can generate completely different results, '
+        'since the target for optimization is different. Built-in Hyperopt-loss-functions are: '
+        f'{", ".join(HYPEROPT_LOSS_BUILTIN)}',
+        metavar='NAME',
+    ),
+    "hyperoptexportfilename": Arg(
+        '--hyperopt-filename',
+        help='Hyperopt result filename.'
+        'Example: `--hyperopt-filename=hyperopt_results_2020-09-27_16-20-48.pickle`',
+        metavar='FILENAME',
+    ),
+    # List exchanges
+    "print_one_column": Arg(
+        '-1', '--one-column',
+        help='Print output in one column.',
+        action='store_true',
+    ),
+    "list_exchanges_all": Arg(
+        '-a', '--all',
+        help='Print all exchanges known to the ccxt library.',
+        action='store_true',
+    ),
+    # List pairs / markets
+    "list_pairs_all": Arg(
+        '-a', '--all',
+        help='Print all pairs or market symbols. By default only active '
+             'ones are shown.',
+        action='store_true',
+    ),
+    "print_list": Arg(
+        '--print-list',
+        help='Print list of pairs or market symbols. By default data is '
+             'printed in the tabular format.',
+        action='store_true',
+    ),
+    "list_pairs_print_json": Arg(
+        '--print-json',
+        help='Print list of pairs or market symbols in JSON format.',
+        action='store_true',
+        default=False,
+    ),
+    "print_csv": Arg(
+        '--print-csv',
+        help='Print exchange pair or market data in the csv format.',
+        action='store_true',
+    ),
+    "quote_currencies": Arg(
+        '--quote',
+        help='Specify quote currency(-ies). Space-separated list.',
+        nargs='+',
+        metavar='QUOTE_CURRENCY',
+    ),
+    "base_currencies": Arg(
+        '--base',
+        help='Specify base currency(-ies). Space-separated list.',
+        nargs='+',
+        metavar='BASE_CURRENCY',
+    ),
+    # Script options
+    "pairs": Arg(
+        '-p', '--pairs',
+        help='Show profits for only these pairs. Pairs are space-separated.',
+        nargs='+',
+    ),
+    # Download data
+    "pairs_file": Arg(
+        '--pairs-file',
+        help='File containing a list of pairs to download.',
+        metavar='FILE',
+    ),
+    "days": Arg(
+        '--days',
+        help='Download data for given number of days.',
+        type=check_int_positive,
+        metavar='INT',
+    ),
+    "download_trades": Arg(
+        '--dl-trades',
+        help='Download trades instead of OHLCV data. The bot will resample trades to the '
+             'desired timeframe as specified as --timeframes/-t.',
+        action='store_true',
+    ),
+    "format_from": Arg(
+        '--format-from',
+        help='Source format for data conversion.',
+        choices=constants.AVAILABLE_DATAHANDLERS,
+        required=True,
+    ),
+    "format_to": Arg(
+        '--format-to',
+        help='Destination format for data conversion.',
+        choices=constants.AVAILABLE_DATAHANDLERS,
+        required=True,
+    ),
+    "dataformat_ohlcv": Arg(
+        '--data-format-ohlcv',
+        help='Storage format for downloaded candle (OHLCV) data. (default: `%(default)s`).',
+        choices=constants.AVAILABLE_DATAHANDLERS,
+    ),
+    "dataformat_trades": Arg(
+        '--data-format-trades',
+        help='Storage format for downloaded trades data. (default: `%(default)s`).',
+        choices=constants.AVAILABLE_DATAHANDLERS,
+    ),
+    "exchange": Arg(
+        '--exchange',
+        help=f'Exchange name (default: `{constants.DEFAULT_EXCHANGE}`). '
+        f'Only valid if no config is provided.',
+    ),
+    "timeframes": Arg(
+        '-t', '--timeframes',
+        help='Specify which tickers to download. Space-separated list. '
+        'Default: `1m 5m`.',
+        choices=['1m', '3m', '5m', '15m', '30m', '1h', '2h', '4h',
+                 '6h', '8h', '12h', '1d', '3d', '1w', '2w', '1M', '1y'],
+        default=['1m', '5m'],
+        nargs='+',
+    ),
+    "erase": Arg(
+        '--erase',
+        help='Clean all existing data for the selected exchange/pairs/timeframes.',
+        action='store_true',
+    ),
+    # Templating options
+    "template": Arg(
+        '--template',
+        help='Use a template which is either `minimal`, '
+        '`full` (containing multiple sample indicators) or `advanced`. Default: `%(default)s`.',
+        choices=['full', 'minimal', 'advanced'],
+        default='full',
+    ),
+    # Plot dataframe
+    "indicators1": Arg(
+        '--indicators1',
+        help='Set indicators from your strategy you want in the first row of the graph. '
+        "Space-separated list. Example: `ema3 ema5`. Default: `['sma', 'ema3', 'ema5']`.",
+        nargs='+',
+    ),
+    "indicators2": Arg(
+        '--indicators2',
+        help='Set indicators from your strategy you want in the third row of the graph. '
+        "Space-separated list. Example: `fastd fastk`. Default: `['macd', 'macdsignal']`.",
+        nargs='+',
+    ),
+    "plot_limit": Arg(
+        '--plot-limit',
+        help='Specify tick limit for plotting. Notice: too high values cause huge files. '
+        'Default: %(default)s.',
+        type=check_int_positive,
+        metavar='INT',
+        default=750,
+    ),
+    "no_trades": Arg(
+        '--no-trades',
+        help='Skip using trades from backtesting file and DB.',
+        action='store_true',
+    ),
+    "trade_source": Arg(
+        '--trade-source',
+        help='Specify the source for trades (Can be DB or file (backtest file)) '
+        'Default: %(default)s',
+        choices=["DB", "file"],
+        default="file",
+    ),
+    "trade_ids": Arg(
+        '--trade-ids',
+        help='Specify the list of trade ids.',
+        nargs='+',
+    ),
+    # hyperopt-list, hyperopt-show
+    "hyperopt_list_profitable": Arg(
+        '--profitable',
+        help='Select only profitable epochs.',
+        action='store_true',
+    ),
+    "hyperopt_list_best": Arg(
+        '--best',
+        help='Select only best epochs.',
+        action='store_true',
+    ),
+    "hyperopt_list_min_trades": Arg(
+        '--min-trades',
+        help='Select epochs with more than INT trades.',
+        type=check_int_positive,
+        metavar='INT',
+    ),
+    "hyperopt_list_max_trades": Arg(
+        '--max-trades',
+        help='Select epochs with less than INT trades.',
+        type=check_int_positive,
+        metavar='INT',
+    ),
+    "hyperopt_list_min_avg_time": Arg(
+        '--min-avg-time',
+        help='Select epochs above average time.',
+        type=float,
+        metavar='FLOAT',
+    ),
+    "hyperopt_list_max_avg_time": Arg(
+        '--max-avg-time',
+        help='Select epochs below average time.',
+        type=float,
+        metavar='FLOAT',
+    ),
+    "hyperopt_list_min_avg_profit": Arg(
+        '--min-avg-profit',
+        help='Select epochs above average profit.',
+        type=float,
+        metavar='FLOAT',
+    ),
+    "hyperopt_list_max_avg_profit": Arg(
+        '--max-avg-profit',
+        help='Select epochs below average profit.',
+        type=float,
+        metavar='FLOAT',
+    ),
+    "hyperopt_list_min_total_profit": Arg(
+        '--min-total-profit',
+        help='Select epochs above total profit.',
+        type=float,
+        metavar='FLOAT',
+    ),
+    "hyperopt_list_max_total_profit": Arg(
+        '--max-total-profit',
+        help='Select epochs below total profit.',
+        type=float,
+        metavar='FLOAT',
+    ),
+    "hyperopt_list_min_objective": Arg(
+        '--min-objective',
+        help='Select epochs above objective.',
+        type=float,
+        metavar='FLOAT',
+    ),
+    "hyperopt_list_max_objective": Arg(
+        '--max-objective',
+        help='Select epochs below objective.',
+        type=float,
+        metavar='FLOAT',
+    ),
+    "hyperopt_list_no_details": Arg(
+        '--no-details',
+        help='Do not print best epoch details.',
+        action='store_true',
+    ),
+    "hyperopt_show_index": Arg(
+        '-n', '--index',
+        help='Specify the index of the epoch to print details for.',
+        type=check_int_nonzero,
+        metavar='INT',
+    ),
+    "hyperopt_show_no_header": Arg(
+        '--no-header',
+        help='Do not print epoch details header.',
+        action='store_true',
+    ),
+}

freqtrade/commands/data_commands.py

@@ -0,0 +1,127 @@
+import logging
+import sys
+from collections import defaultdict
+from datetime import datetime, timedelta
+from typing import Any, Dict, List
+
+from freqtrade.configuration import TimeRange, setup_utils_configuration
+from freqtrade.data.converter import convert_ohlcv_format, convert_trades_format
+from freqtrade.data.history import (convert_trades_to_ohlcv, refresh_backtest_ohlcv_data,
+                                    refresh_backtest_trades_data)
+from freqtrade.exceptions import OperationalException
+from freqtrade.exchange import timeframe_to_minutes
+from freqtrade.resolvers import ExchangeResolver
+from freqtrade.state import RunMode
+
+
+logger = logging.getLogger(__name__)
+
+
+def start_download_data(args: Dict[str, Any]) -> None:
+    """
+    Download data (former download_backtest_data.py script)
+    """
+    config = setup_utils_configuration(args, RunMode.UTIL_EXCHANGE)
+
+    if 'days' in config and 'timerange' in config:
+        raise OperationalException("--days and --timerange are mutually exclusive. "
+                                   "You can only specify one or the other.")
+    timerange = TimeRange()
+    if 'days' in config:
+        time_since = (datetime.now() - timedelta(days=config['days'])).strftime("%Y%m%d")
+        timerange = TimeRange.parse_timerange(f'{time_since}-')
+
+    if 'timerange' in config:
+        timerange = timerange.parse_timerange(config['timerange'])
+
+    # Remove stake-currency to skip checks which are not relevant for datadownload
+    config['stake_currency'] = ''
+
+    if 'pairs' not in config:
+        raise OperationalException(
+            "Downloading data requires a list of pairs. "
+            "Please check the documentation on how to configure this.")
+
+    logger.info(f"About to download pairs: {config['pairs']}, "
+                f"intervals: {config['timeframes']} to {config['datadir']}")
+
+    pairs_not_available: List[str] = []
+
+    # Init exchange
+    exchange = ExchangeResolver.load_exchange(config['exchange']['name'], config, validate=False)
+    # Manual validations of relevant settings
+    exchange.validate_pairs(config['pairs'])
+    for timeframe in config['timeframes']:
+        exchange.validate_timeframes(timeframe)
+
+    try:
+
+        if config.get('download_trades'):
+            pairs_not_available = refresh_backtest_trades_data(
+                exchange, pairs=config['pairs'], datadir=config['datadir'],
+                timerange=timerange, erase=bool(config.get('erase')),
+                data_format=config['dataformat_trades'])
+
+            # Convert downloaded trade data to different timeframes
+            convert_trades_to_ohlcv(
+                pairs=config['pairs'], timeframes=config['timeframes'],
+                datadir=config['datadir'], timerange=timerange, erase=bool(config.get('erase')),
+                data_format_ohlcv=config['dataformat_ohlcv'],
+                data_format_trades=config['dataformat_trades'],
+                )
+        else:
+            pairs_not_available = refresh_backtest_ohlcv_data(
+                exchange, pairs=config['pairs'], timeframes=config['timeframes'],
+                datadir=config['datadir'], timerange=timerange, erase=bool(config.get('erase')),
+                data_format=config['dataformat_ohlcv'])
+
+    except KeyboardInterrupt:
+        sys.exit("SIGINT received, aborting ...")
+
+    finally:
+        if pairs_not_available:
+            logger.info(f"Pairs [{','.join(pairs_not_available)}] not available "
+                        f"on exchange {exchange.name}.")
+
+
+def start_convert_data(args: Dict[str, Any], ohlcv: bool = True) -> None:
+    """
+    Convert data from one format to another
+    """
+    config = setup_utils_configuration(args, RunMode.UTIL_NO_EXCHANGE)
+    if ohlcv:
+        convert_ohlcv_format(config,
+                             convert_from=args['format_from'], convert_to=args['format_to'],
+                             erase=args['erase'])
+    else:
+        convert_trades_format(config,
+                              convert_from=args['format_from'], convert_to=args['format_to'],
+                              erase=args['erase'])
+
+
+def start_list_data(args: Dict[str, Any]) -> None:
+    """
+    List available backtest data
+    """
+
+    config = setup_utils_configuration(args, RunMode.UTIL_NO_EXCHANGE)
+
+    from tabulate import tabulate
+
+    from freqtrade.data.history.idatahandler import get_datahandler
+    dhc = get_datahandler(config['datadir'], config['dataformat_ohlcv'])
+
+    paircombs = dhc.ohlcv_get_available_data(config['datadir'])
+
+    if args['pairs']:
+        paircombs = [comb for comb in paircombs if comb[0] in args['pairs']]
+
+    print(f"Found {len(paircombs)} pair / timeframe combinations.")
+    groupedpair = defaultdict(list)
+    for pair, timeframe in sorted(paircombs, key=lambda x: (x[0], timeframe_to_minutes(x[1]))):
+        groupedpair[pair].append(timeframe)
+
+    if groupedpair:
+        print(tabulate([(pair, ', '.join(timeframes)) for pair, timeframes in groupedpair.items()],
+                       headers=("Pair", "Timeframe"),
+                       tablefmt='psql', stralign='right'))

freqtrade/commands/deploy_commands.py

@@ -0,0 +1,139 @@
+import logging
+import sys
+from pathlib import Path
+from typing import Any, Dict
+
+from freqtrade.configuration import setup_utils_configuration
+from freqtrade.configuration.directory_operations import copy_sample_files, create_userdata_dir
+from freqtrade.constants import USERPATH_HYPEROPTS, USERPATH_STRATEGIES
+from freqtrade.exceptions import OperationalException
+from freqtrade.misc import render_template, render_template_with_fallback
+from freqtrade.state import RunMode
+
+
+logger = logging.getLogger(__name__)
+
+
+def start_create_userdir(args: Dict[str, Any]) -> None:
+    """
+    Create "user_data" directory to contain user data strategies, hyperopt, ...)
+    :param args: Cli args from Arguments()
+    :return: None
+    """
+    if "user_data_dir" in args and args["user_data_dir"]:
+        userdir = create_userdata_dir(args["user_data_dir"], create_dir=True)
+        copy_sample_files(userdir, overwrite=args["reset"])
+    else:
+        logger.warning("`create-userdir` requires --userdir to be set.")
+        sys.exit(1)
+
+
+def deploy_new_strategy(strategy_name: str, strategy_path: Path, subtemplate: str) -> None:
+    """
+    Deploy new strategy from template to strategy_path
+    """
+    fallback = 'full'
+    indicators = render_template_with_fallback(
+        templatefile=f"subtemplates/indicators_{subtemplate}.j2",
+        templatefallbackfile=f"subtemplates/indicators_{fallback}.j2",
+        )
+    buy_trend = render_template_with_fallback(
+        templatefile=f"subtemplates/buy_trend_{subtemplate}.j2",
+        templatefallbackfile=f"subtemplates/buy_trend_{fallback}.j2",
+        )
+    sell_trend = render_template_with_fallback(
+        templatefile=f"subtemplates/sell_trend_{subtemplate}.j2",
+        templatefallbackfile=f"subtemplates/sell_trend_{fallback}.j2",
+        )
+    plot_config = render_template_with_fallback(
+        templatefile=f"subtemplates/plot_config_{subtemplate}.j2",
+        templatefallbackfile=f"subtemplates/plot_config_{fallback}.j2",
+    )
+    additional_methods = render_template_with_fallback(
+        templatefile=f"subtemplates/strategy_methods_{subtemplate}.j2",
+        templatefallbackfile="subtemplates/strategy_methods_empty.j2",
+    )
+
+    strategy_text = render_template(templatefile='base_strategy.py.j2',
+                                    arguments={"strategy": strategy_name,
+                                               "indicators": indicators,
+                                               "buy_trend": buy_trend,
+                                               "sell_trend": sell_trend,
+                                               "plot_config": plot_config,
+                                               "additional_methods": additional_methods,
+                                               })
+
+    logger.info(f"Writing strategy to `{strategy_path}`.")
+    strategy_path.write_text(strategy_text)
+
+
+def start_new_strategy(args: Dict[str, Any]) -> None:
+
+    config = setup_utils_configuration(args, RunMode.UTIL_NO_EXCHANGE)
+
+    if "strategy" in args and args["strategy"]:
+        if args["strategy"] == "DefaultStrategy":
+            raise OperationalException("DefaultStrategy is not allowed as name.")
+
+        new_path = config['user_data_dir'] / USERPATH_STRATEGIES / (args['strategy'] + '.py')
+
+        if new_path.exists():
+            raise OperationalException(f"`{new_path}` already exists. "
+                                       "Please choose another Strategy Name.")
+
+        deploy_new_strategy(args['strategy'], new_path, args['template'])
+
+    else:
+        raise OperationalException("`new-strategy` requires --strategy to be set.")
+
+
+def deploy_new_hyperopt(hyperopt_name: str, hyperopt_path: Path, subtemplate: str) -> None:
+    """
+    Deploys a new hyperopt template to hyperopt_path
+    """
+    fallback = 'full'
+    buy_guards = render_template_with_fallback(
+        templatefile=f"subtemplates/hyperopt_buy_guards_{subtemplate}.j2",
+        templatefallbackfile=f"subtemplates/hyperopt_buy_guards_{fallback}.j2",
+        )
+    sell_guards = render_template_with_fallback(
+        templatefile=f"subtemplates/hyperopt_sell_guards_{subtemplate}.j2",
+        templatefallbackfile=f"subtemplates/hyperopt_sell_guards_{fallback}.j2",
+        )
+    buy_space = render_template_with_fallback(
+        templatefile=f"subtemplates/hyperopt_buy_space_{subtemplate}.j2",
+        templatefallbackfile=f"subtemplates/hyperopt_buy_space_{fallback}.j2",
+        )
+    sell_space = render_template_with_fallback(
+        templatefile=f"subtemplates/hyperopt_sell_space_{subtemplate}.j2",
+        templatefallbackfile=f"subtemplates/hyperopt_sell_space_{fallback}.j2",
+        )
+
+    strategy_text = render_template(templatefile='base_hyperopt.py.j2',
+                                    arguments={"hyperopt": hyperopt_name,
+                                               "buy_guards": buy_guards,
+                                               "sell_guards": sell_guards,
+                                               "buy_space": buy_space,
+                                               "sell_space": sell_space,
+                                               })
+
+    logger.info(f"Writing hyperopt to `{hyperopt_path}`.")
+    hyperopt_path.write_text(strategy_text)
+
+
+def start_new_hyperopt(args: Dict[str, Any]) -> None:
+
+    config = setup_utils_configuration(args, RunMode.UTIL_NO_EXCHANGE)
+
+    if 'hyperopt' in args and args['hyperopt']:
+        if args['hyperopt'] == 'DefaultHyperopt':
+            raise OperationalException("DefaultHyperopt is not allowed as name.")
+
+        new_path = config['user_data_dir'] / USERPATH_HYPEROPTS / (args['hyperopt'] + '.py')
+
+        if new_path.exists():
+            raise OperationalException(f"`{new_path}` already exists. "
+                                       "Please choose another Hyperopt Name.")
+        deploy_new_hyperopt(args['hyperopt'], new_path, args['template'])
+    else:
+        raise OperationalException("`new-hyperopt` requires --hyperopt to be set.")

freqtrade/commands/hyperopt_commands.py

@@ -0,0 +1,228 @@
+import logging
+from operator import itemgetter
+from typing import Any, Dict, List
+
+from colorama import init as colorama_init
+
+from freqtrade.configuration import setup_utils_configuration
+from freqtrade.data.btanalysis import get_latest_hyperopt_file
+from freqtrade.exceptions import OperationalException
+from freqtrade.state import RunMode
+
+
+logger = logging.getLogger(__name__)
+
+
+def start_hyperopt_list(args: Dict[str, Any]) -> None:
+    """
+    List hyperopt epochs previously evaluated
+    """
+    from freqtrade.optimize.hyperopt import Hyperopt
+
+    config = setup_utils_configuration(args, RunMode.UTIL_NO_EXCHANGE)
+
+    print_colorized = config.get('print_colorized', False)
+    print_json = config.get('print_json', False)
+    export_csv = config.get('export_csv', None)
+    no_details = config.get('hyperopt_list_no_details', False)
+    no_header = False
+
+    filteroptions = {
+        'only_best': config.get('hyperopt_list_best', False),
+        'only_profitable': config.get('hyperopt_list_profitable', False),
+        'filter_min_trades': config.get('hyperopt_list_min_trades', 0),
+        'filter_max_trades': config.get('hyperopt_list_max_trades', 0),
+        'filter_min_avg_time': config.get('hyperopt_list_min_avg_time', None),
+        'filter_max_avg_time': config.get('hyperopt_list_max_avg_time', None),
+        'filter_min_avg_profit': config.get('hyperopt_list_min_avg_profit', None),
+        'filter_max_avg_profit': config.get('hyperopt_list_max_avg_profit', None),
+        'filter_min_total_profit': config.get('hyperopt_list_min_total_profit', None),
+        'filter_max_total_profit': config.get('hyperopt_list_max_total_profit', None),
+        'filter_min_objective': config.get('hyperopt_list_min_objective', None),
+        'filter_max_objective': config.get('hyperopt_list_max_objective', None),
+    }
+
+    results_file = get_latest_hyperopt_file(
+        config['user_data_dir'] / 'hyperopt_results',
+        config.get('hyperoptexportfilename'))
+
+    # Previous evaluations
+    epochs = Hyperopt.load_previous_results(results_file)
+    total_epochs = len(epochs)
+
+    epochs = hyperopt_filter_epochs(epochs, filteroptions)
+
+    if print_colorized:
+        colorama_init(autoreset=True)
+
+    if not export_csv:
+        try:
+            print(Hyperopt.get_result_table(config, epochs, total_epochs,
+                                            not filteroptions['only_best'], print_colorized, 0))
+        except KeyboardInterrupt:
+            print('User interrupted..')
+
+    if epochs and not no_details:
+        sorted_epochs = sorted(epochs, key=itemgetter('loss'))
+        results = sorted_epochs[0]
+        Hyperopt.print_epoch_details(results, total_epochs, print_json, no_header)
+
+    if epochs and export_csv:
+        Hyperopt.export_csv_file(
+            config, epochs, total_epochs, not filteroptions['only_best'], export_csv
+        )
+
+
+def start_hyperopt_show(args: Dict[str, Any]) -> None:
+    """
+    Show details of a hyperopt epoch previously evaluated
+    """
+    from freqtrade.optimize.hyperopt import Hyperopt
+
+    config = setup_utils_configuration(args, RunMode.UTIL_NO_EXCHANGE)
+
+    print_json = config.get('print_json', False)
+    no_header = config.get('hyperopt_show_no_header', False)
+    results_file = get_latest_hyperopt_file(
+        config['user_data_dir'] / 'hyperopt_results',
+        config.get('hyperoptexportfilename'))
+
+    n = config.get('hyperopt_show_index', -1)
+
+    filteroptions = {
+        'only_best': config.get('hyperopt_list_best', False),
+        'only_profitable': config.get('hyperopt_list_profitable', False),
+        'filter_min_trades': config.get('hyperopt_list_min_trades', 0),
+        'filter_max_trades': config.get('hyperopt_list_max_trades', 0),
+        'filter_min_avg_time': config.get('hyperopt_list_min_avg_time', None),
+        'filter_max_avg_time': config.get('hyperopt_list_max_avg_time', None),
+        'filter_min_avg_profit': config.get('hyperopt_list_min_avg_profit', None),
+        'filter_max_avg_profit': config.get('hyperopt_list_max_avg_profit', None),
+        'filter_min_total_profit': config.get('hyperopt_list_min_total_profit', None),
+        'filter_max_total_profit': config.get('hyperopt_list_max_total_profit', None),
+        'filter_min_objective': config.get('hyperopt_list_min_objective', None),
+        'filter_max_objective': config.get('hyperopt_list_max_objective', None)
+    }
+
+    # Previous evaluations
+    epochs = Hyperopt.load_previous_results(results_file)
+    total_epochs = len(epochs)
+
+    epochs = hyperopt_filter_epochs(epochs, filteroptions)
+    filtered_epochs = len(epochs)
+
+    if n > filtered_epochs:
+        raise OperationalException(
+            f"The index of the epoch to show should be less than {filtered_epochs + 1}.")
+    if n < -filtered_epochs:
+        raise OperationalException(
+            f"The index of the epoch to show should be greater than {-filtered_epochs - 1}.")
+
+    # Translate epoch index from human-readable format to pythonic
+    if n > 0:
+        n -= 1
+
+    if epochs:
+        val = epochs[n]
+        Hyperopt.print_epoch_details(val, total_epochs, print_json, no_header,
+                                     header_str="Epoch details")
+
+
+def hyperopt_filter_epochs(epochs: List, filteroptions: dict) -> List:
+    """
+    Filter our items from the list of hyperopt results
+    """
+    if filteroptions['only_best']:
+        epochs = [x for x in epochs if x['is_best']]
+    if filteroptions['only_profitable']:
+        epochs = [x for x in epochs if x['results_metrics']['profit'] > 0]
+
+    epochs = _hyperopt_filter_epochs_trade_count(epochs, filteroptions)
+
+    epochs = _hyperopt_filter_epochs_duration(epochs, filteroptions)
+
+    epochs = _hyperopt_filter_epochs_profit(epochs, filteroptions)
+
+    epochs = _hyperopt_filter_epochs_objective(epochs, filteroptions)
+
+    logger.info(f"{len(epochs)} " +
+                ("best " if filteroptions['only_best'] else "") +
+                ("profitable " if filteroptions['only_profitable'] else "") +
+                "epochs found.")
+    return epochs
+
+
+def _hyperopt_filter_epochs_trade_count(epochs: List, filteroptions: dict) -> List:
+
+    if filteroptions['filter_min_trades'] > 0:
+        epochs = [
+            x for x in epochs
+            if x['results_metrics']['trade_count'] > filteroptions['filter_min_trades']
+        ]
+    if filteroptions['filter_max_trades'] > 0:
+        epochs = [
+            x for x in epochs
+            if x['results_metrics']['trade_count'] < filteroptions['filter_max_trades']
+        ]
+    return epochs
+
+
+def _hyperopt_filter_epochs_duration(epochs: List, filteroptions: dict) -> List:
+
+    if filteroptions['filter_min_avg_time'] is not None:
+        epochs = [x for x in epochs if x['results_metrics']['trade_count'] > 0]
+        epochs = [
+            x for x in epochs
+            if x['results_metrics']['duration'] > filteroptions['filter_min_avg_time']
+        ]
+    if filteroptions['filter_max_avg_time'] is not None:
+        epochs = [x for x in epochs if x['results_metrics']['trade_count'] > 0]
+        epochs = [
+            x for x in epochs
+            if x['results_metrics']['duration'] < filteroptions['filter_max_avg_time']
+        ]
+
+    return epochs
+
+
+def _hyperopt_filter_epochs_profit(epochs: List, filteroptions: dict) -> List:
+
+    if filteroptions['filter_min_avg_profit'] is not None:
+        epochs = [x for x in epochs if x['results_metrics']['trade_count'] > 0]
+        epochs = [
+            x for x in epochs
+            if x['results_metrics']['avg_profit'] > filteroptions['filter_min_avg_profit']
+        ]
+    if filteroptions['filter_max_avg_profit'] is not None:
+        epochs = [x for x in epochs if x['results_metrics']['trade_count'] > 0]
+        epochs = [
+            x for x in epochs
+            if x['results_metrics']['avg_profit'] < filteroptions['filter_max_avg_profit']
+        ]
+    if filteroptions['filter_min_total_profit'] is not None:
+        epochs = [x for x in epochs if x['results_metrics']['trade_count'] > 0]
+        epochs = [
+            x for x in epochs
+            if x['results_metrics']['profit'] > filteroptions['filter_min_total_profit']
+        ]
+    if filteroptions['filter_max_total_profit'] is not None:
+        epochs = [x for x in epochs if x['results_metrics']['trade_count'] > 0]
+        epochs = [
+            x for x in epochs
+            if x['results_metrics']['profit'] < filteroptions['filter_max_total_profit']
+        ]
+    return epochs
+
+
+def _hyperopt_filter_epochs_objective(epochs: List, filteroptions: dict) -> List:
+
+    if filteroptions['filter_min_objective'] is not None:
+        epochs = [x for x in epochs if x['results_metrics']['trade_count'] > 0]
+
+        epochs = [x for x in epochs if x['loss'] < filteroptions['filter_min_objective']]
+    if filteroptions['filter_max_objective'] is not None:
+        epochs = [x for x in epochs if x['results_metrics']['trade_count'] > 0]
+
+        epochs = [x for x in epochs if x['loss'] > filteroptions['filter_max_objective']]
+
+    return epochs

freqtrade/commands/list_commands.py

@@ -0,0 +1,227 @@
+import csv
+import logging
+import sys
+from collections import OrderedDict
+from pathlib import Path
+from typing import Any, Dict, List
+
+import rapidjson
+from colorama import Fore, Style
+from colorama import init as colorama_init
+from tabulate import tabulate
+
+from freqtrade.configuration import setup_utils_configuration
+from freqtrade.constants import USERPATH_HYPEROPTS, USERPATH_STRATEGIES
+from freqtrade.exceptions import OperationalException
+from freqtrade.exchange import available_exchanges, ccxt_exchanges, market_is_active
+from freqtrade.misc import plural
+from freqtrade.resolvers import ExchangeResolver, StrategyResolver
+from freqtrade.state import RunMode
+
+
+logger = logging.getLogger(__name__)
+
+
+def start_list_exchanges(args: Dict[str, Any]) -> None:
+    """
+    Print available exchanges
+    :param args: Cli args from Arguments()
+    :return: None
+    """
+    exchanges = ccxt_exchanges() if args['list_exchanges_all'] else available_exchanges()
+    if args['print_one_column']:
+        print('\n'.join(exchanges))
+    else:
+        if args['list_exchanges_all']:
+            print(f"All exchanges supported by the ccxt library: {', '.join(exchanges)}")
+        else:
+            print(f"Exchanges available for Freqtrade: {', '.join(exchanges)}")
+
+
+def _print_objs_tabular(objs: List, print_colorized: bool) -> None:
+    if print_colorized:
+        colorama_init(autoreset=True)
+        red = Fore.RED
+        yellow = Fore.YELLOW
+        reset = Style.RESET_ALL
+    else:
+        red = ''
+        yellow = ''
+        reset = ''
+
+    names = [s['name'] for s in objs]
+    objss_to_print = [{
+        'name': s['name'] if s['name'] else "--",
+        'location': s['location'].name,
+        'status': (red + "LOAD FAILED" + reset if s['class'] is None
+                   else "OK" if names.count(s['name']) == 1
+                   else yellow + "DUPLICATE NAME" + reset)
+    } for s in objs]
+
+    print(tabulate(objss_to_print, headers='keys', tablefmt='psql', stralign='right'))
+
+
+def start_list_strategies(args: Dict[str, Any]) -> None:
+    """
+    Print files with Strategy custom classes available in the directory
+    """
+    config = setup_utils_configuration(args, RunMode.UTIL_NO_EXCHANGE)
+
+    directory = Path(config.get('strategy_path', config['user_data_dir'] / USERPATH_STRATEGIES))
+    strategy_objs = StrategyResolver.search_all_objects(directory, not args['print_one_column'])
+    # Sort alphabetically
+    strategy_objs = sorted(strategy_objs, key=lambda x: x['name'])
+
+    if args['print_one_column']:
+        print('\n'.join([s['name'] for s in strategy_objs]))
+    else:
+        _print_objs_tabular(strategy_objs, config.get('print_colorized', False))
+
+
+def start_list_hyperopts(args: Dict[str, Any]) -> None:
+    """
+    Print files with HyperOpt custom classes available in the directory
+    """
+    from freqtrade.resolvers.hyperopt_resolver import HyperOptResolver
+
+    config = setup_utils_configuration(args, RunMode.UTIL_NO_EXCHANGE)
+
+    directory = Path(config.get('hyperopt_path', config['user_data_dir'] / USERPATH_HYPEROPTS))
+    hyperopt_objs = HyperOptResolver.search_all_objects(directory, not args['print_one_column'])
+    # Sort alphabetically
+    hyperopt_objs = sorted(hyperopt_objs, key=lambda x: x['name'])
+
+    if args['print_one_column']:
+        print('\n'.join([s['name'] for s in hyperopt_objs]))
+    else:
+        _print_objs_tabular(hyperopt_objs, config.get('print_colorized', False))
+
+
+def start_list_timeframes(args: Dict[str, Any]) -> None:
+    """
+    Print ticker intervals (timeframes) available on Exchange
+    """
+    config = setup_utils_configuration(args, RunMode.UTIL_EXCHANGE)
+    # Do not use timeframe set in the config
+    config['timeframe'] = None
+
+    # Init exchange
+    exchange = ExchangeResolver.load_exchange(config['exchange']['name'], config, validate=False)
+
+    if args['print_one_column']:
+        print('\n'.join(exchange.timeframes))
+    else:
+        print(f"Timeframes available for the exchange `{exchange.name}`: "
+              f"{', '.join(exchange.timeframes)}")
+
+
+def start_list_markets(args: Dict[str, Any], pairs_only: bool = False) -> None:
+    """
+    Print pairs/markets on the exchange
+    :param args: Cli args from Arguments()
+    :param pairs_only: if True print only pairs, otherwise print all instruments (markets)
+    :return: None
+    """
+    config = setup_utils_configuration(args, RunMode.UTIL_EXCHANGE)
+
+    # Init exchange
+    exchange = ExchangeResolver.load_exchange(config['exchange']['name'], config, validate=False)
+
+    # By default only active pairs/markets are to be shown
+    active_only = not args.get('list_pairs_all', False)
+
+    base_currencies = args.get('base_currencies', [])
+    quote_currencies = args.get('quote_currencies', [])
+
+    try:
+        pairs = exchange.get_markets(base_currencies=base_currencies,
+                                     quote_currencies=quote_currencies,
+                                     pairs_only=pairs_only,
+                                     active_only=active_only)
+        # Sort the pairs/markets by symbol
+        pairs = OrderedDict(sorted(pairs.items()))
+    except Exception as e:
+        raise OperationalException(f"Cannot get markets. Reason: {e}") from e
+
+    else:
+        summary_str = ((f"Exchange {exchange.name} has {len(pairs)} ") +
+                       ("active " if active_only else "") +
+                       (plural(len(pairs), "pair" if pairs_only else "market")) +
+                       (f" with {', '.join(base_currencies)} as base "
+                        f"{plural(len(base_currencies), 'currency', 'currencies')}"
+                        if base_currencies else "") +
+                       (" and" if base_currencies and quote_currencies else "") +
+                       (f" with {', '.join(quote_currencies)} as quote "
+                        f"{plural(len(quote_currencies), 'currency', 'currencies')}"
+                        if quote_currencies else ""))
+
+        headers = ["Id", "Symbol", "Base", "Quote", "Active",
+                   *(['Is pair'] if not pairs_only else [])]
+
+        tabular_data = []
+        for _, v in pairs.items():
+            tabular_data.append({'Id': v['id'], 'Symbol': v['symbol'],
+                                 'Base': v['base'], 'Quote': v['quote'],
+                                 'Active': market_is_active(v),
+                                 **({'Is pair': exchange.market_is_tradable(v)}
+                                    if not pairs_only else {})})
+
+        if (args.get('print_one_column', False) or
+                args.get('list_pairs_print_json', False) or
+                args.get('print_csv', False)):
+            # Print summary string in the log in case of machine-readable
+            # regular formats.
+            logger.info(f"{summary_str}.")
+        else:
+            # Print empty string separating leading logs and output in case of
+            # human-readable formats.
+            print()
+
+        if len(pairs):
+            if args.get('print_list', False):
+                # print data as a list, with human-readable summary
+                print(f"{summary_str}: {', '.join(pairs.keys())}.")
+            elif args.get('print_one_column', False):
+                print('\n'.join(pairs.keys()))
+            elif args.get('list_pairs_print_json', False):
+                print(rapidjson.dumps(list(pairs.keys()), default=str))
+            elif args.get('print_csv', False):
+                writer = csv.DictWriter(sys.stdout, fieldnames=headers)
+                writer.writeheader()
+                writer.writerows(tabular_data)
+            else:
+                # print data as a table, with the human-readable summary
+                print(f"{summary_str}:")
+                print(tabulate(tabular_data, headers='keys', tablefmt='psql', stralign='right'))
+        elif not (args.get('print_one_column', False) or
+                  args.get('list_pairs_print_json', False) or
+                  args.get('print_csv', False)):
+            print(f"{summary_str}.")
+
+
+def start_show_trades(args: Dict[str, Any]) -> None:
+    """
+    Show trades
+    """
+    import json
+
+    from freqtrade.persistence import Trade, init_db
+    config = setup_utils_configuration(args, RunMode.UTIL_NO_EXCHANGE)
+
+    if 'db_url' not in config:
+        raise OperationalException("--db-url is required for this command.")
+
+    logger.info(f'Using DB: "{config["db_url"]}"')
+    init_db(config['db_url'], clean_open_orders=False)
+    tfilter = []
+
+    if config.get('trade_ids'):
+        tfilter.append(Trade.id.in_(config['trade_ids']))
+
+    trades = Trade.get_trades(tfilter).all()
+    logger.info(f"Printing {len(trades)} Trades: ")
+    if config.get('print_json', False):
+        print(json.dumps([trade.to_json() for trade in trades], indent=4))
+    else:
+        for trade in trades:
+            print(trade)

freqtrade/commands/optimize_commands.py

@@ -0,0 +1,110 @@
+import logging
+from typing import Any, Dict
+
+from freqtrade import constants
+from freqtrade.configuration import setup_utils_configuration
+from freqtrade.exceptions import DependencyException, OperationalException
+from freqtrade.state import RunMode
+
+
+logger = logging.getLogger(__name__)
+
+
+def setup_optimize_configuration(args: Dict[str, Any], method: RunMode) -> Dict[str, Any]:
+    """
+    Prepare the configuration for the Hyperopt module
+    :param args: Cli args from Arguments()
+    :return: Configuration
+    """
+    config = setup_utils_configuration(args, method)
+
+    no_unlimited_runmodes = {
+        RunMode.BACKTEST: 'backtesting',
+        RunMode.HYPEROPT: 'hyperoptimization',
+    }
+    if (method in no_unlimited_runmodes.keys() and
+            config['stake_amount'] == constants.UNLIMITED_STAKE_AMOUNT):
+        raise DependencyException(
+            f'The value of `stake_amount` cannot be set as "{constants.UNLIMITED_STAKE_AMOUNT}" '
+            f'for {no_unlimited_runmodes[method]}')
+
+    return config
+
+
+def start_backtesting(args: Dict[str, Any]) -> None:
+    """
+    Start Backtesting script
+    :param args: Cli args from Arguments()
+    :return: None
+    """
+    # Import here to avoid loading backtesting module when it's not used
+    from freqtrade.optimize.backtesting import Backtesting
+
+    # Initialize configuration
+    config = setup_optimize_configuration(args, RunMode.BACKTEST)
+
+    logger.info('Starting freqtrade in Backtesting mode')
+
+    # Initialize backtesting object
+    backtesting = Backtesting(config)
+    backtesting.start()
+
+
+def start_hyperopt(args: Dict[str, Any]) -> None:
+    """
+    Start hyperopt script
+    :param args: Cli args from Arguments()
+    :return: None
+    """
+    # Import here to avoid loading hyperopt module when it's not used
+    try:
+        from filelock import FileLock, Timeout
+
+        from freqtrade.optimize.hyperopt import Hyperopt
+    except ImportError as e:
+        raise OperationalException(
+            f"{e}. Please ensure that the hyperopt dependencies are installed.") from e
+    # Initialize configuration
+    config = setup_optimize_configuration(args, RunMode.HYPEROPT)
+
+    logger.info('Starting freqtrade in Hyperopt mode')
+
+    lock = FileLock(Hyperopt.get_lock_filename(config))
+
+    try:
+        with lock.acquire(timeout=1):
+
+            # Remove noisy log messages
+            logging.getLogger('hyperopt.tpe').setLevel(logging.WARNING)
+            logging.getLogger('filelock').setLevel(logging.WARNING)
+
+            # Initialize backtesting object
+            hyperopt = Hyperopt(config)
+            hyperopt.start()
+
+    except Timeout:
+        logger.info("Another running instance of freqtrade Hyperopt detected.")
+        logger.info("Simultaneous execution of multiple Hyperopt commands is not supported. "
+                    "Hyperopt module is resource hungry. Please run your Hyperopt sequentially "
+                    "or on separate machines.")
+        logger.info("Quitting now.")
+        # TODO: return False here in order to help freqtrade to exit
+        # with non-zero exit code...
+        # Same in Edge and Backtesting start() functions.
+
+
+def start_edge(args: Dict[str, Any]) -> None:
+    """
+    Start Edge script
+    :param args: Cli args from Arguments()
+    :return: None
+    """
+    from freqtrade.optimize.edge_cli import EdgeCli
+
+    # Initialize configuration
+    config = setup_optimize_configuration(args, RunMode.EDGE)
+    logger.info('Starting freqtrade in Edge mode')
+
+    # Initialize Edge object
+    edge_cli = EdgeCli(config)
+    edge_cli.start()

freqtrade/commands/pairlist_commands.py

@@ -0,0 +1,42 @@
+import logging
+from typing import Any, Dict
+
+import rapidjson
+
+from freqtrade.configuration import setup_utils_configuration
+from freqtrade.resolvers import ExchangeResolver
+from freqtrade.state import RunMode
+
+
+logger = logging.getLogger(__name__)
+
+
+def start_test_pairlist(args: Dict[str, Any]) -> None:
+    """
+    Test Pairlist configuration
+    """
+    from freqtrade.pairlist.pairlistmanager import PairListManager
+    config = setup_utils_configuration(args, RunMode.UTIL_EXCHANGE)
+
+    exchange = ExchangeResolver.load_exchange(config['exchange']['name'], config, validate=False)
+
+    quote_currencies = args.get('quote_currencies')
+    if not quote_currencies:
+        quote_currencies = [config.get('stake_currency')]
+    results = {}
+    for curr in quote_currencies:
+        config['stake_currency'] = curr
+        pairlists = PairListManager(exchange, config)
+        pairlists.refresh_pairlist()
+        results[curr] = pairlists.whitelist
+
+    for curr, pairlist in results.items():
+        if not args.get('print_one_column', False):
+            print(f"Pairs for {curr}: ")
+
+        if args.get('print_one_column', False):
+            print('\n'.join(pairlist))
+        elif args.get('list_pairs_print_json', False):
+            print(rapidjson.dumps(list(pairlist), default=str))
+        else:
+            print(pairlist)

freqtrade/commands/plot_commands.py

@@ -0,0 +1,36 @@
+from typing import Any, Dict
+
+from freqtrade.configuration import setup_utils_configuration
+from freqtrade.exceptions import OperationalException
+from freqtrade.state import RunMode
+
+
+def validate_plot_args(args: Dict[str, Any]) -> None:
+    if not args.get('datadir') and not args.get('config'):
+        raise OperationalException(
+            "You need to specify either `--datadir` or `--config` "
+            "for plot-profit and plot-dataframe.")
+
+
+def start_plot_dataframe(args: Dict[str, Any]) -> None:
+    """
+    Entrypoint for dataframe plotting
+    """
+    # Import here to avoid errors if plot-dependencies are not installed.
+    from freqtrade.plot.plotting import load_and_plot_trades
+    validate_plot_args(args)
+    config = setup_utils_configuration(args, RunMode.PLOT)
+
+    load_and_plot_trades(config)
+
+
+def start_plot_profit(args: Dict[str, Any]) -> None:
+    """
+    Entrypoint for plot_profit
+    """
+    # Import here to avoid errors if plot-dependencies are not installed.
+    from freqtrade.plot.plotting import plot_profit
+    validate_plot_args(args)
+    config = setup_utils_configuration(args, RunMode.PLOT)
+
+    plot_profit(config)

freqtrade/commands/trade_commands.py

@@ -0,0 +1,29 @@
+import logging
+from typing import Any, Dict
+
+
+logger = logging.getLogger(__name__)
+
+
+def start_trading(args: Dict[str, Any]) -> int:
+    """
+    Main entry point for trading mode
+    """
+    # Import here to avoid loading worker module when it's not used
+    from freqtrade.worker import Worker
+
+    # Create and run worker
+    worker = None
+    try:
+        worker = Worker(args)
+        worker.run()
+    except Exception as e:
+        logger.error(str(e))
+        logger.exception("Fatal exception!")
+    except KeyboardInterrupt:
+        logger.info('SIGINT received, aborting ...')
+    finally:
+        if worker:
+            logger.info("worker found ... calling exit")
+            worker.exit()
+    return 0

freqtrade/configuration/__init__.py

@@ -1,2 +1,7 @@
-from freqtrade.configuration.arguments import Arguments, TimeRange  # noqa: F401
+# flake8: noqa: F401
-from freqtrade.configuration.configuration import Configuration  # noqa: F401
+
+from freqtrade.configuration.check_exchange import check_exchange, remove_credentials
+from freqtrade.configuration.config_setup import setup_utils_configuration
+from freqtrade.configuration.config_validation import validate_config_consistency
+from freqtrade.configuration.configuration import Configuration
+from freqtrade.configuration.timerange import TimeRange

freqtrade/configuration/arguments.py

@@ -1,466 +0,0 @@
-"""
-This module contains the argument manager class
-"""
-import argparse
-import os
-import re
-from typing import List, NamedTuple, Optional
-
-import arrow
-from freqtrade import __version__, constants
-
-
-def check_int_positive(value: str) -> int:
-    try:
-        uint = int(value)
-        if uint <= 0:
-            raise ValueError
-    except ValueError:
-        raise argparse.ArgumentTypeError(
-            f"{value} is invalid for this parameter, should be a positive integer value"
-        )
-    return uint
-
-
-class Arg:
-    # Optional CLI arguments
-    def __init__(self, *args, **kwargs):
-        self.cli = args
-        self.kwargs = kwargs
-
-
-# List of available command line options
-AVAILABLE_CLI_OPTIONS = {
-    # Common options
-    "verbosity": Arg(
-        '-v', '--verbose',
-        help='Verbose mode (-vv for more, -vvv to get all messages).',
-        action='count',
-        default=0,
-    ),
-    "logfile": Arg(
-        '--logfile',
-        help='Log to the file specified.',
-        metavar='FILE',
-    ),
-    "version": Arg(
-        '-V', '--version',
-        action='version',
-        version=f'%(prog)s {__version__}',
-    ),
-    "config": Arg(
-        '-c', '--config',
-        help=f'Specify configuration file (default: `{constants.DEFAULT_CONFIG}`). '
-        f'Multiple --config options may be used. '
-        f'Can be set to `-` to read config from stdin.',
-        action='append',
-        metavar='PATH',
-    ),
-    "datadir": Arg(
-        '-d', '--datadir',
-        help='Path to backtest data.',
-        metavar='PATH',
-    ),
-    # Main options
-    "strategy": Arg(
-        '-s', '--strategy',
-        help='Specify strategy class name (default: `%(default)s`).',
-        metavar='NAME',
-        default='DefaultStrategy',
-    ),
-    "strategy_path": Arg(
-        '--strategy-path',
-        help='Specify additional strategy lookup path.',
-        metavar='PATH',
-    ),
-    "db_url": Arg(
-        '--db-url',
-        help=f'Override trades database URL, this is useful in custom deployments '
-        f'(default: `{constants.DEFAULT_DB_PROD_URL}` for Live Run mode, '
-        f'`{constants.DEFAULT_DB_DRYRUN_URL}` for Dry Run).',
-        metavar='PATH',
-    ),
-    "sd_notify": Arg(
-        '--sd-notify',
-        help='Notify systemd service manager.',
-        action='store_true',
-    ),
-    # Optimize common
-    "ticker_interval": Arg(
-        '-i', '--ticker-interval',
-        help='Specify ticker interval (`1m`, `5m`, `30m`, `1h`, `1d`).',
-    ),
-    "timerange": Arg(
-        '--timerange',
-        help='Specify what timerange of data to use.',
-    ),
-    "max_open_trades": Arg(
-        '--max_open_trades',
-        help='Specify max_open_trades to use.',
-        type=int,
-        metavar='INT',
-    ),
-    "stake_amount": Arg(
-        '--stake_amount',
-        help='Specify stake_amount.',
-        type=float,
-    ),
-    "refresh_pairs": Arg(
-        '-r', '--refresh-pairs-cached',
-        help='Refresh the pairs files in tests/testdata with the latest data from the '
-        'exchange. Use it if you want to run your optimization commands with '
-        'up-to-date data.',
-        action='store_true',
-    ),
-    # Backtesting
-    "position_stacking": Arg(
-        '--eps', '--enable-position-stacking',
-        help='Allow buying the same pair multiple times (position stacking).',
-        action='store_true',
-        default=False,
-    ),
-    "use_max_market_positions": Arg(
-        '--dmmp', '--disable-max-market-positions',
-        help='Disable applying `max_open_trades` during backtest '
-        '(same as setting `max_open_trades` to a very high number).',
-        action='store_false',
-        default=True,
-    ),
-    "live": Arg(
-        '-l', '--live',
-        help='Use live data.',
-        action='store_true',
-    ),
-    "strategy_list": Arg(
-        '--strategy-list',
-        help='Provide a comma-separated list of strategies to backtest. '
-        'Please note that ticker-interval needs to be set either in config '
-        'or via command line. When using this together with `--export trades`, '
-        'the strategy-name is injected into the filename '
-        '(so `backtest-data.json` becomes `backtest-data-DefaultStrategy.json`',
-        nargs='+',
-    ),
-    "export": Arg(
-        '--export',
-        help='Export backtest results, argument are: trades. '
-        'Example: `--export=trades`',
-    ),
-    "exportfilename": Arg(
-        '--export-filename',
-        help='Save backtest results to the file with this filename (default: `%(default)s`). '
-        'Requires `--export` to be set as well. '
-        'Example: `--export-filename=user_data/backtest_data/backtest_today.json`',
-        metavar='PATH',
-        default=os.path.join('user_data', 'backtest_data',
-                             'backtest-result.json'),
-    ),
-    # Edge
-    "stoploss_range": Arg(
-        '--stoplosses',
-        help='Defines a range of stoploss values against which edge will assess the strategy. '
-        'The format is "min,max,step" (without any space). '
-        'Example: `--stoplosses=-0.01,-0.1,-0.001`',
-    ),
-    # Hyperopt
-    "hyperopt": Arg(
-        '--customhyperopt',
-        help='Specify hyperopt class name (default: `%(default)s`).',
-        metavar='NAME',
-        default=constants.DEFAULT_HYPEROPT,
-    ),
-    "epochs": Arg(
-        '-e', '--epochs',
-        help='Specify number of epochs (default: %(default)d).',
-        type=check_int_positive,
-        metavar='INT',
-        default=constants.HYPEROPT_EPOCH,
-    ),
-    "spaces": Arg(
-        '-s', '--spaces',
-        help='Specify which parameters to hyperopt. Space-separated list. '
-        'Default: `%(default)s`.',
-        choices=['all', 'buy', 'sell', 'roi', 'stoploss'],
-        nargs='+',
-        default='all',
-    ),
-    "print_all": Arg(
-        '--print-all',
-        help='Print all results, not only the best ones.',
-        action='store_true',
-        default=False,
-    ),
-    "hyperopt_jobs": Arg(
-        '-j', '--job-workers',
-        help='The number of concurrently running jobs for hyperoptimization '
-        '(hyperopt worker processes). '
-        'If -1 (default), all CPUs are used, for -2, all CPUs but one are used, etc. '
-        'If 1 is given, no parallel computing code is used at all.',
-        type=int,
-        metavar='JOBS',
-        default=-1,
-    ),
-    "hyperopt_random_state": Arg(
-        '--random-state',
-        help='Set random state to some positive integer for reproducible hyperopt results.',
-        type=check_int_positive,
-        metavar='INT',
-    ),
-    "hyperopt_min_trades": Arg(
-        '--min-trades',
-        help="Set minimal desired number of trades for evaluations in the hyperopt "
-        "optimization path (default: 1).",
-        type=check_int_positive,
-        metavar='INT',
-        default=1,
-    ),
-    "hyperopt_continue": Arg(
-        "--continue",
-        help="Continue hyperopt from previous runs. "
-        "By default, temporary files will be removed and hyperopt will start from scratch.",
-        default=False,
-        action='store_true',
-    ),
-    "hyperopt_loss": Arg(
-        '--hyperopt-loss',
-        help='Specify the class name of the hyperopt loss function class (IHyperOptLoss). '
-        'Different functions can generate completely different results, '
-        'since the target for optimization is different. (default: `%(default)s`).',
-        metavar='NAME',
-        default=constants.DEFAULT_HYPEROPT_LOSS,
-    ),
-    # List exchanges
-    "print_one_column": Arg(
-        '-1', '--one-column',
-        help='Print exchanges in one column.',
-        action='store_true',
-    ),
-    # Script options
-    "pairs": Arg(
-        '-p', '--pairs',
-        help='Show profits for only these pairs. Pairs are comma-separated.',
-    ),
-    # Download data
-    "pairs_file": Arg(
-        '--pairs-file',
-        help='File containing a list of pairs to download.',
-        metavar='FILE',
-    ),
-    "days": Arg(
-        '--days',
-        help='Download data for given number of days.',
-        type=check_int_positive,
-        metavar='INT',
-    ),
-    "exchange": Arg(
-        '--exchange',
-        help=f'Exchange name (default: `{constants.DEFAULT_EXCHANGE}`). '
-        f'Only valid if no config is provided.',
-    ),
-    "timeframes": Arg(
-        '-t', '--timeframes',
-        help=f'Specify which tickers to download. Space-separated list. '
-        f'Default: `{constants.DEFAULT_DOWNLOAD_TICKER_INTERVALS}`.',
-        choices=['1m', '3m', '5m', '15m', '30m', '1h', '2h', '4h',
-                 '6h', '8h', '12h', '1d', '3d', '1w'],
-        nargs='+',
-    ),
-    "erase": Arg(
-        '--erase',
-        help='Clean all existing data for the selected exchange/pairs/timeframes.',
-        action='store_true',
-    ),
-    # Plot dataframe
-    "indicators1": Arg(
-        '--indicators1',
-        help='Set indicators from your strategy you want in the first row of the graph. '
-        'Comma-separated list. Example: `ema3,ema5`. Default: `%(default)s`.',
-        default='sma,ema3,ema5',
-    ),
-    "indicators2": Arg(
-        '--indicators2',
-        help='Set indicators from your strategy you want in the third row of the graph. '
-        'Comma-separated list. Example: `fastd,fastk`. Default: `%(default)s`.',
-        default='macd,macdsignal',
-    ),
-    "plot_limit": Arg(
-        '--plot-limit',
-        help='Specify tick limit for plotting. Notice: too high values cause huge files. '
-        'Default: %(default)s.',
-        type=check_int_positive,
-        metavar='INT',
-        default=750,
-    ),
-    "trade_source": Arg(
-        '--trade-source',
-        help='Specify the source for trades (Can be DB or file (backtest file)) '
-        'Default: %(default)s',
-        choices=["DB", "file"],
-        default="file",
-    ),
-}
-
-
-ARGS_COMMON = ["verbosity", "logfile", "version", "config", "datadir"]
-
-ARGS_STRATEGY = ["strategy", "strategy_path"]
-
-ARGS_MAIN = ARGS_COMMON + ARGS_STRATEGY + ["db_url", "sd_notify"]
-
-ARGS_COMMON_OPTIMIZE = ["ticker_interval", "timerange",
-                        "max_open_trades", "stake_amount", "refresh_pairs"]
-
-ARGS_BACKTEST = ARGS_COMMON_OPTIMIZE + ["position_stacking", "use_max_market_positions",
-                                        "live", "strategy_list", "export", "exportfilename"]
-
-ARGS_HYPEROPT = ARGS_COMMON_OPTIMIZE + ["hyperopt", "position_stacking", "epochs", "spaces",
-                                        "use_max_market_positions", "print_all", "hyperopt_jobs",
-                                        "hyperopt_random_state", "hyperopt_min_trades",
-                                        "hyperopt_continue", "hyperopt_loss"]
-
-ARGS_EDGE = ARGS_COMMON_OPTIMIZE + ["stoploss_range"]
-
-ARGS_LIST_EXCHANGES = ["print_one_column"]
-
-ARGS_DOWNLOADER = ARGS_COMMON + ["pairs", "pairs_file", "days", "exchange", "timeframes", "erase"]
-
-ARGS_PLOT_DATAFRAME = (ARGS_COMMON + ARGS_STRATEGY +
-                       ["pairs", "indicators1", "indicators2", "plot_limit", "db_url",
-                        "trade_source", "export", "exportfilename", "timerange",
-                        "refresh_pairs", "live"])
-
-ARGS_PLOT_PROFIT = (ARGS_COMMON + ARGS_STRATEGY +
-                    ["pairs", "timerange", "export", "exportfilename", "db_url", "trade_source"])
-
-
-class TimeRange(NamedTuple):
-    """
-    NamedTuple defining timerange inputs.
-    [start/stop]type defines if [start/stop]ts shall be used.
-    if *type is None, don't use corresponding startvalue.
-    """
-    starttype: Optional[str] = None
-    stoptype: Optional[str] = None
-    startts: int = 0
-    stopts: int = 0
-
-
-class Arguments(object):
-    """
-    Arguments Class. Manage the arguments received by the cli
-    """
-    def __init__(self, args: Optional[List[str]], description: str,
-                 no_default_config: bool = False) -> None:
-        self.args = args
-        self._parsed_arg: Optional[argparse.Namespace] = None
-        self.parser = argparse.ArgumentParser(description=description)
-        self._no_default_config = no_default_config
-
-    def _load_args(self) -> None:
-        self._build_args(optionlist=ARGS_MAIN)
-        self._build_subcommands()
-
-    def get_parsed_arg(self) -> argparse.Namespace:
-        """
-        Return the list of arguments
-        :return: List[str] List of arguments
-        """
-        if self._parsed_arg is None:
-            self._load_args()
-            self._parsed_arg = self._parse_args()
-
-        return self._parsed_arg
-
-    def _parse_args(self) -> argparse.Namespace:
-        """
-        Parses given arguments and returns an argparse Namespace instance.
-        """
-        parsed_arg = self.parser.parse_args(self.args)
-
-        # Workaround issue in argparse with action='append' and default value
-        # (see https://bugs.python.org/issue16399)
-        if not self._no_default_config and parsed_arg.config is None:
-            parsed_arg.config = [constants.DEFAULT_CONFIG]
-
-        return parsed_arg
-
-    def _build_args(self, optionlist, parser=None):
-        parser = parser or self.parser
-
-        for val in optionlist:
-            opt = AVAILABLE_CLI_OPTIONS[val]
-            parser.add_argument(*opt.cli, dest=val, **opt.kwargs)
-
-    def _build_subcommands(self) -> None:
-        """
-        Builds and attaches all subcommands.
-        :return: None
-        """
-        from freqtrade.optimize import start_backtesting, start_hyperopt, start_edge
-        from freqtrade.utils import start_list_exchanges
-
-        subparsers = self.parser.add_subparsers(dest='subparser')
-
-        # Add backtesting subcommand
-        backtesting_cmd = subparsers.add_parser('backtesting', help='Backtesting module.')
-        backtesting_cmd.set_defaults(func=start_backtesting)
-        self._build_args(optionlist=ARGS_BACKTEST, parser=backtesting_cmd)
-
-        # Add edge subcommand
-        edge_cmd = subparsers.add_parser('edge', help='Edge module.')
-        edge_cmd.set_defaults(func=start_edge)
-        self._build_args(optionlist=ARGS_EDGE, parser=edge_cmd)
-
-        # Add hyperopt subcommand
-        hyperopt_cmd = subparsers.add_parser('hyperopt', help='Hyperopt module.')
-        hyperopt_cmd.set_defaults(func=start_hyperopt)
-        self._build_args(optionlist=ARGS_HYPEROPT, parser=hyperopt_cmd)
-
-        # Add list-exchanges subcommand
-        list_exchanges_cmd = subparsers.add_parser(
-            'list-exchanges',
-            help='Print available exchanges.'
-        )
-        list_exchanges_cmd.set_defaults(func=start_list_exchanges)
-        self._build_args(optionlist=ARGS_LIST_EXCHANGES, parser=list_exchanges_cmd)
-
-    @staticmethod
-    def parse_timerange(text: Optional[str]) -> TimeRange:
-        """
-        Parse the value of the argument --timerange to determine what is the range desired
-        :param text: value from --timerange
-        :return: Start and End range period
-        """
-        if text is None:
-            return TimeRange(None, None, 0, 0)
-        syntax = [(r'^-(\d{8})$', (None, 'date')),
-                  (r'^(\d{8})-$', ('date', None)),
-                  (r'^(\d{8})-(\d{8})$', ('date', 'date')),
-                  (r'^-(\d{10})$', (None, 'date')),
-                  (r'^(\d{10})-$', ('date', None)),
-                  (r'^(\d{10})-(\d{10})$', ('date', 'date')),
-                  (r'^(-\d+)$', (None, 'line')),
-                  (r'^(\d+)-$', ('line', None)),
-                  (r'^(\d+)-(\d+)$', ('index', 'index'))]
-        for rex, stype in syntax:
-            # Apply the regular expression to text
-            match = re.match(rex, text)
-            if match:  # Regex has matched
-                rvals = match.groups()
-                index = 0
-                start: int = 0
-                stop: int = 0
-                if stype[0]:
-                    starts = rvals[index]
-                    if stype[0] == 'date' and len(starts) == 8:
-                        start = arrow.get(starts, 'YYYYMMDD').timestamp
-                    else:
-                        start = int(starts)
-                    index += 1
-                if stype[1]:
-                    stops = rvals[index]
-                    if stype[1] == 'date' and len(stops) == 8:
-                        stop = arrow.get(stops, 'YYYYMMDD').timestamp
-                    else:
-                        stop = int(stops)
-                return TimeRange(stype[0], stype[1], start, stop)
-        raise Exception('Incorrect syntax for timerange "%s"' % text)

freqtrade/configuration/check_exchange.py

@@ -1,14 +1,28 @@
 import logging
 from typing import Any, Dict
 
-from freqtrade import OperationalException
+from freqtrade.exceptions import OperationalException
-from freqtrade.exchange import (is_exchange_bad, is_exchange_available,
+from freqtrade.exchange import (available_exchanges, get_exchange_bad_reason, is_exchange_bad,
-                                is_exchange_officially_supported, available_exchanges)
+                                is_exchange_known_ccxt, is_exchange_officially_supported)
+from freqtrade.state import RunMode
 
 
 logger = logging.getLogger(__name__)
 
 
+def remove_credentials(config: Dict[str, Any]) -> None:
+    """
+    Removes exchange keys from the configuration and specifies dry-run
+    Used for backtesting / hyperopt / edge and utils.
+    Modifies the input dict!
+    """
+    config['exchange']['key'] = ''
+    config['exchange']['secret'] = ''
+    config['exchange']['password'] = ''
+    config['exchange']['uid'] = ''
+    config['dry_run'] = True
+
+
 def check_exchange(config: Dict[str, Any], check_for_bad: bool = True) -> bool:
     """
     Check if the exchange name in the config file is supported by Freqtrade
@@ -19,28 +33,40 @@ def check_exchange(config: Dict[str, Any], check_for_bad: bool = True) -> bool:
              raises an exception if the exchange if not supported by ccxt
              and thus is not known for the Freqtrade at all.
     """
+
+    if (config['runmode'] in [RunMode.PLOT, RunMode.UTIL_NO_EXCHANGE, RunMode.OTHER]
+       and not config.get('exchange', {}).get('name')):
+        # Skip checking exchange in plot mode, since it requires no exchange
+        return True
     logger.info("Checking exchange...")
 
     exchange = config.get('exchange', {}).get('name').lower()
-    if not is_exchange_available(exchange):
+    if not exchange:
         raise OperationalException(
-                f'Exchange "{exchange}" is not supported by ccxt '
+            f'This command requires a configured exchange. You should either use '
+            f'`--exchange <exchange_name>` or specify a configuration file via `--config`.\n'
+            f'The following exchanges are available for Freqtrade: '
+            f'{", ".join(available_exchanges())}'
+        )
+
+    if not is_exchange_known_ccxt(exchange):
+        raise OperationalException(
+                f'Exchange "{exchange}" is not known to the ccxt library '
                 f'and therefore not available for the bot.\n'
-                f'The following exchanges are supported by ccxt: '
+                f'The following exchanges are available for Freqtrade: '
                 f'{", ".join(available_exchanges())}'
         )
 
     if check_for_bad and is_exchange_bad(exchange):
-        logger.warning(f'Exchange "{exchange}" is known to not work with the bot yet. '
+        raise OperationalException(f'Exchange "{exchange}" is known to not work with the bot yet. '
-                       f'Use it only for development and testing purposes.')
+                                   f'Reason: {get_exchange_bad_reason(exchange)}')
-        return False
 
     if is_exchange_officially_supported(exchange):
         logger.info(f'Exchange "{exchange}" is officially supported '
                     f'by the Freqtrade development team.')
     else:
-        logger.warning(f'Exchange "{exchange}" is supported by ccxt '
+        logger.warning(f'Exchange "{exchange}" is known to the the ccxt library, '
-                       f'and therefore available for the bot but not officially supported '
+                       f'available for the bot, but not officially supported '
                        f'by the Freqtrade development team. '
                        f'It may work flawlessly (please report back) or have serious issues. '
                        f'Use it at your own discretion.')

freqtrade/configuration/config_setup.py

@@ -0,0 +1,27 @@
+import logging
+from typing import Any, Dict
+
+from freqtrade.state import RunMode
+
+from .check_exchange import remove_credentials
+from .config_validation import validate_config_consistency
+from .configuration import Configuration
+
+
+logger = logging.getLogger(__name__)
+
+
+def setup_utils_configuration(args: Dict[str, Any], method: RunMode) -> Dict[str, Any]:
+    """
+    Prepare the configuration for utils subcommands
+    :param args: Cli args from Arguments()
+    :return: Configuration
+    """
+    configuration = Configuration(args, method)
+    config = configuration.get_config()
+
+    # Ensure we do not use Exchange credentials
+    remove_credentials(config)
+    validate_config_consistency(config)
+
+    return config

freqtrade/configuration/config_validation.py

@@ -0,0 +1,153 @@
+import logging
+from copy import deepcopy
+from typing import Any, Dict
+
+from jsonschema import Draft4Validator, validators
+from jsonschema.exceptions import ValidationError, best_match
+
+from freqtrade import constants
+from freqtrade.exceptions import OperationalException
+from freqtrade.state import RunMode
+
+
+logger = logging.getLogger(__name__)
+
+
+def _extend_validator(validator_class):
+    """
+    Extended validator for the Freqtrade configuration JSON Schema.
+    Currently it only handles defaults for subschemas.
+    """
+    validate_properties = validator_class.VALIDATORS['properties']
+
+    def set_defaults(validator, properties, instance, schema):
+        for prop, subschema in properties.items():
+            if 'default' in subschema:
+                instance.setdefault(prop, subschema['default'])
+
+        for error in validate_properties(
+            validator, properties, instance, schema,
+        ):
+            yield error
+
+    return validators.extend(
+        validator_class, {'properties': set_defaults}
+    )
+
+
+FreqtradeValidator = _extend_validator(Draft4Validator)
+
+
+def validate_config_schema(conf: Dict[str, Any]) -> Dict[str, Any]:
+    """
+    Validate the configuration follow the Config Schema
+    :param conf: Config in JSON format
+    :return: Returns the config if valid, otherwise throw an exception
+    """
+    conf_schema = deepcopy(constants.CONF_SCHEMA)
+    if conf.get('runmode', RunMode.OTHER) in (RunMode.DRY_RUN, RunMode.LIVE):
+        conf_schema['required'] = constants.SCHEMA_TRADE_REQUIRED
+    else:
+        conf_schema['required'] = constants.SCHEMA_MINIMAL_REQUIRED
+    try:
+        FreqtradeValidator(conf_schema).validate(conf)
+        return conf
+    except ValidationError as e:
+        logger.critical(
+            f"Invalid configuration. See config.json.example. Reason: {e}"
+        )
+        raise ValidationError(
+            best_match(Draft4Validator(conf_schema).iter_errors(conf)).message
+        )
+
+
+def validate_config_consistency(conf: Dict[str, Any]) -> None:
+    """
+    Validate the configuration consistency.
+    Should be ran after loading both configuration and strategy,
+    since strategies can set certain configuration settings too.
+    :param conf: Config in JSON format
+    :return: Returns None if everything is ok, otherwise throw an OperationalException
+    """
+
+    # validating trailing stoploss
+    _validate_trailing_stoploss(conf)
+    _validate_edge(conf)
+    _validate_whitelist(conf)
+    _validate_unlimited_amount(conf)
+
+    # validate configuration before returning
+    logger.info('Validating configuration ...')
+    validate_config_schema(conf)
+
+
+def _validate_unlimited_amount(conf: Dict[str, Any]) -> None:
+    """
+    If edge is disabled, either max_open_trades or stake_amount need to be set.
+    :raise: OperationalException if config validation failed
+    """
+    if (not conf.get('edge', {}).get('enabled')
+       and conf.get('max_open_trades') == float('inf')
+       and conf.get('stake_amount') == constants.UNLIMITED_STAKE_AMOUNT):
+        raise OperationalException("`max_open_trades` and `stake_amount` cannot both be unlimited.")
+
+
+def _validate_trailing_stoploss(conf: Dict[str, Any]) -> None:
+
+    if conf.get('stoploss') == 0.0:
+        raise OperationalException(
+            'The config stoploss needs to be different from 0 to avoid problems with sell orders.'
+            )
+    # Skip if trailing stoploss is not activated
+    if not conf.get('trailing_stop', False):
+        return
+
+    tsl_positive = float(conf.get('trailing_stop_positive', 0))
+    tsl_offset = float(conf.get('trailing_stop_positive_offset', 0))
+    tsl_only_offset = conf.get('trailing_only_offset_is_reached', False)
+
+    if tsl_only_offset:
+        if tsl_positive == 0.0:
+            raise OperationalException(
+                'The config trailing_only_offset_is_reached needs '
+                'trailing_stop_positive_offset to be more than 0 in your config.')
+    if tsl_positive > 0 and 0 < tsl_offset <= tsl_positive:
+        raise OperationalException(
+            'The config trailing_stop_positive_offset needs '
+            'to be greater than trailing_stop_positive in your config.')
+
+    # Fetch again without default
+    if 'trailing_stop_positive' in conf and float(conf['trailing_stop_positive']) == 0.0:
+        raise OperationalException(
+            'The config trailing_stop_positive needs to be different from 0 '
+            'to avoid problems with sell orders.'
+        )
+
+
+def _validate_edge(conf: Dict[str, Any]) -> None:
+    """
+    Edge and Dynamic whitelist should not both be enabled, since edge overrides dynamic whitelists.
+    """
+
+    if not conf.get('edge', {}).get('enabled'):
+        return
+
+    if conf.get('pairlist', {}).get('method') == 'VolumePairList':
+        raise OperationalException(
+            "Edge and VolumePairList are incompatible, "
+            "Edge will override whatever pairs VolumePairlist selects."
+        )
+
+
+def _validate_whitelist(conf: Dict[str, Any]) -> None:
+    """
+    Dynamic whitelist does not require pair_whitelist to be set - however StaticWhitelist does.
+    """
+    if conf.get('runmode', RunMode.OTHER) in [RunMode.OTHER, RunMode.PLOT,
+                                              RunMode.UTIL_NO_EXCHANGE, RunMode.UTIL_EXCHANGE]:
+        return
+
+    for pl in conf.get('pairlists', [{'method': 'StaticPairList'}]):
+        if (pl.get('method') == 'StaticPairList'
+                and not conf.get('exchange', {}).get('pair_whitelist')):
+            raise OperationalException("StaticPairList requires pair_whitelist to be set.")

freqtrade/configuration/configuration.py

@@ -1,31 +1,33 @@
 """
 This module contains the configuration class
 """
-import json
 import logging
-import sys
+import warnings
-from argparse import Namespace
+from copy import deepcopy
-from typing import Any, Callable, Dict, Optional
+from pathlib import Path
+from typing import Any, Callable, Dict, List, Optional
 
-from freqtrade import OperationalException, constants
+from freqtrade import constants
 from freqtrade.configuration.check_exchange import check_exchange
-from freqtrade.configuration.create_datadir import create_datadir
+from freqtrade.configuration.deprecated_settings import process_temporary_deprecated_settings
-from freqtrade.configuration.json_schema import validate_config_schema
+from freqtrade.configuration.directory_operations import create_datadir, create_userdata_dir
+from freqtrade.configuration.load_config import load_config_file
+from freqtrade.exceptions import OperationalException
 from freqtrade.loggers import setup_logging
-from freqtrade.misc import deep_merge_dicts
+from freqtrade.misc import deep_merge_dicts, json_load
-from freqtrade.state import RunMode
+from freqtrade.state import NON_UTIL_MODES, TRADING_MODES, RunMode
 
 
 logger = logging.getLogger(__name__)
 
 
-class Configuration(object):
+class Configuration:
     """
     Class to read and init the bot configuration
     Reuse this class for the bot, backtesting, hyperopt and every script that required configuration
     """
 
-    def __init__(self, args: Namespace, runmode: RunMode = None) -> None:
+    def __init__(self, args: Dict[str, Any], runmode: RunMode = None) -> None:
         self.args = args
         self.config: Optional[Dict[str, Any]] = None
         self.runmode = runmode
@@ -40,46 +42,48 @@ class Configuration(object):
 
         return self.config
 
-    def _load_config_files(self) -> Dict[str, Any]:
+    @staticmethod
+    def from_files(files: List[str]) -> Dict[str, Any]:
         """
-        Iterate through the config files passed in the args,
+        Iterate through the config files passed in, loading all of them
-        loading all of them and merging their contents.
+        and merging their contents.
+        Files are loaded in sequence, parameters in later configuration files
+        override the same parameter from an earlier file (last definition wins).
+        Runs through the whole Configuration initialization, so all expected config entries
+        are available to interactive environments.
+        :param files: List of file paths
+        :return: configuration dictionary
         """
+        c = Configuration({'config': files}, RunMode.OTHER)
+        return c.get_config()
+
+    def load_from_files(self, files: List[str]) -> Dict[str, Any]:
+
+        # Keep this method as staticmethod, so it can be used from interactive environments
         config: Dict[str, Any] = {}
 
+        if not files:
+            return deepcopy(constants.MINIMAL_CONFIG)
+
         # We expect here a list of config filenames
-        for path in self.args.config:
+        for path in files:
-            logger.info('Using config: %s ...', path)
+            logger.info(f'Using config: {path} ...')
 
             # Merge config options, overwriting old values
-            config = deep_merge_dicts(self._load_config_file(path), config)
+            config = deep_merge_dicts(load_config_file(path), config)
 
-        return config
+        # Normalize config
-
-    def _load_config_file(self, path: str) -> Dict[str, Any]:
-        """
-        Loads a config file from the given path
-        :param path: path as str
-        :return: configuration as dictionary
-        """
-        try:
-            # Read config from stdin if requested in the options
-            with open(path) if path != '-' else sys.stdin as file:
-                config = json.load(file)
-        except FileNotFoundError:
-            raise OperationalException(
-                f'Config file "{path}" not found!'
-                ' Please create a config file or check whether it exists.')
-
-        return config
-
-    def _normalize_config(self, config: Dict[str, Any]) -> None:
-        """
-        Make config more canonical -- i.e. for example add missing parts that we expect
-        to be normally in it...
-        """
         if 'internals' not in config:
             config['internals'] = {}
+        # TODO: This can be deleted along with removal of deprecated
+        # experimental settings
+        if 'ask_strategy' not in config:
+            config['ask_strategy'] = {}
+
+        if 'pairlists' not in config:
+            config['pairlists'] = []
+
+        return config
 
     def load_config(self) -> Dict[str, Any]:
         """
@@ -87,23 +91,29 @@ class Configuration(object):
         :return: Configuration dictionary
         """
         # Load all configs
-        config: Dict[str, Any] = self._load_config_files()
+        config: Dict[str, Any] = self.load_from_files(self.args.get("config", []))
 
-        # Make resulting config more canonical
+        # Keep a copy of the original configuration file
-        self._normalize_config(config)
+        config['original_config'] = deepcopy(config)
 
-        logger.info('Validating configuration ...')
+        self._process_logging_options(config)
-        validate_config_schema(config)
 
-        self._validate_config_consistency(config)
+        self._process_runmode(config)
 
         self._process_common_options(config)
 
+        self._process_trading_options(config)
+
         self._process_optimize_options(config)
 
         self._process_plot_options(config)
 
-        self._process_runmode(config)
+        # Check if the exchange set by the user is supported
+        check_exchange(config, config.get('experimental', {}).get('block_bad_exchanges', True))
+
+        self._resolve_pairs_list(config)
+
+        process_temporary_deprecated_settings(config)
 
         return config
 
@@ -113,34 +123,16 @@ class Configuration(object):
         the -v/--verbose, --logfile options
         """
         # Log level
-        if 'verbosity' in self.args and self.args.verbosity:
+        config.update({'verbosity': self.args.get('verbosity', 0)})
-            config.update({'verbosity': self.args.verbosity})
-        else:
-            config.update({'verbosity': 0})
 
-        if 'logfile' in self.args and self.args.logfile:
+        if 'logfile' in self.args and self.args['logfile']:
-            config.update({'logfile': self.args.logfile})
+            config.update({'logfile': self.args['logfile']})
 
         setup_logging(config)
 
-    def _process_strategy_options(self, config: Dict[str, Any]) -> None:
+    def _process_trading_options(self, config: Dict[str, Any]) -> None:
-
+        if config['runmode'] not in TRADING_MODES:
-        # Set strategy if not specified in config and or if it's non default
+            return
-        if self.args.strategy != constants.DEFAULT_STRATEGY or not config.get('strategy'):
-            config.update({'strategy': self.args.strategy})
-
-        if self.args.strategy_path:
-            config.update({'strategy_path': self.args.strategy_path})
-
-    def _process_common_options(self, config: Dict[str, Any]) -> None:
-
-        self._process_logging_options(config)
-        self._process_strategy_options(config)
-
-        if ('db_url' in self.args and self.args.db_url and
-                self.args.db_url != constants.DEFAULT_DB_PROD_URL):
-            config.update({'db_url': self.args.db_url})
-            logger.info('Parameter --db-url detected ...')
 
         if config.get('dry_run', False):
             logger.info('Dry run is enabled')
@@ -154,90 +146,125 @@ class Configuration(object):
 
         logger.info(f'Using DB: "{config["db_url"]}"')
 
+    def _process_common_options(self, config: Dict[str, Any]) -> None:
+
+        # Set strategy if not specified in config and or if it's non default
+        if self.args.get('strategy') or not config.get('strategy'):
+            config.update({'strategy': self.args.get('strategy')})
+
+        self._args_to_config(config, argname='strategy_path',
+                             logstring='Using additional Strategy lookup path: {}')
+
+        if ('db_url' in self.args and self.args['db_url'] and
+                self.args['db_url'] != constants.DEFAULT_DB_PROD_URL):
+            config.update({'db_url': self.args['db_url']})
+            logger.info('Parameter --db-url detected ...')
+
         if config.get('forcebuy_enable', False):
             logger.warning('`forcebuy` RPC message enabled.')
 
+        # Support for sd_notify
+        if 'sd_notify' in self.args and self.args['sd_notify']:
+            config['internals'].update({'sd_notify': True})
+
+    def _process_datadir_options(self, config: Dict[str, Any]) -> None:
+        """
+        Extract information for sys.argv and load directory configurations
+        --user-data, --datadir
+        """
+        # Check exchange parameter here - otherwise `datadir` might be wrong.
+        if 'exchange' in self.args and self.args['exchange']:
+            config['exchange']['name'] = self.args['exchange']
+            logger.info(f"Using exchange {config['exchange']['name']}")
+
+        if 'pair_whitelist' not in config['exchange']:
+            config['exchange']['pair_whitelist'] = []
+
+        if 'user_data_dir' in self.args and self.args['user_data_dir']:
+            config.update({'user_data_dir': self.args['user_data_dir']})
+        elif 'user_data_dir' not in config:
+            # Default to cwd/user_data (legacy option ...)
+            config.update({'user_data_dir': str(Path.cwd() / 'user_data')})
+
+        # reset to user_data_dir so this contains the absolute path.
+        config['user_data_dir'] = create_userdata_dir(config['user_data_dir'], create_dir=False)
+        logger.info('Using user-data directory: %s ...', config['user_data_dir'])
+
+        config.update({'datadir': create_datadir(config, self.args.get('datadir', None))})
+        logger.info('Using data directory: %s ...', config.get('datadir'))
+
+        if self.args.get('exportfilename'):
+            self._args_to_config(config, argname='exportfilename',
+                                 logstring='Storing backtest results to {} ...')
+            config['exportfilename'] = Path(config['exportfilename'])
+        else:
+            config['exportfilename'] = (config['user_data_dir']
+                                        / 'backtest_results')
+
+    def _process_optimize_options(self, config: Dict[str, Any]) -> None:
+
+        # This will override the strategy configuration
+        self._args_to_config(config, argname='timeframe',
+                             logstring='Parameter -i/--timeframe detected ... '
+                             'Using timeframe: {} ...')
+
+        self._args_to_config(config, argname='position_stacking',
+                             logstring='Parameter --enable-position-stacking detected ...')
+
         # Setting max_open_trades to infinite if -1
         if config.get('max_open_trades') == -1:
             config['max_open_trades'] = float('inf')
 
-        # Support for sd_notify
+        if 'use_max_market_positions' in self.args and not self.args["use_max_market_positions"]:
-        if 'sd_notify' in self.args and self.args.sd_notify:
-            config['internals'].update({'sd_notify': True})
-
-        # Check if the exchange set by the user is supported
-        check_exchange(config)
-
-    def _process_datadir_options(self, config: Dict[str, Any]) -> None:
-        """
-        Extract information for sys.argv and load datadir configuration:
-        the --datadir option
-        """
-        if 'datadir' in self.args and self.args.datadir:
-            config.update({'datadir': create_datadir(config, self.args.datadir)})
-        else:
-            config.update({'datadir': create_datadir(config, None)})
-        logger.info('Using data directory: %s ...', config.get('datadir'))
-
-    def _process_optimize_options(self, config: Dict[str, Any]) -> None:
-
-        # This will override the strategy configuration
-        self._args_to_config(config, argname='ticker_interval',
-                             logstring='Parameter -i/--ticker-interval detected ... '
-                             'Using ticker_interval: {} ...')
-
-        self._args_to_config(config, argname='live',
-                             logstring='Parameter -l/--live detected ...')
-
-        self._args_to_config(config, argname='position_stacking',
-                             logstring='Parameter --enable-position-stacking detected ...')
-
-        if 'use_max_market_positions' in self.args and not self.args.use_max_market_positions:
             config.update({'use_max_market_positions': False})
             logger.info('Parameter --disable-max-market-positions detected ...')
             logger.info('max_open_trades set to unlimited ...')
-        elif 'max_open_trades' in self.args and self.args.max_open_trades:
+        elif 'max_open_trades' in self.args and self.args['max_open_trades']:
-            config.update({'max_open_trades': self.args.max_open_trades})
+            config.update({'max_open_trades': self.args['max_open_trades']})
-            logger.info('Parameter --max_open_trades detected, '
+            logger.info('Parameter --max-open-trades detected, '
                         'overriding max_open_trades to: %s ...', config.get('max_open_trades'))
-        else:
+        elif config['runmode'] in NON_UTIL_MODES:
             logger.info('Using max_open_trades: %s ...', config.get('max_open_trades'))
 
         self._args_to_config(config, argname='stake_amount',
-                             logstring='Parameter --stake_amount detected, '
+                             logstring='Parameter --stake-amount detected, '
                              'overriding stake_amount to: {} ...')
 
+        self._args_to_config(config, argname='fee',
+                             logstring='Parameter --fee detected, '
+                             'setting fee to: {} ...')
+
         self._args_to_config(config, argname='timerange',
                              logstring='Parameter --timerange detected: {} ...')
 
         self._process_datadir_options(config)
 
-        self._args_to_config(config, argname='refresh_pairs',
-                             logstring='Parameter -r/--refresh-pairs-cached detected ...')
-
         self._args_to_config(config, argname='strategy_list',
-                             logstring='Using strategy list of {} Strategies', logfun=len)
+                             logstring='Using strategy list of {} strategies', logfun=len)
 
-        self._args_to_config(config, argname='ticker_interval',
+        self._args_to_config(config, argname='timeframe',
-                             logstring='Overriding ticker interval with Command line argument')
+                             logstring='Overriding timeframe with Command line argument')
 
         self._args_to_config(config, argname='export',
                              logstring='Parameter --export detected: {} ...')
 
-        self._args_to_config(config, argname='exportfilename',
-                             logstring='Storing backtest results to {} ...')
-
         # Edge section:
-        if 'stoploss_range' in self.args and self.args.stoploss_range:
+        if 'stoploss_range' in self.args and self.args["stoploss_range"]:
-            txt_range = eval(self.args.stoploss_range)
+            txt_range = eval(self.args["stoploss_range"])
             config['edge'].update({'stoploss_range_min': txt_range[0]})
             config['edge'].update({'stoploss_range_max': txt_range[1]})
             config['edge'].update({'stoploss_range_step': txt_range[2]})
-            logger.info('Parameter --stoplosses detected: %s ...', self.args.stoploss_range)
+            logger.info('Parameter --stoplosses detected: %s ...', self.args["stoploss_range"])
 
         # Hyperopt section
         self._args_to_config(config, argname='hyperopt',
-                             logstring='Using Hyperopt file {}')
+                             logstring='Using Hyperopt class name: {}')
+
+        self._args_to_config(config, argname='hyperopt_path',
+                             logstring='Using additional Hyperopt lookup path: {}')
+
+        self._args_to_config(config, argname='hyperoptexportfilename',
+                             logstring='Using hyperopt file: {}')
 
         self._args_to_config(config, argname='epochs',
                              logstring='Parameter --epochs detected ... '
@@ -250,6 +277,18 @@ class Configuration(object):
         self._args_to_config(config, argname='print_all',
                              logstring='Parameter --print-all detected ...')
 
+        if 'print_colorized' in self.args and not self.args["print_colorized"]:
+            logger.info('Parameter --no-color detected ...')
+            config.update({'print_colorized': False})
+        else:
+            config.update({'print_colorized': True})
+
+        self._args_to_config(config, argname='print_json',
+                             logstring='Parameter --print-json detected ...')
+
+        self._args_to_config(config, argname='export_csv',
+                             logstring='Parameter --export-csv detected: {}')
+
         self._args_to_config(config, argname='hyperopt_jobs',
                              logstring='Parameter -j/--job-workers detected: {}')
 
@@ -259,11 +298,53 @@ class Configuration(object):
         self._args_to_config(config, argname='hyperopt_min_trades',
                              logstring='Parameter --min-trades detected: {}')
 
-        self._args_to_config(config, argname='hyperopt_continue',
-                             logstring='Hyperopt continue: {}')
-
         self._args_to_config(config, argname='hyperopt_loss',
-                             logstring='Using loss function: {}')
+                             logstring='Using Hyperopt loss class name: {}')
+
+        self._args_to_config(config, argname='hyperopt_show_index',
+                             logstring='Parameter -n/--index detected: {}')
+
+        self._args_to_config(config, argname='hyperopt_list_best',
+                             logstring='Parameter --best detected: {}')
+
+        self._args_to_config(config, argname='hyperopt_list_profitable',
+                             logstring='Parameter --profitable detected: {}')
+
+        self._args_to_config(config, argname='hyperopt_list_min_trades',
+                             logstring='Parameter --min-trades detected: {}')
+
+        self._args_to_config(config, argname='hyperopt_list_max_trades',
+                             logstring='Parameter --max-trades detected: {}')
+
+        self._args_to_config(config, argname='hyperopt_list_min_avg_time',
+                             logstring='Parameter --min-avg-time detected: {}')
+
+        self._args_to_config(config, argname='hyperopt_list_max_avg_time',
+                             logstring='Parameter --max-avg-time detected: {}')
+
+        self._args_to_config(config, argname='hyperopt_list_min_avg_profit',
+                             logstring='Parameter --min-avg-profit detected: {}')
+
+        self._args_to_config(config, argname='hyperopt_list_max_avg_profit',
+                             logstring='Parameter --max-avg-profit detected: {}')
+
+        self._args_to_config(config, argname='hyperopt_list_min_total_profit',
+                             logstring='Parameter --min-total-profit detected: {}')
+
+        self._args_to_config(config, argname='hyperopt_list_max_total_profit',
+                             logstring='Parameter --max-total-profit detected: {}')
+
+        self._args_to_config(config, argname='hyperopt_list_min_objective',
+                             logstring='Parameter --min-objective detected: {}')
+
+        self._args_to_config(config, argname='hyperopt_list_max_objective',
+                             logstring='Parameter --max-objective detected: {}')
+
+        self._args_to_config(config, argname='hyperopt_list_no_details',
+                             logstring='Parameter --no-details detected: {}')
+
+        self._args_to_config(config, argname='hyperopt_show_no_header',
+                             logstring='Parameter --no-header detected: {}')
 
     def _process_plot_options(self, config: Dict[str, Any]) -> None:
 
@@ -276,51 +357,52 @@ class Configuration(object):
         self._args_to_config(config, argname='indicators2',
                              logstring='Using indicators2: {}')
 
+        self._args_to_config(config, argname='trade_ids',
+                             logstring='Filtering on trade_ids: {}')
+
         self._args_to_config(config, argname='plot_limit',
                              logstring='Limiting plot to: {}')
+
         self._args_to_config(config, argname='trade_source',
                              logstring='Using trades from: {}')
 
+        self._args_to_config(config, argname='erase',
+                             logstring='Erase detected. Deleting existing data.')
+
+        self._args_to_config(config, argname='no_trades',
+                             logstring='Parameter --no-trades detected.')
+
+        self._args_to_config(config, argname='timeframes',
+                             logstring='timeframes --timeframes: {}')
+
+        self._args_to_config(config, argname='days',
+                             logstring='Detected --days: {}')
+
+        self._args_to_config(config, argname='download_trades',
+                             logstring='Detected --dl-trades: {}')
+
+        self._args_to_config(config, argname='dataformat_ohlcv',
+                             logstring='Using "{}" to store OHLCV data.')
+
+        self._args_to_config(config, argname='dataformat_trades',
+                             logstring='Using "{}" to store trades data.')
+
     def _process_runmode(self, config: Dict[str, Any]) -> None:
 
+        self._args_to_config(config, argname='dry_run',
+                             logstring='Parameter --dry-run detected, '
+                             'overriding dry_run to: {} ...')
+
         if not self.runmode:
             # Handle real mode, infer dry/live from config
             self.runmode = RunMode.DRY_RUN if config.get('dry_run', True) else RunMode.LIVE
-            logger.info("Runmode set to {self.runmode}.")
+            logger.info(f"Runmode set to {self.runmode.value}.")
 
         config.update({'runmode': self.runmode})
 
-    def _validate_config_consistency(self, conf: Dict[str, Any]) -> None:
-        """
-        Validate the configuration consistency
-        :param conf: Config in JSON format
-        :return: Returns None if everything is ok, otherwise throw an OperationalException
-        """
-        # validating trailing stoploss
-        self._validate_trailing_stoploss(conf)
-
-    def _validate_trailing_stoploss(self, conf: Dict[str, Any]) -> None:
-
-        # Skip if trailing stoploss is not activated
-        if not conf.get('trailing_stop', False):
-            return
-
-        tsl_positive = float(conf.get('trailing_stop_positive', 0))
-        tsl_offset = float(conf.get('trailing_stop_positive_offset', 0))
-        tsl_only_offset = conf.get('trailing_only_offset_is_reached', False)
-
-        if tsl_only_offset:
-            if tsl_positive == 0.0:
-                raise OperationalException(
-                    f'The config trailing_only_offset_is_reached needs '
-                    'trailing_stop_positive_offset to be more than 0 in your config.')
-        if tsl_positive > 0 and 0 < tsl_offset <= tsl_positive:
-            raise OperationalException(
-                f'The config trailing_stop_positive_offset needs '
-                'to be greater than trailing_stop_positive_offset in your config.')
-
     def _args_to_config(self, config: Dict[str, Any], argname: str,
-                        logstring: str, logfun: Optional[Callable] = None) -> None:
+                        logstring: str, logfun: Optional[Callable] = None,
+                        deprecated_msg: Optional[str] = None) -> None:
         """
         :param config: Configuration dictionary
         :param argname: Argumentname in self.args - will be copied to config dict.
@@ -330,10 +412,49 @@ class Configuration(object):
                         sample: logfun=len (prints the length of the found
                         configuration instead of the content)
         """
-        if argname in self.args and getattr(self.args, argname):
+        if (argname in self.args and self.args[argname] is not None
+           and self.args[argname] is not False):
 
-            config.update({argname: getattr(self.args, argname)})
+            config.update({argname: self.args[argname]})
             if logfun:
                 logger.info(logstring.format(logfun(config[argname])))
             else:
                 logger.info(logstring.format(config[argname]))
+            if deprecated_msg:
+                warnings.warn(f"DEPRECATED: {deprecated_msg}", DeprecationWarning)
+
+    def _resolve_pairs_list(self, config: Dict[str, Any]) -> None:
+        """
+        Helper for download script.
+        Takes first found:
+        * -p (pairs argument)
+        * --pairs-file
+        * whitelist from config
+        """
+
+        if "pairs" in config:
+            return
+
+        if "pairs_file" in self.args and self.args["pairs_file"]:
+            pairs_file = Path(self.args["pairs_file"])
+            logger.info(f'Reading pairs file "{pairs_file}".')
+            # Download pairs from the pairs file if no config is specified
+            # or if pairs file is specified explicitely
+            if not pairs_file.exists():
+                raise OperationalException(f'No pairs file found with path "{pairs_file}".')
+            with pairs_file.open('r') as f:
+                config['pairs'] = json_load(f)
+                config['pairs'].sort()
+            return
+
+        if 'config' in self.args and self.args['config']:
+            logger.info("Using pairlist from configuration.")
+            config['pairs'] = config.get('exchange', {}).get('pair_whitelist')
+        else:
+            # Fall back to /dl_path/pairs.json
+            pairs_file = config['datadir'] / 'pairs.json'
+            if pairs_file.exists():
+                with pairs_file.open('r') as f:
+                    config['pairs'] = json_load(f)
+                if 'pairs' in config:
+                    config['pairs'].sort()

freqtrade/configuration/create_datadir.py

@@ -1,20 +0,0 @@
-import logging
-from typing import Any, Dict, Optional
-from pathlib import Path
-
-
-logger = logging.getLogger(__name__)
-
-
-def create_datadir(config: Dict[str, Any], datadir: Optional[str] = None) -> str:
-
-    folder = Path(datadir) if datadir else Path('user_data/data')
-    if not datadir:
-        # set datadir
-        exchange_name = config.get('exchange', {}).get('name').lower()
-        folder = folder.joinpath(exchange_name)
-
-    if not folder.is_dir():
-        folder.mkdir(parents=True)
-        logger.info(f'Created data directory: {datadir}')
-    return str(folder)

freqtrade/configuration/deprecated_settings.py

@@ -0,0 +1,80 @@
+"""
+Functions to handle deprecated settings
+"""
+
+import logging
+from typing import Any, Dict
+
+from freqtrade.exceptions import OperationalException
+
+
+logger = logging.getLogger(__name__)
+
+
+def check_conflicting_settings(config: Dict[str, Any],
+                               section1: str, name1: str,
+                               section2: str, name2: str) -> None:
+    section1_config = config.get(section1, {})
+    section2_config = config.get(section2, {})
+    if name1 in section1_config and name2 in section2_config:
+        raise OperationalException(
+            f"Conflicting settings `{section1}.{name1}` and `{section2}.{name2}` "
+            "(DEPRECATED) detected in the configuration file. "
+            "This deprecated setting will be removed in the next versions of Freqtrade. "
+            f"Please delete it from your configuration and use the `{section1}.{name1}` "
+            "setting instead."
+        )
+
+
+def process_deprecated_setting(config: Dict[str, Any],
+                               section1: str, name1: str,
+                               section2: str, name2: str) -> None:
+    section2_config = config.get(section2, {})
+
+    if name2 in section2_config:
+        logger.warning(
+            "DEPRECATED: "
+            f"The `{section2}.{name2}` setting is deprecated and "
+            "will be removed in the next versions of Freqtrade. "
+            f"Please use the `{section1}.{name1}` setting in your configuration instead."
+        )
+        section1_config = config.get(section1, {})
+        section1_config[name1] = section2_config[name2]
+
+
+def process_temporary_deprecated_settings(config: Dict[str, Any]) -> None:
+
+    check_conflicting_settings(config, 'ask_strategy', 'use_sell_signal',
+                               'experimental', 'use_sell_signal')
+    check_conflicting_settings(config, 'ask_strategy', 'sell_profit_only',
+                               'experimental', 'sell_profit_only')
+    check_conflicting_settings(config, 'ask_strategy', 'ignore_roi_if_buy_signal',
+                               'experimental', 'ignore_roi_if_buy_signal')
+
+    process_deprecated_setting(config, 'ask_strategy', 'use_sell_signal',
+                               'experimental', 'use_sell_signal')
+    process_deprecated_setting(config, 'ask_strategy', 'sell_profit_only',
+                               'experimental', 'sell_profit_only')
+    process_deprecated_setting(config, 'ask_strategy', 'ignore_roi_if_buy_signal',
+                               'experimental', 'ignore_roi_if_buy_signal')
+
+    if (config.get('edge', {}).get('enabled', False)
+       and 'capital_available_percentage' in config.get('edge', {})):
+        raise OperationalException(
+            "DEPRECATED: "
+            "Using 'edge.capital_available_percentage' has been deprecated in favor of "
+            "'tradable_balance_ratio'. Please migrate your configuration to "
+            "'tradable_balance_ratio' and remove 'capital_available_percentage' "
+            "from the edge configuration."
+        )
+    if 'ticker_interval' in config:
+        logger.warning(
+            "DEPRECATED: "
+            "Please use 'timeframe' instead of 'ticker_interval."
+        )
+        if 'timeframe' in config:
+            raise OperationalException(
+                "Both 'timeframe' and 'ticker_interval' detected."
+                "Please remove 'ticker_interval' from your configuration to continue operating."
+                )
+        config['timeframe'] = config['ticker_interval']