Release v1.16.0 (#164)

Author: chairz

CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## 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.
+
+### 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`
+  - 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`
+
 ## 1.15.0 - 2022-07-19
 
 ### Added

binance/__version__.py

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

binance/spot/__init__.py

@@ -273,3 +273,6 @@ def __init__(self, key=None, secret=None, **kwargs):
 
     # Portfolio Margin
     from binance.spot.portfolio_margin import portfolio_margin_account
+    from binance.spot.portfolio_margin import portfolio_margin_collateral_rate
+    from binance.spot.portfolio_margin import portfolio_margin_bankruptcy_loan_amount
+    from binance.spot.portfolio_margin import portfolio_margin_bankruptcy_loan_repay

binance/spot/portfolio_margin.py

@@ -10,3 +10,58 @@ def portfolio_margin_account(self, **kwargs):
     """
 
     return self.sign_request("GET", "/sapi/v1/portfolio/account", {**kwargs})
+
+
+def portfolio_margin_collateral_rate(self):
+    """Portfolio Margin Collateral Rate (MARKET_DATA)
+
+    Portfolio Margin Collateral Rate.
+
+    Weight(IP): 50
+
+    GET /sapi/v1/portfolio/collateralRate
+
+    https://binance-docs.github.io/apidocs/spot/en/#portfolio-margin-collateral-rate-market_data
+
+    """
+
+    url_path = "/sapi/v1/portfolio/collateralRate"
+    return self.sign_request("GET", url_path)
+
+
+def portfolio_margin_bankruptcy_loan_amount(self, **kwargs):
+    """Query Portfolio Margin Bankruptcy Loan Amount (USER_DATA)
+
+    Query Portfolio Margin Bankruptcy Loan Amount.
+
+    Weight(UID): 500
+
+    GET /sapi/v1/portfolio/pmLoan
+
+    https://binance-docs.github.io/apidocs/spot/en/#query-portfolio-margin-bankruptcy-loan-amount-user_data
+
+    Keyword Args:
+        recvWindow (int, optional): The value cannot be greater than 60000
+    """
+
+    url_path = "/sapi/v1/portfolio/pmLoan"
+    return self.sign_request("GET", url_path, {**kwargs})
+
+
+def portfolio_margin_bankruptcy_loan_repay(self, **kwargs):
+    """Portfolio Margin Bankruptcy Loan Repay (USER_DATA)
+
+    Repay Portfolio Margin Bankruptcy Loan.
+
+    Weight(UID): 3000
+
+    POST /sapi/v1/portfolio/repay
+
+    https://binance-docs.github.io/apidocs/spot/en/#portfolio-margin-bankruptcy-loan-repay-user_data
+
+    Keyword Args:
+        recvWindow (int, optional): The value cannot be greater than 60000
+    """
+
+    url_path = "/sapi/v1/portfolio/repay"
+    return self.sign_request("POST", url_path, {**kwargs})

binance/spot/savings.py

@@ -163,24 +163,21 @@ def savings_purchase_project(self, projectId: str, lot: int, **kwargs):
     )
 
 
-def savings_project_position(self, asset: str, **kwargs):
+def savings_project_position(self, **kwargs):
     """Get Fixed/Activity Project Position  (USER_DATA)
 
     GET /sapi/v1/lending/project/position/list
 
     https://binance-docs.github.io/apidocs/spot/en/#get-fixed-activity-project-position-user_data
 
-    Args:
-        asset (str)
     Keyword Args:
+        asset (str, optional)
         projectId (str, optional)
         status (str, optional): "HOLDING", "REDEEMED"
         recvWindow (int, optional): The value cannot be greater than 60000
     """
 
-    check_required_parameter(asset, "asset")
-    payload = {"asset": asset, **kwargs}
-    return self.sign_request("GET", "/sapi/v1/lending/project/position/list", payload)
+    return self.sign_request("GET", "/sapi/v1/lending/project/position/list", kwargs)
 
 
 def savings_account(self, **kwargs):

binance/spot/trade.py

@@ -53,6 +53,8 @@ def new_order(self, symbol: str, side: str, type: str, **kwargs):
         quoteOrderQty (float, optional)
         price (float, optional)
         newClientOrderId (str, optional): A unique id among open orders. Automatically generated if not sent.
+        strategyId (int, optional)
+        strategyType (int, optional): The value cannot be less than 1000000.
         stopPrice (float, optional): Used with STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, and TAKE_PROFIT_LIMIT orders.
         icebergQty (float, optional): Used with LIMIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT to create an iceberg order.
         newOrderRespType (str, optional): Set the response JSON. ACK, RESULT, or FULL;
@@ -166,6 +168,8 @@ def cancel_and_replace(
         cancelOrigClientOrderId (str, optional): Either the cancelOrigClientOrderId or cancelOrderId must be provided. If both are provided, cancelOrderId takes precedence.
         cancelOrderId (int, optional): Either the cancelOrigClientOrderId or cancelOrderId must be provided. If both are provided, cancelOrderId takes precedence.
         newClientOrderId (str, optional): Used to identify the new order. Automatically generated by default
+        strategyId (int, optional)
+        strategyType (int, optional): The value cannot be less than 1000000.
         stopPrice (float, optional): Used with STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, and TAKE_PROFIT_LIMIT orders.
         trailingDelta (float, optional): Used with STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, and TAKE_PROFIT_LIMIT orders.
         icebergQty (float, optional): Used with LIMIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT to create an iceberg order.
@@ -263,8 +267,12 @@ def new_oco_order(
     Keyword Args:
         listClientOrderId (str, optional): A unique Id for the entire orderList
         limitClientOrderId (str, optional)
+        limitStrategyId (int, optional)
+        limitStrategyType (int, optional): The value cannot be less than 1000000.
         limitIcebergQty (float, optional)
         stopClientOrderId (str, optional)
+        stopStrategyId (int, optional)
+        stopStrategyType (int, optional): The value cannot be less than 1000000.
         stopLimitPrice (float, optional)
         stopIcebergQty (float, optional)
         stopLimitTimeInForce (str, optional)

docs/source/CHANGELOG.rst

@@ -2,6 +2,60 @@
 Changelog
 =========
 
+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.
+
+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`
+  * 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`
+
+1.15.0 - 2022-07-19
+-------------------
+
+Added
+^^^^^
+
+* New endpoint for Margin:
+
+  * `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.
+
+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`
+
+Update
+^^^^^^
+
+* #146 `savings_flexible_product_position`  `asset` parameter should be optional
+
 
 1.13.0 - 2022-05-23
 -------------------

docs/source/binance.spot.portfolio_margin.rst

@@ -5,3 +5,11 @@ Portfolio Margin Endpoints
 Get Portfolio Margin Account Info (USER_DATA)
 ---------------------------------------------
 .. autofunction:: binance.spot.portfolio_margin.portfolio_margin_account
+
+Query Portfolio Margin Bankruptcy Loan Amount (USER_DATA)
+---------------------------------------------------------
+.. autofunction:: binance.spot.portfolio_margin.portfolio_margin_bankruptcy_loan_amount
+
+Portfolio Margin Bankruptcy Loan Repay (USER_DATA)
+--------------------------------------------------
+.. autofunction:: binance.spot.portfolio_margin.portfolio_margin_bankruptcy_loan_repay

examples/spot/portfolio_margin/portfolio_margin_bankruptcy_loan_amount.py

@@ -0,0 +1,23 @@
+#!/usr/bin/env python
+
+import logging
+from binance.spot import Spot as Client
+from binance.lib.utils import config_logging
+from binance.error import ClientError
+
+config_logging(logging, logging.DEBUG)
+
+key = ""
+secret = ""
+
+client = Client(key, secret)
+
+try:
+    response = client.portfolio_margin_bankruptcy_loan_amount(recvWindow=5000)
+    logging.info(response)
+except ClientError as error:
+    logging.error(
+        "Found error. status: {}, error code: {}, error message: {}".format(
+            error.status_code, error.error_code, error.error_message
+        )
+    )

examples/spot/portfolio_margin/portfolio_margin_bankruptcy_loan_repay.py

@@ -0,0 +1,23 @@
+#!/usr/bin/env python
+
+import logging
+from binance.spot import Spot as Client
+from binance.lib.utils import config_logging
+from binance.error import ClientError
+
+config_logging(logging, logging.DEBUG)
+
+key = ""
+secret = ""
+
+client = Client(key, secret)
+
+try:
+    response = client.portfolio_margin_bankruptcy_loan_repay(recvWindow=5000)
+    logging.info(response)
+except ClientError as error:
+    logging.error(
+        "Found error. status: {}, error code: {}, error message: {}".format(
+            error.status_code, error.error_code, error.error_message
+        )
+    )

examples/spot/portfolio_margin/portfolio_margin_collateral_rate.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+
+import logging
+from binance.spot import Spot as Client
+from binance.lib.utils import config_logging
+from binance.error import ClientError
+
+config_logging(logging, logging.DEBUG)
+
+key = ""
+
+client = Client(key)
+
+try:
+    response = client.portfolio_margin_collateral_rate()
+    logging.info(response)
+except ClientError as error:
+    logging.error(
+        "Found error. status: {}, error code: {}, error message: {}".format(
+            error.status_code, error.error_code, error.error_message
+        )
+    )

examples/spot/savings/savings_project_position.py

@@ -10,4 +10,4 @@
 secret = ""
 
 client = Client(key, secret)
-logging.info(client.savings_project_position(asset="BTC"))
+logging.info(client.savings_project_position())

tests/spot/portfolio_margin/test_portfolio_margin_bankruptcy_loan_amount.py

@@ -0,0 +1,28 @@
+import responses
+
+from binance.spot import Spot as Client
+from tests.util import random_str
+from urllib.parse import urlencode
+from tests.util import mock_http_response
+
+mock_item = {"key_1": "value_1", "key_2": "value_2"}
+mock_exception = {"code": -1, "msg": "error message"}
+
+key = random_str()
+secret = random_str()
+
+params = {"recvWindow": 5000}
+
+
+@mock_http_response(
+    responses.GET,
+    "/sapi/v1/portfolio/pmLoan\\?" + urlencode(params),
+    mock_item,
+    200,
+)
+def test_portfolio_margin_bankruptcy_loan_amount():
+    """Tests the API endpoint to portfolio margin bankruptcy loan amount"""
+
+    client = Client(key, secret)
+    response = client.portfolio_margin_bankruptcy_loan_amount(**params)
+    response.should.equal(mock_item)

tests/spot/portfolio_margin/test_portfolio_margin_bankruptcy_loan_repay.py

@@ -0,0 +1,28 @@
+import responses
+
+from binance.spot import Spot as Client
+from tests.util import random_str
+from urllib.parse import urlencode
+from tests.util import mock_http_response
+
+mock_item = {"key_1": "value_1", "key_2": "value_2"}
+mock_exception = {"code": -1, "msg": "error message"}
+
+key = random_str()
+secret = random_str()
+
+params = {"recvWindow": 5000}
+
+
+@mock_http_response(
+    responses.POST,
+    "/sapi/v1/portfolio/repay\\?" + urlencode(params),
+    mock_item,
+    200,
+)
+def test_portfolio_margin_bankruptcy_loan_repay():
+    """Tests the API endpoint to portfolio margin bankruptcy loan repay"""
+
+    client = Client(key, secret)
+    response = client.portfolio_margin_bankruptcy_loan_repay(**params)
+    response.should.equal(mock_item)

tests/spot/portfolio_margin/test_portfolio_margin_collateral_rate.py

@@ -0,0 +1,25 @@
+import responses
+
+from binance.spot import Spot as Client
+from tests.util import random_str
+from tests.util import mock_http_response
+
+mock_item = {"key_1": "value_1", "key_2": "value_2"}
+mock_exception = {"code": -1, "msg": "error message"}
+
+key = random_str()
+secret = random_str()
+
+
+@mock_http_response(
+    responses.GET,
+    "/sapi/v1/portfolio/collateralRate",
+    mock_item,
+    200,
+)
+def test_portfolio_margin_collateral_rate():
+    """Tests the API endpoint to portfolio margin collateral rate"""
+
+    client = Client(key, secret)
+    response = client.portfolio_margin_collateral_rate()
+    response.should.equal(mock_item)