Update documentation for historical klines

Sam McHardy · Sam McHardy · commit 4e426a7a1ca5 · 2018-01-09T16:51:16.000+11:00
diff --git a/PYPIREADME.rst b/PYPIREADME.rst
@@ -44,6 +44,7 @@ Features
 - Response exception handling
 - Websocket handling with reconnection and multiplexed connections
 - Symbol Depth Cache
+- Historical Kline/Candle fetching function
 - Withdraw functionality
 - Deposit addresses
 
@@ -112,6 +113,18 @@ Quick Start
     bm.start_aggtrade_socket('BNBBTC', process_message)
     bm.start()
 
+    # get historical kline data from any date range
+
+    # fetch 1 minute klines for the last day up until now
+    klines = client.get_historical_klines("BNBBTC", Client.KLINE_INTERVAL_1MINUTE, "1 day ago UTC"))
+
+    # fetch 30 minute klines for the last month of 2017
+    klines = client.get_historical_klines("ETHBTC", Client.KLINE_INTERVAL_30MINUTE, "1 Dec, 2017", "1 Jan, 2018"))
+
+    # fetch weekly klines since it listed
+    klines = client.get_historical_klines("NEOBTC", KLINE_INTERVAL_1WEEK, "1 Jan, 2017"))
+
+
 For more `check out the documentation <https://python-binance.readthedocs.io/en/latest/>`_.
 
 Donate
diff --git a/README.rst b/README.rst
@@ -44,6 +44,7 @@ Features
 - Response exception handling
 - Websocket handling with reconnection and multiplexed connections
 - Symbol Depth Cache
+- Historical Kline/Candle fetching function
 - Withdraw functionality
 - Deposit addresses
 
@@ -112,6 +113,17 @@ Quick Start
     bm.start_aggtrade_socket('BNBBTC', process_message)
     bm.start()
 
+    # get historical kline data from any date range
+
+    # fetch 1 minute klines for the last day up until now
+    klines = client.get_historical_klines("BNBBTC", Client.KLINE_INTERVAL_1MINUTE, "1 day ago UTC"))
+
+    # fetch 30 minute klines for the last month of 2017
+    klines = client.get_historical_klines("ETHBTC", Client.KLINE_INTERVAL_30MINUTE, "1 Dec, 2017", "1 Jan, 2018"))
+
+    # fetch weekly klines since it listed
+    klines = client.get_historical_klines("NEOBTC", KLINE_INTERVAL_1WEEK, "1 Jan, 2017"))
+
 For more `check out the documentation <https://python-binance.readthedocs.io/en/latest/>`_.
 
 Donate
diff --git a/docs/market_data.rst b/docs/market_data.rst
@@ -36,8 +36,23 @@ Market Data Endpoints
 
 .. code:: python
 
-    from binance.enums import *
-    candles = client.get_klines(symbol='BNBBTC', interval=KLINE_INTERVAL_30MINUTE)
+    candles = client.get_klines(symbol='BNBBTC', interval=Client.KLINE_INTERVAL_30MINUTE)
+
+`Get Historical Kline/Candlesticks <binance.html#binance.client.Client.get_historical_klines>`_
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Fetch klines for any date range and interval
+
+.. code:: python
+
+    # fetch 1 minute klines for the last day up until now
+    klines = client.get_historical_klines("BNBBTC", Client.KLINE_INTERVAL_1MINUTE, "1 day ago UTC"))
+
+    # fetch 30 minute klines for the last month of 2017
+    klines = client.get_historical_klines("ETHBTC", Client.KLINE_INTERVAL_30MINUTE, "1 Dec, 2017", "1 Jan, 2018"))
+
+    # fetch weekly klines since it listed
+    klines = client.get_historical_klines("NEOBTC", KLINE_INTERVAL_1WEEK, "1 Jan, 2017"))
 
 `Get 24hr Ticker <binance.html#binance.client.Client.get_ticker>`_
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
