Fox release 1.5.0 (#92)

* exchangeInfo endpoints now supports single or multi symbol query (#85)

* 2430 add precommit hook (#86)

* add c2c endpoints (#88)

* add testcase

* add orderId in /myTrades endpoint (#91)

* add orderId in /myTrades endpoint

* fixing test case

* pump version to 1.5.0

* add links in rst doc files

Co-authored-by: Chai <31032561+chairz@users.noreply.github.com>
Co-authored-by: ishuen <12228644+ishuen@users.noreply.github.com>

Author: 3 people

.github/workflows/pythonpackage.yml

@@ -29,18 +29,14 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install flake8 pytest
-        if [ -f requirements-test.txt ]; then pip install -r requirements-test.txt; fi
+        pip install -r requirements/requirements-test.txt
     - name: Run black to review standard code format
       run: |
         # Checks if need to reformat files
         black --check --diff .
     - name: Run flake8 to check specific rules not covered by black
       run: |
-        # Checks syntax and undefined names errors
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # Checks code complexity, exit-zero treats all errors as warnings.
-        flake8 . --count --exit-zero --max-complexity=10  --statistics
+        flake8 . --statistics
     - name: Test with pytest
       run: |
         pytest

.gitignore

@@ -10,6 +10,7 @@ __pycache__
 # Environments
 .env
 .venv
+venv/
 
 # IDE
 .idea/

.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+default_stages: [commit]
+fail_fast: true
+repos:
+- repo: https://github.com/ambv/black
+  rev: 21.7b0
+  hooks:
+  - id: black
+- repo: https://gitlab.com/pycqa/flake8
+  rev: 3.9.2
+  hooks:
+  - id: flake8
+- repo: local
+  hooks:
+  - id: pytest-check
+    name: pytest-check
+    entry: pytest
+    language: system
+    pass_filenames: false
+    always_run: true

CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Unreleased
 
+## 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
+
 ## 1.4.0 - 2021-07-30
 
 ### Added
@@ -20,12 +29,12 @@
 
 ## 1.2.0 - 2021-07-12
 
-### Change
+### Changed
 - Remove default value in the parameters
 
 ## 1.1.1 - 2021-06-24
 
-### Change
+### Changed
 - Upgrade the dependency packages
 
 ## 1.1.0 - 2021-06-23

MANIFEST.in

@@ -0,0 +1 @@
+include requirements/common.txt

binance/__version__.py

@@ -1 +1 @@
-__version__ = "1.4.0"
+__version__ = "1.5.0"

binance/error.py

@@ -34,3 +34,19 @@ def __init__(self, params):
 
     def __str__(self):
         return "the enum value %s is invalid." % (", ".join(self.params))
+
+
+class ParameterTypeError(Error):
+    def __init__(self, params):
+        self.params = params
+
+    def __str__(self):
+        return f"{self.params[0]} data type has to be {self.params[1]}"
+
+
+class ParameterArgumentError(Error):
+    def __init__(self, error_message):
+        self.error_message = error_message
+
+    def __str__(self):
+        return self.error_message

binance/lib/utils.py

@@ -1,7 +1,12 @@
+import json
 import time
 
 from urllib.parse import urlencode
-from binance.error import ParameterRequiredError, ParameterValueError
+from binance.error import (
+    ParameterRequiredError,
+    ParameterValueError,
+    ParameterTypeError,
+)
 
 
 def cleanNoneValue(d) -> dict:
@@ -13,7 +18,7 @@ def cleanNoneValue(d) -> dict:
 
 
 def check_required_parameter(value, name):
-    if not value:
+    if not value and value != 0:
         raise ParameterRequiredError([name])
 
 
@@ -34,6 +39,11 @@ def check_enum_parameter(value, enum_class):
         raise ParameterValueError([value])
 
 
+def check_type_parameter(value, name, data_type):
+    if value is not None and type(value) != data_type:
+        raise ParameterTypeError([name, data_type])
+
+
 def get_timestamp():
     return int(time.time() * 1000)
 
@@ -42,5 +52,12 @@ def encoded_string(query):
     return urlencode(query, True).replace("%40", "@")
 
 
+def convert_list_to_json_array(symbols):
+    if symbols is None:
+        return symbols
+    res = json.dumps(symbols)
+    return res.replace(" ", "")
+
+
 def config_logging(logging, logging_devel, log_file=None):
     logging.basicConfig(level=logging_devel, filename=log_file)

binance/spot/__init__.py

@@ -204,3 +204,6 @@ def __init__(self, key=None, secret=None, **kwargs):
     # Fiat
     from binance.spot.fiat import fiat_order_history
     from binance.spot.fiat import fiat_payment_history
+
+    # C2C
+    from binance.spot.c2c import c2c_trade_history

binance/spot/account.py

@@ -343,6 +343,7 @@ def my_trades(self, symbol: str, **kwargs):
         symbol (str)
     Keyword Args:
         fromId (int, optional): TradeId to fetch from. Default gets most recent trades.
+        orderId (int, optional): This can only be used in combination with symbol
         startTime (int, optional)
         endTime (int, optional)
         limit (int, optional): Default Value: 500; Max Value: 1000

binance/spot/c2c.py

@@ -0,0 +1,26 @@
+from binance.lib.utils import check_required_parameter
+
+
+def c2c_trade_history(self, tradeType: str, **kwargs):
+    """Get C2C Trade History (USER_DATA)
+
+    GET /sapi/v1/c2c/orderMatch/listUserOrderHistory
+
+    https://binance-docs.github.io/apidocs/spot/en/#get-c2c-trade-history-user_data
+
+    Args:
+      tradeType (str): BUY, SELL
+    Keyword Args:
+      startTimestamp (int, optional)
+      endTimestamp (int, optional)
+      page (int, optional): default 1
+      rows (int, optional): default 100, max 100
+      recvWindow (int, optional): The value cannot be greater than 60000
+    """
+
+    check_required_parameter(tradeType, "tradeType")
+
+    payload = {"tradeType": tradeType, **kwargs}
+    return self.sign_request(
+        "GET", "/sapi/v1/c2c/orderMatch/listUserOrderHistory", payload
+    )

binance/spot/fiat.py

@@ -1,3 +1,6 @@
+from binance.lib.utils import check_required_parameter
+
+
 def fiat_order_history(self, transactionType: int, **kwargs):
     """Get Fiat Deposit/Withdraw History (USER_DATA)
 
@@ -15,6 +18,7 @@ def fiat_order_history(self, transactionType: int, **kwargs):
       recvWindow (int, optional): The value cannot be greater than 60000
     """
 
+    check_required_parameter(transactionType, "transactionType")
     payload = {"transactionType": transactionType, **kwargs}
     return self.sign_request("GET", "/sapi/v1/fiat/orders", payload)
 
@@ -36,5 +40,6 @@ def fiat_payment_history(self, transactionType: int, **kwargs):
       recvWindow (int, optional): The value cannot be greater than 60000
     """
 
+    check_required_parameter(transactionType, "transactionType")
     payload = {"transactionType": transactionType, **kwargs}
     return self.sign_request("GET", "/sapi/v1/fiat/payments", payload)

binance/spot/market.py

@@ -1,4 +1,9 @@
-from binance.lib.utils import check_required_parameter
+from binance.error import ParameterArgumentError
+from binance.lib.utils import (
+    check_required_parameter,
+    check_type_parameter,
+    convert_list_to_json_array,
+)
 from binance.lib.utils import check_required_parameters
 
 
@@ -30,18 +35,25 @@ def time(self):
     return self.query(url_path)
 
 
-def exchange_info(self):
+def exchange_info(self, symbol: str = None, symbols: list = None):
     """Exchange Information
     Current exchange trading rules and symbol information
 
     GET /api/v3/exchangeinfo
 
     https://binance-docs.github.io/apidocs/spot/en/#exchange-information
 
+     Args:
+        symbol (str, optional): the trading pair
+        symbols (list, optional): list of trading pairs
     """
 
     url_path = "/api/v3/exchangeInfo"
-    return self.query(url_path)
+    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)}
+    return self.query(url_path, params)
 
 
 def depth(self, symbol: str, **kwargs):

docs/source/CHANGELOG.rst

@@ -5,53 +5,76 @@ Changelog
 Unreleased
 ----------
 
+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
+
+
 1.4.0 - 2021-07-30
 ------------------
+
+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 
 
-* Fixed
+Fixed
+^^^^^
+
 
-  * Typo in ``margin_max_transferable``
+* Typo in ``margin_max_transferable``
 
 1.3.0 - 2021-07-22
 ------------------
 
 Added
 ^^^^^
 
-* New endpoint for Wallet:
+
+* 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
 ^^^^^^^
 
-* Remove default value in the parameters
 
+* Remove default value in the parameters
 
 1.1.1 - 2021-06-24
 ------------------
 
 Changed
 ^^^^^^^
 
-* Upgrade the dependency packages
 
+* Upgrade the dependency packages
 
 1.1.0 - 2021-06-23
 ------------------
 
 Added
 ^^^^^
 
+
 * A link to the document on ``README.md``
 * Enabled the sub menu on document nav bar.
 * ``GET /sapi/v1/lending/daily/product/list`` includes new parameters, current and size.
@@ -61,11 +84,11 @@ Added
   * ``GET /sapi/v1/managed-subaccount/asset`` to query managed sub-account asset details (only for investor master account)
   * ``POST /sapi/v1/managed-subaccount/withdraw`` to withdrawal assets from the managed sub-account (only for investor master account)
 
-
 1.0.0 - 2021-06-15
 ------------------
 
 Added
 ^^^^^
 
+
 * First release, please find details from ``README.md``

docs/source/binance.spot.c2c.rst

@@ -0,0 +1,6 @@
+C2C Endpoints
+=============
+
+Get C2C Trade History (USER_DATA)
+---------------------------------
+.. autofunction:: binance.spot.c2c.c2c_trade_history

docs/source/binance.spot.rst

@@ -7,8 +7,10 @@ Spot APIs
    binance.spot.account
    binance.spot.blvt
    binance.spot.bswap
+   binance.spot.c2c
    binance.spot.data_stream
    binance.spot.futures
+   binance.spot.fiat
    binance.spot.margin
    binance.spot.market
    binance.spot.mining

examples/spot/c2c/c2c_trade_history.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.c2c_trade_history("BUY")
+    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
+        )
+    )