Merge pull request #330 from binance/rc-v3.8.1

Release v3.8.1

Author: alplabin

.readthedocs.yaml

@@ -0,0 +1,35 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#   - pdf
+#   - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: requirements/requirements-test.txt

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 3.8.1 - 2024-07-25
+### Added
+- `.readthedocs.yml` to resolve documentation issue
+
+### Changed
+- `GET /api/v3/account` has a new optional parameter `omitZeroBalances`, which if enabled hides all zero balances.
+- `POST /api/v3/order/cancelReplace` has a new optional parameter `orderRateLimitExceededMode`.
+
 ## 3.8.0 - 2024-07-04
 ### Added
 - Trade

binance/__version__.py

@@ -1 +1 @@
-__version__ = "3.8.0"
+__version__ = "3.8.1"

binance/spot/_trade.py

@@ -174,6 +174,9 @@ def cancel_and_replace(
         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.
         newOrderRespType (str, optional): Set the response JSON. MARKET and LIMIT order types default to FULL, all other orders default to ACK.
+        selfTradePreventionMode (str, optional): The allowed enums is dependent on what is configured on the symbol. The possible supported values are EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH, NONE.
+        cancelRestrictions (str, optional): Supported values: ONLY_NEW - Cancel will succeed if the order status is NEW. ONLY_PARTIALLY_FILLED - Cancel will succeed if order status is PARTIALLY_FILLED.
+        orderRateLimitExceededMode (str, optional): Supported values: DO_NOTHING (default)- will only attempt to cancel the order if account has not exceeded the order rate limit. CANCEL_ONLY - will always cancel the order.
         recvWindow (int, optional): The value cannot be greater than 60000
     """
     check_required_parameters(
@@ -580,6 +583,7 @@ def account(self, **kwargs):
     https://binance-docs.github.io/apidocs/spot/en/#account-information-user_data
 
     Keyword Args:
+        omitZeroBalances (bool, optional): When set to true, emits only the non-zero balances of an account. Default value: false
         recvWindow (int, optional): The value cannot be greater than 60000
     """