changed to “Free, open source …”
This commit is contained in:
parent
05ce7787d6
commit
afffa2f313
72
README.md
72
README.md
@ -22,10 +22,33 @@ expect.
|
|||||||
We strongly recommend you to have coding and Python knowledge. Do not
|
We strongly recommend you to have coding and Python knowledge. Do not
|
||||||
hesitate to read the source code and understand the mechanism of this bot.
|
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))
|
||||||
|
- [ ] [113 others to tests](https://github.com/ccxt/ccxt/). _(We cannot guarantee they will work)_
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
|
We invite you to read the bot documentation to ensure you understand how the bot is working.
|
||||||
|
|
||||||
Please find the complete documentation on our [website](https://www.freqtrade.io).
|
Please find the complete documentation on our [website](https://www.freqtrade.io).
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- [x] **Based on Python 3.6+**: For botting on any operating system - Windows, macOS and Linux.
|
||||||
|
- [x] **Persistence**: Persistence is achieved through sqlite.
|
||||||
|
- [x] **Dry-run**: Run the bot without playing money.
|
||||||
|
- [x] **Backtesting**: Run a simulation of your buy/sell strategy.
|
||||||
|
- [x] **Strategy Optimization by machine learning**: Use machine learning to optimize your buy/sell strategy parameters with real exchange data.
|
||||||
|
- [x] **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. [Learn more](https://www.freqtrade.io/en/latest/edge/).
|
||||||
|
- [x] **Whitelist crypto-currencies**: Select which crypto-currency you want to trade or use dynamic whitelists.
|
||||||
|
- [x] **Blacklist crypto-currencies**: Select which crypto-currency you want to avoid.
|
||||||
|
- [x] **Manageable via Telegram**: Manage the bot with Telegram.
|
||||||
|
- [x] **Display profit/loss in fiat**: Display your profit/loss in 33 fiat.
|
||||||
|
- [x] **Daily summary of profit/loss**: Provide a daily summary of your profit/loss.
|
||||||
|
- [x] **Performance status report**: Provide a performance status of your current trades.
|
||||||
|
|
||||||
## Quick start
|
## Quick start
|
||||||
|
|
||||||
Freqtrade provides a Linux/macOS script to install all dependencies and help you to configure the bot.
|
Freqtrade provides a Linux/macOS script to install all dependencies and help you to configure the bot.
|
||||||
@ -42,40 +65,61 @@ For any other type of installation please refer to [Installation doc](https://ww
|
|||||||
|
|
||||||
## Basic Usage
|
## Basic Usage
|
||||||
|
|
||||||
|
### Bot commands
|
||||||
|
|
||||||
```bash
|
```
|
||||||
usage: main.py [-h] [-v] [--version] [-c PATH] [-d PATH] [-s NAME]
|
usage: main.py [-h] [-v] [--version] [-c PATH] [-d PATH] [-s NAME]
|
||||||
[--strategy-path PATH] [--dynamic-whitelist [INT]]
|
[--strategy-path PATH] [--customhyperopt NAME]
|
||||||
[--dry-run-db]
|
[--dynamic-whitelist [INT]] [--db-url PATH]
|
||||||
{backtesting,hyperopt} ...
|
{backtesting,edge,hyperopt} ...
|
||||||
|
|
||||||
Simple High Frequency Trading Bot for crypto currencies
|
Free, open source crypto trading bot
|
||||||
|
|
||||||
positional arguments:
|
positional arguments:
|
||||||
{backtesting,hyperopt}
|
{backtesting,edge,hyperopt}
|
||||||
backtesting backtesting module
|
backtesting backtesting module
|
||||||
|
edge edge module
|
||||||
hyperopt hyperopt module
|
hyperopt hyperopt module
|
||||||
|
|
||||||
optional arguments:
|
optional arguments:
|
||||||
-h, --help show this help message and exit
|
-h, --help show this help message and exit
|
||||||
-v, --verbose be verbose
|
-v, --verbose verbose mode (-vv for more, -vvv to get all messages)
|
||||||
--version show program's version number and exit
|
--version show program\'s version number and exit
|
||||||
-c PATH, --config PATH
|
-c PATH, --config PATH
|
||||||
specify configuration file (default: config.json)
|
specify configuration file (default: config.json)
|
||||||
-d PATH, --datadir PATH
|
-d PATH, --datadir PATH
|
||||||
path to backtest data (default:
|
path to backtest data
|
||||||
freqtrade/tests/testdata
|
|
||||||
-s NAME, --strategy NAME
|
-s NAME, --strategy NAME
|
||||||
specify strategy class name (default: DefaultStrategy)
|
specify strategy class name (default: DefaultStrategy)
|
||||||
--strategy-path PATH specify additional strategy lookup path
|
--strategy-path PATH specify additional strategy lookup path
|
||||||
|
--customhyperopt NAME
|
||||||
|
specify hyperopt class name (default:
|
||||||
|
DefaultHyperOpts)
|
||||||
--dynamic-whitelist [INT]
|
--dynamic-whitelist [INT]
|
||||||
dynamically generate and update whitelist based on 24h
|
dynamically generate and update whitelist based on 24h
|
||||||
BaseVolume (Default 20 currencies)
|
BaseVolume (default: 20) DEPRECATED.
|
||||||
--dry-run-db Force dry run to use a local DB
|
--db-url PATH Override trades database URL, this is useful if
|
||||||
"tradesv3.dry_run.sqlite" instead of memory DB. Work
|
dry_run is enabled or in custom deployments (default:
|
||||||
only if dry_run is enabled.
|
None)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Telegram RPC commands
|
||||||
|
|
||||||
|
Telegram is not mandatory. However, this is a great way to control your bot. More details on our [documentation](https://github.com/freqtrade/freqtrade/blob/develop/docs/index.md)
|
||||||
|
|
||||||
|
- `/start`: Starts the trader
|
||||||
|
- `/stop`: Stops the trader
|
||||||
|
- `/status [table]`: Lists all open trades
|
||||||
|
- `/count`: Displays number of open trades
|
||||||
|
- `/profit`: Lists cumulative profit from all finished trades
|
||||||
|
- `/forcesell <trade_id>|all`: Instantly sells the given trade (Ignoring `minimum_roi`).
|
||||||
|
- `/performance`: Show performance of each finished trade grouped by pair
|
||||||
|
- `/balance`: Show account balance per currency
|
||||||
|
- `/daily <n>`: Shows profit or loss per day, over the last n days
|
||||||
|
- `/help`: Show help message
|
||||||
|
- `/version`: Show version
|
||||||
|
|
||||||
|
|
||||||
## Development branches
|
## Development branches
|
||||||
|
|
||||||
The project is currently setup in two main branches:
|
The project is currently setup in two main branches:
|
||||||
|
@ -11,7 +11,7 @@ usage: main.py [-h] [-v] [--version] [-c PATH] [-d PATH] [-s NAME]
|
|||||||
[--dynamic-whitelist [INT]] [--db-url PATH]
|
[--dynamic-whitelist [INT]] [--db-url PATH]
|
||||||
{backtesting,edge,hyperopt} ...
|
{backtesting,edge,hyperopt} ...
|
||||||
|
|
||||||
Simple High Frequency Trading Bot for crypto currencies
|
Free, open source crypto trading bot
|
||||||
|
|
||||||
positional arguments:
|
positional arguments:
|
||||||
{backtesting,edge,hyperopt}
|
{backtesting,edge,hyperopt}
|
||||||
|
@ -25,7 +25,7 @@ def main(sysargv: List[str]) -> None:
|
|||||||
"""
|
"""
|
||||||
arguments = Arguments(
|
arguments = Arguments(
|
||||||
sysargv,
|
sysargv,
|
||||||
'Simple High Frequency Trading Bot for crypto currencies'
|
'Free, open source crypto trading bot'
|
||||||
)
|
)
|
||||||
args = arguments.get_parsed_arg()
|
args = arguments.get_parsed_arg()
|
||||||
|
|
||||||
@ -45,7 +45,7 @@ def main(sysargv: List[str]) -> None:
|
|||||||
freqtrade = FreqtradeBot(config)
|
freqtrade = FreqtradeBot(config)
|
||||||
|
|
||||||
state = None
|
state = None
|
||||||
while 1:
|
while True:
|
||||||
state = freqtrade.worker(old_state=state)
|
state = freqtrade.worker(old_state=state)
|
||||||
if state == State.RELOAD_CONF:
|
if state == State.RELOAD_CONF:
|
||||||
freqtrade = reconfigure(freqtrade, args)
|
freqtrade = reconfigure(freqtrade, args)
|
||||||
|
2
setup.py
2
setup.py
@ -11,7 +11,7 @@ from freqtrade import __version__
|
|||||||
|
|
||||||
setup(name='freqtrade',
|
setup(name='freqtrade',
|
||||||
version=__version__,
|
version=__version__,
|
||||||
description='Simple High Frequency Trading Bot for crypto currencies',
|
description='Crypto Trading Bot',
|
||||||
url='https://github.com/freqtrade/freqtrade',
|
url='https://github.com/freqtrade/freqtrade',
|
||||||
author='gcarq and contributors',
|
author='gcarq and contributors',
|
||||||
author_email='michael.egger@tsn.at',
|
author_email='michael.egger@tsn.at',
|
||||||
|
Loading…
Reference in New Issue
Block a user