Rc 1.9.0 (#121)

* Added the binance convert endpoint to the binance python connector

* Implementation of remarks from pull request

* Updated convert endpoint method name

* Updated function call to new method name

* Further adjustments as requested

* Copy paste error resolved. 

Copy paste error resolved. Function name updated.

* Types added

Added types for mandatory arguments.

* Update test_convert_trade_history.py

Added second argument to function calls.

* black format

* correct convert test

* remove testnet base url for convert example

* v1.9.0

Co-authored-by: Jacob <jacob@jacob.com>
Co-authored-by: jnuernberg <79695265+jnuernberg@users.noreply.github.com>

Author: 3 people

CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 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/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
+    - `GET /sapi/v1/nft/user/getAsset` to get NFT asset
+
 ## 1.8.0 - 2021-11-25
 
 ### Added
@@ -46,7 +63,7 @@
     - `GET /sapi/v1/bswap/poolConfigure` to get pool configure
     - `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
@@ -60,8 +77,8 @@
 
 ### Added
 - New Fiat endpoints:
-    - `GET /sapi/v1/fiat/orders` to query user fiat deposit and withdraw history 
-    - `GET /sapi/v1/fiat/payments` to query user fiat payments history 
+    - `GET /sapi/v1/fiat/orders` to query user fiat deposit and withdraw history
+    - `GET /sapi/v1/fiat/payments` to query user fiat payments history
 
 ### Fixed
  - Typo in `margin_max_transferable`
@@ -71,7 +88,7 @@
 - New endpoints for Wallet:
     - `POST /sapi/v1/asset/get-funding-asset` to query funding wallet, includes Binance Pay, Binance Card, Binance Gift Card, Stock Token
     - `GET /sapi/v1/account/apiRestrictions` to query user API Key permission
-    
+
 ## 1.2.0 - 2021-07-12
 
 ### Changed

CONTRIBUTING.md

@@ -0,0 +1,101 @@
+# Contributing
+
+Love this package and want to help? Thanks so much, there's something to do for everybody!
+
+Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
+
+Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.
+
+## Using the issue tracker
+
+The [issue tracker](https://github.com/binance/binance-connector-python/issues) is the preferred channel for [bug reports](#bugs), [features requests](#features) and [submitting pull requests](#pull-requests).
+
+<a name="bugs"></a>
+
+## Bug reports
+
+A bug is a _demonstrable problem_ that is caused by the code in the repository.
+Good bug reports are extremely helpful - thank you!
+
+Guidelines for bug reports:
+
+1.  **Use the GitHub issue search** &mdash; check if the issue has already been reported.
+
+2.  **Check if the issue has been fixed** &mdash; try to reproduce it using the latest `master` or development branch in the repository.
+
+3.  **Isolate the problem** &mdash; ideally create a [reduced test case](https://css-tricks.com/reduced-test-cases/) and a live example.
+
+4.  **Use the bug report template** &mdash; please fill in the template which appears when you open a new issue.
+
+A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS
+experience the problem? What would you expect to be the outcome? All these details will help people to fix any potential bugs.
+
+<a name="features"></a>
+
+## Feature requests
+
+Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to _you_ to make a strong case to convince the project's developers of the merits of this feature. Please provide as many details and as much context as possible.
+
+<a name="pull-requests"></a>
+
+## Pull requests
+
+Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
+
+**Please ask first** before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.
+
+Since the `master` branch is what people actually use in production, we have release candidate branches, which are usually name after `rc-`, that unstable changes get merged into first. Only when we consider that stable we merge it into the `master` branch and release the changes officially.
+
+Adhering to the following process is the best way to get your work included in the project:
+
+1.  [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your fork, and configure the remotes:
+
+    ```bash
+    # Clone your fork of the repo into the current directory
+    git clone https://github.com/<your-username>/binance-connector-python.git
+    # Navigate to the newly cloned directory
+    cd binance-connector-python
+    # Assign the original repo to a remote called "upstream"
+    git remote add upstream https://github.com/binance/binance-connector-python.git
+    ```
+
+2.  If you cloned a while ago, get the latest changes from upstream:
+
+    ```bash
+    git checkout <latest_rc_branch>
+    git pull upstream <latest_rc_branch>
+    ```
+
+3.  Create a new topic branch (off the `rc-` branch) to contain your feature, change, or fix:
+
+    ```bash
+    git checkout -b <topic-branch-name>
+    ```
+
+4.  Work on your code, but please don't forget:
+    - Add [Docstring](https://www.python.org/dev/peps/pep-0257/) to any new module, function, class, or method. You can consult files within `/binance` for references;
+    - If reasonable (ex: new endpoint), add example file to the `/examples` folder - please use `logging`/`logger` with ideal logging level to log the messages;
+    - If reasonable (ex: new endpoint), add test file to the `/tests` folder - use [pytest](https://docs.pytest.org/en/6.2.x/contents.html) to check if all tests are passed.
+    - If reasonable (ex: new endpoint), add documentation to the `/docs` folder - please refer to [reStructuredText](https://devguide.python.org/documenting/);
+    - Write changes to `CHANGELOG.md` and `CHANGELOG.rst` under the `Unreleased` section - please create the section if not existing yet, this is later to be converted into the verion and date of release;
+    - Make sure there's no typos and the namings are simple and not ambiguous; 
+
+5.  Commit your changes, taking in attention these [git commit message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
+
+6.  Locally merge (or rebase) the upstream rc branch into your topic branch:
+
+    ```bash
+    git pull [--rebase] upstream <latest_rc_branch>
+    ```
+
+
+7.  Push your topic branch up to your fork:
+
+    ```bash
+    git push origin <topic-branch-name>
+    ```
+
+8.  [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) with a clear title and description.
+
+**IMPORTANT**: By submitting a patch, you agree to allow the project
+owners to license your work under the terms of the MIT License.

README.md

@@ -1,5 +1,8 @@
 # Binance Public API Connector Python
-[![Python 3.6](https://img.shields.io/badge/python-3.6+-blue.svg)](https://www.python.org/downloads/release/python-360/)
+[![PyPI version](https://img.shields.io/pypi/v/binance-connector.svg)](https://pypi.python.org/pypi/binance-connector.svg)
+[![Python version](https://img.shields.io/pypi/pyversions/binance-connector)](https://www.python.org/downloads/)
+[![Documentation](https://img.shields.io/badge/docs-latest-blue)](https://binance-connector.readthedocs.io/en/stable/)
+[![Code Style](https://img.shields.io/badge/code_style-black-black)](https://black.readthedocs.io/en/stable/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 This is a lightweight library that works as a connector to [Binance public API](https://github.com/binance/binance-spot-api-docs)

binance/__version__.py

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

binance/spot/__init__.py

@@ -89,6 +89,9 @@ def __init__(self, key=None, secret=None, **kwargs):
     from binance.spot.margin import cancel_isolated_margin_account
     from binance.spot.margin import enable_isolated_margin_account
     from binance.spot.margin import isolated_margin_account_limit
+    from binance.spot.margin import margin_fee
+    from binance.spot.margin import isolated_margin_fee
+    from binance.spot.margin import isolated_margin_tier
 
     # SAVINGS
     from binance.spot.savings import savings_flexible_products
@@ -229,3 +232,15 @@ def __init__(self, key=None, secret=None, **kwargs):
 
     # PAY
     from binance.spot.pay import pay_history
+
+    # CONVERT
+    from binance.spot.convert import convert_trade_history
+
+    # REBATE
+    from binance.spot.rebate import rebate_spot_history
+
+    # NFT
+    from binance.spot.nft import nft_transaction_history
+    from binance.spot.nft import nft_deposit_history
+    from binance.spot.nft import nft_withdraw_history
+    from binance.spot.nft import nft_asset

binance/spot/convert.py

@@ -0,0 +1,24 @@
+from binance.lib.utils import check_required_parameters
+
+
+def convert_trade_history(self, startTime: int, endTime: int, **kwargs):
+    """Convert Trade History (USER_DATA)
+
+    Get convert history for a specific account.
+
+    GET /sapi/v1/convert/tradeFlow
+
+    https://binance-docs.github.io/apidocs/spot/en/#convert-endpoints
+
+    Args:
+        startTime (int)
+        endTime (int)
+    Keyword Args:
+        limit (int, optional): Default Value: 100; Max Value: 1000
+        recvWindow (int, optional)
+    """
+    check_required_parameters([[startTime, "startTime"], [endTime, "endTime"]])
+
+    url_path = "/sapi/v1/convert/tradeFlow"
+    payload = {"startTime": startTime, "endTime": endTime, **kwargs}
+    return self.sign_request("GET", url_path, payload)

binance/spot/margin.py

@@ -855,3 +855,54 @@ def isolated_margin_account_limit(self, **kwargs):
         recvWindow (int, optional): The value cannot be greater than 60000
     """
     return self.sign_request("GET", "/sapi/v1/margin/isolated/accountLimit", kwargs)
+
+
+def margin_fee(self, **kwargs):
+    """Query Cross Margin Fee Data (USER_DATA)
+    Get cross margin fee data collection with any vip level or user's current specific data as https://www.binance.com/en/margin-fee
+
+    GET /sapi/v1/margin/crossMarginData
+
+    https://binance-docs.github.io/apidocs/spot/en/#query-cross-margin-fee-data-user_data
+
+    Keyword Args:
+        vipLevel (int, optional): User's current specific margin data will be returned if vipLevel is omitted
+        coin (str, optional)
+        recvWindow (int, optional): The value cannot be greater than 60000
+    """
+    return self.sign_request("GET", "/sapi/v1/margin/crossMarginData", kwargs)
+
+
+def isolated_margin_fee(self, **kwargs):
+    """Query Isolated Margin Fee Data (USER_DATA)
+    Get isolated margin fee data collection with any vip level or user's current specific data as https://www.binance.com/en/margin-fee
+
+    GET /sapi/v1/margin/isolatedMarginData
+
+    https://binance-docs.github.io/apidocs/spot/en/#query-isolated-margin-fee-data-user_data
+
+    Keyword Args:
+        vipLevel (int, optional): User's current specific margin data will be returned if vipLevel is omitted
+        symbol (str, optional)
+        recvWindow (int, optional): The value cannot be greater than 60000
+    """
+    return self.sign_request("GET", "/sapi/v1/margin/isolatedMarginData", kwargs)
+
+
+def isolated_margin_tier(self, symbol: str, **kwargs):
+    """Query Isolated Margin Tier Data (USER_DATA)
+    Get isolated margin tier data collection with any tier as https://www.binance.com/en/margin-data
+
+    GET /sapi/v1/margin/isolatedMarginTier
+
+    https://binance-docs.github.io/apidocs/spot/en/#query-isolated-margin-tier-data-user_data
+
+    Args:
+        symbol (str)
+    Keyword Args:
+        tier (int, optional): All margin tier data will be returned if tier is omitted
+        recvWindow (int, optional): The value cannot be greater than 60000
+    """
+    check_required_parameter(symbol, "symbol")
+    payload = {"symbol": symbol, **kwargs}
+    return self.sign_request("GET", "/sapi/v1/margin/isolatedMarginTier", payload)

binance/spot/nft.py

@@ -0,0 +1,74 @@
+from binance.lib.utils import check_required_parameter
+
+
+def nft_transaction_history(self, orderType: int, **kwargs):
+    """Get NFT Transaction History (USER_DATA)
+
+    GET /sapi/v1/nft/history/transactions
+
+    https://binance-docs.github.io/apidocs/spot/en/#get-nft-transaction-history-user_data
+
+    Args:
+      orderType (int): 0: purchase order, 1: sell order, 2: royalty income, 3: primary market order, 4: mint fee
+    Keyword Args:
+      startTime (int, optional)
+      endTime (int, optional)
+      limit (int, optional): Default 50, Max 50
+      page (int, optional): Default 1
+      recvWindow (int, optional): The value cannot be greater than 60000
+    """
+    check_required_parameter(orderType, "orderType")
+    params = {"orderType": orderType, **kwargs}
+    return self.sign_request("GET", "/sapi/v1/nft/history/transactions", params)
+
+
+def nft_deposit_history(self, **kwargs):
+    """Get NFT Deposit History(USER_DATA)
+
+    GET /sapi/v1/nft/history/deposit
+
+    https://binance-docs.github.io/apidocs/spot/en/#get-nft-deposit-history-user_data
+
+    Keyword Args:
+      startTime (int, optional)
+      endTime (int, optional)
+      limit (int, optional): Default 50, Max 50
+      page (int, optional): Default 1
+      recvWindow (int, optional): The value cannot be greater than 60000
+    """
+
+    return self.sign_request("GET", "/sapi/v1/nft/history/deposit", kwargs)
+
+
+def nft_withdraw_history(self, **kwargs):
+    """Get NFT Withdraw History (USER_DATA)
+
+    GET /sapi/v1/nft/history/withdraw
+
+    https://binance-docs.github.io/apidocs/spot/en/#get-nft-withdraw-history-user_data
+
+    Keyword Args:
+      startTime (int, optional)
+      endTime (int, optional)
+      limit (int, optional): Default 50, Max 50
+      page (int, optional): Default 1
+      recvWindow (int, optional): The value cannot be greater than 60000
+    """
+
+    return self.sign_request("GET", "/sapi/v1/nft/history/withdraw", kwargs)
+
+
+def nft_asset(self, **kwargs):
+    """Get NFT Asset (USER_DATA)
+
+    GET /sapi/v1/nft/user/getAsset
+
+    https://binance-docs.github.io/apidocs/spot/en/#get-nft-asset-user_data
+
+    Keyword Args:
+      limit (int, optional): Default 50, Max 50
+      page (int, optional): Default 1
+      recvWindow (int, optional): The value cannot be greater than 60000
+    """
+
+    return self.sign_request("GET", "/sapi/v1/nft/user/getAsset", kwargs)

binance/spot/rebate.py

@@ -0,0 +1,15 @@
+def rebate_spot_history(self, **kwargs):
+    """Get Spot Rebate History Records (USER_DATA)
+
+    GET /sapi/v1/rebate/taxQuery
+
+    https://binance-docs.github.io/apidocs/spot/en/#get-spot-rebate-history-records-user_data
+
+    Keyword Args:
+      startTime (int, optional)
+      endTime (int, optional)
+      page (int, optional): default 1
+      recvWindow (int, optional): The value cannot be greater than 60000
+    """
+
+    return self.sign_request("GET", "/sapi/v1/rebate/taxQuery", kwargs)