Merge pull request #485 from binance/release_clients_january_23

Author: alplabin

README.md

@@ -20,6 +20,7 @@ Before using the SDK, ensure you have:
 ## Available SDK
 
 - [binance-sdk-algo](./clients/algo) - Algo Trading connector
+- [binance-sdk-alpha](./clients/alpha/) - Alpha connector
 - [binance-sdk-c2c](./clients/c2c/) - C2C connector
 - [binance-sdk-convert](./clients/convert/) - Convert connector
 - [binance-sdk-copy-trading](./clients/copy_trading/) - Copy Trading connector

clients/algo/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 2.2.0 - 2026-01-23
+
+### Changed (1)
+
+- Updated `binance-common` library to version `3.4.1`
+
 ## 2.1.0 - 2026-01-13
 
 ### Changed (1)

clients/algo/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "binance-sdk-algo"
-version = "2.1.0"
+version = "2.2.0"
 description = "Official Binance Algo SDK - A lightweight library that provides a convenient interface to Binance's Algo REST API"
 authors = ["Binance"]
 license = "MIT"
@@ -20,7 +20,7 @@ black = "^25.1.0"
 ruff = "^0.12.0"
 pycryptodome = "^3.17"
 aiohttp = "^3.9"
-binance-common = "3.4.0"
+binance-common = "3.4.1"
 pytest = { version = ">=6.2.5", optional = true }
 
 [tool.poetry.extras]

clients/alpha/.gitignore

@@ -0,0 +1,23 @@
+build
+dist
+
+__pycache__
+*.pyc
+.tox
+.python-version
+.DS_Store
+poetry.lock
+
+# Environments
+.env
+.venv
+venv/
+
+# IDE
+.idea/
+.vscode/
+
+# document build
+docs/build/
+
+examples/*.ini

clients/alpha/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0 - 2026-01-23
+
+- Initial release

clients/alpha/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 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.

clients/alpha/README.md

@@ -0,0 +1,172 @@
+# Binance Python Alpha SDK
+
+[![Build Status](https://img.shields.io/github/actions/workflow/status/binance/binance-connector-python/ci.yaml)](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-alpha)](https://pypi.python.org/pypi/binance-sdk-alpha)
+[![PyPI Downloads](https://img.shields.io/pypi/dm/binance-sdk-alpha.svg)](https://pypi.org/project/binance-sdk-alpha/)
+[![Python version](https://img.shields.io/pypi/pyversions/binance-sdk-alpha)](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 Alpha API, enabling developers to interact programmatically with Binance Alpha. The library provides tools to access curated early-stage token data, track Alpha project metrics and integrate discovery-focused market information into applications through the REST API:
+- [REST API](./src/binance_sdk_alpha/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:
+  - `/bapi/defi/v1/*`
+- 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-alpha
+```
+
+## Documentation
+
+For detailed information, refer to the [Binance API Documentation](https://developers.binance.com/docs/alpha/Introduction).
+
+### REST APIs
+
+All REST API endpoints are available through the [`rest_api`](./src/binance_sdk_alpha/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
+import logging
+
+from binance_common.configuration import ConfigurationRestAPI
+from binance_common.constants import ALPHA_REST_API_PROD_URL
+from binance_sdk_alpha.alpha import Alpha
+
+logging.basicConfig(level=logging.INFO)
+configuration = ConfigurationRestAPI(api_key="your-api-key", api_secret="your-api-secret", base_path=ALPHA_REST_API_PROD_URL)
+
+client = Alpha(config_rest_api=configuration)
+
+try:
+        response = client.rest_api.get_exchange_info()
+
+    data = response.data()
+    logging.info(f"get_exchange_info() response: {data}")
+except Exception as e:
+        logging.error(f"get_exchange_info() 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://www.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.

clients/alpha/docs/rest_api/certificate-pinning.md

@@ -0,0 +1,65 @@
+# Certificate Pinning
+
+```python
+import ssl
+import base64
+import hashlib
+
+from socket import create_connection
+from OpenSSL.crypto import dump_publickey, load_certificate, FILETYPE_ASN1
+
+from binance_common.configuration import ConfigurationRestAPI
+from binance_sdk_alpha.alpha import Alpha
+from binance_sdk_alpha.rest_api.models import GetExchangeInfoResponse
+
+PINNED_PUBLIC_KEY = "YOUR-PINNED-PUBLIC-KEY"
+CA_CERT_PATH = "/path/to/certificate.pem"
+
+def verify_certificate(hostname, port=443):
+    """Retrieve the certificate, extract the public key, and verify its hash."""
+    # Establish an SSL connection
+    context = ssl.create_default_context()
+    conn = context.wrap_socket(create_connection((hostname, port)), server_hostname=hostname)
+    
+    # Get the certificate in DER format
+    der_cert = conn.getpeercert(binary_form=True)
+    conn.close()
+
+    # Convert DER to X.509 certificate
+    x509 = load_certificate(FILETYPE_ASN1, der_cert)
+
+    # Extract public key
+    pubkey_der = dump_publickey(FILETYPE_ASN1, x509.get_pubkey())
+
+    # Compute the SHA-256 hash of the public key
+    public_key_hash = base64.b64encode(hashlib.sha256(pubkey_der).digest()).decode()
+
+    # Validate public key hash against the pinned key
+    if public_key_hash != PINNED_PUBLIC_KEY:
+        raise ssl.SSLError(f"Certificate pinning validation failed: expected {PINNED_PUBLIC_KEY}, got {public_key_hash}")
+
+class PinnedSSLContext(ssl.SSLContext):
+    def __init__(self, hostname):
+        super().__init__(ssl.PROTOCOL_TLS_CLIENT)
+        self.verify_mode = ssl.CERT_REQUIRED
+        self.load_verify_locations(CA_CERT_PATH)
+        verify_certificate(hostname)
+
+ssl_context = PinnedSSLContext("api.binance.com")
+
+configuration = ConfigurationRestAPI(
+    api_key="your-api-key",
+    api_secret="your-api-secret",
+    https_agent=ssl_context,
+)
+client = Alpha(config_rest_api=configuration)
+
+try:
+    response = client.rest_api.get_exchange_info()
+    data: GetExchangeInfoResponse = response.data()
+    print(data)
+except ssl.SSLError as ssl_err:
+    print("SSL Certificate validation failed! Possible MITM attack.", ssl_err)
+except Exception as err:
+    print("An error occurred:", err)
+```

clients/alpha/docs/rest_api/compression.md

@@ -0,0 +1,21 @@
+# Compression Configuration
+
+```python
+from binance_common.configuration import ConfigurationRestAPI
+from binance_sdk_alpha.alpha import Alpha
+from binance_sdk_alpha.rest_api.models import GetExchangeInfoResponse
+
+configuration = ConfigurationRestAPI(
+    api_key="your-api-key",
+    api_secret="your-api-secret",
+    compression=False
+)
+client = Alpha(config_rest_api=configuration)
+
+try:
+    response = client.rest_api.get_exchange_info()
+    data: GetExchangeInfoResponse = response.data()
+    print(data)
+except Exception as e:
+    print(e)
+```