stable/docs/index.md

# Freqtrade
[![Build Status](https://travis-ci.org/freqtrade/freqtrade.svg?branch=develop)](https://travis-ci.org/freqtrade/freqtrade)
[![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)

<!-- Place this tag where you want the button to render. -->
<a class="github-button" href="https://github.com/freqtrade/freqtrade" data-icon="octicon-star" data-size="large" aria-label="Star freqtrade/freqtrade on GitHub">Star</a>
<!-- 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>
<!-- 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.

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

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

    We strongly recommend you to have basic coding skills and Python knowledge. Do not hesitate to read the source code and understand the mechanisms of this bot, algorithms and techniques implemented in it.


## Features
 - Based on Python 3.6+: For botting on any operating system — Windows, macOS and Linux.
 - Persistence: Persistence is achieved through sqlite database.
 - Dry-run mode: Run the bot without playing money.
 - Backtesting: Run a simulation of your buy/sell strategy with historical data.
 - Strategy Optimization by machine learning: Use machine learning to optimize your buy/sell strategy parameters with real exchange data.
 - 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.
 - Whitelist crypto-currencies: Select which crypto-currency you want to trade or use dynamic whitelists based on market (pair) trade volume.
 - Blacklist crypto-currencies: Select which crypto-currency you want to avoid.
 - Manageable via Telegram: Manage the bot with Telegram.
 - Display profit/loss in fiat: Display your profit/loss in 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:

- 2GB RAM
- 1GB disk space
- 2vCPU

### Software requirements
- Python 3.6.x
- pip (pip3)
- git
- TA-Lib
- virtualenv (Recommended)
- Docker (Recommended)


## Support
Help / Slack
For any questions not covered by the documentation or for further information about the bot, we encourage you to join our Slack channel.

Click [here](https://join.slack.com/t/highfrequencybot/shared_invite/enQtMjQ5NTM0OTYzMzY3LWMxYzE3M2MxNDdjMGM3ZTYwNzFjMGIwZGRjNTc3ZGU3MGE3NzdmZGMwNmU3NDM5ZTNmM2Y3NjRiNzk4NmM4OGE) to join Slack channel.

## Ready to try?
Begin by reading our installation guide [here](installation).
changing index to about page 2018-12-30 16:58:06 +00:00			`# Freqtrade`
added widgets to index documents 2018-12-30 17:22:28 +00:00			`[![Build Status](https://travis-ci.org/freqtrade/freqtrade.svg?branch=develop)](https://travis-ci.org/freqtrade/freqtrade)`
			`[![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)`

			`<!-- Place this tag where you want the button to render. -->`
			`<a class="github-button" href="https://github.com/freqtrade/freqtrade" data-icon="octicon-star" data-size="large" aria-label="Star freqtrade/freqtrade on GitHub">Star</a>`
			`<!-- 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>`
			`<!-- 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>`
changing index to about page 2018-12-30 16:58:06 +00:00			`## Introduction`
			`Freqtrade is a cryptocurrency trading bot written in Python.`
update documentation 2018-06-26 21:14:12 +00:00
changing index to about page 2018-12-30 16:58:06 +00:00			`!!! 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.`
Reorder and revamp the documentation 2018-01-02 02:17:10 +00:00
changing index to about page 2018-12-30 16:58:06 +00:00			`Always start by running a trading bot in Dry-run and do not engage money before you understand how it works and what profit/loss you should expect.`
update documentation 2018-06-26 21:14:12 +00:00
minor: doc update index.md 2019-03-04 20:44:44 +00:00			`We strongly recommend you to have basic coding skills and Python knowledge. Do not hesitate to read the source code and understand the mechanisms of this bot, algorithms and techniques implemented in it.`
changing index to about page 2018-12-30 16:58:06 +00:00

			`## Features`
minor: doc update index.md 2019-03-04 20:44:44 +00:00			`- Based on Python 3.6+: For botting on any operating system — Windows, macOS and Linux.`
			`- Persistence: Persistence is achieved through sqlite database.`
			`- Dry-run mode: Run the bot without playing money.`
			`- Backtesting: Run a simulation of your buy/sell strategy with historical data.`
changing index to about page 2018-12-30 16:58:06 +00:00			`- Strategy Optimization by machine learning: Use machine learning to optimize your buy/sell strategy parameters with real exchange data.`
minor: doc update index.md 2019-03-04 20:44:44 +00:00			`- 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.`
			`- Whitelist crypto-currencies: Select which crypto-currency you want to trade or use dynamic whitelists based on market (pair) trade volume.`
changing index to about page 2018-12-30 16:58:06 +00:00			`- Blacklist crypto-currencies: Select which crypto-currency you want to avoid.`
minor: doc update index.md 2019-03-04 20:44:44 +00:00			`- Manageable via Telegram: Manage the bot with Telegram.`
			`- 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.`
changing index to about page 2018-12-30 16:58:06 +00:00
requirements added to “about” 2018-12-30 17:03:09 +00:00
			`## Requirements`
minor: doc update index.md 2019-03-04 20:44:44 +00:00			`### 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.`
requirements added to “about” 2018-12-30 17:03:09 +00:00
			`### Hardware requirements`
			`To run this bot we recommend you a cloud instance with a minimum of:`

			`- 2GB RAM`
			`- 1GB disk space`
			`- 2vCPU`

			`### Software requirements`
			`- Python 3.6.x`
minor: doc update index.md 2019-03-04 20:44:44 +00:00			`- pip (pip3)`
requirements added to “about” 2018-12-30 17:03:09 +00:00			`- git`
			`- TA-Lib`
			`- virtualenv (Recommended)`
			`- Docker (Recommended)`


changing index to about page 2018-12-30 16:58:06 +00:00			`## Support`
			`Help / Slack`
minor: doc update index.md 2019-03-04 20:44:44 +00:00			`For any questions not covered by the documentation or for further information about the bot, we encourage you to join our Slack channel.`
changing index to about page 2018-12-30 16:58:06 +00:00
requirements added to “about” 2018-12-30 17:03:09 +00:00			`Click [here](https://join.slack.com/t/highfrequencybot/shared_invite/enQtMjQ5NTM0OTYzMzY3LWMxYzE3M2MxNDdjMGM3ZTYwNzFjMGIwZGRjNTc3ZGU3MGE3NzdmZGMwNmU3NDM5ZTNmM2Y3NjRiNzk4NmM4OGE) to join Slack channel.`
added “ready to try?” 2018-12-30 17:06:09 +00:00
			`## Ready to try?`
minor: doc update index.md 2019-03-04 20:44:44 +00:00			`Begin by reading our installation guide [here](installation).`