bitget-api 2.3.6 → 3.0.0

package/dist/cjs/types/response/v3/strategy.d.ts

@@ -0,0 +1,26 @@
+export interface PlaceStrategyOrderResponseV3 {
+    orderId: string;
+    clientOid: string;
+}
+export interface ModifyStrategyOrderResponseV3 {
+    orderId: string;
+    clientOid: string;
+}
+export interface StrategyOrderV3 {
+    orderId: string;
+    clientOid: string;
+    category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    symbol: string;
+    qty: string;
+    posSide: 'long' | 'short';
+    tpTriggerBy: 'market' | 'mark';
+    slTriggerBy: 'market' | 'mark';
+    takeProfit: string;
+    stopLoss: string;
+    tpOrderType: 'limit' | 'market';
+    slOrderType: 'limit' | 'market';
+    tpLimitPrice: string;
+    slLimitPrice: string;
+    createdTime: string;
+    updatedTime: string;
+}

package/dist/cjs/types/response/v3/strategy.js

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

package/dist/cjs/types/response/v3/strategy.js.map

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

package/dist/cjs/types/response/v3/trade.d.ts

@@ -0,0 +1,193 @@
+export interface BatchModifyOrderResponseV3 {
+    orderId: string;
+    clientOid: string;
+}
+export interface CancelAllOrdersResponseV3 {
+    list: {
+        orderId: string;
+        clientOid: string;
+        code: string;
+        msg: string;
+    }[];
+}
+export interface CancelBatchOrdersResponseV3 {
+    orderId: string;
+    clientOid: string;
+    code?: string;
+    msg?: string;
+}
+export interface CloseAllPositionsResponseV3 {
+    list: {
+        orderId: string;
+        clientOid: string;
+        code: string;
+        msg: string;
+    }[];
+}
+export interface CancelOrderResponseV3 {
+    orderId: string;
+    clientOid: string;
+}
+export interface GetMaxOpenAvailableResponseV3 {
+    available: string;
+    maxOpen: string;
+    buyOpenCost: string;
+    sellOpenCost: string;
+    maxBuyOpen: string;
+    maxSellOpen: string;
+}
+export interface FeeDetailV3 {
+    feeCoin: string;
+    fee: string;
+}
+export interface OrderInfoV3 {
+    orderId: string;
+    clientOid: string;
+    category: string;
+    symbol: string;
+    orderType: string;
+    side: string;
+    price: string;
+    qty: string;
+    amount: string;
+    cumExecQty: string;
+    cumExecValue: string;
+    avgPrice: string;
+    timeInForce: string;
+    orderStatus: string;
+    posSide: string;
+    holdMode: string;
+    reduceOnly: string;
+    feeDetail: FeeDetailV3[];
+    cancelReason: string;
+    execType: string;
+    stpMode?: string;
+    createdTime: string;
+    updatedTime: string;
+}
+export interface FillV3 {
+    execId: string;
+    orderId: string;
+    category: string;
+    symbol: string;
+    orderType: string;
+    side: string;
+    execPrice: string;
+    execQty: string;
+    execValue: string;
+    tradeScope: string;
+    feeDetail: FeeDetailV3[];
+    execPnl?: string;
+    tradeSide?: string;
+    createdTime: string;
+    updatedTime: string;
+}
+export interface UnfilledOrderV3 {
+    orderId: string;
+    clientOid: string;
+    category: string;
+    symbol: string;
+    orderType: string;
+    side: string;
+    price: string;
+    qty: string;
+    amount: string;
+    cumExecQty: string;
+    cumExecValue: string;
+    avgPrice: string;
+    timeInForce: string;
+    orderStatus: string;
+    posSide: string;
+    holdMode: string;
+    reduceOnly: string;
+    feeDetail: FeeDetailV3[];
+    stpMode?: string;
+    createdTime: string;
+    updatedTime: string;
+}
+export interface HistoryOrderV3 {
+    orderId: string;
+    clientOid: string;
+    category: string;
+    symbol: string;
+    orderType: string;
+    side: string;
+    price: string;
+    qty: string;
+    amount: string;
+    cumExecQty: string;
+    cumExecValue: string;
+    avgPrice: string;
+    timeInForce: string;
+    orderStatus: string;
+    posSide: string;
+    holdMode: string;
+    reduceOnly: string;
+    feeDetail: FeeDetailV3[];
+    cancelReason: string;
+    execType: string;
+    stpMode?: string;
+    createdTime: string;
+    updatedTime: string;
+}
+export interface PositionHistoryV3 {
+    positionId: string;
+    category: string;
+    symbol: string;
+    marginCoin: string;
+    holdMode: string;
+    posSide: string;
+    marginMode: string;
+    openPriceAvg: string;
+    closePriceAvg: string;
+    openTotalPos: string;
+    closeTotalPos: string;
+    cumRealisedPnl: string;
+    netProfit: string;
+    totalFunding: string;
+    openFeeTotal: string;
+    closeFeeTotal: string;
+    createdTime: string;
+    updatedTime: string;
+}
+export interface CurrentPositionV3 {
+    category: string;
+    symbol: string;
+    marginCoin: string;
+    holdMode: string;
+    posSide: string;
+    marginMode: string;
+    positionBalance: string;
+    available: string;
+    frozen: string;
+    total: string;
+    leverage: string;
+    curRealisedPnl: string;
+    avgPrice: string;
+    positionStatus: string;
+    unrealisedPnl: string;
+    liquidationPrice: string;
+    mmr: string;
+    profitRate: string;
+    markPrice: string;
+    breakEvenPrice: string;
+    totalFunding: string;
+    openFeeTotal: string;
+    closeFeeTotal: string;
+    createdTime: string;
+    updatedTime: string;
+}
+export interface ModifyOrderResponseV3 {
+    orderId: string;
+    clientOid: string;
+}
+export interface PlaceBatchOrdersResponseV3 {
+    orderId: string;
+    clientOid: string;
+    code?: string;
+    msg?: string;
+}
+export interface PlaceOrderResponseV3 {
+    orderId: string;
+    clientOid: string;
+}

package/dist/cjs/types/response/v3/trade.js

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

package/dist/cjs/types/response/v3/trade.js.map

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

package/dist/cjs/types/shared.d.ts

@@ -0,0 +1,8 @@
+import { REST_CLIENT_TYPE_ENUM } from '../util/requestUtils.js';
+export type numberInString = string;
+export type OrderSide = 'Buy' | 'Sell';
+/**
+ * @deprecated use SpotKlineInterval or FuturesKlineInterval, depending on which API group you're using
+ */
+export type KlineInterval = '1min' | '5min' | '15min' | '30min' | '1h' | '4h' | '6h' | '12h' | '1M' | '1W' | '1week' | '6Hutc' | '12Hutc' | '1Dutc' | '3Dutc' | '1Wutc' | '1Mutc';
+export type RestClientType = (typeof REST_CLIENT_TYPE_ENUM)[keyof typeof REST_CLIENT_TYPE_ENUM];

package/{lib → dist/cjs}/types/shared.js.map

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

package/dist/cjs/types/websockets/ws-api-request.d.ts

@@ -0,0 +1,20 @@
+export interface WSAPIPlaceOrderRequestV3 {
+    symbol: string;
+    orderType: 'limit' | 'market';
+    qty: string;
+    price?: string;
+    side: 'buy' | 'sell';
+    posSide?: 'long' | 'short';
+    timeInForce?: 'gtc' | 'ioc' | 'fok' | 'post_only';
+    reduceOnly?: 'YES' | 'NO';
+    clientOid?: string;
+    stpMode?: 'none' | 'cancel_taker' | 'cancel_maker' | 'cancel_both';
+    tpTriggerBy?: 'market' | 'mark';
+    slTriggerBy?: 'market' | 'mark';
+    takeProfit?: string;
+    stopLoss?: string;
+    tpOrderType?: 'limit' | 'market';
+    slOrderType?: 'limit' | 'market';
+    tpLimitPrice?: string;
+    slLimitPrice?: string;
+}

package/dist/cjs/types/websockets/ws-api-request.js

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

package/dist/cjs/types/websockets/ws-api-request.js.map

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

package/dist/cjs/types/websockets/ws-api-response.d.ts

@@ -0,0 +1,6 @@
+export interface WSAPIPlaceOrderResponseV3 {
+    symbol: string;
+    orderId: string;
+    clientOid: string;
+    cTime: string;
+}

package/dist/cjs/types/websockets/ws-api-response.js

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

package/dist/cjs/types/websockets/ws-api-response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-api-response.js","sourceRoot":"","sources":["../../../../src/types/websockets/ws-api-response.ts"],"names":[],"mappings":""}

package/dist/cjs/types/websockets/ws-api.d.ts

@@ -0,0 +1,91 @@
+import { WS_KEY_MAP } from '../../util/websocket-util.js';
+import { CancelOrderRequestV3 } from '../request/v3/trade.js';
+import { CancelOrderResponseV3 } from '../response/v3/trade.js';
+import { WSAPIPlaceOrderRequestV3 } from './ws-api-request.js';
+import { WSAPIPlaceOrderResponseV3 } from './ws-api-response.js';
+import { BitgetInstTypeV3, WsKey } from './ws-general.js';
+export type WSOperation = 'subscribe' | 'unsubscribe' | 'login';
+export type WSAPIOperation = 'place-order' | 'batch-place' | 'cancel-order' | 'batch-cancel';
+export declare const WS_API_Operations: WSAPIOperation[];
+export interface WSOperationLoginParams {
+    apiKey: string;
+    passphrase: string;
+    timestamp: number;
+    sign: string;
+}
+export interface WSAPIRequestBitgetV3<TWSParams> {
+    op: 'trade';
+    id: string;
+    category: BitgetInstTypeV3;
+    topic: WSAPIOperation;
+    args: TWSParams | TWSParams[];
+}
+export interface WSAPIRequestFlags {
+    /** If true, will skip auth requirement for WS API connection */
+    authIsOptional?: boolean | undefined;
+}
+export type Exact<T> = {
+    [K: string]: never;
+} & {
+    [K in keyof T]: T[K];
+};
+/**
+
+/**
+ * V2 request looks like this:
+{
+  "op":"subscribe",
+  "args":[
+      {
+          "instType":"SPOT",
+          "channel":"ticker",
+          "instId":"BTCUSDT"
+      },
+      {
+          "instType":"SPOT",
+          "channel":"candle5m",
+          "instId":"BTCUSDT"
+      }
+  ]
+}
+ */
+export interface WsRequestOperationBitget<TWSRequestArg> {
+    op: WSOperation;
+    args?: (TWSRequestArg | string | number)[];
+}
+export interface WSAPIResponse<TResponseData extends object = object, TOperation extends WSAPIOperation = WSAPIOperation> {
+    wsKey: WsKey;
+    /** Auto-generated */
+    id: string;
+    event: 'trade';
+    category: BitgetInstTypeV3;
+    topic: TOperation;
+    args: TResponseData;
+    code: '0' | string;
+    msg: 'success' | string;
+    ts: string;
+}
+/**
+ * List of operations supported for this WsKey (connection)
+ */
+export interface WsAPIWsKeyTopicMap {
+    [WS_KEY_MAP.v3Private]: WSAPIOperation;
+}
+/**
+ * Request parameters expected per operation
+ */
+export interface WsAPITopicRequestParamMap {
+    'place-order': WSAPIPlaceOrderRequestV3;
+    'batch-place': WSAPIPlaceOrderRequestV3[];
+    'cancel-order': CancelOrderRequestV3;
+    'batch-cancel': CancelOrderRequestV3[];
+}
+/**
+ * Response structure expected for each operation
+ */
+export interface WsAPIOperationResponseMap {
+    'place-order': WSAPIResponse<[WSAPIPlaceOrderResponseV3], 'place-order'>;
+    'batch-place': WSAPIResponse<WSAPIPlaceOrderResponseV3[], 'batch-place'>;
+    'cancel-order': WSAPIResponse<[CancelOrderResponseV3], 'cancel-order'>;
+    'batch-cancel': WSAPIResponse<CancelOrderResponseV3[], 'batch-cancel'>;
+}

package/dist/cjs/types/websockets/ws-api.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WS_API_Operations = void 0;
+const websocket_util_js_1 = require("../../util/websocket-util.js");
+exports.WS_API_Operations = [
+    'place-order',
+    'batch-place',
+    'cancel-order',
+    'batch-cancel',
+];
+//# sourceMappingURL=ws-api.js.map

package/dist/cjs/types/websockets/ws-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-api.js","sourceRoot":"","sources":["../../../../src/types/websockets/ws-api.ts"],"names":[],"mappings":";;;AAAA,oEAA0D;AAgB7C,QAAA,iBAAiB,GAAqB;IACjD,aAAa;IACb,aAAa;IACb,cAAc;IACd,cAAc;CACf,CAAC"}

package/{lib/types/websockets/events.d.ts → dist/cjs/types/websockets/ws-events.d.ts}

@@ -1,3 +1,9 @@
+export interface MessageEventLike {
+    target: WebSocket;
+    type: 'message';
+    data: string;
+}
+export declare function isMessageEvent(msg: unknown): msg is MessageEventLike;
 export interface WsBaseEvent<TAction = 'snapshot' | string, TData = unknown> {
     action: TAction;
     arg: unknown;

package/dist/cjs/types/websockets/ws-events.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isMessageEvent = isMessageEvent;
+function isMessageEvent(msg) {
+    if (typeof msg !== 'object' || !msg) {
+        return false;
+    }
+    const message = msg;
+    return message['type'] === 'message' && typeof message['data'] === 'string';
+}
+//# sourceMappingURL=ws-events.js.map

package/dist/cjs/types/websockets/ws-events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-events.js","sourceRoot":"","sources":["../../../../src/types/websockets/ws-events.ts"],"names":[],"mappings":";;AAMA,wCAOC;AAPD,SAAgB,cAAc,CAAC,GAAY;IACzC,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,GAAG,EAAE,CAAC;QACpC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,OAAO,GAAG,GAAuB,CAAC;IACxC,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,SAAS,IAAI,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,QAAQ,CAAC;AAC9E,CAAC"}

package/dist/cjs/types/websockets/ws-general.d.ts

@@ -0,0 +1,112 @@
+import { RestClientOptions } from '../../util/requestUtils.js';
+import { WS_KEY_MAP } from '../../util/websocket-util.js';
+import { FuturesProductTypeV2 } from '../request/shared.js';
+export type BitgetInstType = 'SP' | 'SPBL' | 'MC' | 'UMCBL' | 'DMCBL';
+export type BitgetInstTypeV2 = 'SPOT' | FuturesProductTypeV2;
+export type BitgetInstTypeV3 = 'UTA' | 'spot' | 'usdt-futures' | 'coin-futures' | 'usdc-futures';
+/**
+ *
+ * V1  list of topics for WebSocket consumers
+ *
+ */
+export type WsPublicSpotTopic = 'ticker' | 'candle1W' | 'candle1D' | 'candle12H' | 'candle4H' | 'candle1H' | 'candle30m' | 'candle15m' | 'candle5m' | 'candle1m' | 'books' | 'books5' | 'trade';
+export type WsPublicFuturesTopic = WsPublicSpotTopic;
+export type WsPrivateSpotTopic = 'account' | 'orders';
+export type WsPrivateFuturesTopic = 'account' | 'positions' | 'orders' | 'ordersAlgo';
+export type WsPublicTopic = WsPublicSpotTopic | WsPublicFuturesTopic;
+export type WsPrivateTopic = WsPrivateSpotTopic | WsPrivateFuturesTopic;
+export type WsTopic = WsPublicTopic | WsPrivateTopic;
+/**
+ *
+ * V2 list of topics for WebSocket consumers
+ *
+ */
+export type WsPublicTopicV2 = 'index-price' | 'ticker' | 'candle1m' | 'candle5m' | 'candle15m' | 'candle30m' | 'candle1H' | 'candle4H' | 'candle6H' | 'candle12H' | 'candle1D' | 'candle3D' | 'candle1W' | 'candle1M' | 'candle6Hutc' | 'candle12Hutc' | 'candle1Dutc' | 'candle3Dutc' | 'candle1Wutc' | 'candle1Mutc' | 'trade' | 'books' | 'books1' | 'books5' | 'books15';
+export type WSPrivateTopicFuturesV2 = 'positions' | 'orders-algo' | 'positions-history';
+export type WSPrivateTopicMarginV2 = 'orders-crossed' | 'account-crossed' | 'account-isolated' | 'orders-isolated';
+export type WsPrivateTopicV2 = 'account' | 'orders' | WSPrivateTopicFuturesV2 | WSPrivateTopicMarginV2;
+export type WsTopicV2 = WsPublicTopicV2 | WsPrivateTopicV2;
+/**
+ *
+ * V3 / UTA list of topics for WebSocket consumers
+ *
+ */
+export type WsPublicTopicV3 = 'ticker' | 'kline' | 'books' | 'publicTrade';
+export type WsPrivateTopicV3 = 'account' | 'position' | 'fill' | 'order';
+export type WsTopicV3 = WsPublicTopicV3 | WsPrivateTopicV3;
+/** This is used to differentiate between each of the available websocket streams */
+export 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 type WsTopicSubscribePublicArgsV2 = {
+    instType: BitgetInstTypeV2;
+    channel: WsPublicTopicV2;
+    /** The symbol, e.g. "BTCUSDT" */
+    instId: string;
+};
+export type WsInstIdChannelsV2 = 'orders' | WSPrivateTopicFuturesV2 | 'orders-crossed' | 'orders-isolated';
+export type WsTopicSubscribePrivateInstIdArgsV2 = {
+    instType: BitgetInstTypeV2;
+    channel: WsInstIdChannelsV2;
+    /** The symbol, e.g. "BTCUSDT" */
+    instId?: string;
+};
+export type WsCoinChannelsV2 = 'account' | 'account-crossed' | 'account-isolated';
+export type WsTopicSubscribePrivateCoinArgsV2 = {
+    instType: BitgetInstTypeV2;
+    channel: WsCoinChannelsV2;
+    coin: 'default' | string;
+};
+export type WsTopicSubscribePrivateArgsV2 = WsTopicSubscribePrivateInstIdArgsV2 | WsTopicSubscribePrivateCoinArgsV2;
+export type WsTopicSubscribeEventArgsV2 = WsTopicSubscribePublicArgsV2 | WsTopicSubscribePrivateArgsV2;
+/** General configuration for the WebsocketClient */
+export interface WSClientConfigurableOptions {
+    /** Your API key */
+    apiKey?: string;
+    /** Your API secret */
+    apiSecret?: string;
+    /** The passphrase you set when creating the API Key (NOT your account password) */
+    apiPass?: string;
+    /**
+     * Set to `true` to connect to Bitget's demo trading WebSockets:
+     *
+     * - V2: https://www.bitget.com/api-doc/common/demotrading/websocket
+     * - V3/UTA: https://www.bitget.com/api-doc/uta/guide#demo-trading
+     */
+    demoTrading?: boolean;
+    /** Define a recv window when preparing a private websocket signature. This is in milliseconds, so 5000 == 5 seconds */
+    recvWindow?: number;
+    disableHeartbeat?: boolean;
+    /** How often to check if the connection is alive */
+    pingInterval?: number;
+    /** How long to wait for a pong (heartbeat reply) before assuming the connection is dead */
+    pongTimeout?: number;
+    /** Delay in milliseconds before respawning the connection */
+    reconnectTimeout?: number;
+    requestOptions?: RestClientOptions;
+    wsOptions?: {
+        protocols?: string[];
+        agent?: any;
+    };
+    wsUrl?: string;
+    /**
+     * Allows you to provide a custom "signMessage" function, e.g. to use node's much faster createHmac method
+     *
+     * Look in the examples folder for a demonstration on using node's createHmac instead.
+     */
+    customSignMessageFn?: (message: string, secret: string) => Promise<string>;
+}
+export interface WebsocketClientOptions extends WSClientConfigurableOptions {
+    pingInterval: number;
+    pongTimeout: number;
+    reconnectTimeout: number;
+    recvWindow: number;
+    authPrivateConnectionsOnConnect: boolean;
+    authPrivateRequests: boolean;
+}

package/dist/cjs/types/websockets/ws-general.js

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

package/dist/cjs/types/websockets/ws-general.js.map

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

package/{lib → dist/cjs}/util/BaseRestClient.d.ts

@@ -1,6 +1,6 @@
 import { AxiosRequestConfig } from 'axios';
-import { RestClientType } from '../types';
-import { RestClientOptions } from './requestUtils';
+import { RestClientType } from '../types/shared.js';
+import { RestClientOptions } from './requestUtils.js';
 export default abstract class BaseRestClient {
     private options;
     private baseUrl;
@@ -29,6 +29,7 @@ export default abstract class BaseRestClient {
      * @private generic handler to parse request exceptions
      */
     parseException(e: any): unknown;
+    private signMessage;
     /**
      * @private sign request and set recv window
      */