bitget-api 1.1.4 → 2.0.0

package/lib/types/request/index.js

@@ -14,8 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./broker"), exports);
-__exportStar(require("./futures"), exports);
+__exportStar(require("./v1/brokerV1"), exports);
+__exportStar(require("./v1/futuresV1"), exports);
+__exportStar(require("./v1/spotV1"), exports);
+__exportStar(require("./v2/futures"), exports);
+__exportStar(require("./v2/spot"), exports);
 __exportStar(require("./shared"), exports);
-__exportStar(require("./spot"), exports);
 //# sourceMappingURL=index.js.map

package/lib/types/request/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/request/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,4CAA0B;AAC1B,2CAAyB;AACzB,yCAAuB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/request/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,iDAA+B;AAC/B,8CAA4B;AAC5B,+CAA6B;AAC7B,4CAA0B;AAC1B,2CAAyB"}

package/lib/types/request/shared.d.ts

@@ -15,3 +15,7 @@ export interface GetHistoricTradesParams {
     startTime?: string;
     endTime?: string;
 }
+/**
+ * The margin type, used directly in building the endpoint URL
+ */
+export declare type MarginType = 'crossed' | 'isolated';

package/lib/types/request/v1/brokerV1.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=brokerV1.js.map

package/lib/types/request/v1/brokerV1.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"brokerV1.js","sourceRoot":"","sources":["../../../../src/types/request/v1/brokerV1.ts"],"names":[],"mappings":""}

package/lib/types/request/{futures.d.ts → v1/futuresV1.d.ts}

@@ -1,4 +1,4 @@
-import { OrderTimeInForce } from './shared';
+import { OrderTimeInForce } from '../shared';
 export declare type FuturesProductType = 'umcbl' | 'dmcbl' | 'cmcbl' | 'sumcbl' | 'sdmcbl' | 'scmcbl';
 export declare type FuturesKlineInterval = '1m' | '3m' | '5m' | '15m' | '30m' | '1H' | '2H' | '4H' | '6H' | '12H' | '1D' | '3D' | '1W' | '1M' | '6Hutc' | '12Hutc' | '1Dutc' | '3Dutc' | '1Wutc' | '1Mutc';
 export declare type FuturesHoldSide = 'long' | 'short';

package/lib/types/request/v1/futuresV1.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=futuresV1.js.map

package/lib/types/request/v1/futuresV1.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"futuresV1.js","sourceRoot":"","sources":["../../../../src/types/request/v1/futuresV1.ts"],"names":[],"mappings":""}

package/lib/types/request/{spot.d.ts → v1/spotV1.d.ts}

@@ -1,4 +1,4 @@
-import { OrderTimeInForce } from './shared';
+import { OrderTimeInForce } from '../shared';
 export declare type WalletType = 'spot' | 'mix_usdt' | 'mix_usd';
 export declare type SpotKlineInterval = '1min' | '5min' | '15min' | '30min' | '1h' | '4h' | '6h' | '12h' | '1M' | '1W' | '1week' | '6Hutc' | '12Hutc' | '1Dutc' | '3Dutc' | '1Wutc' | '1Mutc';
 export interface NewWalletTransfer {

package/lib/types/request/{broker.js → v1/spotV1.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=broker.js.map
+//# sourceMappingURL=spotV1.js.map

package/lib/types/request/v1/spotV1.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spotV1.js","sourceRoot":"","sources":["../../../../src/types/request/v1/spotV1.ts"],"names":[],"mappings":""}

package/lib/types/request/v2/futures.d.ts

@@ -0,0 +1,22 @@
+import { FuturesKlineInterval } from '../v1/futuresV1';
+export declare type FuturesProductTypeV2 = 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES' | 'SUSDT-FUTURES' | 'SCOIN-FUTURES' | 'SUSDC-FUTURES';
+export declare type FuturesKlineTypeV2 = 'MARKET' | 'MARK' | 'INDEX';
+export interface FuturesAccountBillRequestV2 {
+    productType: FuturesProductTypeV2;
+    symbol?: string;
+    coin?: string;
+    businessType?: string;
+    idLessThan?: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+}
+export interface FuturesCandlesRequestV2 {
+    symbol: string;
+    productType: FuturesProductTypeV2;
+    granularity: FuturesKlineInterval;
+    startTime?: string;
+    endTime?: string;
+    kLineType?: FuturesKlineTypeV2;
+    limit?: string;
+}

package/lib/types/request/v2/futures.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"futures.js","sourceRoot":"","sources":["../../../../src/types/request/v2/futures.ts"],"names":[],"mappings":""}

package/lib/types/request/v2/spot.d.ts

@@ -0,0 +1,8 @@
+import { SpotKlineInterval } from '../v1/spotV1';
+export interface SpotCandlesRequestV2 {
+    symbol: string;
+    granularity: SpotKlineInterval;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+}

package/lib/types/request/{spot.js.map → v2/spot.js.map}

@@ -1 +1 @@
-{"version":3,"file":"spot.js","sourceRoot":"","sources":["../../../src/types/request/spot.ts"],"names":[],"mappings":""}
+{"version":3,"file":"spot.js","sourceRoot":"","sources":["../../../../src/types/request/v2/spot.ts"],"names":[],"mappings":""}

package/lib/types/response/shared.d.ts

@@ -1,8 +1,8 @@
 export interface APIResponse<T> {
     code: string;
-    data: T;
-    msg: 'success' | string;
     requestTime: number;
+    msg: 'success' | string;
+    data: T;
 }
 export interface VIPFeeRate {
     level: number;

package/lib/types/websockets/client.d.ts

@@ -1,4 +1,8 @@
 import { WS_KEY_MAP } from '../../util';
+import { FuturesProductTypeV2 } from '../request';
+/** A "topic" is always a string */
+export declare type BitgetInstType = 'SP' | 'SPBL' | 'MC' | 'UMCBL' | 'DMCBL';
+export declare type BitgetInstTypeV2 = 'SPOT' | FuturesProductTypeV2;
 export declare type WsPublicSpotTopic = 'ticker' | 'candle1W' | 'candle1D' | 'candle12H' | 'candle4H' | 'candle1H' | 'candle30m' | 'candle15m' | 'candle5m' | 'candle1m' | 'books' | 'books5' | 'trade';
 export declare type WsPublicFuturesTopic = WsPublicSpotTopic;
 export declare type WsPrivateSpotTopic = 'account' | 'orders';
@@ -6,8 +10,43 @@ export declare type WsPrivateFuturesTopic = 'account' | 'positions' | 'orders' |
 export declare type WsPublicTopic = WsPublicSpotTopic | WsPublicFuturesTopic;
 export declare type WsPrivateTopic = WsPrivateSpotTopic | WsPrivateFuturesTopic;
 export declare type WsTopic = WsPublicTopic | WsPrivateTopic;
+export declare type WsPublicTopicV2 = 'index-price' | 'ticker' | 'candle1m' | 'candle5m' | 'candle15' | 'candle30m' | 'candle1H' | 'candle4H' | 'candle6H' | 'candle12H' | 'candle1D' | 'candle3D' | 'candle1W' | 'candle1M' | 'candle6Hutc' | 'candle12Hutc' | 'candle1Dutc' | 'candle3Dutc' | 'candle1Wutc' | 'candle1Mutc' | 'trade' | 'books' | 'books1' | 'books5' | 'books15';
+export declare type WSPrivateTopicFuturesV2 = 'positions' | 'orders-algo' | 'positions-history';
+export declare type WSPrivateTopicMarginV2 = 'orders-crossed' | 'account-crossed' | 'account-isolated' | 'orders-isolated';
+export declare type WsPrivateTopicV2 = 'account' | 'orders' | WSPrivateTopicFuturesV2 | WSPrivateTopicMarginV2;
+export declare type WsTopicV2 = WsPublicTopicV2 | WsPrivateTopicV2;
 /** This is used to differentiate between each of the available websocket streams */
-export declare type WsKey = typeof WS_KEY_MAP[keyof typeof WS_KEY_MAP];
+export declare type WsKey = (typeof WS_KEY_MAP)[keyof typeof WS_KEY_MAP];
+/**
+ * Event args for subscribing/unsubscribing
+ */
+export interface WsTopicSubscribeEventArgs {
+    instType: BitgetInstType;
+    channel: WsTopic;
+    instId?: string;
+}
+export declare type WsTopicSubscribePublicArgsV2 = {
+    instType: BitgetInstTypeV2;
+    channel: WsPublicTopicV2;
+    /** The symbol, e.g. "BTCUSDT" */
+    instId: string;
+};
+export declare type WsInstIdChannelsV2 = 'orders' | WSPrivateTopicFuturesV2 | 'orders-crossed' | 'orders-isolated';
+export declare type WsTopicSubscribePrivateInstIdArgsV2 = {
+    instType: BitgetInstTypeV2;
+    channel: WsInstIdChannelsV2;
+    /** The symbol, e.g. "BTCUSDT" */
+    instId?: string;
+};
+export declare type WsCoinChannelsV2 = 'account' | 'account-crossed' | 'account-isolated';
+export declare type WsTopicSubscribePrivateCoinArgsV2 = {
+    instType: BitgetInstTypeV2;
+    channel: WsCoinChannelsV2;
+    coin: 'default' | string;
+};
+export declare type WsTopicSubscribePrivateArgsV2 = WsTopicSubscribePrivateInstIdArgsV2 | WsTopicSubscribePrivateCoinArgsV2;
+export declare type WsTopicSubscribeEventArgsV2 = WsTopicSubscribePublicArgsV2 | WsTopicSubscribePrivateArgsV2;
+/** General configuration for the WebsocketClient */
 export interface WSClientConfigurableOptions {
     /** Your API key */
     apiKey?: string;

package/lib/util/BaseWSClient.d.ts

@@ -0,0 +1,112 @@
+/// <reference types="node" />
+import EventEmitter from 'events';
+import WebSocket from 'isomorphic-ws';
+import { WebsocketClientOptions, WSClientConfigurableOptions } from '../types';
+import WsStore from './WsStore';
+import { DefaultLogger } from './logger';
+interface WSClientEventMap<WsKey extends string> {
+    /** Connection opened. If this connection was previously opened and reconnected, expect the reconnected event instead */
+    open: (evt: {
+        wsKey: WsKey;
+        event: any;
+    }) => void;
+    /** Reconnecting a dropped connection */
+    reconnect: (evt: {
+        wsKey: WsKey;
+        event: any;
+    }) => void;
+    /** Successfully reconnected a connection that dropped */
+    reconnected: (evt: {
+        wsKey: WsKey;
+        event: any;
+    }) => void;
+    /** Connection closed */
+    close: (evt: {
+        wsKey: WsKey;
+        event: any;
+    }) => void;
+    /** Received reply to websocket command (e.g. after subscribing to topics) */
+    response: (response: any & {
+        wsKey: WsKey;
+    }) => void;
+    /** Received data for topic */
+    update: (response: any & {
+        wsKey: WsKey;
+    }) => void;
+    /** Exception from ws client OR custom listeners (e.g. if you throw inside your event handler) */
+    exception: (response: any & {
+        wsKey: WsKey;
+    }) => void;
+    /** Confirmation that a connection successfully authenticated */
+    authenticated: (event: {
+        wsKey: WsKey;
+        event: any;
+    }) => void;
+}
+export interface BaseWebsocketClient<TWSKey extends string, TWSTopicSubscribeEventArgs extends object> {
+    on<U extends keyof WSClientEventMap<TWSKey>>(event: U, listener: WSClientEventMap<TWSKey>[U]): this;
+    emit<U extends keyof WSClientEventMap<TWSKey>>(event: U, ...args: Parameters<WSClientEventMap<TWSKey>[U]>): boolean;
+}
+export interface BaseWSClientImpl {
+}
+export declare abstract class BaseWebsocketClient<TWSKey extends string, TWSTopicSubscribeEventArgs extends object> extends EventEmitter {
+    private wsStore;
+    protected logger: typeof DefaultLogger;
+    protected options: WebsocketClientOptions;
+    constructor(options: WSClientConfigurableOptions, logger?: typeof DefaultLogger);
+    protected abstract getWsKeyForTopic(subscribeEvent: TWSTopicSubscribeEventArgs, isPrivate?: boolean): TWSKey;
+    protected abstract isPrivateChannel(subscribeEvent: TWSTopicSubscribeEventArgs): boolean;
+    protected abstract shouldAuthOnConnect(wsKey: TWSKey): boolean;
+    protected abstract getWsUrl(wsKey: TWSKey): string;
+    protected abstract getMaxTopicsPerSubscribeEvent(wsKey: TWSKey): number | null;
+    /**
+     * Request connection of all dependent (public & private) websockets, instead of waiting for automatic connection by library
+     */
+    abstract connectAll(): Promise<WebSocket | undefined>[];
+    /**
+     * Subscribe to topics & track/persist them. They will be automatically resubscribed to if the connection drops/reconnects.
+     * @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: TWSTopicSubscribeEventArgs[] | TWSTopicSubscribeEventArgs, isPrivateTopic?: boolean): void;
+    /**
+     * Unsubscribe from topics & remove them from memory. They won't be re-subscribed to if the connection reconnects.
+     * @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: TWSTopicSubscribeEventArgs[] | TWSTopicSubscribeEventArgs, isPrivateTopic?: boolean): void;
+    /** Get the WsStore that tracks websockets & topics */
+    getWsStore(): WsStore<TWSKey, TWSTopicSubscribeEventArgs>;
+    close(wsKey: TWSKey, force?: boolean): void;
+    closeAll(force?: boolean): void;
+    /**
+     * Request connection to a specific websocket, instead of waiting for automatic connection.
+     */
+    protected connect(wsKey: TWSKey): Promise<WebSocket | undefined>;
+    private parseWsError;
+    /** Get a signature, build the auth request and send it */
+    private sendAuthRequest;
+    private reconnectWithDelay;
+    private ping;
+    private clearTimers;
+    private clearPingTimer;
+    private clearPongTimer;
+    /**
+     * @private Use the `subscribe(topics)` method to subscribe to topics. Send WS message to subscribe to topics.
+     */
+    private requestSubscribeTopics;
+    /**
+     * @private Use the `unsubscribe(topics)` method to unsubscribe from topics. Send WS message to unsubscribe from topics.
+     */
+    private requestUnsubscribeTopics;
+    tryWsSend(wsKey: TWSKey, wsMessage: string): void;
+    private connectToWsUrl;
+    private onWsOpen;
+    /** Handle subscription to private topics _after_ authentication successfully completes asynchronously */
+    private onWsAuthenticated;
+    private onWsMessage;
+    private onWsClose;
+    private getWs;
+    private setWsState;
+}
+export {};