diff --git a/docs/rest-api.md b/docs/rest-api.md index 229fa5f94..3baff8506 100644 --- a/docs/rest-api.md +++ b/docs/rest-api.md @@ -95,11 +95,13 @@ Make sure that the following 2 lines are available in your docker-compose file: ### 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. +You can consume the API by using `freqtrade-client` (also available as `scripts/rest_client.py`). +This command can be installed independent of the bot by using `pip install freqtrade-client`. + +This module is designed to be lightweight, and only depends on the `requests` and `python-rapidjson` modules, skipping all heavy dependencies freqtrade otherwise needs. ``` bash -python3 scripts/rest_client.py [optional parameters] +freqtrade-client [optional parameters] ``` By default, the script assumes `127.0.0.1` (localhost) and port `8080` to be used, however you can specify a configuration file to override this behaviour. @@ -120,7 +122,7 @@ By default, the script assumes `127.0.0.1` (localhost) and port `8080` to be use ``` ``` bash -python3 scripts/rest_client.py --config rest_config.json [optional parameters] +freqtrade-client --config rest_config.json [optional parameters] ``` ### Available endpoints @@ -176,7 +178,7 @@ python3 scripts/rest_client.py --config rest_config.json [optional par Possible commands can be listed from the rest-client script using the `help` command. ``` bash -python3 scripts/rest_client.py help +freqtrade-client help ``` ``` output diff --git a/ft_client/pyproject.toml b/ft_client/pyproject.toml index e308eefea..919e524f8 100644 --- a/ft_client/pyproject.toml +++ b/ft_client/pyproject.toml @@ -42,7 +42,7 @@ Documentation = "https://freqtrade.io" [project.scripts] -ft_rest = "freqtrade_client.ft_client:main" +freqtrade-client = "freqtrade_client.ft_client:main" [tool.setuptools.packages.find] where = ["."]