Binance JavaScript Alpha Connector

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
• Websocket Stream

Table of Contents

• Supported Features
• Installation
• Documentation
• REST APIs
• Websocket Streams
• Testing
• Contributing
• Licence

Supported Features

• REST API Endpoints:
  • /bapi/defi/v1/*
• WebSocket Endpoints: Real-time data streaming.
• 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:

nvm install 22.12.0
nvm use 22.12.0
Copy

Then install the library using npm:

npm install @binance/alpha
Copy

Documentation

For detailed information, refer to the Binance API Documentation.

REST APIs

All REST API endpoints are available through the rest-api module. Note that some endpoints require authentication using your Binance API credentials.

import { Alpha, AlphaRestAPI } from '@binance/alpha';

const configurationRestAPI = {
    apiKey: 'your-api-key',
    apiSecret: 'your-api-secret',
};
const client = new Alpha({ configurationRestAPI });

client.restAPI
    .getExchangeInfo()
    .then((res) => res.data())
    .then((data: AlphaRestAPI.GetExchangeInfoResponse) => console.log(data))
    .catch((err) => console.error(err));
Copy

More examples can be found in the 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 for detailed usage.

Proxy

The REST API supports HTTP/HTTPS proxy configurations. See the Proxy example for detailed usage.

Keep-Alive

Enable HTTP keep-alive for persistent connections. See the Keep-Alive example for detailed usage.

Compression

Enable or disable response compression. See the Compression example for detailed usage.

Retries

Configure the number of retry attempts and delay in milliseconds between retries for failed requests. See the Retries example for detailed usage.

HTTPS Agent

Customize the HTTPS agent for advanced TLS configurations. See the HTTPS Agent example 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 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 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 for detailed usage.

If basePath is not provided, it defaults to https://www.binance.com.

Websocket Streams

WebSocket Streams provide real-time data feeds for market trades, candlesticks, and more. Use the websocket-streams module to subscribe to these streams.

import { Alpha, ALPHA_WS_STREAMS_PROD_URL } from '@binance/alpha';

const configurationWebsocketStreams = {
    wsURL: ALPHA_WS_STREAMS_PROD_URL,
};
const client = new Alpha({ configurationWebsocketStreams });

client.websocketStreams
    .connect()
    .then((connection) => {
        const stream = connection.allBookTickerStream();
        stream.on('message', (data) => console.info(data));
    })
    .catch((err) => console.error(err));
Copy

More examples are available in the examples/websocket-streams folder.

Configuration Options

The WebSocket Streams API supports the following advanced configuration options:

• reconnectDelay: Specify the delay between reconnection attempts (default: 5000 ms).
• compression: Enable or disable compression for WebSocket messages (default: true).
• agent: Customize the WebSocket agent for advanced configurations.
• mode: Choose between single and pool connection modes.
  • single: A single WebSocket connection.
  • pool: A pool of WebSocket connections.
• poolSize: Define the number of WebSocket connections in pool mode.

Reconnect Delay

Specify the delay in milliseconds between WebSocket reconnection attempts for streams. See the Reconnect Delay example for detailed usage.

Compression

Enable or disable compression for WebSocket Streams messages. See the Compression example for detailed usage.

WebSocket Agent

Customize the agent for advanced configurations. See the WebSocket Agent example for detailed usage.

Connection Mode

Choose between single and pool connection modes for WebSocket Streams. The single mode uses a single WebSocket connection, while the pool mode uses a pool of WebSocket connections. See the Connection Mode example for detailed usage.

Certificate Pinning

To enhance security, you can use certificate pinning with the agent option in the configuration. This ensures the client only communicates with servers using specific certificates. See the Certificate Pinning example for detailed usage.

Unsubscribing from Streams

You can unsubscribe from specific WebSocket streams using the unsubscribe method. This is useful for managing active subscriptions without closing the connection.

import { Alpha, ALPHA_WS_STREAMS_PROD_URL } from '@binance/alpha';

const configurationWebsocketStreams = {
    wsURL: ALPHA_WS_STREAMS_PROD_URL,
};
const client = new Alpha({ configurationWebsocketStreams });

client.websocketStreams
    .connect()
    .then((connection) => {
        const stream = connection.allBookTickerStream();
        stream.on('message', (data) => console.info(data));

        setTimeout(() => {
            stream.unsubscribe();
            console.log('Unsubscribed from allBookTickerStream stream');
        }, 10000);
    })
    .catch((err) => console.error(err));
Copy

If wsURL is not provided, it defaults to wss://nbstream.binance.com/w3w/wsa.

Automatic Connection Renewal

The WebSocket connection is automatically renewed for the WebSocket Streams connections, before the 24 hours expiration of the API key. This ensures continuous connectivity.

Testing

To run the tests:

npm install

npm run test
Copy

The tests cover:

• REST API endpoints
• Error handling and 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!

Disclaimer

This SDK is provided by Binance on an "as is" and "as available" basis for use at your own risk. Binance makes no representations or warranties of any kind, whether express or implied, as to the operation of the SDK, its accuracy, reliability, completeness, or fitness for any particular purpose.

To the fullest extent permitted by law, Binance shall not be liable for any losses, damages, or expenses of any kind arising from or in connection with your use of, or inability to use, this SDK, including but not limited to any financial losses resulting from errors, bugs, interruptions, or inaccuracies in the SDK.

Your use of this SDK to access the Binance Platform is subject to the Binance API Key Terms and the Binance Terms of Use, which shall prevail in the event of any conflict with this disclaimer. You are solely responsible for any orders or transactions executed through the Binance Platform using this SDK.

This SDK is not intended to constitute investment advice or a recommendation to buy, sell, or hold any digital asset. You should independently evaluate and verify all information before acting.

• Binance Terms of Use
• Binance API Key Terms

Licence

This project is licensed under the MIT License. See the LICENCE file for details.