1.10.0 release (#123)

Author: aisling11

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 1.10.0 - 2022-01-11
+
+### Added
+- New endpoint for Mining:
+    - `GET /sapi/v1/mining/payment/uid` to get Mining account earning
+- New endpoint for BSwap:
+    - `GET /sapi/v1/bswap/unclaimedRewards` to get unclaimed rewards record
+    - `POST /sapi/v1/bswap/claimRewards` to claim swap rewards or liquidity rewards
+    - `GET /sapi/v1/bswap/claimedHistory` to get history of claimed rewards
+
+### Removed
+- Transfer types `MAIN_MINING`, `MINING_MAIN`, `MINING_UMFUTURE`, `MARGIN_MINING`, and `MINING_MARGIN` as they are discontinued in Universal Transfer endpoint `POST /sapi/v1/asset/transfer` from January 05, 2022 08:00 AM UTC
+
 ## 1.9.0 - 2021-12-22
 
 ### Added

binance/__version__.py

@@ -1 +1 @@
-__version__ = "1.9.0"
+__version__ = "1.10.0"

binance/lib/enums.py

@@ -10,18 +10,13 @@ class TransferType(AutoName):
     MAIN_UMFUTURE = auto()
     MAIN_CMFUTURE = auto()
     MAIN_MARGIN = auto()
-    MAIN_MINING = auto()
     UMFUTURE_MAIN = auto()
     UMFUTURE_MARGIN = auto()
     CMFUTURE_MAIN = auto()
     CMFUTURE_MARGIN = auto()
     MARGIN_MAIN = auto()
     MARGIN_UMFUTURE = auto()
     MARGIN_CMFUTURE = auto()
-    MARGIN_MINING = auto()
-    MINING_MAIN = auto()
-    MINING_UMFUTURE = auto()
-    MINING_MARGIN = auto()
     ISOLATEDMARGIN_MARGIN = auto()
     MARGIN_ISOLATEDMARGIN = auto()
     ISOLATEDMARGIN_ISOLATEDMARGIN = auto()

binance/spot/__init__.py

@@ -144,6 +144,7 @@ def __init__(self, key=None, secret=None, **kwargs):
     from binance.spot.mining import mining_hashrate_resale_cancellation
     from binance.spot.mining import mining_hashrate_resale_list
     from binance.spot.mining import mining_hashrate_resale_details
+    from binance.spot.mining import mining_account_earning
 
     # SUB-ACCOUNT
     from binance.spot.sub_account import sub_account_create
@@ -219,6 +220,9 @@ def __init__(self, key=None, secret=None, **kwargs):
     from binance.spot.bswap import bswap_pool_configure
     from binance.spot.bswap import bswap_add_liquidity_preview
     from binance.spot.bswap import bswap_remove_liquidity_preview
+    from binance.spot.bswap import bswap_unclaimed_rewards
+    from binance.spot.bswap import bswap_claim_rewards
+    from binance.spot.bswap import bswap_claimed_rewards
 
     # FIAT
     from binance.spot.fiat import fiat_order_history

binance/spot/bswap.py

@@ -277,3 +277,56 @@ def bswap_remove_liquidity_preview(
         **kwargs,
     }
     return self.sign_request("GET", "/sapi/v1/bswap/removeLiquidityPreview", payload)
+
+
+def bswap_unclaimed_rewards(self, **kwargs):
+    """Get Unclaimed Rewards Record (USER_DATA)
+    Get unclaimed rewards record.
+
+    GET /sapi/v1/bswap/unclaimedRewards
+
+    https://binance-docs.github.io/apidocs/spot/en/#get-unclaimed-rewards-record-user_data
+
+    Keyword Args:
+        type (int, optional): 0: Swap rewards,1:Liquidity rewards, default to 0
+        recvWindow (int, optional): The value cannot be greater than 60000
+    """
+
+    return self.sign_request("GET", "/sapi/v1/bswap/unclaimedRewards", kwargs)
+
+
+def bswap_claim_rewards(self, **kwargs):
+    """Claim rewards (TRADE)
+    Claim swap rewards or liquidity rewards
+
+    POST /sapi/v1/bswap/claimRewards
+
+    https://binance-docs.github.io/apidocs/spot/en/#claim-rewards-trade
+
+    Keyword Args:
+        type (int, optional): 0: Swap rewards,1:Liquidity rewards, default to 0
+        recvWindow (int, optional): The value cannot be greater than 60000
+    """
+
+    return self.sign_request("POST", "/sapi/v1/bswap/claimRewards", kwargs)
+
+
+def bswap_claimed_rewards(self, **kwargs):
+    """Get Claimed History (USER_DATA)
+    Get history of claimed rewards.
+
+    GET /sapi/v1/bswap/claimedHistory
+
+    https://binance-docs.github.io/apidocs/spot/en/#get-claimed-history-user_data
+
+    Keyword Args:
+        poolId (int, optional)
+        assetRewards (str, optional)
+        type (int, optional): 0: Swap rewards,1:Liquidity rewards, default to 0
+        startTime (int, optional)
+        endTime (int, optional)
+        limit (int, optional): default 3, max 100
+        recvWindow (int, optional): The value cannot be greater than 60000
+    """
+
+    return self.sign_request("GET", "/sapi/v1/bswap/claimedHistory", kwargs)

binance/spot/margin.py

@@ -636,8 +636,7 @@ def margin_interest_rate_history(self, asset: str, **kwargs):
     Keyword Args:
         vipLevel (str, optional): Default: user's vip level
         startTime (int, optional): Default: 7 days ago.
-        endTime (int, optional): Default: present. Maximum range: 3 months.
-        limit (int, optional): Default: 20. Maximum: 100.
+        endTime (int, optional): Default: present. Maximum range: 1 month.
         recvWindow (int, optional): The value cannot be greater than 60000
     """
 

binance/spot/mining.py

@@ -1,4 +1,5 @@
 from binance.lib.utils import check_required_parameters
+from binance.lib.utils import check_required_parameter
 
 
 def mining_algo_list(self):
@@ -271,3 +272,25 @@ def mining_hashrate_resale_details(self, configId: int, userName: str, **kwargs)
     return self.sign_request(
         "GET", "/sapi/v1/mining/hash-transfer/profit/details", payload
     )
+
+
+def mining_account_earning(self, algo: str, **kwargs):
+    """Mining Account Earning (USER_DATA)
+
+    GET /sapi/v1/mining/payment/uid
+
+    https://binance-docs.github.io/apidocs/spot/en/#mining-account-earning-user_data
+
+    Args:
+        algo (str): Algorithm(sha256)
+    Keyword Args:
+        startDate (int, optional): Millisecond timestamp
+        endDate (int, optional): Millisecond timestamp
+        pageIndex (int, optional): Default 1
+        pageSize (int, optional): Min 10,Max 200
+        recvWindow (int, optional): The value cannot be greater than 60000
+    """
+    check_required_parameter(algo, "algo")
+
+    payload = {"algo": algo, **kwargs}
+    return self.sign_request("GET", "/sapi/v1/mining/payment/uid", payload)

binance/spot/sub_account.py

@@ -436,6 +436,7 @@ def sub_account_universal_transfer(
     Keyword Args:
         fromEmail (str, optional)
         toEmail (str, optional)
+        clientTranId (str, optional): Must be unique
         recvWindow (int, optional): The value cannot be greater than 60000
     """
     check_required_parameters(
@@ -473,6 +474,7 @@ def sub_account_universal_transfer_history(self, **kwargs):
     Keyword Args:
         fromEmail (str, optional)
         toEmail (str, optional)
+        clientTranId (str, optional)
         startTime (int, optional)
         endTime (int, optional)
         page (int, optional)

docs/source/CHANGELOG.rst

@@ -2,21 +2,52 @@
 Changelog
 =========
 
+1.10.0 - 2022-01-11
+-------------------
+
+Added
+^^^^^
+
+
+* New endpoint for Mining:
+
+  * ``GET /sapi/v1/mining/payment/uid`` to get Mining account earning
+
+* New endpoint for BSwap:
+
+  * ``GET /sapi/v1/bswap/unclaimedRewards`` to get unclaimed rewards record
+  * ``POST /sapi/v1/bswap/claimRewards`` to claim swap rewards or liquidity rewards
+  * ``GET /sapi/v1/bswap/claimedHistory`` to get history of claimed rewards
+
+Removed
+^^^^^^^
+
+
+* Transfer types ``MAIN_MINING``\ , ``MINING_MAIN``\ , ``MINING_UMFUTURE``\ , ``MARGIN_MINING``\ , and ``MINING_MARGIN`` as they are discontinued in Universal Transfer endpoint ``POST /sapi/v1/asset/transfer`` from January 05, 2022 08:00 AM UTC
 
 1.9.0 - 2021-12-22
 ------------------
 
 Added
 ^^^^^
+
+
 * New endpoint for Convert:
-  * ``GET /sapi/v1/convert/tradeFlow`` to support user query convert trade history records* New endpoint for Rebate:
+
+  * ``GET /sapi/v1/convert/tradeFlow`` to support user query convert trade history records
+
 * New endpoint for Rebate:
+
   * ``GET /sapi/v1/rebate/taxQuery`` to support user query spot rebate history records
+
 * New endpoints for Margin:
+
   * ``GET /sapi/v1/margin/crossMarginData`` to get cross margin fee data collection
   * ``GET /sapi/v1/margin/isolatedMarginData`` to get isolated margin fee data collection
   * ``GET /sapi/v1/margin/isolatedMarginTier`` to get isolated margin tier data collection
+
 * New endpoints for NFT:
+
   * ``GET /sapi/v1/nft/history/transactions`` to get NFT transaction history
   * ``GET /sapi/v1/nft/history/deposit`` to get NFT deposit history
   * ``GET /sapi/v1/nft/history/withdraw`` to get NFT withdraw history
@@ -27,44 +58,58 @@ Added
 
 Added
 ^^^^^
+
+
 * New endpoint for Crypto Loans:
+
   * ``GET /sapi/v1/loan/income`` to query an asset's loan history
+
 * New endpoints for Sub-Account:
+
   * ``POST /sapi/v1/sub-account/subAccountApi/ipRestriction`` to support master account enable and disable IP restriction for a sub-account API Key
   * ``POST /sapi/v1/sub-account/subAccountApi/ipRestriction/ipList`` to support master account add IP list for a sub-account API Key
   * ``GET /sapi/v1/sub-account/subAccountApi/ipRestriction`` to support master account query IP restriction for a sub-account API Key
   * ``DELETE /sapi/v1/sub-account/subAccountApi/ipRestriction/ipList`` to support master account delete IP list for a sub-account API Key
+
 * New endpoint for Pay:
+
   * ``GET /sapi/v1/pay/transactions`` to support user query Pay trade history
 
 Fixed
 ^^^^^
-* Removed epoch time from util method ``config_logging`` to provide compatibility with Windows OS
+
+
+* Removed epoch time in util method ``config_logging`` to provide compatibility with Windows OS
 * Allow optional parameter for method ``isolated_margin_account_limit``
 
 1.7.0 - 2021-11-04
 ------------------
 
 Updated
 ^^^^^^^
+
+
 * Universal transfer types:
-  * Added ``MAIN_FUNDING``, ``FUNDING_MAIN``, ``FUNDING_UMFUTURE``, ``UMFUTURE_FUNDING``, ``MARGIN_FUNDING``, ``FUNDING_MARGIN``, ``FUNDING_CMFUTURE`` and ``CMFUTURE_FUNDING`` to support transfer assets among funding account and other accounts
-  * Deleted ``MAIN_C2C``, ``C2C_MAIN``, ``C2C_UMFUTURE``, ``C2C_MINING``, ``UMFUTURE_C2C``, ``MINING_C2C``, ``MARGIN_C2C``, ``C2C_MARGIN``, ``MAIN_PAY`` and ``PAY_MAIN`` as C2C account, Binance Payment, Binance Card and other business accounts are merged into a Funding account and they'll be discontinued on November 04, 2021 08:00 AM UTC
+
+  * Added ``MAIN_FUNDING``\ , ``FUNDING_MAIN``\ , ``FUNDING_UMFUTURE``\ , ``UMFUTURE_FUNDING``\ , ``MARGIN_FUNDING``\ , ``FUNDING_MARGIN``\ , ``FUNDING_CMFUTURE`` and ``CMFUTURE_FUNDING`` to support transfer assets among funding account and other accounts
+  * Deleted ``MAIN_C2C``\ , ``C2C_MAIN``\ , ``C2C_UMFUTURE``\ , ``C2C_MINING``\ , ``UMFUTURE_C2C``\ , ``MINING_C2C``\ , ``MARGIN_C2C``\ , ``C2C_MARGIN``\ , ``MAIN_PAY`` and ``PAY_MAIN`` as C2C account, Binance Payment, Binance Card and other business accounts are merged into a Funding account and they'll be discontinued on November 04, 2021 08:00 AM UTC
+
 * Util method ``config_logging`` can now provide date time in UTC and epoch time
 
 Added
 ^^^^^
-* New endpoint ``GET api/v3/rateLimit/order`` to display the user's current order count usage for all intervals
 
 
+* New endpoint ``GET api/v3/rateLimit/order`` to display the user's current order count usage for all intervals
+
 1.6.0 - 2021-09-24
 ------------------
 
 Added
 ^^^^^
 
-* Universal transfer types ``MAIN_PAY``, ``PAY_MAIN``, ``ISOLATEDMARGIN_MARGIN``，``MARGIN_ISOLATEDMARGIN``，``ISOLATEDMARGIN_ISOLATEDMARGIN``
 
+* Universal transfer types ``MAIN_PAY``\ , ``PAY_MAIN``\ , ``ISOLATEDMARGIN_MARGIN``\ ，\ ``MARGIN_ISOLATEDMARGIN``\ ，\ ``ISOLATEDMARGIN_ISOLATEDMARGIN``
 * New endpoints for Margin OCO orders:
 
   * ``POST /sapi/v1/margin/order/oco`` to send new margin OCO order
@@ -85,21 +130,21 @@ Added
   * ``GET /sapi/v1/bswap/addLiquidityPreview`` to calculate expected share amount for adding liquidity in single or dual token
   * ``GET /sapi/v1/bswap/removeLiquidityPreview`` to calculate expected asset amount of single token redemption or dual token redemption
 
-
 1.5.0 - 2021-08-17
 ------------------
 
 Changed
 ^^^^^^^
 
+
 * ``GET api/v3/exchangeInfo`` now supports single or multi-symbol query
 * ``GET api/v3/myTrades`` has a new optional field ``orderId``
 
 Added
 ^^^^^
 
-* ``GET /sapi/v1/c2c/orderMatch/listUserOrderHistory`` to query user C2C trade history
 
+* ``GET /sapi/v1/c2c/orderMatch/listUserOrderHistory`` to query user C2C trade history
 
 1.4.0 - 2021-07-30
 ------------------

docs/source/binance.spot.bswap.rst

@@ -44,3 +44,15 @@ Add Liquidity Preview (USER_DATA)
 Remove Liquidity Preview (USER_DATA)
 ------------------------------------
 .. autofunction:: binance.spot.bswap.bswap_remove_liquidity_preview
+
+Get Unclaimed Rewards Record (USER_DATA)
+----------------------------------------
+.. autofunction:: binance.spot.bswap_unclaimed_rewards
+
+Claim rewards (TRADE)
+---------------------
+.. autofunction:: binance.spot.bswap.bswap_claim_rewards
+
+Get Claimed History (USER_DATA)
+-------------------------------
+.. autofunction:: binance.spot.bswap.bswap_claimed_rewards

docs/source/binance.spot.mining.rst

@@ -48,3 +48,7 @@ Hashrate Resale List (USER_DATA)
 Hashrate Resale Detail (USER_DATA)
 ----------------------------------
 .. autofunction:: binance.spot.mining.mining_hashrate_resale_details
+
+Mining Account Earning (USER_DATA)
+----------------------------------
+.. autofunction:: binance.spot.mining.mining_account_earning

examples/spot/bswap/bswap_claim_rewards.py

@@ -0,0 +1,14 @@
+#!/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)
+
+key = ""
+secret = ""
+
+
+client = Client(key, secret)
+logging.info(client.bswap_claim_rewards(type=0))

examples/spot/bswap/bswap_claimed_rewards.py

@@ -0,0 +1,14 @@
+#!/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)
+
+key = ""
+secret = ""
+
+
+client = Client(key, secret)
+logging.info(client.bswap_claimed_rewards(type=0, assetRewards="BNB"))

examples/spot/bswap/bswap_unclaimed_rewards.py

@@ -0,0 +1,14 @@
+#!/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)
+
+key = ""
+secret = ""
+
+
+client = Client(key, secret)
+logging.info(client.bswap_unclaimed_rewards(type=0))