Module @binance/common
Binance Common Types and Utilities for Binance Connectors
@binance/common is a utility package for Binance modular connectors, providing commonly used functions and helpers for working with Binance REST/WebSocket APIs. It ensures reusable and optimized utilities to streamline development.
Installation
To use this package, install it via npm:
npm install @binance/common
Features
- Common Utility Functions for API requests, timestamps, and signatures.
- Optimized for Binance Connectors to ensure seamless integration.
- Lightweight & Tree-Shakeable – only imports what you need.
- Fully Compatible with TypeScript for strong type safety.
Contributing
Contributions are welcome!
- Open a GitHub issue before making changes.
- Discuss proposed changes with maintainers.
- Follow the existing TypeScript structure.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Enumerations
Classes
- BadRequestError
- ConfigurationRestAPI
- ConfigurationWebsocketAPI
- ConfigurationWebsocketStreams
- ConnectorClientError
- ForbiddenError
- Logger
- NetworkError
- NotFoundError
- RateLimitBanError
- RequiredError
- ServerError
- TooManyRequestsError
- UnauthorizedError
- WebsocketAPIBase
- WebsocketCommon
- WebsocketEventEmitter
- WebsocketStreamsBase
Interfaces
Type Aliases
Variables
- ALGO_REST_API_PROD_URL
- AUTO_INVEST_REST_API_PROD_URL
- C2C_REST_API_PROD_URL
- CONVERT_REST_API_PROD_URL
- COPY_TRADING_REST_API_PROD_URL
- CRYPTO_LOAN_REST_API_PROD_URL
- DERIVATIVES_TRADING_COIN_FUTURES_REST_API_PROD_URL
- DERIVATIVES_TRADING_COIN_FUTURES_REST_API_TESTNET_URL
- DERIVATIVES_TRADING_COIN_FUTURES_WS_API_PROD_URL
- DERIVATIVES_TRADING_COIN_FUTURES_WS_API_TESTNET_URL
- DERIVATIVES_TRADING_COIN_FUTURES_WS_STREAMS_PROD_URL
- DERIVATIVES_TRADING_COIN_FUTURES_WS_STREAMS_TESTNET_URL
- DERIVATIVES_TRADING_OPTIONS_REST_API_PROD_URL
- DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_PROD_URL
- DERIVATIVES_TRADING_PORTFOLIO_MARGIN_PRO_REST_API_PROD_URL
- DERIVATIVES_TRADING_PORTFOLIO_MARGIN_PRO_WS_STREAMS_PROD_URL
- DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_PROD_URL
- DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_TESTNET_URL
- DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_PROD_URL
- DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_TESTNET_URL
- DERIVATIVES_TRADING_USDS_FUTURES_REST_API_PROD_URL
- DERIVATIVES_TRADING_USDS_FUTURES_REST_API_TESTNET_URL
- DERIVATIVES_TRADING_USDS_FUTURES_WS_API_PROD_URL
- DERIVATIVES_TRADING_USDS_FUTURES_WS_API_TESTNET_URL
- DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_PROD_URL
- DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_TESTNET_URL
- DUAL_INVESTMENT_REST_API_PROD_URL
- FIAT_REST_API_PROD_URL
- GIFT_CARD_REST_API_PROD_URL
- MARGIN_TRADING_REST_API_PROD_URL
- MARGIN_TRADING_RISK_WS_STREAMS_PROD_URL
- MARGIN_TRADING_WS_STREAMS_PROD_URL
- MINING_REST_API_PROD_URL
- NFT_REST_API_PROD_URL
- PAY_REST_API_PROD_URL
- REBATE_REST_API_PROD_URL
- SIMPLE_EARN_REST_API_PROD_URL
- SPOT_REST_API_MARKET_URL
- SPOT_REST_API_PROD_URL
- SPOT_REST_API_TESTNET_URL
- SPOT_WS_API_PROD_URL
- SPOT_WS_API_TESTNET_URL
- SPOT_WS_STREAMS_MARKET_URL
- SPOT_WS_STREAMS_PROD_URL
- SPOT_WS_STREAMS_TESTNET_URL
- STAKING_REST_API_PROD_URL
- SUB_ACCOUNT_REST_API_PROD_URL
- TimeUnit
- VIP_LOAN_REST_API_PROD_URL
- WALLET_REST_API_PROD_URL
Functions
- assertParamExists
- buildQueryString
- buildUserAgent
- buildWebsocketAPIMessage
- clearSignerCache
- createStreamHandler
- delay
- getSignature
- getTimestamp
- httpRequestFunction
- parseCustomHeaders
- parseRateLimitHeaders
- randomString
- removeEmptyValue
- replaceWebsocketStreamsPlaceholders
- sanitizeHeaderValue
- sendRequest
- setFlattenedQueryParams
- setSearchParams
- shouldRetryRequest
- sortObject
- toPathString
- validateTimeUnit