From a3d0889dab7314b902507f68782fba37cf7c9845 Mon Sep 17 00:00:00 2001 From: Matthias Date: Sun, 13 Sep 2020 20:09:54 +0200 Subject: [PATCH] Add alpha to endpoint documentation --- docs/rest-api.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/rest-api.md b/docs/rest-api.md index 73a7b9c89..b832b8b0c 100644 --- a/docs/rest-api.md +++ b/docs/rest-api.md @@ -129,13 +129,16 @@ python3 scripts/rest_client.py --config rest_config.json [optional par | `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. -| `pair_history` | Returns an analyzed dataframe for a given timerange, analyzed by a given strategy. -| `plot_config` | Get plot config from the strategy (or nothing if not configured). -| `strategies` | List strategies in strategy directory. -| `available_pairs` | List available backtest data. +| `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** +| `available_pairs` | List available backtest data. **Alpha** | `version` | Show version +!!! Warning "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