Release stocks v1.0.0

clients/pom.xml

@@ -39,6 +39,7 @@
         <module>simple-earn</module>
         <module>spot</module>
         <module>staking</module>
+        <module>stocks</module>
         <module>sub-account</module>
         <module>vip-loan</module>
         <module>w3w-prediction</module>

clients/stocks/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0 - 2026-08-17
+
+- Initial release

clients/stocks/README.md

@@ -0,0 +1,162 @@
+# Binance Java Stocks Connector
+
+[![Open Issues](https://img.shields.io/github/issues/binance/binance-connector-java)](https://github.com/binance/binance-connector-java/issues)
+[![Code Style: Spotless](https://img.shields.io/badge/code%20style-spotless-ff69b4)](https://github.com/diffplug/spotless)
+[![Maven Central Version](https://img.shields.io/maven-central/v/io.github.binance/binance-stocks)](https://central.sonatype.com/artifact/io.github.binance/binance-stocks)
+![Java Version](https://img.shields.io/badge/Java-%3E=11-brightgreen)
+[![Known Vulnerabilities](https://snyk.io/test/github/binance/binance-connector-java/badge.svg)](https://snyk.io/test/github/binance/binance-connector-java)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+This is a client library for the Binance Stocks API, enabling developers to interact programmatically with Binance Stocks. The library provides tools to access trade U.S.-listed stocks and ETFs programmatically through a secure and developer-friendly REST API.
+
+- [REST API](./src/main/java/com/binance/connector/client/stocks/rest/api)
+
+## Table of Contents
+
+- [Supported Features](#supported-features)
+- [Installation](#installation)
+- [Documentation](#documentation)
+- [REST APIs](#rest-apis)
+- [Testing](#testing)
+- [Migration Guide](#migration-guide)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Supported Features
+
+- REST API Endpoints:
+    - `/sapi/v1/equity/*`
+- Inclusion of test cases and examples for quick onboarding.
+
+## Installation
+
+To use this library, ensure your environment is running Java version **11** or newer.
+
+Then add dependency to pom.xml:
+
+```xml
+<dependency>
+  <groupId>io.github.binance</groupId>
+  <artifactId>binance-stocks</artifactId>
+  <version>1.0.0</version>
+</dependency>
+```
+
+## Documentation
+
+For detailed information, refer to the [Binance API Documentation](https://developers.binance.com/docs/stocks).
+
+### REST APIs
+
+All REST API endpoints are available through the [`rest`](./src/main/java/com/binance/connector/client/stocks/rest) module. Note that some endpoints require authentication using your Binance API credentials.
+
+```java
+import com.binance.connector.client.stocks.rest.StocksRestApiUtil;
+import com.binance.connector.client.stocks.rest.api.StocksRestApi;
+import com.binance.connector.client.common.ApiException;
+import com.binance.connector.client.common.ApiResponse;
+import com.binance.connector.client.common.configuration.ClientConfiguration;
+import com.binance.connector.client.common.configuration.SignatureConfiguration;
+
+public static void main(String[] args) {
+    ClientConfiguration clientConfiguration = StocksRestApiUtil.getClientConfiguration();
+    SignatureConfiguration signatureConfiguration = new SignatureConfiguration();
+    signatureConfiguration.setApiKey("apiKey");
+    signatureConfiguration.setPrivateKey("path/to/private.key");
+    clientConfiguration.setSignatureConfiguration(signatureConfiguration);
+    StocksRestApi api = new StocksRestApi(clientConfiguration);
+}
+```
+
+More examples can be found in the [`examples/rest`](./../../examples/stocks/src/main/java/com/binance/connector/client/stocks/rest) folder.
+
+#### Configuration Options
+
+The REST API supports the following advanced configuration options:
+
+- `proxy`: Proxy configuration for http client.
+- `certificatePinner`: Certificate Pinner configuration for http client.
+- `connectTimeout`: Timeout for requests in milliseconds (default: 1000 ms).
+- `readTimeout`: Timeout for requests in milliseconds (default: 5000 ms).
+- `compression`: Enable response compression (default: true).
+- `retries`: Number of retry attempts for failed requests (default: 3).
+- `backoff`: Delay in milliseconds between retries (default: 200 ms).
+- `timeUnit`: TimeUnit to be returned by API (default MILLISECOND).
+- `apiKey`: Binance API Key
+- `secretKey`: Binance Secret Key, if using HMAC algorithm 
+- `privateKey`: RSA or ED25519 private key for authentication.
+- `privateKeyPass`: 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.
+
+##### 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.
+
+##### 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 `httpsAgent` 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:
+
+- `ConnectorClientError`: General client error.
+
+See the [Error Handling example](./docs/rest-api/error-handling.md) for detailed usage.
+
+If `basePath` is not provided, it defaults to `https://api.binance.com`.
+
+## Testing
+
+To run the tests:
+
+```bash
+mvn -f clients/pom.xml -pl stocks test
+```
+
+The tests cover:
+
+- REST API endpoints
+- Signature generation
+
+## Migration Guide
+
+If you are upgrading to the new modularized structure, refer to the [Migration Guide](./docs/rest-api/migration-guide.md) for detailed steps.
+
+## 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!
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](../../LICENSE) file for details.

clients/stocks/docs/AccountApi.md

@@ -0,0 +1,71 @@
+# AccountApi
+
+All URIs are relative to *https://api.binance.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**signUsEquityDisclaimer**](AccountApi.md#signUsEquityDisclaimer) | **POST** /sapi/v1/equity/account/disclaimer | Sign US Equity Disclaimer (TRADE) |
+
+
+<a id="signUsEquityDisclaimer"></a>
+# **signUsEquityDisclaimer**
+> SignUsEquityDisclaimerResponse signUsEquityDisclaimer(recvWindow)
+
+Sign US Equity Disclaimer (TRADE)
+
+Records the user&#39;s acknowledgement and acceptance of the US equity disclaimer. This must be completed before the account can access certain US equity trading features. The acceptance is tied to the account associated with the API key.  Weight: 1  Security Type: TRADE
+
+### Example
+```java
+// Import classes:
+import com.binance.connector.client.stocks.ApiClient;
+import com.binance.connector.client.stocks.ApiException;
+import com.binance.connector.client.stocks.Configuration;
+import com.binance.connector.client.stocks.models.*;
+import com.binance.connector.client.stocks.rest.api.AccountApi;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = Configuration.getDefaultApiClient();
+    defaultClient.setBasePath("https://api.binance.com");
+
+    AccountApi apiInstance = new AccountApi(defaultClient);
+    Long recvWindow = 5000L; // Long | The value cannot be greater than `60000`.
+    try {
+      SignUsEquityDisclaimerResponse result = apiInstance.signUsEquityDisclaimer(recvWindow);
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling AccountApi#signUsEquityDisclaimer");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}
+```
+
+### Parameters
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **recvWindow** | **Long**| The value cannot be greater than &#x60;60000&#x60;. | [optional] |
+
+### Return type
+
+[**SignUsEquityDisclaimerResponse**](SignUsEquityDisclaimerResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Sign US Equity Disclaimer |  -  |
+

clients/stocks/docs/CalendarStreamResponse.md

@@ -0,0 +1,16 @@
+
+
+# CalendarStreamResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**ELowerCase** | **String** | Event type, always `\"calendar\"`. |  [optional] |
+|**from** | **String** | Previous market phase. |  [optional] |
+|**to** | **String** | New market phase. |  [optional] |
+|**ts** | **Long** | Event timestamp (epoch milliseconds UTC) when the transition was detected. |  [optional] |
+
+
+

clients/stocks/docs/CancelAllEquityOrdersResponse.md

@@ -0,0 +1,13 @@
+
+
+# CancelAllEquityOrdersResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**success** | **Boolean** | `true` when the cancel-all request was accepted by upstream. Per-order outcomes live in `/order/history`. |  [optional] |
+
+
+

clients/stocks/docs/CancelEquityOrderResponse.md

@@ -0,0 +1,14 @@
+
+
+# CancelEquityOrderResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**orderId** | **String** | Echoes the requested order id. |  [optional] |
+|**status** | **String** | Acknowledgement code: `S` = cancel accepted by upstream, `F` = cancel failed. Not an order lifecycle status — use `/order/detail` for lifecycle poll. |  [optional] |
+
+
+

clients/stocks/docs/ConvertType.md

@@ -0,0 +1,13 @@
+
+
+# ConvertType
+
+## Enum
+
+
+* `MINT` (value: `"MINT"`)
+
+* `REDEEM` (value: `"REDEEM"`)
+
+
+

clients/stocks/docs/CreateRenewListenKeyResponse.md

@@ -0,0 +1,13 @@
+
+
+# CreateRenewListenKeyResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**listenKey** | **String** | Session identifier for the stock user data stream. |  [optional] |
+
+
+

clients/stocks/docs/CurrentOpenOrdersResponse.md

@@ -0,0 +1,13 @@
+
+
+# CurrentOpenOrdersResponse
+
+Array of open order objects. Fields are identical to the order rows in Equity Order History.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+
+
+

clients/stocks/docs/CurrentOpenOrdersResponseInner.md

@@ -0,0 +1,28 @@
+
+
+# CurrentOpenOrdersResponseInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**orderId** | **String** | Equity order id. |  [optional] |
+|**symbol** | **String** | US-equity ticker. |  [optional] |
+|**quote** | **String** | Quote asset (e.g. `USDC`). |  [optional] |
+|**side** | **String** | `BUY` / `SELL`. |  [optional] |
+|**orderType** | **String** | `MARKET` / `LIMIT`. |  [optional] |
+|**limitPrice** | **String** | Limit price (USD). Non-null for `LIMIT` orders, `null` for `MARKET`. |  [optional] |
+|**avgFilledPrice** | **String** | Average fill price (USD). `null` until the first fill. |  [optional] |
+|**qty** | **String** | Requested quantity. `null` for `BUY MARKET` (use `notional` instead). |  [optional] |
+|**notional** | **String** | Requested notional. Non-null for `BUY MARKET`; `null` otherwise. |  [optional] |
+|**filledQty** | **String** | Cumulative filled quantity. |  [optional] |
+|**filledTotal** | **String** | Cumulative filled notional. Populated only for `BUY MARKET`. |  [optional] |
+|**fee** | **String** | Total commission fee (USD). |  [optional] |
+|**session** | **String** | Trading session the order was placed under: `RTH` / `EXTENDED` / `24H`. `null` for `MARKET` orders. |  [optional] |
+|**status** | **String** | Order lifecycle status — one of `NEW` / `ACCEPTED` / `PARTIALLY_FILLED` / `FILLED` / `CANCELED` / `EXPIRED` / `REJECTED`. |  [optional] |
+|**createdAt** | **Long** | Order creation time (ms epoch). |  [optional] |
+|**updatedAt** | **Long** | Last update time (ms epoch). |  [optional] |
+
+
+

clients/stocks/docs/EquityOrderDetailResponse.md

@@ -0,0 +1,31 @@
+
+
+# EquityOrderDetailResponse
+
+Top-level fields mirror an order row from `/order/history` (orderId, symbol, quote, side, orderType, limitPrice, avgFilledPrice, qty, notional, filledQty, filledTotal, fee, session, status, createdAt, updatedAt), plus a `trades` array. `clientOrderId` is present only in Order Detail, not in Order History.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**orderId** | **String** | Equity order id. |  [optional] |
+|**clientOrderId** | **String** | Client-supplied order id. Present only in Order Detail, not in Order History. |  [optional] |
+|**symbol** | **String** | US-equity ticker. |  [optional] |
+|**quote** | **String** | Quote asset. |  [optional] |
+|**side** | **String** | `BUY` / `SELL`. |  [optional] |
+|**orderType** | **String** | `MARKET` / `LIMIT`. |  [optional] |
+|**limitPrice** | **String** | Limit price (USD). Non-null for `LIMIT`, `null` for `MARKET`. |  [optional] |
+|**avgFilledPrice** | **String** | Average fill price (USD). Only present when the order has at least one fill. |  [optional] |
+|**qty** | **String** | Requested quantity. |  [optional] |
+|**notional** | **String** | Requested notional. |  [optional] |
+|**filledQty** | **String** | Cumulative filled quantity. |  [optional] |
+|**filledTotal** | **String** | Cumulative filled notional. |  [optional] |
+|**fee** | **String** | Total commission fee (USD). |  [optional] |
+|**session** | **String** | Trading session. |  [optional] |
+|**status** | **String** | Order lifecycle status. |  [optional] |
+|**createdAt** | **Long** | Order creation time (ms epoch). |  [optional] |
+|**updatedAt** | **Long** | Last update time (ms epoch). |  [optional] |
+|**trades** | [**List<EquityOrderDetailResponseTradesInner>**](EquityOrderDetailResponseTradesInner.md) | Trade executions for this order, most recent first. Empty array when no fills. |  [optional] |
+
+
+