binance-sdk-algo 1.0.0__tar.gz

binance_sdk_algo-1.0.0/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0 - 2025-07-17
+
+- Initial release

binance_sdk_algo-1.0.0/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Binance
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

binance_sdk_algo-1.0.0/PKG-INFO

@@ -0,0 +1,197 @@
+Metadata-Version: 2.1
+Name: binance-sdk-algo
+Version: 1.0.0
+Summary: Official Binance Algo SDK - A lightweight library that provides a convenient interface to Binance's Algo REST API
+License: MIT
+Author: Binance
+Requires-Python: >=3.9,<=3.13
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Provides-Extra: dev
+Requires-Dist: aiohttp (>=3.9,<4.0)
+Requires-Dist: binance-common (==1.0.0)
+Requires-Dist: black (>=25.1.0,<26.0.0)
+Requires-Dist: pycryptodome (>=3.17,<4.0)
+Requires-Dist: pydantic (>=2.10.0)
+Requires-Dist: pytest (>=6.2.5) ; extra == "dev"
+Requires-Dist: requests (>=2.31.0)
+Requires-Dist: ruff (>=0.12.0,<0.13.0)
+Requires-Dist: websocket-client (>=1.6.3)
+Requires-Dist: websockets (>=15.0.1,<16.0.0)
+Description-Content-Type: text/markdown
+
+# Binance Python Algo SDK
+
+[![Build Status](https://img.shields.io/github/actions/workflow/status/binance/binance-connector-python/ci-algo.yml)](https://github.com/binance/binance-connector-python/actions)
+[![Open Issues](https://img.shields.io/github/issues/binance/binance-connector-python)](https://github.com/binance/binance-connector-python/issues)
+[![Code Style: Black](https://img.shields.io/badge/code_style-black-black)](https://black.readthedocs.io/en/stable/)
+[![PyPI version](https://img.shields.io/pypi/v/binance-sdk-algo)](https://pypi.python.org/pypi/binance-sdk-algo)
+[![PyPI Downloads](https://img.shields.io/pypi/dm/binance-sdk-algo.svg)](https://pypi.org/project/binance-sdk-algo/)
+[![Python version](https://img.shields.io/pypi/pyversions/binance-connector)](https://www.python.org/downloads/)
+[![Known Vulnerabilities](https://img.shields.io/badge/security-scanned-brightgreen)](https://github.com/binance/binance-connector-python/security)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+This is a client library for the Binance Algo SDK API, enabling developers to interact programmatically with Binance's Algo trading platform. The library provides tools to programmatically leverage Binance in-house algorithmic trading capability to automate order execution strategy, improve execution transparency and give users smart access to the available market liquidity through the REST API:
+- [REST API](./src/binance_sdk_algo/rest_api/rest_api.py)
+
+## Table of Contents
+
+- [Supported Features](#supported-features)
+- [Installation](#installation)
+- [Documentation](#documentation)
+- [REST APIs](#rest-apis)
+- [Testing](#testing)
+- [Contributing](#contributing)
+- [Licence](#licence)
+
+## Supported Features
+
+- REST API Endpoints:
+  - `/sapi/v1/algo/*`
+- Inclusion of test cases and examples for quick onboarding.
+
+## Installation
+
+To use this library, ensure your environment is running Python version **3.9** or later.
+
+```bash
+pip install binance-sdk-algo
+```
+
+## Documentation
+
+For detailed information, refer to the [Binance API Documentation](https://developers.binance.com/docs/algo/Introduction).
+
+### REST APIs
+
+All REST API endpoints are available through the [`rest_api`](./src/binance_sdk_algo/rest_api/rest_api.py) module. The REST API enables you to fetch market data, manage trades, and access account information. Note that some endpoints require authentication using your Binance API credentials.
+
+```python
+from binance_common.configuration import ConfigurationRestAPI
+from binance_common.constants import ALGO_REST_API_PROD_URL
+from binance_sdk_algo.algo import Algo
+
+logging.basicConfig(level=logging.INFO)
+configuration = ConfigurationRestAPI(api_key="your-api-key", api_secret="your-api-secret", base_path=ALGO_REST_API_PROD_URL)
+
+client = Algo(config_rest_api=configuration)
+
+try:
+    response = client.rest_api.query_historical_algo_orders_spot_algo()
+
+    data = response.data()
+    logging.info(f"query_historical_algo_orders_spot_algo() response: {data}")
+except Exception as e:
+    logging.error(f"query_historical_algo_orders_spot_algo() error: {e}")
+```
+
+More examples can be found in the [`examples/rest_api`](./examples/rest_api/) folder.
+
+#### Configuration Options
+
+The REST API supports the following advanced configuration options:
+
+- `timeout`: Timeout for requests in milliseconds (default: 1000 ms).
+- `proxy`: Proxy configuration:
+  - `host`: Proxy server hostname.
+  - `port`: Proxy server port.
+  - `protocol`: Proxy protocol (http or https).
+  - `auth`: Proxy authentication credentials:
+    - `username`: Proxy username.
+    - `password`: Proxy password.
+- `keep_alive`: Enable HTTP keep-alive (default: true).
+- `compression`: Enable response compression (default: true).
+- `retries`: Number of retry attempts for failed requests (default: 3).
+- `backoff`: Delay in milliseconds between retries (default: 1000 ms).
+- `https_agent`: Custom HTTPS agent for advanced TLS configuration.
+- `private_key`: RSA or ED25519 private key for authentication.
+- `private_key_passphrase`: Passphrase for the private key, if encrypted.
+
+##### Timeout
+
+You can configure a timeout for requests in milliseconds. If the request exceeds the specified timeout, it will be aborted. See the [Timeout example](./docs/rest_api/timeout.md) for detailed usage.
+
+##### Proxy
+
+The REST API supports HTTP/HTTPS proxy configurations. See the [Proxy example](./docs/rest_api/proxy.md) for detailed usage.
+
+##### Keep-Alive
+
+Enable HTTP keep-alive for persistent connections. See the [Keep-Alive example](./docs/rest_api/keepAlive.md) for detailed usage.
+
+##### Compression
+
+Enable or disable response compression. See the [Compression example](./docs/rest_api/compression.md) for detailed usage.
+
+##### Retries
+
+Configure the number of retry attempts and delay in milliseconds between retries for failed requests. See the [Retries example](./docs/rest_api/retries.md) for detailed usage.
+
+##### HTTPS Agent
+
+Customize the HTTPS agent for advanced TLS configurations. See the [HTTPS Agent example](./docs/rest_api/httpsAgent.md) for detailed usage.
+
+##### Key Pair Based Authentication
+
+The REST API supports key pair-based authentication for secure communication. You can use `RSA` or `ED25519` keys for signing requests. See the [Key Pair Based Authentication example](./docs/rest_api/key-pair-authentication.md) for detailed usage.
+
+##### Certificate Pinning
+
+To enhance security, you can use certificate pinning with the `https_agent` option in the configuration. This ensures the client only communicates with servers using specific certificates. See the [Certificate Pinning example](./docs/rest_api/certificate-pinning.md) for detailed usage.
+
+#### Error Handling
+
+The REST API provides detailed error types to help you handle issues effectively:
+
+- `ClientError`: Represents an error that occurred in the SDK client.
+- `RequiredError`: Thrown when a required parameter is missing or undefined.
+- `UnauthorizedError`: Indicates missing or invalid authentication credentials.
+- `ForbiddenError`: Access to the requested resource is forbidden.
+- `TooManyRequestsError`: Rate limit exceeded.
+- `RateLimitBanError`: IP address banned for exceeding rate limits.
+- `ServerError`: Internal server error, optionally includes a status code.
+- `NetworkError`: Issues with network connectivity.
+- `NotFoundError`: Resource not found.
+- `BadRequestError`: Invalid request or one that cannot be served.
+
+See the [Error Handling example](./docs/rest_api/error-handling.md) for detailed usage.
+
+If `base_path` is not provided, it defaults to `https://api.binance.com`.
+
+## Testing
+
+To run the tests, ensure you have [Poetry](https://python-poetry.org/) installed, then execute the following commands:
+
+```bash
+poetry install
+poetry run pytest ./tests
+```
+
+The tests cover:
+* REST API endpoints
+* Error handling
+* Edge cases
+
+## Contributing
+
+Contributions are welcome!
+
+Since this repository contains auto-generated code, we encourage you to start by opening a GitHub issue to discuss your ideas or suggest improvements. This helps ensure that changes align with the project's goals and auto-generation processes.
+
+To contribute:
+
+1. Open a GitHub issue describing your suggestion or the bug you've identified.
+2. If it's determined that changes are necessary, the maintainers will merge the changes into the main branch.
+
+Please ensure that all tests pass if you're making a direct contribution. Submit a pull request only after discussing and confirming the change.
+
+Thank you for your contributions!
+
+## Licence
+
+This project is licensed under the MIT License. See the [LICENCE](./LICENCE) file for details.

binance_sdk_algo-1.0.0/README.md

@@ -0,0 +1,170 @@
+# Binance Python Algo SDK
+
+[![Build Status](https://img.shields.io/github/actions/workflow/status/binance/binance-connector-python/ci-algo.yml)](https://github.com/binance/binance-connector-python/actions)
+[![Open Issues](https://img.shields.io/github/issues/binance/binance-connector-python)](https://github.com/binance/binance-connector-python/issues)
+[![Code Style: Black](https://img.shields.io/badge/code_style-black-black)](https://black.readthedocs.io/en/stable/)
+[![PyPI version](https://img.shields.io/pypi/v/binance-sdk-algo)](https://pypi.python.org/pypi/binance-sdk-algo)
+[![PyPI Downloads](https://img.shields.io/pypi/dm/binance-sdk-algo.svg)](https://pypi.org/project/binance-sdk-algo/)
+[![Python version](https://img.shields.io/pypi/pyversions/binance-connector)](https://www.python.org/downloads/)
+[![Known Vulnerabilities](https://img.shields.io/badge/security-scanned-brightgreen)](https://github.com/binance/binance-connector-python/security)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+This is a client library for the Binance Algo SDK API, enabling developers to interact programmatically with Binance's Algo trading platform. The library provides tools to programmatically leverage Binance in-house algorithmic trading capability to automate order execution strategy, improve execution transparency and give users smart access to the available market liquidity through the REST API:
+- [REST API](./src/binance_sdk_algo/rest_api/rest_api.py)
+
+## Table of Contents
+
+- [Supported Features](#supported-features)
+- [Installation](#installation)
+- [Documentation](#documentation)
+- [REST APIs](#rest-apis)
+- [Testing](#testing)
+- [Contributing](#contributing)
+- [Licence](#licence)
+
+## Supported Features
+
+- REST API Endpoints:
+  - `/sapi/v1/algo/*`
+- Inclusion of test cases and examples for quick onboarding.
+
+## Installation
+
+To use this library, ensure your environment is running Python version **3.9** or later.
+
+```bash
+pip install binance-sdk-algo
+```
+
+## Documentation
+
+For detailed information, refer to the [Binance API Documentation](https://developers.binance.com/docs/algo/Introduction).
+
+### REST APIs
+
+All REST API endpoints are available through the [`rest_api`](./src/binance_sdk_algo/rest_api/rest_api.py) module. The REST API enables you to fetch market data, manage trades, and access account information. Note that some endpoints require authentication using your Binance API credentials.
+
+```python
+from binance_common.configuration import ConfigurationRestAPI
+from binance_common.constants import ALGO_REST_API_PROD_URL
+from binance_sdk_algo.algo import Algo
+
+logging.basicConfig(level=logging.INFO)
+configuration = ConfigurationRestAPI(api_key="your-api-key", api_secret="your-api-secret", base_path=ALGO_REST_API_PROD_URL)
+
+client = Algo(config_rest_api=configuration)
+
+try:
+    response = client.rest_api.query_historical_algo_orders_spot_algo()
+
+    data = response.data()
+    logging.info(f"query_historical_algo_orders_spot_algo() response: {data}")
+except Exception as e:
+    logging.error(f"query_historical_algo_orders_spot_algo() error: {e}")
+```
+
+More examples can be found in the [`examples/rest_api`](./examples/rest_api/) folder.
+
+#### Configuration Options
+
+The REST API supports the following advanced configuration options:
+
+- `timeout`: Timeout for requests in milliseconds (default: 1000 ms).
+- `proxy`: Proxy configuration:
+  - `host`: Proxy server hostname.
+  - `port`: Proxy server port.
+  - `protocol`: Proxy protocol (http or https).
+  - `auth`: Proxy authentication credentials:
+    - `username`: Proxy username.
+    - `password`: Proxy password.
+- `keep_alive`: Enable HTTP keep-alive (default: true).
+- `compression`: Enable response compression (default: true).
+- `retries`: Number of retry attempts for failed requests (default: 3).
+- `backoff`: Delay in milliseconds between retries (default: 1000 ms).
+- `https_agent`: Custom HTTPS agent for advanced TLS configuration.
+- `private_key`: RSA or ED25519 private key for authentication.
+- `private_key_passphrase`: Passphrase for the private key, if encrypted.
+
+##### Timeout
+
+You can configure a timeout for requests in milliseconds. If the request exceeds the specified timeout, it will be aborted. See the [Timeout example](./docs/rest_api/timeout.md) for detailed usage.
+
+##### Proxy
+
+The REST API supports HTTP/HTTPS proxy configurations. See the [Proxy example](./docs/rest_api/proxy.md) for detailed usage.
+
+##### Keep-Alive
+
+Enable HTTP keep-alive for persistent connections. See the [Keep-Alive example](./docs/rest_api/keepAlive.md) for detailed usage.
+
+##### Compression
+
+Enable or disable response compression. See the [Compression example](./docs/rest_api/compression.md) for detailed usage.
+
+##### Retries
+
+Configure the number of retry attempts and delay in milliseconds between retries for failed requests. See the [Retries example](./docs/rest_api/retries.md) for detailed usage.
+
+##### HTTPS Agent
+
+Customize the HTTPS agent for advanced TLS configurations. See the [HTTPS Agent example](./docs/rest_api/httpsAgent.md) for detailed usage.
+
+##### Key Pair Based Authentication
+
+The REST API supports key pair-based authentication for secure communication. You can use `RSA` or `ED25519` keys for signing requests. See the [Key Pair Based Authentication example](./docs/rest_api/key-pair-authentication.md) for detailed usage.
+
+##### Certificate Pinning
+
+To enhance security, you can use certificate pinning with the `https_agent` option in the configuration. This ensures the client only communicates with servers using specific certificates. See the [Certificate Pinning example](./docs/rest_api/certificate-pinning.md) for detailed usage.
+
+#### Error Handling
+
+The REST API provides detailed error types to help you handle issues effectively:
+
+- `ClientError`: Represents an error that occurred in the SDK client.
+- `RequiredError`: Thrown when a required parameter is missing or undefined.
+- `UnauthorizedError`: Indicates missing or invalid authentication credentials.
+- `ForbiddenError`: Access to the requested resource is forbidden.
+- `TooManyRequestsError`: Rate limit exceeded.
+- `RateLimitBanError`: IP address banned for exceeding rate limits.
+- `ServerError`: Internal server error, optionally includes a status code.
+- `NetworkError`: Issues with network connectivity.
+- `NotFoundError`: Resource not found.
+- `BadRequestError`: Invalid request or one that cannot be served.
+
+See the [Error Handling example](./docs/rest_api/error-handling.md) for detailed usage.
+
+If `base_path` is not provided, it defaults to `https://api.binance.com`.
+
+## Testing
+
+To run the tests, ensure you have [Poetry](https://python-poetry.org/) installed, then execute the following commands:
+
+```bash
+poetry install
+poetry run pytest ./tests
+```
+
+The tests cover:
+* REST API endpoints
+* Error handling
+* Edge cases
+
+## Contributing
+
+Contributions are welcome!
+
+Since this repository contains auto-generated code, we encourage you to start by opening a GitHub issue to discuss your ideas or suggest improvements. This helps ensure that changes align with the project's goals and auto-generation processes.
+
+To contribute:
+
+1. Open a GitHub issue describing your suggestion or the bug you've identified.
+2. If it's determined that changes are necessary, the maintainers will merge the changes into the main branch.
+
+Please ensure that all tests pass if you're making a direct contribution. Submit a pull request only after discussing and confirming the change.
+
+Thank you for your contributions!
+
+## Licence
+
+This project is licensed under the MIT License. See the [LICENCE](./LICENCE) file for details.

binance_sdk_algo-1.0.0/pyproject.toml

@@ -0,0 +1,40 @@
+[tool.poetry]
+name = "binance-sdk-algo"
+version = "1.0.0"
+description = "Official Binance Algo SDK - A lightweight library that provides a convenient interface to Binance's Algo REST API"
+authors = ["Binance"]
+license = "MIT"
+readme = "README.md"
+include = ["CHANGELOG.md", "LICENSE", "README.md"]
+packages = [
+  { include = "binance_sdk_algo", from = "src" }
+]
+
+[tool.poetry.dependencies]
+python = ">=3.9,<=3.13"
+requests = ">=2.31.0"
+pydantic = ">=2.10.0"
+websockets = "^15.0.1"
+websocket-client = ">=1.6.3"
+black = "^25.1.0"
+ruff = "^0.12.0"
+pycryptodome = "^3.17"
+aiohttp = "^3.9"
+binance-common = "1.0.0"
+pytest = { version = ">=6.2.5", optional = true }
+
+[tool.poetry.extras]
+dev = ["pytest"]
+
+[tool.poetry.group.dev.dependencies]
+tox = "^4.27.0"
+pytest = ">=8.4.1"
+pytest-asyncio = "^1.0.0"
+
+[tool.ruff]
+exclude = [".git", ".tox", "build", "dist"]
+lint.ignore = ["E741"]
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

binance_sdk_algo-1.0.0/src/binance_sdk_algo/__init__.py

@@ -0,0 +1,31 @@
+from binance_sdk_algo.algo import Algo
+from binance_common.errors import (
+    ClientError,
+    RequiredError,
+    UnauthorizedError,
+    ForbiddenError,
+    TooManyRequestsError,
+    RateLimitBanError,
+    ServerError,
+    NetworkError,
+    NotFoundError,
+    BadRequestError,
+)
+from binance_common.constants import (
+    ALGO_REST_API_PROD_URL,
+)
+
+__all__ = [
+    "Algo",
+    "ALGO_REST_API_PROD_URL",
+    "ClientError",
+    "RequiredError",
+    "UnauthorizedError",
+    "ForbiddenError",
+    "TooManyRequestsError",
+    "RateLimitBanError",
+    "ServerError",
+    "NetworkError",
+    "NotFoundError",
+    "BadRequestError",
+]

binance_sdk_algo-1.0.0/src/binance_sdk_algo/algo.py

@@ -0,0 +1,34 @@
+import platform
+from importlib.metadata import version
+
+from binance_common.configuration import ConfigurationRestAPI
+from binance_common.constants import ALGO_REST_API_PROD_URL
+from . import metadata
+from .rest_api import AlgoRestAPI
+
+LIB_NAME = metadata.NAME
+LIB_VERSION = version(LIB_NAME)
+
+
+class Algo:
+    """Algo API that exposes REST APIs in a single interface."""
+
+    def __init__(self, config_rest_api: ConfigurationRestAPI = None) -> None:
+        self._rest_api = None
+        self._rest_api_config = (
+            ConfigurationRestAPI() if config_rest_api is None else config_rest_api
+        )
+
+    @property
+    def rest_api(self) -> AlgoRestAPI:
+        if self._rest_api is None and self._rest_api_config:
+            self._rest_api_config.base_headers["User-Agent"] = (
+                f"{LIB_NAME}/{LIB_VERSION} (Python/{platform.python_version()}; {platform.system()}; {platform.machine()})"
+            )
+            self._rest_api_config.base_path = (
+                ALGO_REST_API_PROD_URL
+                if self._rest_api_config.base_path is None
+                else self._rest_api_config.base_path
+            )
+            self._rest_api = AlgoRestAPI(self._rest_api_config)
+        return self._rest_api

binance_sdk_algo-1.0.0/src/binance_sdk_algo/metadata.py

@@ -0,0 +1 @@
+NAME = "binance-sdk-algo"

binance_sdk_algo-1.0.0/src/binance_sdk_algo/rest_api/__init__.py

@@ -0,0 +1,13 @@
+"""
+Binance Algo REST API
+
+OpenAPI Specification for the Binance Algo REST API
+The version of the OpenAPI document: 1.0.0
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""
+
+from .rest_api import AlgoRestAPI
+
+__all__ = ["AlgoRestAPI"]

binance_sdk_algo-1.0.0/src/binance_sdk_algo/rest_api/api/__init__.py

@@ -0,0 +1,12 @@
+"""
+Binance Algo REST API
+
+OpenAPI Specification for the Binance Algo REST API
+The version of the OpenAPI document: 1.0.0
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""
+
+from .future_algo_api import FutureAlgoApi as FutureAlgoApi
+from .spot_algo_api import SpotAlgoApi as SpotAlgoApi