Merge pull request #84 from gcarq/telegram/show-balance

Telegram command: /show balance

freqtrade/exchange/__init__.py

@@ -84,6 +84,8 @@ def get_balance(currency: str) -> float:
 
     return EXCHANGE.get_balance(currency)
 
+def get_balances():
+    return EXCHANGE.get_balances()
 
 def get_ticker(pair: str) -> dict:
     return EXCHANGE.get_ticker(pair)

freqtrade/exchange/bittrex.py

@@ -54,6 +54,12 @@ class Bittrex(Exchange):
             raise RuntimeError('{}: {}'.format(self.name.upper(), data['message']))
         return float(data['result']['Balance'] or 0.0)
 
+    def get_balances(self):
+        data = _API.get_balances()
+        if not data['success']:
+            raise RuntimeError('{}: {}'.format(self.name.upper(), data['message']))
+        return data['result']
+    
     def get_ticker(self, pair: str) -> dict:
         data = _API.get_ticker(pair.replace('_', '-'))
         if not data['success']:

freqtrade/exchange/interface.py

@@ -49,6 +49,21 @@ class Exchange(ABC):
         :return: float
         """
 
+    @abstractmethod
+    def get_balances(self) -> List[dict]:
+        """
+        Gets account balances across currencies
+        :return: List of dicts, format: [
+          {
+            'Currency': str,
+            'Balance': float,
+            'Available': float,
+            'Pending': float,
+          }
+          ...
+        ]
+        """
+
     @abstractmethod
     def get_ticker(self, pair: str) -> dict:
         """

freqtrade/rpc/telegram.py

@@ -41,6 +41,7 @@ def init(config: dict) -> None:
     handles = [
         CommandHandler('status', _status),
         CommandHandler('profit', _profit),
+        CommandHandler('balance', _balance),
         CommandHandler('start', _start),
         CommandHandler('stop', _stop),
         CommandHandler('forcesell', _forcesell),
@@ -201,6 +202,25 @@ def _profit(bot: Bot, update: Update) -> None:
     )
     send_msg(markdown_msg, bot=bot)
 
+@authorized_only
+def _balance(bot: Bot, update: Update) -> None:
+    """
+    Hander for /balance
+    Returns current account balance per crypto
+    """
+    output = ""
+
+    balances = exchange.get_balances()
+
+    for currency in balances:
+        output += """*Currency*: {Currency}
+*Available*: {Available}
+*Balance*: {Balance}
+*Pending*: {Pending}
+
+""".format(**currency)
+
+    send_msg(output)
 
 @authorized_only
 def _start(bot: Bot, update: Update) -> None:
@@ -326,6 +346,7 @@ def _help(bot: Bot, update: Update) -> None:
 */profit:* `Lists cumulative profit from all finished trades`
 */forcesell <trade_id>:* `Instantly sells the given trade, regardless of profit`
 */performance:* `Show performance of each finished trade grouped by pair`
+*/balance:* `Show account balance per currency`
 */help:* `This help message`
     """
     send_msg(message, bot=bot)

freqtrade/tests/test_telegram.py

@@ -9,7 +9,7 @@ from telegram import Bot, Update, Message, Chat
 from freqtrade.main import init, create_trade
 from freqtrade.misc import update_state, State, get_state, CONF_SCHEMA
 from freqtrade.persistence import Trade
-from freqtrade.rpc.telegram import _status, _profit, _forcesell, _performance, _start, _stop
+from freqtrade.rpc.telegram import _status, _profit, _forcesell, _performance, _start, _stop, _balance
 
 
 @pytest.fixture
@@ -197,3 +197,21 @@ def test_stop_handle(conf, update, mocker):
     assert get_state() == State.STOPPED
     assert msg_mock.call_count == 1
     assert 'Stopping trader' in msg_mock.call_args_list[0][0][0]
+
+def test_balance_handle(conf, update, mocker):
+    mock_balance = [{
+        'Currency': 'BTC',
+        'Balance': 10.0,
+        'Available': 12.0,
+        'Pending': 0.0,
+        'CryptoAddress': 'XXXX'}]
+    mocker.patch.dict('freqtrade.main._CONF', conf)
+    msg_mock = MagicMock()
+    mocker.patch.multiple('freqtrade.main.telegram', _CONF=conf, init=MagicMock(), send_msg=msg_mock)
+    mocker.patch.multiple('freqtrade.main.exchange',
+                          get_balances=MagicMock(return_value=mock_balance))
+
+    _balance(bot=MagicBot(), update=update)
+    assert msg_mock.call_count == 1
+    assert '*Currency*: BTC' in msg_mock.call_args_list[0][0][0]
+    assert 'Balance' in msg_mock.call_args_list[0][0][0]