stable/docs/bot-usage.md

216 lines
8.8 KiB
Markdown
Raw Normal View History

# Start the bot
This page explains the different parameters of the bot and how to run it.
2018-01-02 02:17:10 +00:00
2019-08-22 04:57:32 +00:00
!!! 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.
2018-01-02 02:17:10 +00:00
## Bot commands
2018-01-02 02:17:10 +00:00
```
usage: freqtrade [-h] [-V]
2020-06-02 08:06:26 +00:00
{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}
...
2018-01-02 02:17:10 +00:00
2019-01-03 13:38:38 +00:00
Free, open source crypto trading bot
2018-01-02 02:17:10 +00:00
positional arguments:
2020-06-02 08:06:26 +00:00
{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.
2020-06-02 08:06:26 +00:00
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.
2019-03-04 06:24:41 +00:00
backtesting Backtesting module.
edge Edge module.
hyperopt Hyperopt module.
2020-06-02 08:06:26 +00:00
hyperopt-list List Hyperopt results
hyperopt-show Show details of Hyperopt results
2019-07-28 13:34:49 +00:00
list-exchanges Print available exchanges.
2020-06-02 08:06:26 +00:00
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
2019-10-20 17:35:38 +00:00
```
### Bot trading commands
```
usage: freqtrade trade [-h] [-v] [--logfile FILE] [-V] [-c PATH] [-d PATH]
[--userdir PATH] [-s NAME] [--strategy-path PATH]
2019-10-15 04:51:03 +00:00
[--db-url PATH] [--sd-notify] [--dry-run]
2021-02-10 18:45:59 +00:00
[--dry-run-wallet DRY_RUN_WALLET]
2018-01-02 02:17:10 +00:00
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.
2019-10-15 10:26:06 +00:00
--dry-run Enforce dry-run for trading (removes Exchange secrets
and simulates trades).
2021-02-10 18:45:59 +00:00
--dry-run-wallet DRY_RUN_WALLET
Starting balance, used for backtesting / hyperopt and
dry-runs.
Common arguments:
2019-03-04 06:24:41 +00:00
-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.
2019-07-18 09:12:34 +00:00
-V, --version show program's version number and exit
2018-01-18 07:06:37 +00:00
-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.
2018-05-30 05:24:13 +00:00
-d PATH, --datadir PATH
2019-07-31 04:49:25 +00:00
Path to directory with historical backtesting data.
2019-07-28 13:34:49 +00:00
--userdir PATH, --user-data-dir PATH
2019-07-31 04:49:25 +00:00
Path to userdata directory.
Strategy arguments:
-s NAME, --strategy NAME
2019-09-21 17:54:44 +00:00
Specify strategy class name which will be used by the
bot.
2019-03-04 06:24:41 +00:00
--strategy-path PATH Specify additional strategy lookup path.
2018-01-02 02:17:10 +00:00
```
### How to specify which configuration file be used?
The bot allows you to select which configuration file you want to use by means of
the `-c/--config` command line option:
2018-01-02 02:17:10 +00:00
```bash
2019-09-29 17:21:18 +00:00
freqtrade trade -c path/far/far/away/config.json
2018-01-02 02:17:10 +00:00
```
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` options in the command line. Configuration parameters
defined in the latter configuration files override parameters with the same name
defined in the previous configuration files specified in the command line earlier.
2019-11-27 13:18:40 +00:00
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
2019-11-27 13:18:40 +00:00
empty key and secret values while running in the Dry Mode (which does not actually
require them):
```bash
2019-09-29 17:21:18 +00:00
freqtrade trade -c ./config.json
```
and specify both configuration files when running in the normal Live Trade Mode:
```bash
2019-09-29 17:21:18 +00:00
freqtrade trade -c ./config.json -c path/to/secrets/keys.config.json
```
2019-11-27 13:18:40 +00:00
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.
See more details on this technique with examples in the documentation page on
2019-04-01 17:25:13 +00:00
[configuration](configuration.md).
2019-07-28 13:34:49 +00:00
### 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:
2019-07-31 04:49:25 +00:00
```
2019-07-28 13:34:49 +00:00
user_data/
├── backtest_results
├── data
├── hyperopts
├── hyperopt_results
2019-07-28 13:34:49 +00:00
├── plot
└── strategies
2019-07-31 04:49:25 +00:00
```
2019-07-28 13:34:49 +00:00
2019-07-31 04:49:25 +00:00
You can add the entry "user_data_dir" setting to your configuration, to always point your bot to this directory.
2019-07-28 13:34:49 +00:00
Alternatively, pass in `--userdir` to every command.
The bot will fail to start if the directory does not exist, but will create necessary subdirectories.
2019-07-28 13:34:49 +00:00
2019-11-13 10:13:48 +00:00
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.
2019-07-28 13:34:49 +00:00
2019-07-31 04:49:25 +00:00
It is recommended to use version control to keep track of changes to your strategies.
2019-07-28 13:34:49 +00:00
### How to use **--strategy**?
This parameter will allow you to load your custom strategy class.
2020-03-30 06:11:38 +00:00
To test the bot installation, you can use the `SampleStrategy` installed by the `create-userdir` subcommand (usually `user_data/strategy/sample_strategy.py`).
2018-01-18 07:06:37 +00:00
The bot will search your strategy file within `user_data/strategies`.
2020-03-30 06:11:38 +00:00
To use other directories, please read the next section about `--strategy-path`.
2018-01-18 07:06:37 +00:00
To load a strategy, simply pass the class name (e.g.: `CustomStrategy`) in this parameter.
2018-01-18 07:06:37 +00:00
2018-11-15 18:54:17 +00:00
**Example:**
In `user_data/strategies` you have a file `my_awesome_strategy.py` which has
2018-03-25 14:42:20 +00:00
a strategy class called `AwesomeStrategy` to load it:
2018-01-18 07:06:37 +00:00
```bash
freqtrade trade --strategy AwesomeStrategy
2018-01-18 07:06:37 +00:00
```
2018-11-15 18:54:17 +00:00
If the bot does not find your strategy file, it will display in an error
message the reason (File not found, or errors in your code).
2018-01-18 07:06:37 +00:00
Learn more about strategy file in
2019-05-19 07:07:43 +00:00
[Strategy Customization](strategy-customization.md).
2018-01-18 07:06:37 +00:00
### How to use **--strategy-path**?
2018-03-27 16:46:42 +00:00
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!):
2019-08-22 04:57:32 +00:00
2018-03-27 16:46:42 +00:00
```bash
freqtrade trade --strategy AwesomeStrategy --strategy-path /some/directory
2018-03-27 16:46:42 +00:00
```
2018-01-18 07:06:37 +00:00
#### How to install a strategy?
This is very simple. Copy paste your strategy file into the directory
2018-03-27 16:46:42 +00:00
`user_data/strategies` or use `--strategy-path`. And voila, the bot is ready to use it.
2018-01-18 07:06:37 +00:00
### How to use **--db-url**?
2018-11-15 18:54:17 +00:00
When you run the bot in Dry-run mode, per default no transactions are
stored in a database. If you want to store your bot actions in a DB
2018-06-07 03:36:39 +00:00
using `--db-url`. This can also be used to specify a custom database
in production mode. Example command:
2018-01-02 02:17:10 +00:00
```bash
2019-09-29 17:21:18 +00:00
freqtrade trade -c config.json --db-url sqlite:///tradesv3.dry_run.sqlite
2018-01-02 02:17:10 +00:00
```
## Next step
2018-11-15 18:54:17 +00:00
The optimal strategy of the bot will change with time depending of the market trends. The next step is to
2019-05-19 07:07:43 +00:00
[Strategy Customization](strategy-customization.md).