From 759bbd8e72fb72507669b1c67671eb3c67a95c64 Mon Sep 17 00:00:00 2001 From: Matthias Date: Tue, 20 Apr 2021 21:23:37 +0200 Subject: [PATCH] Update documentation about pagination --- docs/rest-api.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/rest-api.md b/docs/rest-api.md index 5c25e9eeb..514e0f719 100644 --- a/docs/rest-api.md +++ b/docs/rest-api.md @@ -124,7 +124,7 @@ python3 scripts/rest_client.py --config rest_config.json [optional par | `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. +| `trades` | List last trades. Limited to 500 trades per call. | `trade/` | Get specific trade. | `delete_trade ` | 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. @@ -280,9 +280,10 @@ trade :param trade_id: Specify which trade to get. trades - Return trades history. + Return trades history, sorted by id - :param limit: Limits trades to the X last trades. No limit to get all the trades. + :param limit: Limits trades to the X last trades. Max 500 trades. + :param offset: Offset by this amount of trades. version Return the version of the bot. @@ -290,6 +291,7 @@ version whitelist Show the current whitelist. + ``` ### OpenAPI interface