bitget-api 0.0.1 → 1.0.0

package/README.md

@@ -1,14 +1,21 @@
-# bitget-api
-[![Tests](https://circleci.com/gh/tiagosiebler/bitget-api.svg?style=shield)](https://circleci.com/gh/tiagosiebler/bitget-api)
-[![npm version](https://img.shields.io/npm/v/bitget-api)][1] [![npm size](https://img.shields.io/bundlephobia/min/bitget-api/latest)][1] [![npm downloads](https://img.shields.io/npm/dt/bitget-api)][1]
+# Node.js & Typescript Bitget API SDK
+
+[![Build & Test](https://github.com/tiagosiebler/bitget-api/actions/workflows/e2etests.yml/badge.svg?branch=master)](https://github.com/tiagosiebler/bitget-api/actions/workflows/e2etests.yml) [![npm version](https://img.shields.io/npm/v/bitget-api)][1] [![npm size](https://img.shields.io/bundlephobia/min/bitget-api/latest)][1] [![npm downloads](https://img.shields.io/npm/dt/bitget-api)][1]
 [![last commit](https://img.shields.io/github/last-commit/tiagosiebler/bitget-api)][1]
-[![CodeFactor](https://www.codefactor.io/repository/github/tiagosiebler/bitget-api/badge)](https://www.codefactor.io/repository/github/tiagosiebler/bitget-api)
+[![CodeFactor](https://www.codefactor.io/repository/github/tiagosiebler/bitget-api/badge)](https://www.codefactor.io/repository/github/tiagosiebler/bitget-api) [![Telegram](https://img.shields.io/badge/chat-on%20telegram-blue.svg)](https://t.me/nodetraders)
+
+
+[![connector logo](https://github.com/tiagosiebler/bitget-api/blob/master/docs/images/logo1.png?raw=true)][1]
 
 [1]: https://www.npmjs.com/package/bitget-api
 
-WARNING: This package is still early beta, following the designs of my other connectors. If you want to stay informed when this may be ready for testing, please get in touch via telegram.
 
-Node.js connector for the bitget APIs and WebSockets, with TypeScript & browser support.
+Node.js connector for the Bitget APIs and WebSockets:
+- Complete integration with all Bitget APIs.
+- TypeScript support (with type declarations for most API requests & responses).
+- Over 100 integration tests making real API calls & WebSocket connections, validating any changes before they reach npm.
+- Robust WebSocket integration with configurable connection heartbeats & automatic reconnect then resubscribe workflows.
+- Browser support (via webpack bundle - see "Browser Usage" below).
 
 ## Installation
 `npm install --save bitget-api`
@@ -17,171 +24,101 @@ Node.js connector for the bitget APIs and WebSockets, with TypeScript & browser
 - Issues? Check the [issues tab](https://github.com/tiagosiebler/bitget-api/issues).
 - Discuss & collaborate with other node devs? Join our [Node.js Algo Traders](https://t.me/nodetraders) engineering community on telegram.
 
+## Related projects
+Check out my related projects:
+- Try my connectors:
+  - [binance](https://www.npmjs.com/package/binance)
+  - [bybit-api](https://www.npmjs.com/package/bybit-api)
+  - [okx-api](https://www.npmjs.com/package/okx-api)
+  - [bitget-api](https://www.npmjs.com/package/bitget-api)
+  - [ftx-api](https://www.npmjs.com/package/ftx-api)
+- Try my misc utilities:
+  - [orderbooks](https://www.npmjs.com/package/orderbooks)
+- Check out my examples:
+  - [awesome-crypto-examples](https://github.com/tiagosiebler/awesome-crypto-examples)
+
 ## Documentation
-Most methods accept JS objects. These can be populated using parameters specified by bitget's API documentation.
+Most methods pass values as-is into HTTP requests. These can be populated using parameters specified by Bitget's API documentation, or check the type definition in each class within this repository (see table below for convenient links to each class).
 - [bitget API Documentation](https://www.bitget.com/docs-v5/en/#rest-api).
 
 ## Structure
-This project uses typescript. Resources are stored in 3 key structures:
-- [src](./src) - the whole connector written in typescript
-- [lib](./lib) - the javascript version of the project (compiled from typescript). This should not be edited directly, as it will be overwritten with each release.
-- [dist](./dist) - the packed bundle of the project for use in browser environments.
+This connector is fully compatible with both TypeScript and pure JavaScript projects, while the connector is written in TypeScript. A pure JavaScript version can be built using `npm run build`, which is also the version published to [npm](https://www.npmjs.com/package/bitget-api).
+
+The version on npm is the output from the `build` command and can be used in projects without TypeScript (although TypeScript is definitely recommended).
+- [src](./src) - the whole connector written in TypeScript
+- [lib](./lib) - the JavaScript version of the project (built from TypeScript). This should not be edited directly, as it will be overwritten with each release.
+- [dist](./dist) - the webpack bundle of the project for use in browser environments (see guidance on webpack below).
 - [examples](./examples) - some implementation examples & demonstrations. Contributions are welcome!
 
 ---
 
-# Usage
-Create API credentials at bitget
-- [bitget my-api](https://www.bitget.com/account/my-api)
+## REST API Clients
+Each REST API group has a dedicated REST client. To avoid confusion, here are the available REST clients and the corresponding API groups:
+|                         Class           |                                                                 Description                    |
+|:------------------------------------:   |:---------------------------------------------------------------------------------------------: |
+| [SpotClient](src/spot-client.ts)        | [Spot APIs](https://bitgetlimited.github.io/apidoc/en/spot/#introduction)                      |
+| [FuturesClient](src/futures-client.ts)  | [Futures APIs](https://bitgetlimited.github.io/apidoc/en/mix/#introduction)                    |
+| [BrokerClient](src/broker-client.ts)    | [Broker APIs](https://bitgetlimited.github.io/apidoc/en/broker/#introduction)                  |
+| [WebsocketClient](src/websocket-client.ts)    | Universal client for all Bitget's Websockets                  |
 
-<!--
-### REST Inverse
-To use the inverse REST APIs, import the `InverseClient`:
+Examples for using each client can be found in:
+- the [examples](./examples) folder.
+- the [awesome-crypto-examples](https://github.com/tiagosiebler/awesome-crypto-examples) repository.
 
-```javascript
-const { InverseClient } = require('bitget-api');
+If you're missing an example, you're welcome to request one. Priority will be given to [github sponsors](https://github.com/sponsors/tiagosiebler).
 
-const restClientOptions = {
-  // override the max size of the request window (in ms)
-  recv_window?: number;
 
-  // how often to sync time drift with bitget servers
-  sync_interval_ms?: number | string;
+### Usage
+First, create API credentials on Bitget's website.
 
-  // Default: false. Disable above sync mechanism if true.
-  disable_time_sync?: boolean;
+All REST clients have can be used in a similar way. However, method names, parameters and responses may vary depending on the API category you're using!
 
-  // Default: false. If true, we'll throw errors if any params are undefined
-  strict_param_validation?: boolean;
+Not sure which function to call or which parameters to use? Click the class name in the table above to look at all the function names (they are in the same order as the official API docs), and check the API docs for a list of endpoints/paramters/responses.
 
-  // Optionally override API protocol + domain
-  // e.g 'https://api.bytick.com'
-  baseUrl?: string;
-
-  // Default: true. whether to try and post-process request exceptions.
-  parse_exceptions?: boolean;
-};
+```javascript
+const {
+  SpotClient,
+  FuturesClient,
+  BrokerClient,
+} = require('bitget-api');
 
 const API_KEY = 'xxx';
-const PRIVATE_KEY = 'yyy';
-const useLivenet = false;
-
-const client = new InverseClient(
-  API_KEY,
-  PRIVATE_KEY,
-
-  // optional, uses testnet by default. Set to 'true' to use livenet.
-  useLivenet,
-
-  // restClientOptions,
+const API_SECRET = 'yyy';
+const API_PASS = 'zzz';
+
+const client = new SpotClient({
+    apiKey: API_KEY,
+    apiSecret: API_SECRET,
+    apiPass: API_PASS,
+},
   // requestLibraryOptions
 );
 
+// For public-only API calls, simply don't provide a key & secret or set them to undefined
+// const client = new SpotClient();
+
+
 client.getApiKeyInfo()
   .then(result => {
-    console.log("apiKey result: ", result);
+    console.log("getApiKeyInfo result: ", result);
   })
   .catch(err => {
-    console.error("apiKey error: ", err);
+    console.error("getApiKeyInfo error: ", err);
   });
 
-client.getOrderBook({ symbol: 'BTCUSD' })
+const symbol = 'BTCUSDT_SPBL';
+client.getCandles(symbol, '1min');
   .then(result => {
-    console.log("getOrderBook inverse result: ", result);
+    console.log("getCandles result: ", result);
   })
   .catch(err => {
-    console.error("getOrderBook inverse error: ", err);
+    console.error("getCandles error: ", err);
   });
 ```
 
+#### WebSockets
 
-See [inverse-client.ts](./src/inverse-client.ts) for further information. -->
-
-## WebSockets
-Inverse, linear & spot WebSockets can be used via a shared `WebsocketClient`. However, make sure to make one instance of WebsocketClient per market type (spot vs inverse vs linear vs linearfutures):
-
-```javascript
-const { WebsocketClient } = require('bitget-api');
-
-const API_KEY = 'xxx';
-const PRIVATE_KEY = 'yyy';
-
-const wsConfig = {
-  key: API_KEY,
-  secret: PRIVATE_KEY,
-
-  /*
-    The following parameters are optional:
-  */
-
-  // defaults to false == testnet. Set to true for livenet.
-  // livenet: true
-
-  // NOTE: to listen to multiple markets (spot vs inverse vs linear vs linearfutures) at once, make one WebsocketClient instance per market
-
-  // defaults to inverse:
-  // market: 'inverse'
-  // market: 'linear'
-  // market: 'spot'
-
-  // how long to wait (in ms) before deciding the connection should be terminated & reconnected
-  // pongTimeout: 1000,
-
-  // how often to check (in ms) that WS connection is still alive
-  // pingInterval: 10000,
-
-  // how long to wait before attempting to reconnect (in ms) after connection is closed
-  // reconnectTimeout: 500,
-
-  // config options sent to RestClient (used for time sync). See RestClient docs.
-  // restOptions: { },
-
-  // config for axios used for HTTP requests. E.g for proxy support
-  // requestOptions: { }
-
-  // override which URL to use for websocket connections
-  // wsUrl: 'wss://stream.bytick.com/realtime'
-};
-
-const ws = new WebsocketClient(wsConfig);
-
-// subscribe to multiple topics at once
-ws.subscribe(['position', 'execution', 'trade']);
-
-// and/or subscribe to individual topics on demand
-ws.subscribe('kline.BTCUSD.1m');
-
-// Listen to events coming from websockets. This is the primary data source
-ws.on('update', data => {
-  console.log('update', data);
-});
-
-// Optional: Listen to websocket connection open event (automatic after subscribing to one or more topics)
-ws.on('open', ({ wsKey, event }) => {
-  console.log('connection open for websocket with ID: ' + wsKey);
-});
-
-// Optional: Listen to responses to websocket queries (e.g. the response after subscribing to a topic)
-ws.on('response', response => {
-  console.log('response', response);
-});
-
-// Optional: Listen to connection close event. Unexpected connection closes are automatically reconnected.
-ws.on('close', () => {
-  console.log('connection closed');
-});
-
-// Optional: Listen to raw error events.
-// Note: responses to invalid topics are currently only sent in the "response" event.
-ws.on('error', err => {
-  console.error('ERR', err);
-});
-```
-
-
-See [websocket-client.ts](./src/websocket-client.ts) for further information.
-
-Note: for linear websockets, pass `linear: true` in the constructor options when instancing the `WebsocketClient`. To connect to both linear and inverse websockets, make two instances of the WebsocketClient.
+For more examples, including how to use websockets with bitget, check the [examples](./examples/) and [test](./test/) folders.
 
 ---
 
@@ -195,7 +132,11 @@ const { WebsocketClient, DefaultLogger } = require('bitget-api');
 DefaultLogger.silly = () => {};
 
 const ws = new WebsocketClient(
-  { key: 'xxx', secret: 'yyy' },
+  {
+      apiKey: 'API_KEY',
+      apiSecret: 'API_SECRET',
+      apiPass: 'API_PASS',
+  },
   DefaultLogger
 );
 ```
@@ -216,7 +157,7 @@ The bundle can be found in `dist/`. Altough usage should be largely consistent,
 Support my efforts to make algo trading accessible to all - register with my referral links:
 - [Bybit](https://www.bybit.com/en-US/register?affiliate_id=9410&language=en-US&group_id=0&group_type=1)
 - [Binance](https://www.binance.com/en/register?ref=20983262)
-- [bitget](https://www.bitget.com/join/18504944)
+- [Bitget](https://www.bitget.com/join/18504944)
 - [FTX](https://ftx.com/referrals#a=ftxapigithub)
 
 Or buy me a coffee using any of these:
@@ -225,3 +166,7 @@ Or buy me a coffee using any of these:
 
 ### Contributions & Pull Requests
 Contributions are encouraged, I will review any incoming pull requests. See the issues tab for todo items.
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=tiagosiebler/bitget-api,tiagosiebler/bybit-api,tiagosiebler/binance,tiagosiebler/orderbooks,tiagosiebler/okx-api,tiagosiebler/awesome-crypto-examples,tiagosiebler/ftx-api&type=Date)](https://star-history.com/#tiagosiebler/bitget-api&tiagosiebler/bybit-api&tiagosiebler/binance&tiagosiebler/orderbooks&tiagosiebler/okx-api&tiagosiebler/awesome-crypto-examples&tiagosiebler/ftx-api&Date)

package/lib/broker-client.d.ts

@@ -0,0 +1,46 @@
+import { APIResponse, BrokerProductType, BrokerSubWithdrawalRequest, BrokerSubAPIKeyModifyRequest, BrokerSubListRequest } from './types';
+import BaseRestClient from './util/BaseRestClient';
+/**
+ * REST API client for broker APIs
+ */
+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>>;
+}

package/lib/broker-client.js

@@ -0,0 +1,113 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BrokerClient = void 0;
+const util_1 = require("./util");
+const BaseRestClient_1 = __importDefault(require("./util/BaseRestClient"));
+/**
+ * REST API client for broker APIs
+ */
+class BrokerClient extends BaseRestClient_1.default {
+    getClientType() {
+        return util_1.REST_CLIENT_TYPE_ENUM.broker;
+    }
+    /**
+     *
+     * Sub Account Interface
+     *
+     */
+    /** Get Broker Info */
+    getBrokerInfo() {
+        return this.getPrivate('/api/broker/v1/account/info');
+    }
+    /** Create Sub Account */
+    createSubAccount(subName, remark) {
+        return this.postPrivate('/api/broker/v1/account/sub-create', {
+            subName,
+            remark,
+        });
+    }
+    /** Get Sub List */
+    getSubAccounts(params) {
+        return this.getPrivate('/api/broker/v1/account/sub-list', params);
+    }
+    /** Modify Sub Account */
+    modifySubAccount(subUid, perm, status) {
+        return this.postPrivate('/api/broker/v1/account/sub-modify', {
+            subUid,
+            perm,
+            status,
+        });
+    }
+    /** Modify Sub Email */
+    modifySubEmail(subUid, subEmail) {
+        return this.postPrivate('/api/broker/v1/account/sub-modify-email', {
+            subUid,
+            subEmail,
+        });
+    }
+    /** Get Sub Email */
+    getSubEmail(subUid) {
+        return this.getPrivate('/api/broker/v1/account/sub-email', { subUid });
+    }
+    /** Get Sub Spot Assets */
+    getSubSpotAssets(subUid) {
+        return this.getPrivate('/api/broker/v1/account/sub-spot-assets', {
+            subUid,
+        });
+    }
+    /** Get Sub Future Assets */
+    getSubFutureAssets(subUid, productType) {
+        return this.getPrivate('/api/broker/v1/account/sub-future-assets', {
+            subUid,
+            productType,
+        });
+    }
+    /** Get Sub Deposit Address (Only Broker) */
+    getSubDepositAddress(subUid, coin, chain) {
+        return this.postPrivate('/api/broker/v1/account/sub-address', {
+            subUid,
+            coin,
+            chain,
+        });
+    }
+    /** Sub Withdrawal (Only Broker) */
+    subWithdrawal(params) {
+        return this.postPrivate('/api/broker/v1/account/sub-withdrawal', params);
+    }
+    /** Sub Deposit Auto Transfer (Only Broker) */
+    setSubDepositAutoTransfer(subUid, coin, toAccountType) {
+        return this.postPrivate('/api/broker/v1/account/sub-auto-transfer', {
+            subUid,
+            coin,
+            toAccountType,
+        });
+    }
+    /**
+     *
+     * Sub API Interface
+     *
+     */
+    /** Create Sub ApiKey (Only Broker) */
+    createSubAPIKey(subUid, passphrase, remark, ip, perm) {
+        return this.postPrivate('/api/broker/v1/manage/sub-api-create', {
+            subUid,
+            passphrase,
+            remark,
+            ip,
+            perm,
+        });
+    }
+    /** Get Sub ApiKey List */
+    getSubAPIKeys(subUid) {
+        return this.getPrivate('/api/broker/v1/manage/sub-api-list', { subUid });
+    }
+    /** Modify Sub ApiKey (Only Broker) */
+    modifySubAPIKey(params) {
+        return this.postPrivate('/api/broker/v1/manage/sub-api-modify', params);
+    }
+}
+exports.BrokerClient = BrokerClient;
+//# sourceMappingURL=broker-client.js.map

package/lib/broker-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"broker-client.js","sourceRoot":"","sources":["../src/broker-client.ts"],"names":[],"mappings":";;;;;;AAOA,iCAA+C;AAC/C,2EAAmD;AAEnD;;GAEG;AACH,MAAa,YAAa,SAAQ,wBAAc;IAC9C,aAAa;QACX,OAAO,4BAAqB,CAAC,MAAM,CAAC;IACtC,CAAC;IAED;;;;OAIG;IAEH,sBAAsB;IACtB,aAAa;QACX,OAAO,IAAI,CAAC,UAAU,CAAC,6BAA6B,CAAC,CAAC;IACxD,CAAC;IAED,yBAAyB;IACzB,gBAAgB,CACd,OAAe,EACf,MAAe;QAEf,OAAO,IAAI,CAAC,WAAW,CAAC,mCAAmC,EAAE;YAC3D,OAAO;YACP,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED,mBAAmB;IACnB,cAAc,CAAC,MAA6B;QAC1C,OAAO,IAAI,CAAC,UAAU,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED,yBAAyB;IACzB,gBAAgB,CACd,MAAc,EACd,IAAY,EACZ,MAAmC;QAEnC,OAAO,IAAI,CAAC,WAAW,CAAC,mCAAmC,EAAE;YAC3D,MAAM;YACN,IAAI;YACJ,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED,uBAAuB;IACvB,cAAc,CAAC,MAAc,EAAE,QAAgB;QAC7C,OAAO,IAAI,CAAC,WAAW,CAAC,yCAAyC,EAAE;YACjE,MAAM;YACN,QAAQ;SACT,CAAC,CAAC;IACL,CAAC;IAED,oBAAoB;IACpB,WAAW,CAAC,MAAc;QACxB,OAAO,IAAI,CAAC,UAAU,CAAC,kCAAkC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACzE,CAAC;IAED,0BAA0B;IAC1B,gBAAgB,CAAC,MAAc;QAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,wCAAwC,EAAE;YAC/D,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED,4BAA4B;IAC5B,kBAAkB,CAChB,MAAc,EACd,WAA8B;QAE9B,OAAO,IAAI,CAAC,UAAU,CAAC,0CAA0C,EAAE;YACjE,MAAM;YACN,WAAW;SACZ,CAAC,CAAC;IACL,CAAC;IAED,4CAA4C;IAC5C,oBAAoB,CAClB,MAAc,EACd,IAAY,EACZ,KAAc;QAEd,OAAO,IAAI,CAAC,WAAW,CAAC,oCAAoC,EAAE;YAC5D,MAAM;YACN,IAAI;YACJ,KAAK;SACN,CAAC,CAAC;IACL,CAAC;IAED,mCAAmC;IACnC,aAAa,CAAC,MAAkC;QAC9C,OAAO,IAAI,CAAC,WAAW,CAAC,uCAAuC,EAAE,MAAM,CAAC,CAAC;IAC3E,CAAC;IAED,8CAA8C;IAC9C,yBAAyB,CACvB,MAAc,EACd,IAAY,EACZ,aAA2D;QAE3D,OAAO,IAAI,CAAC,WAAW,CAAC,0CAA0C,EAAE;YAClE,MAAM;YACN,IAAI;YACJ,aAAa;SACd,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IAEH,sCAAsC;IACtC,eAAe,CACb,MAAc,EACd,UAAkB,EAClB,MAAc,EACd,EAAU,EACV,IAAa;QAEb,OAAO,IAAI,CAAC,WAAW,CAAC,sCAAsC,EAAE;YAC9D,MAAM;YACN,UAAU;YACV,MAAM;YACN,EAAE;YACF,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAED,0BAA0B;IAC1B,aAAa,CAAC,MAAc;QAC1B,OAAO,IAAI,CAAC,UAAU,CAAC,oCAAoC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED,sCAAsC;IACtC,eAAe,CACb,MAAoC;QAEpC,OAAO,IAAI,CAAC,WAAW,CAAC,sCAAsC,EAAE,MAAM,CAAC,CAAC;IAC1E,CAAC;CACF;AA7ID,oCA6IC"}

package/lib/constants/enum.d.ts

@@ -0,0 +1,17 @@
+export declare const API_ERROR_CODE: {
+    readonly SUCCESS: "00000";
+    readonly INCORRECT_PERMISSIONS: "40014";
+    readonly ACCOUNT_NOT_COPY_TRADER: "40017";
+    readonly FUTURES_POSITION_DIRECTION_EMPTY: "40017";
+    readonly ACCOUNT_NOT_BROKER: "40029";
+    readonly FUTURES_ORDER_GET_NOT_FOUND: "40109";
+    readonly SERVICE_RETURNED_ERROR: "40725";
+    readonly INSUFFICIENT_BALANCE: "40754";
+    readonly FUTURES_ORDER_CANCEL_NOT_FOUND: "40768";
+    readonly QTY_LESS_THAN_MINIMUM: "43006";
+    /** Parameter verification exception margin mode == FIXED */
+    readonly PARAMETER_EXCEPTION: "40808";
+    readonly ORDER_NOT_FOUND: "43001";
+    readonly FUTURES_ORDER_TPSL_NOT_FOUND: "43020";
+    readonly PLAN_ORDER_NOT_FOUND: "43025";
+};

package/lib/constants/enum.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.API_ERROR_CODE = void 0;
+exports.API_ERROR_CODE = {
+    SUCCESS: '00000',
+    INCORRECT_PERMISSIONS: '40014',
+    ACCOUNT_NOT_COPY_TRADER: '40017',
+    FUTURES_POSITION_DIRECTION_EMPTY: '40017',
+    ACCOUNT_NOT_BROKER: '40029',
+    FUTURES_ORDER_GET_NOT_FOUND: '40109',
+    SERVICE_RETURNED_ERROR: '40725',
+    INSUFFICIENT_BALANCE: '40754',
+    FUTURES_ORDER_CANCEL_NOT_FOUND: '40768',
+    QTY_LESS_THAN_MINIMUM: '43006',
+    /** Parameter verification exception margin mode == FIXED */
+    PARAMETER_EXCEPTION: '40808',
+    ORDER_NOT_FOUND: '43001',
+    FUTURES_ORDER_TPSL_NOT_FOUND: '43020',
+    PLAN_ORDER_NOT_FOUND: '43025',
+};
+//# sourceMappingURL=enum.js.map

package/lib/constants/enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enum.js","sourceRoot":"","sources":["../../src/constants/enum.ts"],"names":[],"mappings":";;;AAAa,QAAA,cAAc,GAAG;IAC5B,OAAO,EAAE,OAAO;IAChB,qBAAqB,EAAE,OAAO;IAC9B,uBAAuB,EAAE,OAAO;IAChC,gCAAgC,EAAE,OAAO;IACzC,kBAAkB,EAAE,OAAO;IAC3B,2BAA2B,EAAE,OAAO;IACpC,sBAAsB,EAAE,OAAO;IAC/B,oBAAoB,EAAE,OAAO;IAC7B,8BAA8B,EAAE,OAAO;IACvC,qBAAqB,EAAE,OAAO;IAC9B,4DAA4D;IAC5D,mBAAmB,EAAE,OAAO;IAC5B,eAAe,EAAE,OAAO;IACxB,4BAA4B,EAAE,OAAO;IACrC,oBAAoB,EAAE,OAAO;CACrB,CAAC"}

package/lib/futures-client.d.ts

@@ -0,0 +1,146 @@
+import { APIResponse, KlineInterval, FuturesProductType, FuturesAccountBillRequest, FuturesBusinessBillRequest, NewFuturesOrder, NewBatchFuturesOrder, FuturesPagination, NewFuturesPlanOrder, ModifyFuturesPlanOrder, ModifyFuturesPlanOrderTPSL, NewFuturesPlanPositionTPSL, ModifyFuturesPlanStopOrder, CancelFuturesPlanTPSL, HistoricPlanOrderTPSLRequest, NewFuturesPlanStopOrder, FuturesAccount, FuturesSymbolRule, FuturesMarginMode, FuturesPosition } from './types';
+import BaseRestClient from './util/BaseRestClient';
+/**
+ * REST API client
+ */
+export declare class FuturesClient extends BaseRestClient {
+    getClientType(): "futures";
+    /**
+     *
+     * Market
+     *
+     */
+    /** Get Symbols : Get basic configuration information of all trading pairs (including rules) */
+    getSymbols(productType: FuturesProductType): Promise<APIResponse<FuturesSymbolRule[]>>;
+    /** Get Depth */
+    getDepth(symbol: string, limit?: string): Promise<APIResponse<any>>;
+    /** Get Single Symbol Ticker */
+    getTicker(symbol: string): Promise<APIResponse<any>>;
+    /** Get All Tickers */
+    getAllTickers(productType: FuturesProductType): Promise<APIResponse<any>>;
+    /** Get Market Trades */
+    getMarketTrades(symbol: string, limit?: string): Promise<APIResponse<any>>;
+    /** Get Candle Data */
+    getCandles(symbol: string, granularity: KlineInterval, startTime: string, endTime: string): Promise<any>;
+    /** Get symbol index price */
+    getIndexPrice(symbol: string): Promise<APIResponse<any>>;
+    /** Get symbol next funding time */
+    getNextFundingTime(symbol: string): Promise<APIResponse<any>>;
+    /** Get Withdraw List */
+    getHistoricFundingRate(symbol: string, pageSize?: string, pageNo?: string, nextPage?: boolean): Promise<APIResponse<any>>;
+    /** Get symbol current funding time */
+    getCurrentFundingRate(symbol: string): Promise<APIResponse<any>>;
+    /** Get symbol open interest */
+    getOpenInterest(symbol: string): Promise<APIResponse<any>>;
+    /** Get symbol mark price */
+    getMarkPrice(symbol: string): Promise<APIResponse<any>>;
+    /** Get symbol min/max leverage rules */
+    getLeverageMinMax(symbol: string): Promise<APIResponse<any>>;
+    /**
+     *
+     * Account Endpoints
+     *
+     */
+    /** Get Single Account */
+    getAccount(symbol: string, marginCoin: string): Promise<APIResponse<FuturesAccount>>;
+    /** Get Account List */
+    getAccounts(productType: FuturesProductType): Promise<APIResponse<any>>;
+    /**
+     * This interface is only used to calculate the maximum number of positions that can be opened when the user does not hold a position by default.
+     * The result does not represent the actual number of positions opened.
+     */
+    getOpenCount(symbol: string, marginCoin: string, openPrice: number, openAmount: number, leverage?: number): Promise<APIResponse<any>>;
+    /** Change Leverage */
+    setLeverage(symbol: string, marginCoin: string, leverage: string, holdSide?: string): Promise<APIResponse<any>>;
+    /** Change Margin */
+    setMargin(symbol: string, marginCoin: string, amount: string, holdSide?: string): Promise<APIResponse<any>>;
+    /** Change Margin Mode */
+    setMarginMode(symbol: string, marginCoin: string, marginMode: FuturesMarginMode): Promise<APIResponse<any>>;
+    /** Get Symbol Position */
+    getPosition(symbol: string, marginCoin?: string): Promise<APIResponse<FuturesPosition[]>>;
+    /** Get All Position */
+    getPositions(productType: FuturesProductType, marginCoin?: string): Promise<APIResponse<FuturesPosition[]>>;
+    /** Get Account Bill */
+    getAccountBill(params: FuturesAccountBillRequest): Promise<APIResponse<any>>;
+    /** Get Business Account Bill */
+    getBusinessBill(params: FuturesBusinessBillRequest): Promise<APIResponse<any>>;
+    /**
+     *
+     * Trade Endpoints
+     *
+     */
+    /** Place Order */
+    submitOrder(params: NewFuturesOrder): Promise<APIResponse<any>>;
+    /** Batch Order */
+    batchSubmitOrder(symbol: string, marginCoin: string, orders: NewBatchFuturesOrder[]): Promise<APIResponse<any>>;
+    /** Cancel Order */
+    cancelOrder(symbol: string, marginCoin: string, orderId: string): Promise<APIResponse<any>>;
+    /** Batch Cancel Order */
+    batchCancelOrder(symbol: string, marginCoin: string, orderIds: string[]): Promise<APIResponse<any>>;
+    /** Cancel All Order */
+    cancelAllOrders(productType: FuturesProductType, marginCoin: string): Promise<APIResponse<any>>;
+    /** Get Open Order */
+    getOpenSymbolOrders(symbol: string): Promise<APIResponse<any>>;
+    /** Get All Open Order */
+    getOpenOrders(productType: FuturesProductType, marginCoin: string): Promise<APIResponse<any>>;
+    /** Get History Orders */
+    getOrderHistory(symbol: string, startTime: string, endTime: string, pageSize: string, lastEndId?: string, isPre?: boolean): Promise<APIResponse<any>>;
+    /** Get ProductType History Orders */
+    getProductTypeOrderHistory(productType: FuturesProductType, startTime: string, endTime: string, pageSize: string, lastEndId?: string, isPre?: boolean): Promise<APIResponse<any>>;
+    /** Get order details */
+    getOrder(symbol: string, orderId?: string, clientOid?: string): Promise<APIResponse<any>>;
+    /** Get transaction details / history (fills)  */
+    getOrderFills(symbol: string, orderId?: string, pagination?: FuturesPagination): Promise<APIResponse<any>>;
+    /** Get ProductType Order fill detail */
+    getProductTypeOrderFills(productType: FuturesProductType, pagination?: FuturesPagination): Promise<APIResponse<any>>;
+    /** Place Plan order */
+    submitPlanOrder(params: NewFuturesPlanOrder): Promise<APIResponse<any>>;
+    /** Modify Plan Order */
+    modifyPlanOrder(params: ModifyFuturesPlanOrder): Promise<APIResponse<any>>;
+    /** Modify Plan Order TPSL */
+    modifyPlanOrderTPSL(params: ModifyFuturesPlanOrderTPSL): Promise<APIResponse<any>>;
+    /** Place Stop order */
+    submitStopOrder(params: NewFuturesPlanStopOrder): Promise<APIResponse<any>>;
+    /** Place Position TPSL */
+    submitPositionTPSL(params: NewFuturesPlanPositionTPSL): Promise<APIResponse<any>>;
+    /** Modify Stop Order */
+    modifyStopOrder(params: ModifyFuturesPlanStopOrder): Promise<APIResponse<any>>;
+    /** Cancel Plan Order TPSL */
+    cancelPlanOrderTPSL(params: CancelFuturesPlanTPSL): Promise<APIResponse<any>>;
+    /** Get Plan Order (TPSL) List */
+    getPlanOrderTPSLs(symbol: string, isPlan?: string, productType?: FuturesProductType): Promise<APIResponse<any>>;
+    /** Get History Plan Orders (TPSL) */
+    getHistoricPlanOrdersTPSL(params: HistoricPlanOrderTPSLRequest): Promise<APIResponse<any>>;
+    /**
+     *
+     * Trade Endpoints
+     *
+     */
+    /** Get Trader Open order */
+    getCopyTraderOpenOrder(symbol: string, productType: FuturesProductType, pageSize: number, pageNo: number): Promise<APIResponse<any>>;
+    /** Get Followers Open Order */
+    getCopyFollowersOpenOrder(symbol: string, productType: FuturesProductType, pageSize: number, pageNo: number): Promise<APIResponse<any>>;
+    /** Trader Close Position */
+    closeCopyTraderPosition(symbol: string, trackingNo: string): Promise<APIResponse<any>>;
+    /** Trader Modify TPSL */
+    modifyCopyTraderTPSL(symbol: string, trackingNo: string, changes?: {
+        stopProfitPrice?: number;
+        stopLossPrice?: number;
+    }): Promise<APIResponse<any>>;
+    /** Get Traders History Orders */
+    getCopyTraderOrderHistory(startTime: string, endTime: string, pageSize: number, pageNo: number): Promise<APIResponse<any>>;
+    /** Get Trader Profit Summary */
+    getCopyTraderProfitSummary(): Promise<APIResponse<any>>;
+    /** Get Trader History Profit Summary (according to settlement currency) */
+    getCopyTraderHistoricProfitSummary(): Promise<APIResponse<any>>;
+    /** Get Trader History Profit Summary (according to settlement currency and date) */
+    getCopyTraderHistoricProfitSummaryByDate(marginCoin: string, dateMs: string, pageSize: number, pageNo: number): Promise<APIResponse<any>>;
+    /** Get Trader Histroy Profit Detail */
+    getCopyTraderHistoricProfitDetail(marginCoin: string, dateMs: string, pageSize: number, pageNo: number): Promise<APIResponse<any>>;
+    /** Get Trader Profits Details */
+    getCopyTraderProfitDetails(pageSize: number, pageNo: number): Promise<APIResponse<any>>;
+    /** Get CopyTrade Symbols */
+    getCopyTraderSymbols(): Promise<APIResponse<any>>;
+    /** Trader Change CopyTrade symbol */
+    setCopyTraderSymbols(symbol: string, operation: 'add' | 'delete'): Promise<APIResponse<any>>;
+}