bitget-api 2.3.6 → 3.0.0

package/dist/cjs/websocket-client-v3.js

@@ -0,0 +1,408 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebsocketClientV3 = void 0;
+const BaseWSClient_js_1 = require("./util/BaseWSClient.js");
+const requestUtils_js_1 = require("./util/requestUtils.js");
+const type_guards_js_1 = require("./util/type-guards.js");
+const webCryptoAPI_js_1 = require("./util/webCryptoAPI.js");
+const websocket_util_js_1 = require("./util/websocket-util.js");
+/**
+ * WebSocket client dedicated to the unified account (V3) WebSockets.
+ *
+ * Your Bitget account needs to be upgraded to unified account mode, to use the account-level WebSocket topics.
+ */
+class WebsocketClientV3 extends BaseWSClient_js_1.BaseWebsocketClient {
+    /**
+     * Request connection of all dependent (public & private) websockets, instead of waiting for automatic connection by library
+     */
+    connectAll() {
+        return [
+            this.connect(websocket_util_js_1.WS_KEY_MAP.v3Private),
+            this.connect(websocket_util_js_1.WS_KEY_MAP.v3Public),
+        ];
+    }
+    /**
+     * Ensures the WS API connection is active and ready.
+     *
+     * You do not need to call this, but if you call this before making any WS API requests,
+     * it can accelerate the first request (by preparing the connection in advance).
+     */
+    connectWSAPI() {
+        /** This call automatically ensures the connection is active AND authenticated before resolving */
+        return this.assertIsAuthenticated(websocket_util_js_1.WS_KEY_MAP.v3Private);
+    }
+    /**
+     * Request subscription to one or more topics. Pass topics as either an array of strings,
+     * or array of objects (if the topic has parameters).
+     *
+     * Objects should be formatted as {topic: string, params: object, category: CategoryV5}.
+     *
+     * - Subscriptions are automatically routed to the correct websocket connection.
+     * - Authentication/connection is automatic.
+     * - Resubscribe after network issues is automatic.
+     *
+     * Call `unsubscribe(topics)` to remove topics
+     */
+    subscribe(requests, wsKey) {
+        const topicRequests = Array.isArray(requests) ? requests : [requests];
+        const normalisedTopicRequests = (0, websocket_util_js_1.getNormalisedTopicRequests)(topicRequests);
+        return this.subscribeTopicsForWsKey(normalisedTopicRequests, wsKey);
+    }
+    /**
+     * Unsubscribe from one or more topics. Similar to subscribe() but in reverse.
+     *
+     * - Requests are automatically routed to the correct websocket connection.
+     * - These topics will be removed from the topic cache, so they won't be subscribed to again.
+     */
+    unsubscribe(requests, wsKey) {
+        const topicRequests = Array.isArray(requests) ? requests : [requests];
+        const normalisedTopicRequests = (0, websocket_util_js_1.getNormalisedTopicRequests)(topicRequests);
+        return this.unsubscribeTopicsForWsKey(normalisedTopicRequests, wsKey);
+    }
+    /**
+     *
+     *
+     * Internal methods required to integrate with the BaseWSClient
+     *
+     *
+     */
+    sendPingEvent(wsKey) {
+        this.tryWsSend(wsKey, 'ping');
+    }
+    sendPongEvent(wsKey) {
+        this.tryWsSend(wsKey, 'pong');
+    }
+    isWsPing(data) {
+        if (data?.data === 'ping') {
+            return true;
+        }
+        return false;
+    }
+    isWsPong(data) {
+        return (0, requestUtils_js_1.isWsPong)(data);
+    }
+    isPrivateTopicRequest(_request, wsKey) {
+        return websocket_util_js_1.WS_AUTH_ON_CONNECT_KEYS.includes(wsKey);
+    }
+    getPrivateWSKeys() {
+        return websocket_util_js_1.WS_AUTH_ON_CONNECT_KEYS;
+    }
+    isAuthOnConnectWsKey(wsKey) {
+        return websocket_util_js_1.WS_AUTH_ON_CONNECT_KEYS.includes(wsKey);
+    }
+    async getWsUrl(wsKey) {
+        return (0, websocket_util_js_1.getWsUrl)(wsKey, this.options, this.logger);
+    }
+    getMaxTopicsPerSubscribeEvent(wsKey) {
+        return (0, websocket_util_js_1.getMaxTopicsPerSubscribeEvent)(wsKey);
+    }
+    /**
+     * @returns one or more correctly structured request events for performing a operations over WS. This can vary per exchange spec.
+     */
+    async getWsRequestEvents(operation, requests) {
+        const wsRequestBuildingErrors = [];
+        const topics = requests.map((r) => r.topic + ',' + Object.values(r.payload || {}).join(','));
+        // Previously used to track topics in a request. Keeping this for subscribe/unsubscribe requests, no need for incremental values
+        const req_id = ['subscribe', 'unsubscribe'].includes(operation) && topics.length
+            ? topics.join(',')
+            : this.getNewRequestId().toFixed();
+        /**
+          {
+            "op":"subscribe",
+            "args":[
+                {
+                    "instType":"spot",
+                    "topic":"ticker",
+                    "symbol":"BTCUSDT"
+                },
+                {
+                    "instType":"spot",
+                    "topic":"candle5m",
+                    "symbol":"BTCUSDT"
+                }
+            ]
+          }
+        */
+        const wsEvent = {
+            op: operation,
+            args: requests.map((request) => {
+                // const request = {
+                //   topic: 'ticker',
+                //   payload: { instType: 'spot', symbol: 'BTCUSDT' },
+                // };
+                // becomes:
+                // const request = {
+                //   topic: 'ticker',
+                //   instType: 'spot',
+                //   symbol: 'BTCUSDT',
+                // };
+                return {
+                    topic: request.topic,
+                    ...request.payload,
+                };
+            }),
+        };
+        const midflightWsEvent = {
+            requestKey: req_id,
+            requestEvent: wsEvent,
+        };
+        if (wsRequestBuildingErrors.length) {
+            const label = wsRequestBuildingErrors.length === requests.length ? 'all' : 'some';
+            this.logger.error(`Failed to build/send ${wsRequestBuildingErrors.length} event(s) for ${label} WS requests due to exceptions`, {
+                ...websocket_util_js_1.WS_LOGGER_CATEGORY,
+                wsRequestBuildingErrors,
+                wsRequestBuildingErrorsStringified: JSON.stringify(wsRequestBuildingErrors, null, 2),
+            });
+        }
+        return [midflightWsEvent];
+    }
+    async getWsAuthSignature(wsKey) {
+        const { apiKey, apiSecret, apiPass, recvWindow } = this.options;
+        if (!apiKey || !apiSecret || !apiPass) {
+            this.logger.error('Cannot authenticate websocket, either api key, secret or passphrase missing.', { ...websocket_util_js_1.WS_LOGGER_CATEGORY, wsKey });
+            throw new Error('Cannot auth - missing api or secret or pass in config');
+        }
+        this.logger.trace("Getting auth'd request params", {
+            ...websocket_util_js_1.WS_LOGGER_CATEGORY,
+            wsKey,
+        });
+        const signatureExpiresAt = ((Date.now() + recvWindow) / 1000).toFixed(0);
+        const signature = await this.signMessage(signatureExpiresAt + 'GET' + '/user/verify', apiSecret, 'base64', 'SHA-256');
+        return {
+            expiresAt: +signatureExpiresAt,
+            signature,
+        };
+    }
+    async signMessage(paramsStr, secret, method, algorithm) {
+        if (typeof this.options.customSignMessageFn === 'function') {
+            return this.options.customSignMessageFn(paramsStr, secret);
+        }
+        return await (0, webCryptoAPI_js_1.signMessage)(paramsStr, secret, method, algorithm);
+    }
+    async getWsAuthRequestEvent(wsKey) {
+        try {
+            const { apiKey, apiSecret, apiPass } = this.options;
+            const { signature, expiresAt } = await this.getWsAuthSignature(wsKey);
+            if (!apiKey || !apiSecret || !apiPass) {
+                this.logger.error('Cannot authenticate websocket, either api key, secret or passphrase missing.', { ...websocket_util_js_1.WS_LOGGER_CATEGORY, wsKey });
+                throw new Error('Cannot auth - missing api or secret or pass in config');
+            }
+            const request = {
+                op: 'login',
+                args: [
+                    {
+                        apiKey,
+                        passphrase: apiPass,
+                        timestamp: expiresAt,
+                        sign: signature,
+                    },
+                ],
+            };
+            return request;
+        }
+        catch (e) {
+            this.logger.error(e, { ...websocket_util_js_1.WS_LOGGER_CATEGORY, wsKey });
+            throw e;
+        }
+    }
+    /**
+     * Abstraction called to sort ws events into emittable event types (response to a request, data update, etc)
+     */
+    resolveEmittableEvents(wsKey, event) {
+        const results = [];
+        try {
+            const msg = JSON.parse(event.data);
+            const emittableEvent = { ...msg, wsKey };
+            /**
+             * WS API response handling
+             */
+            if ((0, type_guards_js_1.isWSAPIResponse)(emittableEvent)) {
+                // const eg1 = {
+                //   event: 'error',
+                //   id: '1',
+                //   code: '43012',
+                //   msg: 'Insufficient balance',
+                // };
+                const retCode = emittableEvent.code;
+                const reqId = emittableEvent.id;
+                const isError = retCode !== '0';
+                const promiseRef = [emittableEvent.id].join('_');
+                const loggableContext = {
+                    wsKey,
+                    promiseRef,
+                    parsedEvent: emittableEvent,
+                };
+                if (!reqId) {
+                    this.logger.error('WS API response is missing reqId - promisified workflow could get stuck. If this happens, please get in touch with steps to reproduce. Trace:', loggableContext);
+                }
+                if (isError) {
+                    try {
+                        this.getWsStore().rejectDeferredPromise(wsKey, promiseRef, emittableEvent, true);
+                    }
+                    catch (e) {
+                        this.logger.error('Exception trying to reject WSAPI promise', {
+                            ...loggableContext,
+                            error: e,
+                        });
+                    }
+                    results.push({
+                        eventType: 'exception',
+                        event: emittableEvent,
+                        isWSAPIResponse: true,
+                    });
+                    return results;
+                }
+                // WS API Success
+                try {
+                    this.getWsStore().resolveDeferredPromise(wsKey, promiseRef, emittableEvent, true);
+                }
+                catch (e) {
+                    this.logger.error('Exception trying to resolve WSAPI promise', {
+                        ...loggableContext,
+                        error: e,
+                    });
+                }
+                results.push({
+                    eventType: 'response',
+                    event: emittableEvent,
+                    isWSAPIResponse: true,
+                });
+                return results;
+            }
+            /**
+             * V3 event handling for consumers - behaves the same as V2
+             */
+            if (typeof msg === 'object') {
+                if (typeof msg['code'] === 'number') {
+                    // v2 authentication event
+                    if (msg.event === 'login' && msg.code === 0) {
+                        results.push({
+                            eventType: 'response',
+                            event: emittableEvent,
+                        });
+                        results.push({
+                            eventType: 'authenticated',
+                            event: emittableEvent,
+                        });
+                        return results;
+                    }
+                }
+                if (msg['event']) {
+                    results.push({
+                        eventType: 'response',
+                        event: emittableEvent,
+                    });
+                    if (msg.event === 'error') {
+                        this.logger.error('WS Error received', {
+                            ...websocket_util_js_1.WS_LOGGER_CATEGORY,
+                            wsKey,
+                            message: msg || 'no message',
+                            // messageType: typeof msg,
+                            // messageString: JSON.stringify(msg),
+                            event,
+                        });
+                        results.push({
+                            eventType: 'exception',
+                            event: emittableEvent,
+                        });
+                    }
+                    return results;
+                }
+                if (msg['arg']) {
+                    results.push({
+                        eventType: 'update',
+                        event: emittableEvent,
+                    });
+                    return results;
+                }
+            }
+            this.logger.info('Unhandled/unrecognised ws event message', {
+                ...websocket_util_js_1.WS_LOGGER_CATEGORY,
+                message: msg || 'no message',
+                // messageType: typeof msg,
+                // messageString: JSON.stringify(msg),
+                event,
+                wsKey,
+            });
+            // fallback emit anyway
+            results.push({
+                eventType: 'update',
+                event: emittableEvent,
+            });
+            return results;
+        }
+        catch (e) {
+            this.logger.error('Failed to parse ws event message', {
+                ...websocket_util_js_1.WS_LOGGER_CATEGORY,
+                error: e,
+                event,
+                wsKey,
+            });
+        }
+        return results;
+    }
+    /**
+     * V3/UTA supports order placement via WebSockets. This is the WS API:
+     * https://www.bitget.com/api-doc/uta/websocket/private/Place-Order-Channel
+     *
+     * @returns a promise that resolves/rejects when a matching response arrives
+     */
+    async sendWSAPIRequest(wsKey, operation, category, params, requestFlags) {
+        this.logger.trace(`sendWSAPIRequest(): assert "${wsKey}" is connected`);
+        await this.assertIsConnected(wsKey);
+        this.logger.trace('sendWSAPIRequest()->assertIsConnected() ok');
+        if (requestFlags?.authIsOptional !== true) {
+            // this.logger.trace('sendWSAPIRequest(): assertIsAuthenticated(${wsKey})...');
+            await this.assertIsAuthenticated(wsKey);
+            // this.logger.trace('sendWSAPIRequest(): assertIsAuthenticated(${wsKey}) ok');
+        }
+        const request = {
+            op: 'trade',
+            id: `${this.getNewRequestId()}`,
+            category: category,
+            topic: operation,
+            // Ensure "args" is always wrapped as array
+            args: Array.isArray(params) ? params : [params],
+        };
+        // Store deferred promise, resolved within the "resolveEmittableEvents" method while parsing incoming events
+        const promiseRef = (0, websocket_util_js_1.getPromiseRefForWSAPIRequest)(request);
+        const deferredPromise = this.getWsStore().createDeferredPromise(wsKey, promiseRef, false);
+        // Enrich returned promise with request context for easier debugging
+        deferredPromise.promise
+            ?.then((res) => {
+            if (!Array.isArray(res)) {
+                res.request = {
+                    wsKey,
+                    ...request,
+                };
+            }
+            return res;
+        })
+            .catch((e) => {
+            if (typeof e === 'string') {
+                this.logger.error('Unexpected string thrown without Error object:', {
+                    e,
+                    wsKey,
+                    request,
+                });
+                return e;
+            }
+            e.request = {
+                wsKey,
+                operation,
+                params: params,
+            };
+            // throw e;
+            return e;
+        });
+        this.logger.trace(`sendWSAPIRequest(): sending raw request: ${JSON.stringify(request, null, 2)}`);
+        // Send event
+        const throwExceptions = false;
+        this.tryWsSend(wsKey, JSON.stringify(request), throwExceptions);
+        this.logger.trace(`sendWSAPIRequest(): sent "${operation}" event with promiseRef(${promiseRef})`);
+        // Return deferred promise, so caller can await this call
+        return deferredPromise.promise;
+    }
+}
+exports.WebsocketClientV3 = WebsocketClientV3;
+//# sourceMappingURL=websocket-client-v3.js.map

package/dist/cjs/websocket-client-v3.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket-client-v3.js","sourceRoot":"","sources":["../../src/websocket-client-v3.ts"],"names":[],"mappings":";;;AAgBA,4DAIgC;AAChC,4DAAkD;AAClD,0DAAwD;AACxD,4DAAoE;AACpE,gEASkC;AAGlC;;;;GAIG;AACH,MAAa,iBAAkB,SAAQ,qCAGtC;IACC;;OAEG;IACI,UAAU;QACf,OAAO;YACL,IAAI,CAAC,OAAO,CAAC,8BAAU,CAAC,SAAS,CAAC;YAClC,IAAI,CAAC,OAAO,CAAC,8BAAU,CAAC,QAAQ,CAAC;SAClC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,YAAY;QACjB,kGAAkG;QAClG,OAAO,IAAI,CAAC,qBAAqB,CAAC,8BAAU,CAAC,SAAS,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;OAWG;IACI,SAAS,CACd,QAEyD,EACzD,KAAY;QAEZ,MAAM,aAAa,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QACtE,MAAM,uBAAuB,GAAG,IAAA,8CAA0B,EAAC,aAAa,CAAC,CAAC;QAC1E,OAAO,IAAI,CAAC,uBAAuB,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAC;IACtE,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAChB,QAEyD,EACzD,KAAY;QAEZ,MAAM,aAAa,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QACtE,MAAM,uBAAuB,GAAG,IAAA,8CAA0B,EAAC,aAAa,CAAC,CAAC;QAE1E,OAAO,IAAI,CAAC,yBAAyB,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;OAMG;IAEO,aAAa,CAAC,KAAY;QAClC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAChC,CAAC;IAES,aAAa,CAAC,KAAY;QAClC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAChC,CAAC;IAES,QAAQ,CAAC,IAAS;QAC1B,IAAI,IAAI,EAAE,IAAI,KAAK,MAAM,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAES,QAAQ,CAAC,IAAS;QAC1B,OAAO,IAAA,0BAAQ,EAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAES,qBAAqB,CAC7B,QAAgC,EAChC,KAAY;QAEZ,OAAO,2CAAuB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACjD,CAAC;IAES,gBAAgB;QACxB,OAAO,2CAAuB,CAAC;IACjC,CAAC;IAES,oBAAoB,CAAC,KAAY;QACzC,OAAO,2CAAuB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACjD,CAAC;IAES,KAAK,CAAC,QAAQ,CAAC,KAAY;QACnC,OAAO,IAAA,4BAAQ,EAAC,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC;IAES,6BAA6B,CAAC,KAAY;QAClD,OAAO,IAAA,iDAA6B,EAAC,KAAK,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,kBAAkB,CAChC,SAAsB,EACtB,QAA0C;QAE1C,MAAM,uBAAuB,GAAc,EAAE,CAAC;QAE9C,MAAM,MAAM,GAAG,QAAQ,CAAC,GAAG,CACzB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAChE,CAAC;QAEF,gIAAgI;QAChI,MAAM,MAAM,GACV,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,MAAM,CAAC,MAAM;YAC/D,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;YAClB,CAAC,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC,OAAO,EAAE,CAAC;QAEvC;;;;;;;;;;;;;;;;UAgBE;QACF,MAAM,OAAO,GAAqC;YAChD,EAAE,EAAE,SAAS;YACb,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC7B,oBAAoB;gBACpB,qBAAqB;gBACrB,sDAAsD;gBACtD,KAAK;gBACL,WAAW;gBACX,oBAAoB;gBACpB,qBAAqB;gBACrB,sBAAsB;gBACtB,uBAAuB;gBACvB,KAAK;gBACL,OAAO;oBACL,KAAK,EAAE,OAAO,CAAC,KAAK;oBACpB,GAAG,OAAO,CAAC,OAAO;iBACnB,CAAC;YACJ,CAAC,CAAC;SACH,CAAC;QAEF,MAAM,gBAAgB,GAElB;YACF,UAAU,EAAE,MAAM;YAClB,YAAY,EAAE,OAAO;SACtB,CAAC;QAEF,IAAI,uBAAuB,CAAC,MAAM,EAAE,CAAC;YACnC,MAAM,KAAK,GACT,uBAAuB,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;YAEtE,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,wBAAwB,uBAAuB,CAAC,MAAM,iBAAiB,KAAK,gCAAgC,EAC5G;gBACE,GAAG,sCAAkB;gBACrB,uBAAuB;gBACvB,kCAAkC,EAAE,IAAI,CAAC,SAAS,CAChD,uBAAuB,EACvB,IAAI,EACJ,CAAC,CACF;aACF,CACF,CAAC;QACJ,CAAC;QAED,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC5B,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAC9B,KAAY;QAEZ,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QAEhE,IAAI,CAAC,MAAM,IAAI,CAAC,SAAS,IAAI,CAAC,OAAO,EAAE,CAAC;YACtC,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,8EAA8E,EAC9E,EAAE,GAAG,sCAAkB,EAAE,KAAK,EAAE,CACjC,CAAC;YACF,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;QAC3E,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+BAA+B,EAAE;YACjD,GAAG,sCAAkB;YACrB,KAAK;SACN,CAAC,CAAC;QAEH,MAAM,kBAAkB,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAEzE,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,WAAW,CACtC,kBAAkB,GAAG,KAAK,GAAG,cAAc,EAC3C,SAAS,EACT,QAAQ,EACR,SAAS,CACV,CAAC;QAEF,OAAO;YACL,SAAS,EAAE,CAAC,kBAAkB;YAC9B,SAAS;SACV,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,WAAW,CACvB,SAAiB,EACjB,MAAc,EACd,MAAwB,EACxB,SAAwB;QAExB,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,KAAK,UAAU,EAAE,CAAC;YAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAC7D,CAAC;QACD,OAAO,MAAM,IAAA,6BAAW,EAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;IACjE,CAAC;IAES,KAAK,CAAC,qBAAqB,CACnC,KAAY;QAEZ,IAAI,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;YACpD,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAEtE,IAAI,CAAC,MAAM,IAAI,CAAC,SAAS,IAAI,CAAC,OAAO,EAAE,CAAC;gBACtC,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,8EAA8E,EAC9E,EAAE,GAAG,sCAAkB,EAAE,KAAK,EAAE,CACjC,CAAC;gBACF,MAAM,IAAI,KAAK,CACb,uDAAuD,CACxD,CAAC;YACJ,CAAC;YAED,MAAM,OAAO,GAAqD;gBAChE,EAAE,EAAE,OAAO;gBACX,IAAI,EAAE;oBACJ;wBACE,MAAM;wBACN,UAAU,EAAE,OAAO;wBACnB,SAAS,EAAE,SAAS;wBACpB,IAAI,EAAE,SAAS;qBAChB;iBACF;aACF,CAAC;YAEF,OAAO,OAAO,CAAC;QACjB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,GAAG,sCAAkB,EAAE,KAAK,EAAE,CAAC,CAAC;YACvD,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;IAED;;OAEG;IACO,sBAAsB,CAC9B,KAAY,EACZ,KAAuB;QAEvB,MAAM,OAAO,GAAqB,EAAE,CAAC;QAErC,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACnC,MAAM,cAAc,GAAG,EAAE,GAAG,GAAG,EAAE,KAAK,EAAE,CAAC;YAEzC;;eAEG;YACH,IAAI,IAAA,gCAAe,EAAC,cAAc,CAAC,EAAE,CAAC;gBACpC,gBAAgB;gBAChB,oBAAoB;gBACpB,aAAa;gBACb,mBAAmB;gBACnB,iCAAiC;gBACjC,KAAK;gBAEL,MAAM,OAAO,GAAG,cAAc,CAAC,IAAI,CAAC;gBACpC,MAAM,KAAK,GAAG,cAAc,CAAC,EAAE,CAAC;gBAChC,MAAM,OAAO,GAAG,OAAO,KAAK,GAAG,CAAC;gBAEhC,MAAM,UAAU,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAEjD,MAAM,eAAe,GAAG;oBACtB,KAAK;oBACL,UAAU;oBACV,WAAW,EAAE,cAAc;iBAC5B,CAAC;gBAEF,IAAI,CAAC,KAAK,EAAE,CAAC;oBACX,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,+IAA+I,EAC/I,eAAe,CAChB,CAAC;gBACJ,CAAC;gBAED,IAAI,OAAO,EAAE,CAAC;oBACZ,IAAI,CAAC;wBACH,IAAI,CAAC,UAAU,EAAE,CAAC,qBAAqB,CACrC,KAAK,EACL,UAAU,EACV,cAAc,EACd,IAAI,CACL,CAAC;oBACJ,CAAC;oBAAC,OAAO,CAAC,EAAE,CAAC;wBACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,0CAA0C,EAAE;4BAC5D,GAAG,eAAe;4BAClB,KAAK,EAAE,CAAC;yBACT,CAAC,CAAC;oBACL,CAAC;oBAED,OAAO,CAAC,IAAI,CAAC;wBACX,SAAS,EAAE,WAAW;wBACtB,KAAK,EAAE,cAAc;wBACrB,eAAe,EAAE,IAAI;qBACtB,CAAC,CAAC;oBACH,OAAO,OAAO,CAAC;gBACjB,CAAC;gBAED,iBAAiB;gBACjB,IAAI,CAAC;oBACH,IAAI,CAAC,UAAU,EAAE,CAAC,sBAAsB,CACtC,KAAK,EACL,UAAU,EACV,cAAc,EACd,IAAI,CACL,CAAC;gBACJ,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,2CAA2C,EAAE;wBAC7D,GAAG,eAAe;wBAClB,KAAK,EAAE,CAAC;qBACT,CAAC,CAAC;gBACL,CAAC;gBAED,OAAO,CAAC,IAAI,CAAC;oBACX,SAAS,EAAE,UAAU;oBACrB,KAAK,EAAE,cAAc;oBACrB,eAAe,EAAE,IAAI;iBACtB,CAAC,CAAC;gBAEH,OAAO,OAAO,CAAC;YACjB,CAAC;YAED;;eAEG;YACH,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC5B,IAAI,OAAO,GAAG,CAAC,MAAM,CAAC,KAAK,QAAQ,EAAE,CAAC;oBACpC,0BAA0B;oBAC1B,IAAI,GAAG,CAAC,KAAK,KAAK,OAAO,IAAI,GAAG,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;wBAC5C,OAAO,CAAC,IAAI,CAAC;4BACX,SAAS,EAAE,UAAU;4BACrB,KAAK,EAAE,cAAc;yBACtB,CAAC,CAAC;wBACH,OAAO,CAAC,IAAI,CAAC;4BACX,SAAS,EAAE,eAAe;4BAC1B,KAAK,EAAE,cAAc;yBACtB,CAAC,CAAC;wBACH,OAAO,OAAO,CAAC;oBACjB,CAAC;gBACH,CAAC;gBAED,IAAI,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;oBACjB,OAAO,CAAC,IAAI,CAAC;wBACX,SAAS,EAAE,UAAU;wBACrB,KAAK,EAAE,cAAc;qBACtB,CAAC,CAAC;oBAEH,IAAI,GAAG,CAAC,KAAK,KAAK,OAAO,EAAE,CAAC;wBAC1B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,mBAAmB,EAAE;4BACrC,GAAG,sCAAkB;4BACrB,KAAK;4BACL,OAAO,EAAE,GAAG,IAAI,YAAY;4BAC5B,2BAA2B;4BAC3B,sCAAsC;4BACtC,KAAK;yBACN,CAAC,CAAC;wBACH,OAAO,CAAC,IAAI,CAAC;4BACX,SAAS,EAAE,WAAW;4BACtB,KAAK,EAAE,cAAc;yBACtB,CAAC,CAAC;oBACL,CAAC;oBAED,OAAO,OAAO,CAAC;gBACjB,CAAC;gBAED,IAAI,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;oBACf,OAAO,CAAC,IAAI,CAAC;wBACX,SAAS,EAAE,QAAQ;wBACnB,KAAK,EAAE,cAAc;qBACtB,CAAC,CAAC;oBACH,OAAO,OAAO,CAAC;gBACjB,CAAC;YACH,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,yCAAyC,EAAE;gBAC1D,GAAG,sCAAkB;gBACrB,OAAO,EAAE,GAAG,IAAI,YAAY;gBAC5B,2BAA2B;gBAC3B,sCAAsC;gBACtC,KAAK;gBACL,KAAK;aACN,CAAC,CAAC;YAEH,uBAAuB;YACvB,OAAO,CAAC,IAAI,CAAC;gBACX,SAAS,EAAE,QAAQ;gBACnB,KAAK,EAAE,cAAc;aACtB,CAAC,CAAC;YACH,OAAO,OAAO,CAAC;QACjB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,kCAAkC,EAAE;gBACpD,GAAG,sCAAkB;gBACrB,KAAK,EAAE,CAAC;gBACR,KAAK;gBACL,KAAK;aACN,CAAC,CAAC;QACL,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,gBAAgB,CAOpB,KAAY,EACZ,SAAuB,EACvB,QAA0B,EAC1B,MAA6C,EAC7C,YAAgC;QAEhC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+BAA+B,KAAK,gBAAgB,CAAC,CAAC;QAExE,MAAM,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAEhE,IAAI,YAAY,EAAE,cAAc,KAAK,IAAI,EAAE,CAAC;YAC1C,+EAA+E;YAC/E,MAAM,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;YACxC,+EAA+E;QACjF,CAAC;QAED,MAAM,OAAO,GAAoC;YAC/C,EAAE,EAAE,OAAO;YACX,EAAE,EAAE,GAAG,IAAI,CAAC,eAAe,EAAE,EAAE;YAC/B,QAAQ,EAAE,QAAQ;YAClB,KAAK,EAAE,SAAS;YAChB,2CAA2C;YAC3C,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;SAChD,CAAC;QAEF,4GAA4G;QAC5G,MAAM,UAAU,GAAG,IAAA,gDAA4B,EAAC,OAAO,CAAC,CAAC;QAEzD,MAAM,eAAe,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,qBAAqB,CAG7D,KAAK,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;QAE5B,oEAAoE;QACpE,eAAe,CAAC,OAAO;YACrB,EAAE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;YACb,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;gBACxB,GAAG,CAAC,OAAO,GAAG;oBACZ,KAAK;oBACL,GAAG,OAAO;iBACX,CAAC;YACJ,CAAC;YAED,OAAO,GAAG,CAAC;QACb,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACX,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;gBAC1B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gDAAgD,EAAE;oBAClE,CAAC;oBACD,KAAK;oBACL,OAAO;iBACR,CAAC,CAAC;gBACH,OAAO,CAAC,CAAC;YACX,CAAC;YACD,CAAC,CAAC,OAAO,GAAG;gBACV,KAAK;gBACL,SAAS;gBACT,MAAM,EAAE,MAAM;aACf,CAAC;YACF,WAAW;YACX,OAAO,CAAC,CAAC;QACX,CAAC,CAAC,CAAC;QAEL,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,4CAA4C,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAC/E,CAAC;QAEF,aAAa;QACb,MAAM,eAAe,GAAG,KAAK,CAAC;QAC9B,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,eAAe,CAAC,CAAC;QAEhE,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,6BAA6B,SAAS,2BAA2B,UAAU,GAAG,CAC/E,CAAC;QAEF,yDAAyD;QACzD,OAAO,eAAe,CAAC,OAAQ,CAAC;IAClC,CAAC;CACF;AA9hBD,8CA8hBC"}

package/dist/mjs/broker-client.d.ts

@@ -0,0 +1,127 @@
+import { BrokerProductType, BrokerSubAPIKeyModifyRequest, BrokerSubListRequest, BrokerSubWithdrawalRequest } from './types/request/v1/brokerV1.js';
+import { APIResponse } from './types/response/v1/shared.js';
+import BaseRestClient from './util/BaseRestClient.js';
+/**
+ * REST API client for the V1 bitget Broker APIs. These are the previous generation of Bitget's APIs and should be considered deprecated.
+ * These will be removed in a future release, once Bitget formally deprecates them.
+ *
+ * @deprecated use RestClientV2 instead
+ */
+export declare class BrokerClient extends BaseRestClient {
+    getClientType(): "broker";
+    /**
+     *
+     * Sub Account Interface
+     *
+     */
+    /** Get Broker Info */
+    getBrokerInfo(): Promise<APIResponse<any>>;
+    /** Create Sub Account */
+    createSubAccount(subName: string, remark?: string): Promise<APIResponse<any>>;
+    /** Get Sub List */
+    getSubAccounts(params?: BrokerSubListRequest): Promise<APIResponse<any>>;
+    /** Modify Sub Account */
+    modifySubAccount(subUid: string, perm: string, status: 'normal' | 'freeze' | 'del'): Promise<APIResponse<any>>;
+    /** Modify Sub Email */
+    modifySubEmail(subUid: string, subEmail: string): Promise<APIResponse<any>>;
+    /** Get Sub Email */
+    getSubEmail(subUid: string): Promise<APIResponse<any>>;
+    /** Get Sub Spot Assets */
+    getSubSpotAssets(subUid: string): Promise<APIResponse<any>>;
+    /** Get Sub Future Assets */
+    getSubFutureAssets(subUid: string, productType: BrokerProductType): Promise<APIResponse<any>>;
+    /** Get Sub Deposit Address (Only Broker) */
+    getSubDepositAddress(subUid: string, coin: string, chain?: string): Promise<APIResponse<any>>;
+    /** Sub Withdrawal (Only Broker) */
+    subWithdrawal(params: BrokerSubWithdrawalRequest): Promise<APIResponse<any>>;
+    /** Sub Deposit Auto Transfer (Only Broker) */
+    setSubDepositAutoTransfer(subUid: string, coin: string, toAccountType: 'spot' | 'mix_usdt' | 'mix_usd' | 'mix_usdc'): Promise<APIResponse<any>>;
+    /**
+     *
+     * Sub API Interface
+     *
+     */
+    /** Create Sub ApiKey (Only Broker) */
+    createSubAPIKey(subUid: string, passphrase: string, remark: string, ip: string, perm?: string): Promise<APIResponse<any>>;
+    /** Get Sub ApiKey List */
+    getSubAPIKeys(subUid: string): Promise<APIResponse<any>>;
+    /** Modify Sub ApiKey (Only Broker) */
+    modifySubAPIKey(params: BrokerSubAPIKeyModifyRequest): Promise<APIResponse<any>>;
+    /**
+     * Undocumented endpoints
+     */
+    getAgentCommissionDetail(params?: {
+        startTime?: string;
+        endTime?: string;
+        limit?: string;
+        idLessThan?: string;
+    }): Promise<APIResponse<any>>;
+    /** Get Agent Customer List */
+    getAgentCustomerList(params?: {
+        startTime?: string;
+        endTime?: string;
+        pageNo?: string;
+        pageSize?: string;
+        uid?: string;
+        referralCode?: string;
+    }): Promise<APIResponse<any>>;
+    /**
+     * Get Agent Customer Deposit List
+     * Includes both on-chain deposits and internal transfers
+     * Note: Can only query data within the last 90 days
+     */
+    getAgentCustomerDepositList(params?: {
+        startTime?: string;
+        endTime?: string;
+        pageNo?: string;
+        pageSize?: string;
+        uid?: string;
+    }): Promise<APIResponse<any>>;
+    /**
+     * Get Agent Customer Trade Volume List
+     * Includes trading volume for both spot and futures
+     * Note: Data updates every 10 minutes and can only query last 90 days
+     */
+    getAgentCustomerTradeVolumeList(params?: {
+        startTime?: string;
+        endTime?: string;
+        pageNo?: string;
+        pageSize?: string;
+        uid?: string;
+    }): Promise<APIResponse<any>>;
+    /**
+     * Get Agent Customer Assets List
+     * Returns account balances for customer accounts
+     * Note: Data updates every 10 minutes
+     */
+    getAgentCustomerAssetsList(params?: {
+        pageNo?: string;
+        pageSize?: string;
+        uid?: string;
+    }): Promise<APIResponse<any>>;
+    /**
+     * Get Agent Direct Commissions
+     * Returns commission data for direct customers
+     * Note: Data updates on T+1 (UTC+8) basis and can only query last 90 days
+     */
+    getAgentCustomerCommissions(params?: {
+        startTime?: string;
+        endTime?: string;
+        idLessThan?: string;
+        limit?: string;
+        uid?: string;
+        coin?: string;
+        symbol?: string;
+    }): Promise<APIResponse<any>>;
+    /**
+     * Get Agent Customer KYC Result
+     * Returns KYC verification status for customers
+     */
+    getAgentCustomerKycResult(params?: {
+        startTime?: string;
+        endTime?: string;
+        pageNo?: string;
+        pageSize?: string;
+        uid?: string;
+    }): Promise<APIResponse<any>>;
+}