diff --git a/docs/rest-api.md b/docs/rest-api.md index b958c0927..10e4534c0 100644 --- a/docs/rest-api.md +++ b/docs/rest-api.md @@ -302,6 +302,19 @@ trades :param limit: Limits trades to the X last trades. Max 500 trades. :param offset: Offset by this amount of trades. +list_open_trades_custom_data + Return a dict containing open trades custom-datas + + :param key: str, optional - Key of the custom-data + :param limit: Limits trades to X trades. + :param offset: Offset by this amount of trades. + +list_custom_data + Return a dict containing custom-datas of a specified trade + + :param trade_id: int - ID of the trade + :param key: str, optional - Key of the custom-data + version Return the version of the bot. diff --git a/ft_client/freqtrade_client/ft_rest_client.py b/ft_client/freqtrade_client/ft_rest_client.py index 799a28959..0460bec29 100755 --- a/ft_client/freqtrade_client/ft_rest_client.py +++ b/ft_client/freqtrade_client/ft_rest_client.py @@ -272,10 +272,9 @@ class FtRestClient: def list_open_trades_custom_data(self, key=None, limit=100, offset=0): """List open trades custom_data of the running bot. - :param key: Optional keyword argument - key of the custom-data + :param key: str, optional - Key of the custom-data :param limit: limit of trades :param offset: trades offset for pagination - :return: json object """ params = {} @@ -287,12 +286,11 @@ class FtRestClient: return self._get("trades/open/custom_data", params=params) def list_custom_data(self, trade_id, key=None): - """List custom_data of the running bot for specific trade. + """List custom_data of the running bot for a specific trade. - :param tradeid: keyword argument - Id of the trade - :param key: Optional keyword argument - key of the custom-data - - :return: json object + :param trade_id: int - ID of the trade + :param key: str, optional - Key of the custom-data + :return: JSON object """ params = {} params["trade_id"] = trade_id