@binance/common 2.1.1 → 2.3.0

package/dist/index.d.mts

@@ -28,7 +28,9 @@ declare const DERIVATIVES_TRADING_USDS_FUTURES_WS_API_TESTNET_URL = "wss://testn
 declare const DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_PROD_URL = "wss://fstream.binance.com";
 declare const DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_TESTNET_URL = "wss://stream.binancefuture.com";
 declare const DERIVATIVES_TRADING_OPTIONS_REST_API_PROD_URL = "https://eapi.binance.com";
-declare const DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_PROD_URL = "wss://nbstream.binance.com/eoptions";
+declare const DERIVATIVES_TRADING_OPTIONS_REST_API_TESTNET_URL = "https://testnet.binancefuture.com";
+declare const DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_PROD_URL = "wss://fstream.binance.com";
+declare const DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_TESTNET_URL = "wss://fstream.binancefuture.com";
 declare const DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_PROD_URL = "https://papi.binance.com";
 declare const DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_TESTNET_URL = "https://testnet.binancefuture.com";
 declare const DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_PROD_URL = "wss://fstream.binance.com/pm";
@@ -310,7 +312,8 @@ declare class ConfigurationWebsocketStreams {
  * @param msg - An optional error message.
  */
 declare class ConnectorClientError extends Error {
-  constructor(msg?: string);
+  code?: number;
+  constructor(msg?: string, code?: number);
 }
 /**
  * Represents an error that occurs when a required parameter is missing or undefined.
@@ -326,28 +329,32 @@ declare class RequiredError extends Error {
  * @param msg - An optional error message.
  */
 declare class UnauthorizedError extends Error {
-  constructor(msg?: string);
+  code?: number;
+  constructor(msg?: string, code?: number);
 }
 /**
  * Represents an error that occurs when a resource is forbidden to the client.
  * @param msg - An optional error message.
  */
 declare class ForbiddenError extends Error {
-  constructor(msg?: string);
+  code?: number;
+  constructor(msg?: string, code?: number);
 }
 /**
  * Represents an error that occurs when client is doing too many requests.
  * @param msg - An optional error message.
  */
 declare class TooManyRequestsError extends Error {
-  constructor(msg?: string);
+  code?: number;
+  constructor(msg?: string, code?: number);
 }
 /**
  * Represents an error that occurs when client's IP has been banned.
  * @param msg - An optional error message.
  */
 declare class RateLimitBanError extends Error {
-  constructor(msg?: string);
+  code?: number;
+  constructor(msg?: string, code?: number);
 }
 /**
  * Represents an error that occurs when there is an internal server error.
@@ -370,14 +377,16 @@ declare class NetworkError extends Error {
  * @param msg - An optional error message.
  */
 declare class NotFoundError extends Error {
-  constructor(msg?: string);
+  code?: number;
+  constructor(msg?: string, code?: number);
 }
 /**
  * Represents an error that occurs when a request is invalid or cannot be otherwise served.
  * @param msg - An optional error message.
  */
 declare class BadRequestError extends Error {
-  constructor(msg?: string);
+  code?: number;
+  constructor(msg?: string, code?: number);
 }
 //#endregion
 //#region src/logger.d.ts
@@ -759,6 +768,7 @@ interface WebsocketConnection {
   }>;
   pendingSubscriptions?: string[];
   ws?: WebSocketClient;
+  urlPath?: string;
   isSessionLoggedOn?: boolean;
   sessionLogonReq?: {
     method: string;
@@ -793,18 +803,20 @@ declare class WebsocketCommon extends WebsocketEventEmitter {
    * In 'single' mode, returns the first connection in the pool.
    * In 'pool' mode, filters and returns connections that are ready for use.
    * @param allowNonEstablishedWebsockets - Optional flag to include non-established WebSocket connections.
+   * @param urlPath - Optional URL path to filter connections.
    * @returns An array of available WebSocket connections.
    */
-  protected getAvailableConnections(allowNonEstablishedWebsockets?: boolean): WebsocketConnection[];
+  protected getAvailableConnections(allowNonEstablishedWebsockets?: boolean, urlPath?: string): WebsocketConnection[];
   /**
    * Gets a WebSocket connection from the pool or single connection.
    * If the connection mode is 'single', it returns the first connection in the pool.
    * If the connection mode is 'pool', it returns an available connection from the pool,
    * using a round-robin selection strategy. If no available connections are found, it throws an error.
    * @param allowNonEstablishedWebsockets - A boolean indicating whether to allow connections that are not established.
+   * @param urlPath - An optional URL path to filter connections.
    * @returns {WebsocketConnection} The selected WebSocket connection.
    */
-  protected getConnection(allowNonEstablishedWebsockets?: boolean): WebsocketConnection;
+  protected getConnection(allowNonEstablishedWebsockets?: boolean, urlPath?: string): WebsocketConnection;
   /**
    * Checks if the provided WebSocket connection is ready for use.
    * A connection is considered ready if it is open, has no pending reconnection, and has not been closed.
@@ -899,9 +911,10 @@ declare class WebsocketCommon extends WebsocketEventEmitter {
   /**
    * Connects all WebSocket connections in the pool
    * @param url - The Websocket server URL.
+   * @param connections - An optional array of WebSocket connections to connect. If not provided, all connections in the pool are connected.
    * @returns A promise that resolves when all connections are established.
    */
-  protected connectPool(url: string): Promise<void>;
+  protected connectPool(url: string, connections?: WebsocketConnection[]): Promise<void>;
   /**
    * Creates a new WebSocket client instance.
    * @param url - The URL to connect to.
@@ -993,15 +1006,31 @@ declare class WebsocketAPIBase extends WebsocketCommon {
 }
 declare class WebsocketStreamsBase extends WebsocketCommon {
   private streamConnectionMap;
+  protected urlPaths: string[];
   protected configuration: ConfigurationWebsocketStreams;
   protected wsURL: string;
   streamIdIsStrictlyNumber?: boolean;
   streamCallbackMap: Map<string, Set<(data: unknown) => void>>;
   logger: Logger;
-  constructor(configuration: ConfigurationWebsocketStreams, connectionPool?: WebsocketConnection[]);
+  constructor(configuration: ConfigurationWebsocketStreams, connectionPool?: WebsocketConnection[], urlPaths?: string[]);
+  /**
+   * Ensures the connection pool has the required size based on the configured mode and number of URL paths.
+   *
+   * If no URL paths are configured, the method returns early without modifications.
+   * In 'pool' mode, the pool size is multiplied by the number of URL paths.
+   * In 'single' mode, only one connection per URL path is maintained.
+   *
+   * New connections are initialized with unique IDs and default state flags when the pool
+   * size is less than the expected size.
+   *
+   * @private
+   * @returns {void}
+   */
+  private ensurePoolSizeForUrlPaths;
   /**
    * Formats the WebSocket URL for a given stream or streams.
    * @param streams - Array of stream names to include in the URL.
+   * @param urlPath - Optional URL path to include in the WebSocket URL.
    * @returns The formatted WebSocket URL with the provided streams.
    */
   private prepareURL;
@@ -1015,6 +1044,7 @@ declare class WebsocketStreamsBase extends WebsocketCommon {
   /**
    * Handles subscription to streams and assigns them to specific connections
    * @param streams Array of stream names to subscribe to
+   * @param urlPath Optional URL path for the streams
    * @returns Map of connections to streams
    */
   private handleStreamAssignment;
@@ -1048,6 +1078,13 @@ declare class WebsocketStreamsBase extends WebsocketCommon {
    * @param oldConnection The previous WebSocket connection, if any.
    */
   protected onOpen(url: string, targetConnection: WebsocketConnection, oldWSConnection: WebSocketClient): void;
+  /**
+   * Generates a stream key by combining a stream name with an optional URL path.
+   * @param stream - The stream name to use as the key or suffix.
+   * @param urlPath - Optional URL path to prepend to the stream name.
+   * @returns A stream key in the format `urlPath::stream` if urlPath is provided, otherwise just the stream name.
+   */
+  streamKey(stream: string, urlPath?: string): string;
   /**
    * Connects to the WebSocket server and subscribes to the specified streams.
    * This method returns a Promise that resolves when the connection is established,
@@ -1066,17 +1103,19 @@ declare class WebsocketStreamsBase extends WebsocketCommon {
    * Handles both single and pool modes
    * @param stream Single stream name or array of stream names to subscribe to
    * @param id Optional subscription ID
+   * @param urlPath Optional URL path for the streams
    * @returns void
    */
-  subscribe(stream: string | string[], id?: number | string): void;
+  subscribe(stream: string | string[], id?: number | string, urlPath?: string): void;
   /**
    * Unsubscribes from one or multiple WebSocket streams
    * Handles both single and pool modes
    * @param stream Single stream name or array of stream names to unsubscribe from
    * @param id Optional unsubscription ID
+   * @param urlPath Optional URL path for the streams
    * @returns void
    */
-  unsubscribe(stream: string | string[], id?: number | string): void;
+  unsubscribe(stream: string | string[], id?: number | string, urlPath?: string): void;
   /**
    * Checks if the specified stream is currently subscribed.
    * @param stream - The name of the stream to check.
@@ -1103,9 +1142,10 @@ interface WebsocketStream<T> {
  * @param {WebsocketAPIBase | WebsocketStreamsBase} websocketBase The WebSocket base instance
  * @param {string} streamOrId The stream identifier
  * @param {string} [id] Optional additional identifier
+ * @param {string} [urlPath] Optional URL path for the stream
  * @returns {WebsocketStream<T>} A stream handler with methods to register callbacks and unsubscribe
  */
-declare function createStreamHandler<T>(websocketBase: WebsocketAPIBase | WebsocketStreamsBase, streamOrId: string, id?: number | string): WebsocketStream<T>;
+declare function createStreamHandler<T>(websocketBase: WebsocketAPIBase | WebsocketStreamsBase, streamOrId: string, id?: number | string, urlPath?: string): WebsocketStream<T>;
 //#endregion
-export { ALGO_REST_API_PROD_URL, AxiosRequestArgs, BadRequestError, C2C_REST_API_PROD_URL, CONVERT_REST_API_PROD_URL, COPY_TRADING_REST_API_PROD_URL, CRYPTO_LOAN_REST_API_PROD_URL, ConfigurationRestAPI, ConfigurationWebsocketAPI, ConfigurationWebsocketStreams, ConnectorClientError, 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, ForbiddenError, GIFT_CARD_REST_API_PROD_URL, LogLevel, Logger, 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, NetworkError, NotFoundError, ObjectType, PAY_REST_API_PROD_URL, REBATE_REST_API_PROD_URL, RateLimitBanError, RequestArgs, RequiredError, RestApiRateLimit, RestApiResponse, 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, SendMessageOptions, ServerError, TimeUnit, TimerRecord, TooManyRequestsError, UnauthorizedError, VIP_LOAN_REST_API_PROD_URL, WALLET_REST_API_PROD_URL, WebsocketAPIBase, WebsocketApiRateLimit, WebsocketApiResponse, WebsocketCommon, WebsocketConnection, WebsocketEventEmitter, WebsocketSendMsgConfig, WebsocketSendMsgOptions, WebsocketStream, WebsocketStreamsBase, assertParamExists, buildQueryString, buildUserAgent, buildWebsocketAPIMessage, clearSignerCache, createStreamHandler, delay, getSignature, getTimestamp, httpRequestFunction, normalizeScientificNumbers, normalizeStreamId, parseCustomHeaders, parseRateLimitHeaders, randomInteger, randomString, removeEmptyValue, replaceWebsocketStreamsPlaceholders, sanitizeHeaderValue, sendRequest, setSearchParams, shouldRetryRequest, sortObject, toPathString, validateTimeUnit };
+export { ALGO_REST_API_PROD_URL, AxiosRequestArgs, BadRequestError, C2C_REST_API_PROD_URL, CONVERT_REST_API_PROD_URL, COPY_TRADING_REST_API_PROD_URL, CRYPTO_LOAN_REST_API_PROD_URL, ConfigurationRestAPI, ConfigurationWebsocketAPI, ConfigurationWebsocketStreams, ConnectorClientError, 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_REST_API_TESTNET_URL, DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_TESTNET_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, ForbiddenError, GIFT_CARD_REST_API_PROD_URL, LogLevel, Logger, 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, NetworkError, NotFoundError, ObjectType, PAY_REST_API_PROD_URL, REBATE_REST_API_PROD_URL, RateLimitBanError, RequestArgs, RequiredError, RestApiRateLimit, RestApiResponse, 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, SendMessageOptions, ServerError, TimeUnit, TimerRecord, TooManyRequestsError, UnauthorizedError, VIP_LOAN_REST_API_PROD_URL, WALLET_REST_API_PROD_URL, WebsocketAPIBase, WebsocketApiRateLimit, WebsocketApiResponse, WebsocketCommon, WebsocketConnection, WebsocketEventEmitter, WebsocketSendMsgConfig, WebsocketSendMsgOptions, WebsocketStream, WebsocketStreamsBase, assertParamExists, buildQueryString, buildUserAgent, buildWebsocketAPIMessage, clearSignerCache, createStreamHandler, delay, getSignature, getTimestamp, httpRequestFunction, normalizeScientificNumbers, normalizeStreamId, parseCustomHeaders, parseRateLimitHeaders, randomInteger, randomString, removeEmptyValue, replaceWebsocketStreamsPlaceholders, sanitizeHeaderValue, sendRequest, setSearchParams, shouldRetryRequest, sortObject, toPathString, validateTimeUnit };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.ts

@@ -28,7 +28,9 @@ declare const DERIVATIVES_TRADING_USDS_FUTURES_WS_API_TESTNET_URL = "wss://testn
 declare const DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_PROD_URL = "wss://fstream.binance.com";
 declare const DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_TESTNET_URL = "wss://stream.binancefuture.com";
 declare const DERIVATIVES_TRADING_OPTIONS_REST_API_PROD_URL = "https://eapi.binance.com";
-declare const DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_PROD_URL = "wss://nbstream.binance.com/eoptions";
+declare const DERIVATIVES_TRADING_OPTIONS_REST_API_TESTNET_URL = "https://testnet.binancefuture.com";
+declare const DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_PROD_URL = "wss://fstream.binance.com";
+declare const DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_TESTNET_URL = "wss://fstream.binancefuture.com";
 declare const DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_PROD_URL = "https://papi.binance.com";
 declare const DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_TESTNET_URL = "https://testnet.binancefuture.com";
 declare const DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_PROD_URL = "wss://fstream.binance.com/pm";
@@ -310,7 +312,8 @@ declare class ConfigurationWebsocketStreams {
  * @param msg - An optional error message.
  */
 declare class ConnectorClientError extends Error {
-  constructor(msg?: string);
+  code?: number;
+  constructor(msg?: string, code?: number);
 }
 /**
  * Represents an error that occurs when a required parameter is missing or undefined.
@@ -326,28 +329,32 @@ declare class RequiredError extends Error {
  * @param msg - An optional error message.
  */
 declare class UnauthorizedError extends Error {
-  constructor(msg?: string);
+  code?: number;
+  constructor(msg?: string, code?: number);
 }
 /**
  * Represents an error that occurs when a resource is forbidden to the client.
  * @param msg - An optional error message.
  */
 declare class ForbiddenError extends Error {
-  constructor(msg?: string);
+  code?: number;
+  constructor(msg?: string, code?: number);
 }
 /**
  * Represents an error that occurs when client is doing too many requests.
  * @param msg - An optional error message.
  */
 declare class TooManyRequestsError extends Error {
-  constructor(msg?: string);
+  code?: number;
+  constructor(msg?: string, code?: number);
 }
 /**
  * Represents an error that occurs when client's IP has been banned.
  * @param msg - An optional error message.
  */
 declare class RateLimitBanError extends Error {
-  constructor(msg?: string);
+  code?: number;
+  constructor(msg?: string, code?: number);
 }
 /**
  * Represents an error that occurs when there is an internal server error.
@@ -370,14 +377,16 @@ declare class NetworkError extends Error {
  * @param msg - An optional error message.
  */
 declare class NotFoundError extends Error {
-  constructor(msg?: string);
+  code?: number;
+  constructor(msg?: string, code?: number);
 }
 /**
  * Represents an error that occurs when a request is invalid or cannot be otherwise served.
  * @param msg - An optional error message.
  */
 declare class BadRequestError extends Error {
-  constructor(msg?: string);
+  code?: number;
+  constructor(msg?: string, code?: number);
 }
 //#endregion
 //#region src/logger.d.ts
@@ -759,6 +768,7 @@ interface WebsocketConnection {
   }>;
   pendingSubscriptions?: string[];
   ws?: WebSocketClient;
+  urlPath?: string;
   isSessionLoggedOn?: boolean;
   sessionLogonReq?: {
     method: string;
@@ -793,18 +803,20 @@ declare class WebsocketCommon extends WebsocketEventEmitter {
    * In 'single' mode, returns the first connection in the pool.
    * In 'pool' mode, filters and returns connections that are ready for use.
    * @param allowNonEstablishedWebsockets - Optional flag to include non-established WebSocket connections.
+   * @param urlPath - Optional URL path to filter connections.
    * @returns An array of available WebSocket connections.
    */
-  protected getAvailableConnections(allowNonEstablishedWebsockets?: boolean): WebsocketConnection[];
+  protected getAvailableConnections(allowNonEstablishedWebsockets?: boolean, urlPath?: string): WebsocketConnection[];
   /**
    * Gets a WebSocket connection from the pool or single connection.
    * If the connection mode is 'single', it returns the first connection in the pool.
    * If the connection mode is 'pool', it returns an available connection from the pool,
    * using a round-robin selection strategy. If no available connections are found, it throws an error.
    * @param allowNonEstablishedWebsockets - A boolean indicating whether to allow connections that are not established.
+   * @param urlPath - An optional URL path to filter connections.
    * @returns {WebsocketConnection} The selected WebSocket connection.
    */
-  protected getConnection(allowNonEstablishedWebsockets?: boolean): WebsocketConnection;
+  protected getConnection(allowNonEstablishedWebsockets?: boolean, urlPath?: string): WebsocketConnection;
   /**
    * Checks if the provided WebSocket connection is ready for use.
    * A connection is considered ready if it is open, has no pending reconnection, and has not been closed.
@@ -899,9 +911,10 @@ declare class WebsocketCommon extends WebsocketEventEmitter {
   /**
    * Connects all WebSocket connections in the pool
    * @param url - The Websocket server URL.
+   * @param connections - An optional array of WebSocket connections to connect. If not provided, all connections in the pool are connected.
    * @returns A promise that resolves when all connections are established.
    */
-  protected connectPool(url: string): Promise<void>;
+  protected connectPool(url: string, connections?: WebsocketConnection[]): Promise<void>;
   /**
    * Creates a new WebSocket client instance.
    * @param url - The URL to connect to.
@@ -993,15 +1006,31 @@ declare class WebsocketAPIBase extends WebsocketCommon {
 }
 declare class WebsocketStreamsBase extends WebsocketCommon {
   private streamConnectionMap;
+  protected urlPaths: string[];
   protected configuration: ConfigurationWebsocketStreams;
   protected wsURL: string;
   streamIdIsStrictlyNumber?: boolean;
   streamCallbackMap: Map<string, Set<(data: unknown) => void>>;
   logger: Logger;
-  constructor(configuration: ConfigurationWebsocketStreams, connectionPool?: WebsocketConnection[]);
+  constructor(configuration: ConfigurationWebsocketStreams, connectionPool?: WebsocketConnection[], urlPaths?: string[]);
+  /**
+   * Ensures the connection pool has the required size based on the configured mode and number of URL paths.
+   *
+   * If no URL paths are configured, the method returns early without modifications.
+   * In 'pool' mode, the pool size is multiplied by the number of URL paths.
+   * In 'single' mode, only one connection per URL path is maintained.
+   *
+   * New connections are initialized with unique IDs and default state flags when the pool
+   * size is less than the expected size.
+   *
+   * @private
+   * @returns {void}
+   */
+  private ensurePoolSizeForUrlPaths;
   /**
    * Formats the WebSocket URL for a given stream or streams.
    * @param streams - Array of stream names to include in the URL.
+   * @param urlPath - Optional URL path to include in the WebSocket URL.
    * @returns The formatted WebSocket URL with the provided streams.
    */
   private prepareURL;
@@ -1015,6 +1044,7 @@ declare class WebsocketStreamsBase extends WebsocketCommon {
   /**
    * Handles subscription to streams and assigns them to specific connections
    * @param streams Array of stream names to subscribe to
+   * @param urlPath Optional URL path for the streams
    * @returns Map of connections to streams
    */
   private handleStreamAssignment;
@@ -1048,6 +1078,13 @@ declare class WebsocketStreamsBase extends WebsocketCommon {
    * @param oldConnection The previous WebSocket connection, if any.
    */
   protected onOpen(url: string, targetConnection: WebsocketConnection, oldWSConnection: WebSocketClient): void;
+  /**
+   * Generates a stream key by combining a stream name with an optional URL path.
+   * @param stream - The stream name to use as the key or suffix.
+   * @param urlPath - Optional URL path to prepend to the stream name.
+   * @returns A stream key in the format `urlPath::stream` if urlPath is provided, otherwise just the stream name.
+   */
+  streamKey(stream: string, urlPath?: string): string;
   /**
    * Connects to the WebSocket server and subscribes to the specified streams.
    * This method returns a Promise that resolves when the connection is established,
@@ -1066,17 +1103,19 @@ declare class WebsocketStreamsBase extends WebsocketCommon {
    * Handles both single and pool modes
    * @param stream Single stream name or array of stream names to subscribe to
    * @param id Optional subscription ID
+   * @param urlPath Optional URL path for the streams
    * @returns void
    */
-  subscribe(stream: string | string[], id?: number | string): void;
+  subscribe(stream: string | string[], id?: number | string, urlPath?: string): void;
   /**
    * Unsubscribes from one or multiple WebSocket streams
    * Handles both single and pool modes
    * @param stream Single stream name or array of stream names to unsubscribe from
    * @param id Optional unsubscription ID
+   * @param urlPath Optional URL path for the streams
    * @returns void
    */
-  unsubscribe(stream: string | string[], id?: number | string): void;
+  unsubscribe(stream: string | string[], id?: number | string, urlPath?: string): void;
   /**
    * Checks if the specified stream is currently subscribed.
    * @param stream - The name of the stream to check.
@@ -1103,9 +1142,10 @@ interface WebsocketStream<T> {
  * @param {WebsocketAPIBase | WebsocketStreamsBase} websocketBase The WebSocket base instance
  * @param {string} streamOrId The stream identifier
  * @param {string} [id] Optional additional identifier
+ * @param {string} [urlPath] Optional URL path for the stream
  * @returns {WebsocketStream<T>} A stream handler with methods to register callbacks and unsubscribe
  */
-declare function createStreamHandler<T>(websocketBase: WebsocketAPIBase | WebsocketStreamsBase, streamOrId: string, id?: number | string): WebsocketStream<T>;
+declare function createStreamHandler<T>(websocketBase: WebsocketAPIBase | WebsocketStreamsBase, streamOrId: string, id?: number | string, urlPath?: string): WebsocketStream<T>;
 //#endregion
-export { ALGO_REST_API_PROD_URL, AxiosRequestArgs, BadRequestError, C2C_REST_API_PROD_URL, CONVERT_REST_API_PROD_URL, COPY_TRADING_REST_API_PROD_URL, CRYPTO_LOAN_REST_API_PROD_URL, ConfigurationRestAPI, ConfigurationWebsocketAPI, ConfigurationWebsocketStreams, ConnectorClientError, 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, ForbiddenError, GIFT_CARD_REST_API_PROD_URL, LogLevel, Logger, 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, NetworkError, NotFoundError, ObjectType, PAY_REST_API_PROD_URL, REBATE_REST_API_PROD_URL, RateLimitBanError, RequestArgs, RequiredError, RestApiRateLimit, RestApiResponse, 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, SendMessageOptions, ServerError, TimeUnit, TimerRecord, TooManyRequestsError, UnauthorizedError, VIP_LOAN_REST_API_PROD_URL, WALLET_REST_API_PROD_URL, WebsocketAPIBase, WebsocketApiRateLimit, WebsocketApiResponse, WebsocketCommon, WebsocketConnection, WebsocketEventEmitter, WebsocketSendMsgConfig, WebsocketSendMsgOptions, WebsocketStream, WebsocketStreamsBase, assertParamExists, buildQueryString, buildUserAgent, buildWebsocketAPIMessage, clearSignerCache, createStreamHandler, delay, getSignature, getTimestamp, httpRequestFunction, normalizeScientificNumbers, normalizeStreamId, parseCustomHeaders, parseRateLimitHeaders, randomInteger, randomString, removeEmptyValue, replaceWebsocketStreamsPlaceholders, sanitizeHeaderValue, sendRequest, setSearchParams, shouldRetryRequest, sortObject, toPathString, validateTimeUnit };
+export { ALGO_REST_API_PROD_URL, AxiosRequestArgs, BadRequestError, C2C_REST_API_PROD_URL, CONVERT_REST_API_PROD_URL, COPY_TRADING_REST_API_PROD_URL, CRYPTO_LOAN_REST_API_PROD_URL, ConfigurationRestAPI, ConfigurationWebsocketAPI, ConfigurationWebsocketStreams, ConnectorClientError, 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_REST_API_TESTNET_URL, DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_TESTNET_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, ForbiddenError, GIFT_CARD_REST_API_PROD_URL, LogLevel, Logger, 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, NetworkError, NotFoundError, ObjectType, PAY_REST_API_PROD_URL, REBATE_REST_API_PROD_URL, RateLimitBanError, RequestArgs, RequiredError, RestApiRateLimit, RestApiResponse, 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, SendMessageOptions, ServerError, TimeUnit, TimerRecord, TooManyRequestsError, UnauthorizedError, VIP_LOAN_REST_API_PROD_URL, WALLET_REST_API_PROD_URL, WebsocketAPIBase, WebsocketApiRateLimit, WebsocketApiResponse, WebsocketCommon, WebsocketConnection, WebsocketEventEmitter, WebsocketSendMsgConfig, WebsocketSendMsgOptions, WebsocketStream, WebsocketStreamsBase, assertParamExists, buildQueryString, buildUserAgent, buildWebsocketAPIMessage, clearSignerCache, createStreamHandler, delay, getSignature, getTimestamp, httpRequestFunction, normalizeScientificNumbers, normalizeStreamId, parseCustomHeaders, parseRateLimitHeaders, randomInteger, randomString, removeEmptyValue, replaceWebsocketStreamsPlaceholders, sanitizeHeaderValue, sendRequest, setSearchParams, shouldRetryRequest, sortObject, toPathString, validateTimeUnit };
 //# sourceMappingURL=index.d.ts.map