bybit-api 2.3.2 → 2.4.0-beta.2

package/lib/util/websocket-util.js

@@ -0,0 +1,194 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.neverGuard = exports.WS_ERROR_ENUM = exports.getUsdcWsKeyForTopic = exports.getWsKeyForTopic = exports.PUBLIC_WS_KEYS = exports.WS_AUTH_ON_CONNECT_KEYS = exports.WS_KEY_MAP = exports.WS_BASE_URL_MAP = void 0;
+exports.WS_BASE_URL_MAP = {
+    inverse: {
+        public: {
+            livenet: 'wss://stream.bybit.com/realtime',
+            testnet: 'wss://stream-testnet.bybit.com/realtime',
+        },
+        private: {
+            livenet: 'wss://stream.bybit.com/realtime',
+            testnet: 'wss://stream-testnet.bybit.com/realtime',
+        },
+    },
+    linear: {
+        public: {
+            livenet: 'wss://stream.bybit.com/realtime_public',
+            livenet2: 'wss://stream.bytick.com/realtime_public',
+            testnet: 'wss://stream-testnet.bybit.com/realtime_public',
+        },
+        private: {
+            livenet: 'wss://stream.bybit.com/realtime_private',
+            livenet2: 'wss://stream.bytick.com/realtime_private',
+            testnet: 'wss://stream-testnet.bybit.com/realtime_private',
+        },
+    },
+    spot: {
+        public: {
+            livenet: 'wss://stream.bybit.com/spot/quote/ws/v1',
+            livenet2: 'wss://stream.bybit.com/spot/quote/ws/v2',
+            testnet: 'wss://stream-testnet.bybit.com/spot/quote/ws/v1',
+            testnet2: 'wss://stream-testnet.bybit.com/spot/quote/ws/v2',
+        },
+        private: {
+            livenet: 'wss://stream.bybit.com/spot/ws',
+            testnet: 'wss://stream-testnet.bybit.com/spot/ws',
+        },
+    },
+    spotv3: {
+        public: {
+            livenet: 'wss://stream.bybit.com/spot/public/v3',
+            testnet: 'wss://stream-testnet.bybit.com/spot/public/v3',
+        },
+        private: {
+            livenet: 'wss://stream.bybit.com/spot/private/v3',
+            testnet: 'wss://stream-testnet.bybit.com/spot/private/v3',
+        },
+    },
+    usdcOption: {
+        public: {
+            livenet: 'wss://stream.bybit.com/trade/option/usdc/public/v1',
+            livenet2: 'wss://stream.bytick.com/trade/option/usdc/public/v1',
+            testnet: 'wss://stream-testnet.bybit.com/trade/option/usdc/public/v1',
+        },
+        private: {
+            livenet: 'wss://stream.bybit.com/trade/option/usdc/private/v1',
+            livenet2: 'wss://stream.bytick.com/trade/option/usdc/private/v1',
+            testnet: 'wss://stream-testnet.bybit.com/trade/option/usdc/private/v1',
+        },
+    },
+    usdcPerp: {
+        public: {
+            livenet: 'wss://stream.bybit.com/perpetual/ws/v1/realtime_public',
+            livenet2: 'wss://stream.bytick.com/perpetual/ws/v1/realtime_public',
+            testnet: 'wss://stream-testnet.bybit.com/perpetual/ws/v1/realtime_public',
+        },
+        private: {
+            livenet: 'wss://stream.bybit.com/trade/option/usdc/private/v1',
+            livenet2: 'wss://stream.bytick.com/trade/option/usdc/private/v1',
+            testnet: 'wss://stream-testnet.bybit.com/trade/option/usdc/private/v1',
+        },
+    },
+};
+exports.WS_KEY_MAP = {
+    inverse: 'inverse',
+    linearPrivate: 'linearPrivate',
+    linearPublic: 'linearPublic',
+    spotPrivate: 'spotPrivate',
+    spotPublic: 'spotPublic',
+    spotV3Private: 'spotV3Private',
+    spotV3Public: 'spotV3Public',
+    usdcOptionPrivate: 'usdcOptionPrivate',
+    usdcOptionPublic: 'usdcOptionPublic',
+    usdcPerpPrivate: 'usdcPerpPrivate',
+    usdcPerpPublic: 'usdcPerpPublic',
+};
+exports.WS_AUTH_ON_CONNECT_KEYS = [
+    exports.WS_KEY_MAP.spotV3Private,
+    exports.WS_KEY_MAP.usdcOptionPrivate,
+    exports.WS_KEY_MAP.usdcPerpPrivate,
+];
+exports.PUBLIC_WS_KEYS = [
+    exports.WS_KEY_MAP.linearPublic,
+    exports.WS_KEY_MAP.spotPublic,
+    exports.WS_KEY_MAP.spotV3Public,
+    exports.WS_KEY_MAP.usdcOptionPublic,
+    exports.WS_KEY_MAP.usdcPerpPublic,
+];
+/** Used to automatically determine if a sub request should be to the public or private ws (when there's two) */
+const PRIVATE_TOPICS = [
+    'position',
+    'execution',
+    'order',
+    'stop_order',
+    'wallet',
+    'outboundAccountInfo',
+    'executionReport',
+    'ticketInfo',
+    // copy trading apis
+    'copyTradePosition',
+    'copyTradeOrder',
+    'copyTradeExecution',
+    'copyTradeWallet',
+    // usdc options
+    'user.openapi.option.position',
+    'user.openapi.option.trade',
+    'user.order',
+    'user.openapi.option.order',
+    'user.service',
+    'user.openapi.greeks',
+    'user.mmp.event',
+    // usdc perps
+    'user.openapi.perp.position',
+    'user.openapi.perp.trade',
+    'user.openapi.perp.order',
+    'user.service',
+    // unified margin
+    'user.position.unifiedAccount',
+    'user.execution.unifiedAccount',
+    'user.order.unifiedAccount',
+    'user.wallet.unifiedAccount',
+    'user.greeks.unifiedAccount',
+];
+function getWsKeyForTopic(market, topic, isPrivate) {
+    const isPrivateTopic = isPrivate === true || PRIVATE_TOPICS.includes(topic);
+    switch (market) {
+        case 'inverse': {
+            return exports.WS_KEY_MAP.inverse;
+        }
+        case 'linear': {
+            return isPrivateTopic
+                ? exports.WS_KEY_MAP.linearPrivate
+                : exports.WS_KEY_MAP.linearPublic;
+        }
+        case 'spot': {
+            return isPrivateTopic ? exports.WS_KEY_MAP.spotPrivate : exports.WS_KEY_MAP.spotPublic;
+        }
+        case 'spotv3': {
+            return isPrivateTopic
+                ? exports.WS_KEY_MAP.spotV3Private
+                : exports.WS_KEY_MAP.spotV3Public;
+        }
+        case 'usdcOption': {
+            return isPrivateTopic
+                ? exports.WS_KEY_MAP.usdcOptionPrivate
+                : exports.WS_KEY_MAP.usdcOptionPublic;
+        }
+        case 'usdcPerp': {
+            return isPrivateTopic
+                ? exports.WS_KEY_MAP.usdcPerpPrivate
+                : exports.WS_KEY_MAP.usdcPerpPublic;
+        }
+        default: {
+            throw neverGuard(market, `getWsKeyForTopic(): Unhandled market`);
+        }
+    }
+}
+exports.getWsKeyForTopic = getWsKeyForTopic;
+function getUsdcWsKeyForTopic(topic, subGroup) {
+    const isPrivateTopic = PRIVATE_TOPICS.includes(topic);
+    if (subGroup === 'option') {
+        return isPrivateTopic
+            ? exports.WS_KEY_MAP.usdcOptionPrivate
+            : exports.WS_KEY_MAP.usdcOptionPublic;
+    }
+    return isPrivateTopic
+        ? exports.WS_KEY_MAP.usdcOptionPrivate
+        : exports.WS_KEY_MAP.usdcOptionPublic;
+    // return isPrivateTopic
+    //   ? WS_KEY_MAP.usdcPerpPrivate
+    //   : WS_KEY_MAP.usdcPerpPublic;
+}
+exports.getUsdcWsKeyForTopic = getUsdcWsKeyForTopic;
+exports.WS_ERROR_ENUM = {
+    NOT_AUTHENTICATED_SPOT_V3: '-1004',
+    API_ERROR_GENERIC: '10001',
+    API_SIGN_AUTH_FAILED: '10003',
+    USDC_OPTION_AUTH_FAILED: '3303006',
+};
+function neverGuard(x, msg) {
+    return new Error(`Unhandled value exception "x", ${msg}`);
+}
+exports.neverGuard = neverGuard;
+//# sourceMappingURL=websocket-util.js.map

package/lib/util/websocket-util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket-util.js","sourceRoot":"","sources":["../../src/util/websocket-util.ts"],"names":[],"mappings":";;;AAWa,QAAA,eAAe,GAGxB;IACF,OAAO,EAAE;QACP,MAAM,EAAE;YACN,OAAO,EAAE,iCAAiC;YAC1C,OAAO,EAAE,yCAAyC;SACnD;QACD,OAAO,EAAE;YACP,OAAO,EAAE,iCAAiC;YAC1C,OAAO,EAAE,yCAAyC;SACnD;KACF;IACD,MAAM,EAAE;QACN,MAAM,EAAE;YACN,OAAO,EAAE,wCAAwC;YACjD,QAAQ,EAAE,yCAAyC;YACnD,OAAO,EAAE,gDAAgD;SAC1D;QACD,OAAO,EAAE;YACP,OAAO,EAAE,yCAAyC;YAClD,QAAQ,EAAE,0CAA0C;YACpD,OAAO,EAAE,iDAAiD;SAC3D;KACF;IACD,IAAI,EAAE;QACJ,MAAM,EAAE;YACN,OAAO,EAAE,yCAAyC;YAClD,QAAQ,EAAE,yCAAyC;YACnD,OAAO,EAAE,iDAAiD;YAC1D,QAAQ,EAAE,iDAAiD;SAC5D;QACD,OAAO,EAAE;YACP,OAAO,EAAE,gCAAgC;YACzC,OAAO,EAAE,wCAAwC;SAClD;KACF;IACD,MAAM,EAAE;QACN,MAAM,EAAE;YACN,OAAO,EAAE,uCAAuC;YAChD,OAAO,EAAE,+CAA+C;SACzD;QACD,OAAO,EAAE;YACP,OAAO,EAAE,wCAAwC;YACjD,OAAO,EAAE,gDAAgD;SAC1D;KACF;IACD,UAAU,EAAE;QACV,MAAM,EAAE;YACN,OAAO,EAAE,oDAAoD;YAC7D,QAAQ,EAAE,qDAAqD;YAC/D,OAAO,EAAE,4DAA4D;SACtE;QACD,OAAO,EAAE;YACP,OAAO,EAAE,qDAAqD;YAC9D,QAAQ,EAAE,sDAAsD;YAChE,OAAO,EAAE,6DAA6D;SACvE;KACF;IACD,QAAQ,EAAE;QACR,MAAM,EAAE;YACN,OAAO,EAAE,wDAAwD;YACjE,QAAQ,EAAE,yDAAyD;YACnE,OAAO,EAAE,gEAAgE;SAC1E;QACD,OAAO,EAAE;YACP,OAAO,EAAE,qDAAqD;YAC9D,QAAQ,EAAE,sDAAsD;YAChE,OAAO,EAAE,6DAA6D;SACvE;KACF;CACF,CAAC;AAEW,QAAA,UAAU,GAAG;IACxB,OAAO,EAAE,SAAS;IAClB,aAAa,EAAE,eAAe;IAC9B,YAAY,EAAE,cAAc;IAC5B,WAAW,EAAE,aAAa;IAC1B,UAAU,EAAE,YAAY;IACxB,aAAa,EAAE,eAAe;IAC9B,YAAY,EAAE,cAAc;IAC5B,iBAAiB,EAAE,mBAAmB;IACtC,gBAAgB,EAAE,kBAAkB;IACpC,eAAe,EAAE,iBAAiB;IAClC,cAAc,EAAE,gBAAgB;CACxB,CAAC;AAEE,QAAA,uBAAuB,GAAY;IAC9C,kBAAU,CAAC,aAAa;IACxB,kBAAU,CAAC,iBAAiB;IAC5B,kBAAU,CAAC,eAAe;CAC3B,CAAC;AAEW,QAAA,cAAc,GAAG;IAC5B,kBAAU,CAAC,YAAY;IACvB,kBAAU,CAAC,UAAU;IACrB,kBAAU,CAAC,YAAY;IACvB,kBAAU,CAAC,gBAAgB;IAC3B,kBAAU,CAAC,cAAc;CACd,CAAC;AAEd,gHAAgH;AAChH,MAAM,cAAc,GAAG;IACrB,UAAU;IACV,WAAW;IACX,OAAO;IACP,YAAY;IACZ,QAAQ;IACR,qBAAqB;IACrB,iBAAiB;IACjB,YAAY;IACZ,oBAAoB;IACpB,mBAAmB;IACnB,gBAAgB;IAChB,oBAAoB;IACpB,iBAAiB;IACjB,eAAe;IACf,8BAA8B;IAC9B,2BAA2B;IAC3B,YAAY;IACZ,2BAA2B;IAC3B,cAAc;IACd,qBAAqB;IACrB,gBAAgB;IAChB,aAAa;IACb,4BAA4B;IAC5B,yBAAyB;IACzB,yBAAyB;IACzB,cAAc;IACd,iBAAiB;IACjB,8BAA8B;IAC9B,+BAA+B;IAC/B,2BAA2B;IAC3B,4BAA4B;IAC5B,4BAA4B;CAC7B,CAAC;AAEF,SAAgB,gBAAgB,CAC9B,MAAiB,EACjB,KAAa,EACb,SAAmB;IAEnB,MAAM,cAAc,GAAG,SAAS,KAAK,IAAI,IAAI,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC5E,QAAQ,MAAM,EAAE;QACd,KAAK,SAAS,CAAC,CAAC;YACd,OAAO,kBAAU,CAAC,OAAO,CAAC;SAC3B;QACD,KAAK,QAAQ,CAAC,CAAC;YACb,OAAO,cAAc;gBACnB,CAAC,CAAC,kBAAU,CAAC,aAAa;gBAC1B,CAAC,CAAC,kBAAU,CAAC,YAAY,CAAC;SAC7B;QACD,KAAK,MAAM,CAAC,CAAC;YACX,OAAO,cAAc,CAAC,CAAC,CAAC,kBAAU,CAAC,WAAW,CAAC,CAAC,CAAC,kBAAU,CAAC,UAAU,CAAC;SACxE;QACD,KAAK,QAAQ,CAAC,CAAC;YACb,OAAO,cAAc;gBACnB,CAAC,CAAC,kBAAU,CAAC,aAAa;gBAC1B,CAAC,CAAC,kBAAU,CAAC,YAAY,CAAC;SAC7B;QACD,KAAK,YAAY,CAAC,CAAC;YACjB,OAAO,cAAc;gBACnB,CAAC,CAAC,kBAAU,CAAC,iBAAiB;gBAC9B,CAAC,CAAC,kBAAU,CAAC,gBAAgB,CAAC;SACjC;QACD,KAAK,UAAU,CAAC,CAAC;YACf,OAAO,cAAc;gBACnB,CAAC,CAAC,kBAAU,CAAC,eAAe;gBAC5B,CAAC,CAAC,kBAAU,CAAC,cAAc,CAAC;SAC/B;QACD,OAAO,CAAC,CAAC;YACP,MAAM,UAAU,CAAC,MAAM,EAAE,sCAAsC,CAAC,CAAC;SAClE;KACF;AACH,CAAC;AArCD,4CAqCC;AAED,SAAgB,oBAAoB,CAClC,KAAa,EACb,QAA2B;IAE3B,MAAM,cAAc,GAAG,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACtD,IAAI,QAAQ,KAAK,QAAQ,EAAE;QACzB,OAAO,cAAc;YACnB,CAAC,CAAC,kBAAU,CAAC,iBAAiB;YAC9B,CAAC,CAAC,kBAAU,CAAC,gBAAgB,CAAC;KACjC;IACD,OAAO,cAAc;QACnB,CAAC,CAAC,kBAAU,CAAC,iBAAiB;QAC9B,CAAC,CAAC,kBAAU,CAAC,gBAAgB,CAAC;IAChC,wBAAwB;IACxB,iCAAiC;IACjC,iCAAiC;AACnC,CAAC;AAhBD,oDAgBC;AAEY,QAAA,aAAa,GAAG;IAC3B,yBAAyB,EAAE,OAAO;IAClC,iBAAiB,EAAE,OAAO;IAC1B,oBAAoB,EAAE,OAAO;IAC7B,uBAAuB,EAAE,SAAS;CACnC,CAAC;AAEF,SAAgB,UAAU,CAAC,CAAQ,EAAE,GAAW;IAC9C,OAAO,IAAI,KAAK,CAAC,kCAAkC,GAAG,EAAE,CAAC,CAAC;AAC5D,CAAC;AAFD,gCAEC"}

package/lib/websocket-client.d.ts

@@ -1,103 +1,63 @@
 /// <reference types="node" />
 import { EventEmitter } from 'events';
 import WebSocket from 'isomorphic-ws';
-import { DefaultLogger } from './logger';
-import { KlineInterval } from './types/shared';
-import { RestClientOptions } from './util/requestUtils';
-export declare enum WsConnectionState {
-    READY_STATE_INITIAL = 0,
-    READY_STATE_CONNECTING = 1,
-    READY_STATE_CONNECTED = 2,
-    READY_STATE_CLOSING = 3,
-    READY_STATE_RECONNECTING = 4
-}
-export declare type APIMarket = 'inverse' | 'linear' | 'spot';
-export declare type WsPublicInverseTopic = 'orderBookL2_25' | 'orderBookL2_200' | 'trade' | 'insurance' | 'instrument_info' | 'klineV2';
-export declare type WsPublicUSDTPerpTopic = 'orderBookL2_25' | 'orderBookL2_200' | 'trade' | 'insurance' | 'instrument_info' | 'kline';
-export declare type WsPublicSpotV1Topic = 'trade' | 'realtimes' | 'kline' | 'depth' | 'mergedDepth' | 'diffDepth';
-export declare type WsPublicSpotV2Topic = 'depth' | 'kline' | 'trade' | 'bookTicker' | 'realtimes';
-export declare type WsPublicTopics = WsPublicInverseTopic | WsPublicUSDTPerpTopic | WsPublicSpotV1Topic | WsPublicSpotV2Topic | string;
-export declare type WsPrivateInverseTopic = 'position' | 'execution' | 'order' | 'stop_order';
-export declare type WsPrivateUSDTPerpTopic = 'position' | 'execution' | 'order' | 'stop_order' | 'wallet';
-export declare type WsPrivateSpotTopic = 'outboundAccountInfo' | 'executionReport' | 'ticketInfo';
-export declare type WsPrivateTopic = WsPrivateInverseTopic | WsPrivateUSDTPerpTopic | WsPrivateSpotTopic | string;
-export declare type WsTopic = WsPublicTopics | WsPrivateTopic;
-export interface WSClientConfigurableOptions {
-    key?: string;
-    secret?: string;
-    livenet?: boolean;
-    /**
-     * @deprecated Use the property { market: 'linear' } instead
-     */
-    linear?: boolean;
-    market?: APIMarket;
-    pongTimeout?: number;
-    pingInterval?: number;
-    reconnectTimeout?: number;
-    restOptions?: RestClientOptions;
-    requestOptions?: any;
-    wsUrl?: string;
-    /** If true, fetch server time before trying to authenticate (disabled by default) */
-    fetchTimeOffsetBeforeAuth?: boolean;
-}
-export interface WebsocketClientOptions extends WSClientConfigurableOptions {
-    livenet: boolean;
-    /**
-     * @deprecated Use the property { market: 'linear' } instead
-     */
-    linear?: boolean;
-    market?: APIMarket;
-    pongTimeout: number;
-    pingInterval: number;
-    reconnectTimeout: number;
+import { KlineInterval, WSClientConfigurableOptions, WsKey, WsTopic } from './types';
+import { DefaultLogger } from './util';
+export declare type WsClientEvent = 'open' | 'update' | 'close' | 'errorEvent' | 'reconnect' | 'reconnected' | 'response';
+interface WebsocketClientEvents {
+    open: (evt: {
+        wsKey: WsKey;
+        event: any;
+    }) => void;
+    reconnect: (evt: {
+        wsKey: WsKey;
+        event: any;
+    }) => void;
+    reconnected: (evt: {
+        wsKey: WsKey;
+        event: any;
+    }) => void;
+    close: (evt: {
+        wsKey: WsKey;
+        event: any;
+    }) => void;
+    response: (response: any) => void;
+    update: (response: any) => void;
+    errorEvent: (response: any) => void;
 }
-export declare const wsKeyInverse = "inverse";
-export declare const wsKeyLinearPrivate = "linearPrivate";
-export declare const wsKeyLinearPublic = "linearPublic";
-export declare const wsKeySpotPrivate = "spotPrivate";
-export declare const wsKeySpotPublic = "spotPublic";
-export declare type WsKey = 'inverse' | 'linearPrivate' | 'linearPublic' | 'spotPrivate' | 'spotPublic';
 export declare interface WebsocketClient {
-    on(event: 'open' | 'reconnected', listener: ({ wsKey: WsKey, event: any }: {
-        wsKey: any;
-        event: any;
-    }) => void): this;
-    on(event: 'response' | 'update' | 'error', listener: (response: any) => void): this;
-    on(event: 'reconnect' | 'close', listener: ({ wsKey: WsKey }: {
-        wsKey: any;
-    }) => void): this;
+    on<U extends keyof WebsocketClientEvents>(event: U, listener: WebsocketClientEvents[U]): this;
+    emit<U extends keyof WebsocketClientEvents>(event: U, ...args: Parameters<WebsocketClientEvents[U]>): boolean;
 }
 export declare class WebsocketClient extends EventEmitter {
     private logger;
-    private restClient;
+    private restClient?;
     private options;
     private wsStore;
     constructor(options: WSClientConfigurableOptions, logger?: typeof DefaultLogger);
-    isLivenet(): boolean;
-    isLinear(): boolean;
-    isSpot(): boolean;
-    isInverse(): boolean;
     /**
-     * Add topic/topics to WS subscription list
+     * Only used if we fetch exchange time before attempting auth.
+     * Disabled by default.
+     * I've removed this for ftx and it's working great, tempted to remove this here
      */
-    subscribe(wsTopics: WsTopic[] | WsTopic): void;
-    /**
-     * Remove topic/topics from WS subscription list
-     */
-    unsubscribe(wsTopics: WsTopic[] | WsTopic): void;
+    prepareRESTClient(): void;
+    isTestnet(): boolean;
     close(wsKey: WsKey): void;
+    closeAll(): void;
     /**
-     * Request connection of all dependent websockets, instead of waiting for automatic connection by library
+     * Request connection of all dependent (public & private) websockets, instead of waiting for automatic connection by library
      */
-    connectAll(): Promise<WebSocket | undefined>[] | undefined;
-    connectPublic(): Promise<WebSocket | undefined> | undefined;
-    connectPrivate(): Promise<WebSocket | undefined> | undefined;
+    connectAll(): Promise<WebSocket | undefined>[];
+    connectPublic(): Promise<WebSocket | undefined>;
+    connectPrivate(): Promise<WebSocket | undefined>;
     private connect;
     private parseWsError;
     /**
      * Return params required to make authorized request
      */
     private getAuthParams;
+    private sendAuthRequest;
+    private getWsAuthSignature;
     private reconnectWithDelay;
     private ping;
     private clearTimers;
@@ -111,21 +71,35 @@ export declare class WebsocketClient extends EventEmitter {
      * Send WS message to unsubscribe from topics.
      */
     private requestUnsubscribeTopics;
-    private tryWsSend;
+    tryWsSend(wsKey: WsKey, wsMessage: string): void;
     private connectToWsUrl;
     private onWsOpen;
     private onWsMessage;
     private onWsError;
     private onWsClose;
-    private onWsMessageResponse;
-    private onWsMessageUpdate;
     private getWs;
     private setWsState;
     private getWsUrl;
-    private getWsKeyForTopic;
     private wrongMarketError;
+    /**
+     * Add topic/topics to WS subscription list
+     * @param wsTopics topic or list of topics
+     * @param isPrivateTopic optional - the library will try to detect private topics, you can use this to mark a topic as private (if the topic isn't recognised yet)
+     */
+    subscribe(wsTopics: WsTopic[] | WsTopic, isPrivateTopic?: boolean): void;
+    /**
+     * Remove topic/topics from WS subscription list
+     * @param wsTopics topic or list of topics
+     * @param isPrivateTopic optional - the library will try to detect private topics, you can use this to mark a topic as private (if the topic isn't recognised yet)
+     */
+    unsubscribe(wsTopics: WsTopic[] | WsTopic, isPrivateTopic?: boolean): void;
+    /** @deprecated use "market: 'spotv3" client */
     subscribePublicSpotTrades(symbol: string, binary?: boolean): void;
+    /** @deprecated use "market: 'spotv3" client */
     subscribePublicSpotTradingPair(symbol: string, binary?: boolean): void;
+    /** @deprecated use "market: 'spotv3" client */
     subscribePublicSpotV1Kline(symbol: string, candleSize: KlineInterval, binary?: boolean): void;
+    /** @deprecated use "market: 'spotv3" client */
     subscribePublicSpotOrderbook(symbol: string, depth: 'full' | 'merge' | 'delta', dumpScale?: number, binary?: boolean): void;
 }
+export {};