REST API & FreqUI¶

FreqUI¶

Freqtrade provides a builtin webserver, which can serve FreqUI, the freqtrade UI.

By default, the UI is not included in the installation (except for docker images), and must be installed explicitly with freqtrade install-ui. This same command can also be used to update freqUI, should there be a new release.

Once the bot is started in trade / dry-run mode (with freqtrade trade) - the UI will be available under the configured port below (usually http://127.0.0.1:8080).

Alpha release

FreqUI is still considered an alpha release - if you encounter bugs or inconsistencies please open a FreqUI issue.

developers

Developers should not use this method, but instead use the method described in the freqUI repository to get the source-code of freqUI.

Configuration¶

Enable the rest API by adding the api_server section to your configuration and setting api_server.enabled to true.

Sample configuration:

json "api_server": { "enabled": true, "listen_ip_address": "127.0.0.1", "listen_port": 8080, "verbosity": "error", "enable_openapi": false, "jwt_secret_key": "somethingrandom", "CORS_origins": [], "username": "Freqtrader", "password": "SuperSecret1!" },

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.

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.

Security¶

To generate a secure password, best use a password manager, or use the below code.

python import secrets secrets.token_hex()

JWT token

Use the same method to also generate a JWT secret key (jwt_secret_key).

Password selection

Please make sure to select a very strong, unique password to protect your bot from unauthorized access. Also change jwt_secret_key to something random (no need to remember this, but it'll be used to encrypt your session, so it better be something unique!).

Configuration with 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": { "enabled": true, "listen_ip_address": "0.0.0.0", "listen_port": 8080 },

Uncomment the following from your docker-compose file:

yml ports: - "127.0.0.1:8080:8080"

Security warning

By using 8080:8080 in the docker port mapping, the API will be available to everyone connecting to the server under the correct port, so others may be able to control your bot.

Rest API¶

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.

bash python3 scripts/rest_client.py <command> [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.

Minimalistic client config¶

json { "api_server": { "enabled": true, "listen_ip_address": "0.0.0.0", "listen_port": 8080 } }

bash python3 scripts/rest_client.py --config rest_config.json <command> [optional parameters]

Available endpoints¶

Command	Description
`ping`	Simple command testing the API Readiness - requires no authentication.
`start`	Starts the trader.
`stop`	Stops the trader.
`stopbuy`	Stops the trader from opening new trades. Gracefully closes open trades according to their rules.
`reload_config`	Reloads the configuration file.
`trades`	List last trades.
`delete_trade <trade_id>`	Remove trade from the database. Tries to close open orders. Requires manual handling of this trade on the exchange.
`show_config`	Shows part of the current configuration with relevant settings to operation.
`logs`	Shows last log messages.
`status`	Lists all open trades.
`count`	Displays number of trades used and available.
`locks`	Displays currently locked pairs.
`delete_lock <lock_id>`	Deletes (disables) the lock by id.
`profit`	Display a summary of your profit/loss from close trades and some stats about your performance.
`forcesell <trade_id>`	Instantly sells the given trade (Ignoring `minimum_roi`).
`forcesell all`	Instantly sells all open trades (Ignoring `minimum_roi`).
`forcebuy <pair> [rate]`	Instantly buys the given pair. Rate is optional. (`forcebuy_enable` must be set to True)
`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 (n defaults to 7).
`stats`	Display a summary of profit / loss reasons as well as average holding times.
`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.

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.

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

blacklist Show the current blacklist.

    :param add: List of coins to add (example: "BNB/BTC")

count Return the amount of open trades.

daily Return the amount of open trades.

delete_lock Delete (disable) lock from the database.

    :param lock_id: ID for the lock to delete

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 Return information about edge.

forcebuy Buy an asset.

    :param pair: Pair to buy (ETH/BTC)
    :param price: Optional - price to buy

forcesell Force-sell a trade.

    :param tradeid: Id of the trade (can be received via status command)

locks Return current locks

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 .

    :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 Return the performance of the different coins.

plot_config Return plot configuration if the strategy defines one.

profit Return the profit summary.

reload_config Reload configuration.

show_config

    Returns part of the configuration, relevant for trading operations.

start Start the bot if it's in the stopped state.

stats Return the stats report (durations, sell-reasons).

status Get the status of open trades.

stop Stop the bot. Use start to restart.

stopbuy Stop buying (but handle sells gracefully). Use reload_config to reset.

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 Return the version of the bot.

whitelist Show the current whitelist.

```

OpenAPI interface¶

To enable the builtin openAPI interface (Swagger UI), specify "enable_openapi": true in the api_server configuration. This will enable the Swagger UI at the /docs endpoint. By default, that's running at http://localhost:8080/docs/ - but it'll depend on your settings.

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"

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 front-ends are subject to 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.