Merge pull request sammchardy#114 from sujitnair/miniticker_socket

Sam McHardy · web-flow · commit 7d19a88e3c19 · 2018-01-17T13:29:52.000+11:00
Add support for miniticker websocket
diff --git a/binance/websockets.py b/binance/websockets.py
@@ -212,6 +212,38 @@ def start_kline_socket(self, symbol, callback, interval=Client.KLINE_INTERVAL_1M
         socket_name = '{}@kline_{}'.format(symbol.lower(), interval)
         return self._start_socket(socket_name, callback)
 
+    def start_miniticker_socket(self, callback):
+        """Start a miniticker websocket for all trades
+
+        This is not in the official Binance api docs, but this is what
+        feeds the right column on a ticker page on Binance.
+
+        :param callback: callback function to handle messages
+        :type callback: function
+
+        :returns: connection key string if successful, False otherwise
+
+        Message Format
+
+        .. code-block:: python
+
+            [
+                {
+                    'e': '24hrMiniTicker',  # Event type
+                    'E': 1515906156273,     # Event time
+                    's': 'QTUMETH',         # Symbol
+                    'c': '0.03836900',      # close
+                    'o': '0.03953500',      # open
+                    'h': '0.04400000',      # high
+                    'l': '0.03756000',      # low
+                    'v': '147435.80000000', # volume
+                    'q': '5903.84338533'    # quote volume
+                }
+            ]
+        """
+
+        return self._start_socket('!miniTicker@arr@3000ms', callback)
+
     def start_trade_socket(self, symbol, callback):
         """Start a websocket for symbol trade data
 
