Release v1.17.0 (#165)

* 1.17.0

Author: chairz-2

.github/workflows/pythonpackage.yml

@@ -26,6 +26,10 @@ jobs:
       uses: actions/setup-python@v1
       with:
         python-version: ${{ matrix.python-version }}
+    - uses: actions/cache@v3
+      with:
+        path: ~/.cache/pip
+        key: ${{ hashFiles('requirements/requirements-test.txt') }}
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 1.17.0 - 2022-09-05
+
+### Added
+- New endpoint for Market:
+  - `GET /api/v3/uiKlines`
+- New kline interval: `1s`
+
+### Changed
+- Changes to `GET /api/v3/ticker` and `GET /api/v3/ticker/24hr`
+  - New optional parameter type added
+  - Supported values for parameter type are `FULL` and `MINI`
+    - `FULL` is the default value and the response that is currently being returned from the endpoint
+    - `MINI` omits the following fields from the response: `priceChangePercent`, `weightedAvgPrice`, `bidPrice`, `bidQty`, `askPrice`, `askQty`, and `lastQty`
+
 ## 1.16.0 - 2022-08-11
 
 ### Added

binance/__version__.py

@@ -1 +1 @@
-__version__ = "1.16.0"
+__version__ = "1.17.0"

binance/spot/__init__.py

@@ -16,6 +16,7 @@ def __init__(self, key=None, secret=None, **kwargs):
     from binance.spot.market import historical_trades
     from binance.spot.market import agg_trades
     from binance.spot.market import klines
+    from binance.spot.market import ui_klines
     from binance.spot.market import avg_price
     from binance.spot.market import ticker_24hr
     from binance.spot.market import ticker_price

binance/spot/market.py

@@ -141,7 +141,7 @@ def klines(self, symbol: str, interval: str, **kwargs):
 
     Args:
         symbol (str): the trading pair
-        interval (str): the interval of kline, e.g 1m, 5m, 1h, 1d, etc.
+        interval (str): the interval of kline, e.g 1s, 1m, 5m, 1h, 1d, etc.
     Keyword Args:
         limit (int, optional): limit the results. Default 500; max 1000.
         startTime (int, optional): Timestamp in ms to get aggregate trades from INCLUSIVE.
@@ -153,6 +153,27 @@ def klines(self, symbol: str, interval: str, **kwargs):
     return self.query("/api/v3/klines", params)
 
 
+def ui_klines(self, symbol: str, interval: str, **kwargs):
+    """Kline/Candlestick Data
+
+    GET /api/v3/uiKlines
+
+    https://binance-docs.github.io/apidocs/spot/en/#uiklines
+
+    Args:
+        symbol (str): the trading pair
+        interval (str): the interval of kline, e.g 1s, 1m, 5m, 1h, 1d, etc.
+    Keyword Args:
+        limit (int, optional): limit the results. Default 500; max 1000.
+        startTime (int, optional): Timestamp in ms to get aggregate trades from INCLUSIVE.
+        endTime (int, optional): Timestamp in ms to get aggregate trades until INCLUSIVE.
+    """
+    check_required_parameters([[symbol, "symbol"], [interval, "interval"]])
+
+    params = {"symbol": symbol, "interval": interval, **kwargs}
+    return self.query("/api/v3/uiKlines", params)
+
+
 def avg_price(self, symbol: str):
     """Current Average Price
 
@@ -171,7 +192,7 @@ def avg_price(self, symbol: str):
     return self.query("/api/v3/avgPrice", params)
 
 
-def ticker_24hr(self, symbol: str = None, symbols: list = None):
+def ticker_24hr(self, symbol: str = None, symbols: list = None, **kwargs):
     """24hr Ticker Price Change Statistics
 
     GET /api/v3/ticker/24hr
@@ -186,7 +207,11 @@ def ticker_24hr(self, symbol: str = None, symbols: list = None):
     if symbol and symbols:
         raise ParameterArgumentError("symbol and symbols cannot be sent together.")
     check_type_parameter(symbols, "symbols", list)
-    params = {"symbol": symbol, "symbols": convert_list_to_json_array(symbols)}
+    params = {
+        "symbol": symbol,
+        "symbols": convert_list_to_json_array(symbols),
+        **kwargs,
+    }
     return self.query("/api/v3/ticker/24hr", params)
 
 

docs/source/CHANGELOG.rst

@@ -2,29 +2,49 @@
 Changelog
 =========
 
+1.17.0 - 2022-09-05
+-------------------
+
+Added
+^^^^^
+
+* New endpoint for Market:
+    * ``GET /api/v3/uiKlines``
+
+* New kline interval: ``1s``
+
+Changed
+^^^^^^^
+
+* Changes to ``GET /api/v3/ticker`` and ``GET /api/v3/ticker/24hr``
+    * New optional parameter type added
+    * Supported values for parameter type are ``FULL`` and ``MINI``
+        * ``FULL`` is the default value and the response that is currently being returned from the endpoint
+        * ``MINI`` omits the following fields from the response: ``priceChangePercent``, ``weightedAvgPrice``, ``bidPrice``, ``bidQty``, ``askPrice``, ``askQty``, and ``lastQty``
+
 1.16.0 - 2022-08-11
 -------------------
 
 Added
 ^^^^^
 
 * New endpoint for Portfolio Margin:
-  * `GET /sapi/v1/portfolio/pmLoan` to query Portfolio Margin Bankruptcy Loan Record.
-  * `POST /sapi/v1/portfolio/repay` to repay Portfolio Margin Bankruptcy Loan.
-  * `GET /sapi/v1/portfolio/collateralRate` to get Portfolio Margin Collateral Rate.
+  * ``GET /sapi/v1/portfolio/pmLoan`` to query Portfolio Margin Bankruptcy Loan Record.
+  * ``POST /sapi/v1/portfolio/repay`` to repay Portfolio Margin Bankruptcy Loan.
+  * ``GET /sapi/v1/portfolio/collateralRate`` to get Portfolio Margin Collateral Rate.
 
 Update
 ^^^^^^
 
-* Changes to `POST /api/v3/order` and `POST /api/v3/order/cancelReplace`
-  * New optional field `strategyId` is a parameter used to identify an order as part of a strategy.
-  * New optional field `strategyType` is a parameter used to identify what strategy was running. (E.g. If all the orders are part of spot grid strategy, it can be set to strategyType=1000000)
-  * Note: `strategyType` cannot be less than 1000000.
-* Changes to `POST /api/v3/order/oco`
-  * New optional fields `limitStrategyId`, `limitStrategyType`, `stopStrategyId`, `stopStrategyType`
+* Changes to ``POST /api/v3/order`` and ``POST /api/v3/order/cancelReplace``
+  * New optional field ``strategyId`` is a parameter used to identify an order as part of a strategy.
+  * New optional field ``strategyType`` is a parameter used to identify what strategy was running. (E.g. If all the orders are part of spot grid strategy, it can be set to strategyType=1000000)
+  * Note: ``strategyType`` cannot be less than 1000000.
+* Changes to ``POST /api/v3/order/oco``
+  * New optional fields ``limitStrategyId``, ``limitStrategyType``, ``stopStrategyId``, ``stopStrategyType``
   * These are the strategy metadata parameters for both legs of the OCO orders.
-  * `limitStrategyType` and `stopStrategyType` both cannot be less than 1000000.
-* `asset` is no longer mandatory in `GET /sapi/v1/lending/project/position/list`
+  * ``limitStrategyType`` and ``stopStrategyType`` both cannot be less than 1000000.
+* ``asset`` is no longer mandatory in ``GET /sapi/v1/lending/project/position/list``
 
 1.15.0 - 2022-07-19
 -------------------
@@ -34,27 +54,27 @@ Added
 
 * New endpoint for Margin:
 
-  * `POST /sapi/v3/asset/getUserAsset` to get user assets.
+  * ``POST /sapi/v3/asset/getUserAsset`` to get user assets.
 
 * New endpoint for Wallet:
 
-  * `GET /sapi/v1/margin/dribblet` to query the historical information of user's margin account small-value asset conversion BNB.
+  * ``GET /sapi/v1/margin/dribblet`` to query the historical information of user's margin account small-value asset conversion BNB.
 
 1.14.0 - 2022-07-04
 -------------------
 
 Added
 ^^^^^
 
-* New endpoint `GET /api/v3/ticker`
-* New endpoint `POST /api/v3/order/cancelReplace`
-* New websocket stream `<symbol>@ticker_<window_size>`
-* New websocket stream `!ticker_<window-size>@arr`
+* New endpoint ``GET /api/v3/ticker``
+* New endpoint ``POST /api/v3/order/cancelReplace``
+* New websocket stream ``<symbol>@ticker_<window_size>``
+* New websocket stream ``!ticker_<window-size>@arr``
 
 Update
 ^^^^^^
 
-* #146 `savings_flexible_product_position`  `asset` parameter should be optional
+* #146 ``savings_flexible_product_position``  ``asset`` parameter should be optional
 
 
 1.13.0 - 2022-05-23

docs/source/binance.spot.market.rst

@@ -33,6 +33,10 @@ Kline/Candlestick Data
 ----------------------
 .. autofunction:: binance.spot.market.klines
 
+UIKlines
+--------
+.. autofunction:: binance.spot.market.ui_klines
+
 Current Average Price
 ---------------------
 .. autofunction:: binance.spot.market.avg_price

examples/spot/market/rolling_window_ticker.py

@@ -11,7 +11,7 @@
 client = Client()
 
 try:
-    response = client.rolling_window_ticker("BNBUSDT", windowSize="1d")
+    response = client.rolling_window_ticker("BNBUSDT", windowSize="1d", type="MINI")
     logging.info(response)
 except ClientError as error:
     logging.error(

examples/spot/market/ticker_24hr.py

@@ -8,5 +8,7 @@
 
 spot_client = Client(base_url="https://testnet.binance.vision")
 
-logging.info(spot_client.ticker_24hr("BTCUSDT"))
-logging.info(spot_client.ticker_24hr(symbols=["BTCUSDT", "BNBUSDT"]))
+logging.info(spot_client.ticker_24hr("BTCUSDT", symbols=None, type="MINI"))
+logging.info(
+    spot_client.ticker_24hr(symbol=None, symbols=["BTCUSDT", "BNBUSDT"], type="FULL")
+)

examples/spot/market/ui_klines.py

@@ -0,0 +1,12 @@
+#!/usr/bin/env python
+
+import logging
+from binance.spot import Spot as Client
+from binance.lib.utils import config_logging
+
+config_logging(logging, logging.DEBUG)
+
+spot_client = Client(base_url="https://testnet.binance.vision")
+
+logging.info(spot_client.ui_klines("BTCUSDT", "1m"))
+logging.info(spot_client.ui_klines("BTCUSDT", "1h", limit=10))

tests/spot/market/test_rolling_window_ticker.py

@@ -54,13 +54,15 @@ def test_rolling_window_ticker_with_double_parameter():
 
 @mock_http_response(
     responses.GET,
-    "/api/v3/ticker\\?symbol=BTCUSDT&windowSize=" + str(windowSize),
+    "/api/v3/ticker\\?symbol=BTCUSDT&windowSize=" + str(windowSize) + "&type=MINI",
     mock_item,
     200,
 )
 def test_rolling_window_ticker_with_given_params():
-    """Tests the API endpoint to get ticker with given parametes"""
+    """Tests the API endpoint to get ticker with given parameters"""
 
     client = Client()
-    response = client.rolling_window_ticker(symbol="BTCUSDT", windowSize=windowSize)
+    response = client.rolling_window_ticker(
+        symbol="BTCUSDT", windowSize=windowSize, type="MINI"
+    )
     response.should.equal(mock_item)

tests/spot/market/test_ticker_24hr.py

@@ -58,3 +58,17 @@ def test_avg_price_with_double_parameter():
     api.ticker_24hr.when.called_with(symbol=symbol, symbols=symbols).should.throw(
         ParameterArgumentError
     )
+
+
+@mock_http_response(
+    responses.GET,
+    "/api/v3/ticker/24hr\\?symbol=BTCUSDT&type=MINI",
+    mock_item,
+    200,
+)
+def test_rolling_window_ticker_with_given_params():
+    """Tests the API endpoint to get ticker with given parameters"""
+
+    api = Client()
+    response = api.ticker_24hr(symbol="BTCUSDT", symbols=None, type="MINI")
+    response.should.equal(mock_item)

tests/spot/market/test_ui_klines.py

@@ -0,0 +1,58 @@
+import responses
+
+from binance.spot import Spot as Client
+
+from tests.util import mock_http_response
+from tests.util import random_id
+from tests.util import timestamp
+from binance.error import ParameterRequiredError
+
+mock_item = {"key_1": "value_1", "key_2": "value_2"}
+fromId = random_id()
+startTime = timestamp()
+endTime = startTime + random_id()
+client = Client()
+
+
+def test_kline_without_symbol():
+    """Tests the API endpoint to get uikline without symbol"""
+
+    client.ui_klines.when.called_with(symbol="", interval="1m").should.throw(
+        ParameterRequiredError
+    )
+
+
+def test_kline_without_interval():
+    """Tests the API endpoint to get kline without interval"""
+
+    client.ui_klines.when.called_with(symbol="BTCUSDT", interval="").should.throw(
+        ParameterRequiredError
+    )
+
+
+@mock_http_response(
+    responses.GET, "/api/v3/uiKlines\\?symbol=BTCUSDT&interval=1h", mock_item, 200
+)
+def test_kline_with_default_limit():
+    """Tests the API endpoint to get kline with default limit"""
+
+    response = client.ui_klines(symbol="BTCUSDT", interval="1h")
+    response.should.equal(mock_item)
+
+
+@mock_http_response(
+    responses.GET,
+    "/api/v3/uiKlines\\?symbol=BTCUSDT&interval=1h&limit=10&startTime="
+    + str(startTime)
+    + "&endTime="
+    + str(endTime),
+    mock_item,
+    200,
+)
+def test_kline_with_given_params():
+    """Tests the API endpoint to get kline with given parametes"""
+
+    response = client.ui_klines(
+        symbol="BTCUSDT", interval="1h", limit=10, startTime=startTime, endTime=endTime
+    )
+    response.should.equal(mock_item)