@binance/rebate 1.0.0

package/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.

package/README.md

@@ -0,0 +1,195 @@
+# Binance JavaScript Rebate Connector
+
+[![Open Issues](https://img.shields.io/github/issues/binance/binance-connector-js)](https://github.com/binance/binance-connector-js/issues)
+[![Code Style: Prettier](https://img.shields.io/badge/code%20style-prettier-ff69b4)](https://prettier.io/)
+[![npm version](https://badge.fury.io/js/@binance%2Frebate.svg)](https://badge.fury.io/js/@binance%2Frebate)
+[![npm Downloads](https://img.shields.io/npm/dm/@binance/rebate.svg)](https://www.npmjs.com/package/@binance/rebate)
+![Node.js Version](https://img.shields.io/badge/Node.js-%3E=22.12.0-brightgreen)
+[![Known Vulnerabilities](https://snyk.io/test/github/binance/binance-connector-js/badge.svg)](https://snyk.io/test/github/binance/binance-connector-js)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+This is a client library for the Binance Rebate API, enabling developers to interact programmatically with Binance's Rebate trading platform. The library provides tools to query spot rebate history Records through the REST API:
+
+- [REST API](./src/rest-api/rest-api.ts)
+
+## Table of Contents
+
+- [Supported Features](#supported-features)
+- [Installation](#installation)
+- [Documentation](#documentation)
+- [REST APIs](#rest-apis)
+- [Testing](#testing)
+- [Migration Guide](#migration-guide)
+- [Contributing](#contributing)
+- [Licence](#licence)
+
+## Supported Features
+
+- REST API Endpoints:
+  - `/sapi/v1/rebate/*`
+- Inclusion of test cases and examples for quick onboarding.
+
+## Installation
+
+To use this library, ensure your environment is running Node.js version **22.12.0** or later. If you're using `nvm` (Node Version Manager), you can set the correct version as follows:
+
+```bash
+nvm install 22.12.0
+nvm use 22.12.0
+```
+
+Then install the library using `npm`:
+
+```bash
+npm install @binance/rebate
+```
+
+## Documentation
+
+For detailed information, refer to the [Binance API Documentation](https://developers.binance.com/docs/rebate).
+
+### REST APIs
+
+All REST API endpoints are available through the [`rest-api`](./src/rest-api/rest-api.ts) module. Note that some endpoints require authentication using your Binance API credentials.
+
+```typescript
+import { Rebate, RebateRestAPI } from '@binance/rebate';
+
+const configurationRestAPI = {
+    apiKey: 'your-api-key',
+    apiSecret: 'your-api-secret',
+};
+const client = new Rebate({ configurationRestAPI });
+
+client.restAPI
+    .getSpotRebateHistoryRecords()
+    .then((res) => res.data())
+    .then((data: RebateRestAPI.GetSpotRebateHistoryRecordsResponse) => console.log(data))
+    .catch((err) => console.error(err));
+```
+
+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.
+- `keepAlive`: 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).
+- `httpsAgent`: Custom HTTPS agent for advanced TLS configuration.
+- `privateKey`: RSA or ED25519 private key for authentication.
+- `privateKeyPassphrase`: 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 `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.
+- `RequiredError`: Thrown when a required parameter is missing.
+- `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.
+- `NetworkError`: Issues with network connectivity.
+- `NotFoundError`: Resource not found.
+- `BadRequestError`: Invalid request.
+
+See the [Error Handling example](./docs/rest-api/error-handling.md) for detailed usage.
+
+#### Testnet
+
+For testing purposes, `/sapi/v1/rebate/*` endpoints can be used in the [Testnet](https://testnet.binance.vision/). Update the `basePath` in your configuration:
+
+```typescript
+import { Rebate, RebateRestAPI, REBATE_REST_API_TESTNET_URL } from '@binance/rebate';
+
+const configurationRestAPI = {
+    apiKey: 'your-api-key',
+    apiSecret: 'your-api-secret',
+    basePath: REBATE_REST_API_TESTNET_URL,
+};
+const client = new Rebate({ configurationRestAPI });
+```
+
+If `basePath` is not provided, it defaults to `https://api.binance.com`.
+
+## Testing
+
+To run the tests:
+
+```bash
+npm install
+
+npm run test
+```
+
+The tests cover:
+
+- REST API endpoints
+- Error handling and edge cases
+
+## Migration Guide
+
+If you are upgrading to the new modularized structure, refer to the [Migration Guide](./docs/migration_guide_rebate_connector.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!
+
+## Licence
+
+This project is licensed under the MIT License. See the [LICENCE](./LICENCE) file for details.

package/dist/index.d.mts

@@ -0,0 +1,362 @@
+import { RestApiResponse, ConfigurationRestAPI } from '@binance/common';
+export { BadRequestError, ConnectorClientError, ForbiddenError, NetworkError, NotFoundError, REBATE_REST_API_PROD_URL, REBATE_REST_API_TESTNET_URL, RateLimitBanError, RequiredError, ServerError, TooManyRequestsError, UnauthorizedError } from '@binance/common';
+
+/**
+ * Binance Public Rebate REST API
+ *
+ * OpenAPI Specification for the Binance Public Rebate REST API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface BadRequest
+ */
+interface BadRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof BadRequest
+     */
+    code: number;
+    /**
+     *
+     * @type {string}
+     * @memberof BadRequest
+     */
+    message: string;
+}
+
+/**
+ * Binance Public Rebate REST API
+ *
+ * OpenAPI Specification for the Binance Public Rebate REST API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface GetSpotRebateHistoryRecordsResponseDataDataInner
+ */
+interface GetSpotRebateHistoryRecordsResponseDataDataInner {
+    /**
+     *
+     * @type {string}
+     * @memberof GetSpotRebateHistoryRecordsResponseDataDataInner
+     */
+    asset?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof GetSpotRebateHistoryRecordsResponseDataDataInner
+     */
+    type?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof GetSpotRebateHistoryRecordsResponseDataDataInner
+     */
+    amount?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof GetSpotRebateHistoryRecordsResponseDataDataInner
+     */
+    updateTime?: number;
+}
+
+/**
+ * Binance Public Rebate REST API
+ *
+ * OpenAPI Specification for the Binance Public Rebate REST API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ *
+ * @export
+ * @interface GetSpotRebateHistoryRecordsResponseData
+ */
+interface GetSpotRebateHistoryRecordsResponseData {
+    /**
+     *
+     * @type {number}
+     * @memberof GetSpotRebateHistoryRecordsResponseData
+     */
+    page?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetSpotRebateHistoryRecordsResponseData
+     */
+    totalRecords?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetSpotRebateHistoryRecordsResponseData
+     */
+    totalPageNum?: number;
+    /**
+     *
+     * @type {Array<GetSpotRebateHistoryRecordsResponseDataDataInner>}
+     * @memberof GetSpotRebateHistoryRecordsResponseData
+     */
+    data?: Array<GetSpotRebateHistoryRecordsResponseDataDataInner>;
+}
+
+/**
+ * Binance Public Rebate REST API
+ *
+ * OpenAPI Specification for the Binance Public Rebate REST API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ *
+ * @export
+ * @interface GetSpotRebateHistoryRecordsResponse
+ */
+interface GetSpotRebateHistoryRecordsResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof GetSpotRebateHistoryRecordsResponse
+     */
+    status?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetSpotRebateHistoryRecordsResponse
+     */
+    type?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetSpotRebateHistoryRecordsResponse
+     */
+    code?: string;
+    /**
+     *
+     * @type {GetSpotRebateHistoryRecordsResponseData}
+     * @memberof GetSpotRebateHistoryRecordsResponse
+     */
+    data?: GetSpotRebateHistoryRecordsResponseData;
+}
+
+/**
+ * Binance Public Rebate REST API
+ *
+ * OpenAPI Specification for the Binance Public Rebate REST API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * RebateApi - interface
+ * @interface RebateApi
+ */
+interface RebateApiInterface {
+    /**
+     * Get Spot Rebate History Records
+     *
+     * The max interval between startTime and endTime is 30 days.
+     * If startTime and endTime are not sent, the recent 7 days' data will be returned.
+     * The earliest startTime is supported on June 10, 2020
+     * Return up to 200 records per request.
+     *
+     * Weight: 12000
+     *
+     * @summary Get Spot Rebate History Records (USER_DATA)
+     * @param {GetSpotRebateHistoryRecordsRequest} requestParameters Request parameters.
+     *
+     * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
+     * @memberof RebateApiInterface
+     */
+    getSpotRebateHistoryRecords(requestParameters?: GetSpotRebateHistoryRecordsRequest): Promise<RestApiResponse<GetSpotRebateHistoryRecordsResponse>>;
+}
+/**
+ * Request parameters for getSpotRebateHistoryRecords operation in RebateApi.
+ * @interface GetSpotRebateHistoryRecordsRequest
+ */
+interface GetSpotRebateHistoryRecordsRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof RebateApiGetSpotRebateHistoryRecords
+     */
+    readonly startTime?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof RebateApiGetSpotRebateHistoryRecords
+     */
+    readonly endTime?: number;
+    /**
+     * Default 1
+     * @type {number}
+     * @memberof RebateApiGetSpotRebateHistoryRecords
+     */
+    readonly page?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof RebateApiGetSpotRebateHistoryRecords
+     */
+    readonly recvWindow?: number;
+}
+/**
+ * RebateApi - object-oriented interface
+ * @class RebateApi
+ */
+declare class RebateApi implements RebateApiInterface {
+    private readonly configuration;
+    private localVarAxiosParamCreator;
+    constructor(configuration: ConfigurationRestAPI);
+    /**
+     * Get Spot Rebate History Records
+     *
+     * The max interval between startTime and endTime is 30 days.
+     * If startTime and endTime are not sent, the recent 7 days' data will be returned.
+     * The earliest startTime is supported on June 10, 2020
+     * Return up to 200 records per request.
+     *
+     * Weight: 12000
+     *
+     * @summary Get Spot Rebate History Records (USER_DATA)
+     * @param {GetSpotRebateHistoryRecordsRequest} requestParameters Request parameters.
+     * @returns {Promise<RestApiResponse<GetSpotRebateHistoryRecordsResponse>>}
+     * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
+     * @memberof RebateApi
+     * @see {@link https://developers.binance.com/docs/rebate/rest-api/Get-Spot-Rebate-History-Records Binance API Documentation}
+     */
+    getSpotRebateHistoryRecords(requestParameters?: GetSpotRebateHistoryRecordsRequest): Promise<RestApiResponse<GetSpotRebateHistoryRecordsResponse>>;
+}
+
+/**
+ * Binance Public Rebate REST API
+ *
+ * OpenAPI Specification for the Binance Public Rebate REST API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+declare class RestAPI {
+    private configuration;
+    private rebateApi;
+    constructor(configuration: ConfigurationRestAPI);
+    /**
+     * Generic function to send a request.
+     * @param endpoint - The API endpoint to call.
+     * @param method - HTTP method to use (GET, POST, DELETE, etc.).
+     * @param params - Query parameters for the request.
+     *
+     * @returns A promise resolving to the response data object.
+     */
+    sendRequest<T>(endpoint: string, method: 'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH', params?: Record<string, unknown>): Promise<RestApiResponse<T>>;
+    /**
+     * Generic function to send a signed request.
+     * @param endpoint - The API endpoint to call.
+     * @param method - HTTP method to use (GET, POST, DELETE, etc.).
+     * @param params - Query parameters for the request.
+     *
+     * @returns A promise resolving to the response data object.
+     */
+    sendSignedRequest<T>(endpoint: string, method: 'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH', params?: Record<string, unknown>): Promise<RestApiResponse<T>>;
+    /**
+     * Get Spot Rebate History Records
+     *
+     * The max interval between startTime and endTime is 30 days.
+     * If startTime and endTime are not sent, the recent 7 days' data will be returned.
+     * The earliest startTime is supported on June 10, 2020
+     * Return up to 200 records per request.
+     *
+     * Weight: 12000
+     *
+     * @summary Get Spot Rebate History Records (USER_DATA)
+     * @param {GetSpotRebateHistoryRecordsRequest} requestParameters Request parameters.
+     * @returns {Promise<RestApiResponse<GetSpotRebateHistoryRecordsResponse>>}
+     * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
+     * @see {@link https://developers.binance.com/docs/rebate/rest-api/Get-Spot-Rebate-History-Records Binance API Documentation}
+     */
+    getSpotRebateHistoryRecords(requestParameters?: GetSpotRebateHistoryRecordsRequest): Promise<RestApiResponse<GetSpotRebateHistoryRecordsResponse>>;
+}
+
+/**
+ * Binance Public Rebate REST API
+ *
+ * OpenAPI Specification for the Binance Public Rebate REST API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+type index_BadRequest = BadRequest;
+type index_GetSpotRebateHistoryRecordsRequest = GetSpotRebateHistoryRecordsRequest;
+type index_GetSpotRebateHistoryRecordsResponse = GetSpotRebateHistoryRecordsResponse;
+type index_GetSpotRebateHistoryRecordsResponseData = GetSpotRebateHistoryRecordsResponseData;
+type index_GetSpotRebateHistoryRecordsResponseDataDataInner = GetSpotRebateHistoryRecordsResponseDataDataInner;
+type index_RebateApi = RebateApi;
+declare const index_RebateApi: typeof RebateApi;
+type index_RebateApiInterface = RebateApiInterface;
+type index_RestAPI = RestAPI;
+declare const index_RestAPI: typeof RestAPI;
+declare namespace index {
+  export {
+    index_BadRequest as BadRequest,
+    index_GetSpotRebateHistoryRecordsRequest as GetSpotRebateHistoryRecordsRequest,
+    index_GetSpotRebateHistoryRecordsResponse as GetSpotRebateHistoryRecordsResponse,
+    index_GetSpotRebateHistoryRecordsResponseData as GetSpotRebateHistoryRecordsResponseData,
+    index_GetSpotRebateHistoryRecordsResponseDataDataInner as GetSpotRebateHistoryRecordsResponseDataDataInner,
+    index_RebateApi as RebateApi,
+    index_RebateApiInterface as RebateApiInterface,
+    index_RestAPI as RestAPI,
+  };
+}
+
+interface ConfigurationRebate {
+    configurationRestAPI?: ConfigurationRestAPI;
+}
+declare class Rebate {
+    restAPI: RestAPI;
+    constructor(config: ConfigurationRebate);
+}
+
+export { ConfigurationRebate, Rebate, index as RebateRestAPI };