bybit-api 2.3.2 → 2.4.0-beta.2

package/README.md

@@ -4,9 +4,16 @@
 [![last commit](https://img.shields.io/github/last-commit/tiagosiebler/bybit-api)][1]
 [![CodeFactor](https://www.codefactor.io/repository/github/tiagosiebler/bybit-api/badge)](https://www.codefactor.io/repository/github/tiagosiebler/bybit-api)
 
+[![connector logo](https://cdn.builder.io/api/v1/image/assets%2Ffddee401a9284ab792b271538c28932d%2F5190c99403ac474699a1959fdee1ab6c?format=webp&width=2000)][1]
+
 [1]: https://www.npmjs.com/package/bybit-api
 
-Node.js connector for the Bybit APIs and WebSockets, with TypeScript & browser support.
+Node.js connector for the Bybit APIs and WebSockets:
+- Complete integration with all bybit APIs.
+- TypeScript support (with type declarations for most API requests & responses).
+- Over 300 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 bybit-api`
@@ -21,43 +28,70 @@ Check out my related projects:
   - [ftx-api](https://www.npmjs.com/package/ftx-api)
   - [bybit-api](https://www.npmjs.com/package/bybit-api)
   - [binance](https://www.npmjs.com/package/binance)
+  - [okx-api](https://www.npmjs.com/package/okx-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 Bybit's API documentation.
-- [Bybit API Inverse Documentation](https://bybit-exchange.github.io/docs/inverse/#t-introduction).
-- [Bybit API Inverse Futures Documentation](https://bybit-exchange.github.io/docs/inverse_futures/#t-introduction).
-- [Bybit API Linear Documentation](https://bybit-exchange.github.io/docs/linear/#t-introduction)
+Most methods accept JS objects. These can be populated using parameters specified by Bybit's API documentation, or check the type definition in each class within this repository (see table below for convenient links to each class).
+- [Bybit API Docs (choose API category from the tabs at the top)](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-introduction).
 
 ## 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.
+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/bybit-api).
+
+This connector is fully compatible with both TypeScript and pure JavaScript projects. 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 web-packed bundle of the project for use in browser environments.
 - [examples](./examples) - some implementation examples & demonstrations. Contributions are welcome!
 
 ---
-
-# Usage
-Create API credentials at Bybit
+## 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                                       	          |
+|:------------------------------------------------------------------:   |:----------------------------------------------------------------------------------------------------------------------------: |
+| [InverseClient](src/inverse-client.ts)                	              | [Inverse Perpetual Futures (v2) APIs](https://bybit-exchange.github.io/docs/futuresV2/inverse/)                               |
+| [LinearClient](src/linear-client.ts)                  	              | [USDT Perpetual Futures (v2) APIs](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-introduction)                    |
+| [InverseFuturesClient](src/inverse-futures-client.ts) 	              | [Inverse Futures (v2) APIs](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-introduction)                  |
+| [USDCPerpetualClient](src/usdc-perpetual-client.ts)                   | [USDC Perpetual APIs](https://bybit-exchange.github.io/docs/usdc/option/?console#t-querydeliverylog)                          |
+| [UnifiedMarginClient](src/unified-margin-client.ts)                   | [Derivatives (v3) unified margin APIs](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-introduction)    |
+| [USDCOptionClient](src/usdc-option-client.ts)                         | [USDC Option APIs](https://bybit-exchange.github.io/docs/usdc/option/#t-introduction)                                         |
+| [SpotClientV3](src/spot-client-v3.ts)                                 | [Spot Market (v3) APIs](https://bybit-exchange.github.io/docs/spot/v3/#t-introduction)                   	                    |
+| [~SpotClient~](src/spot-client.ts) (deprecated, v3 client recommended)| [Spot Market (v1) APIs](https://bybit-exchange.github.io/docs/spot/v1/#t-introduction)                   	                    |
+| [AccountAssetClient](src/account-asset-client.ts)                     | [Account Asset APIs](https://bybit-exchange.github.io/docs/account_asset/#t-introduction)                                     |
+| [CopyTradingClient](src/copy-trading-client.ts)                       | [Copy Trading APIs](https://bybit-exchange.github.io/docs/copy_trading/#t-introduction)           	                          |
+| [WebsocketClient](src/websocket-client.ts)                            | All WebSocket Events (Public & Private for all API categories)                                                                |
+
+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.
+
+If you're missing an example, you're welcome to request one. Priority will be given to [github sponsors](https://github.com/sponsors/tiagosiebler).
+
+### Usage
+Create API credentials on Bybit's website:
 - [Livenet](https://bybit.com/app/user/api-management?affiliate_id=9410&language=en-US&group_id=0&group_type=1)
 - [Testnet](https://testnet.bybit.com/app/user/api-management)
 
-## REST API Clients
-
-There are three REST API modules as there are some differences in each contract type.
-1. `InverseClient` for inverse perpetual
-2. `InverseFuturesClient` for inverse futures
-3. `LinearClient` for linear perpetual
+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!
 
-### REST Inverse
-To use the inverse REST APIs, import the `InverseClient`:
+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.
 
 ```javascript
-const { InverseClient } = require('bybit-api');
+const {
+  InverseClient,
+  LinearClient,
+  InverseFuturesClient,
+  SpotClient,
+  SpotClient3,
+  USDCOptionClient,
+  USDCPerpetualClient,
+  CopyTradingClient,
+  AccountAssetClient,
+} = require('bybit-api');
 
 const restClientOptions = {
   // override the max size of the request window (in ms)
@@ -97,146 +131,36 @@ const client = new InverseClient(
 
 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' })
   .then(result => {
-    console.log("getOrderBook inverse result: ", result);
-  })
-  .catch(err => {
-    console.error("getOrderBook inverse error: ", err);
-  });
-```
-
-
-See [inverse-client.ts](./src/inverse-client.ts) for further information.
-
-### REST Inverse Futures
-To use the inverse futures REST APIs, import the `InverseFuturesClient`:
-
-```javascript
-const { InverseFuturesClient } = require('bybit-api');
-
-const API_KEY = 'xxx';
-const PRIVATE_KEY = 'yyy';
-const useLivenet = false;
-
-const client = new InverseFuturesClient(
-  API_KEY,
-  PRIVATE_KEY,
-
-  // optional, uses testnet by default. Set to 'true' to use livenet.
-  useLivenet,
-
-  // restClientOptions,
-  // requestLibraryOptions
-);
-
-client.getApiKeyInfo()
-  .then(result => {
-    console.log("apiKey result: ", result);
-  })
-  .catch(err => {
-    console.error("apiKey error: ", err);
-  });
-
-client.getOrderBook({ symbol: 'BTCUSDH21' })
-  .then(result => {
-    console.log("getOrderBook inverse futures result: ", result);
-  })
-  .catch(err => {
-    console.error("getOrderBook inverse futures error: ", err);
-  });
-```
-
-See [inverse-futures-client.ts](./src/inverse-futures-client.ts) for further information.
-
-### REST Linear
-To use the Linear (USDT) REST APIs, import the `LinearClient`:
-
-```javascript
-const { LinearClient } = require('bybit-api');
-
-const API_KEY = 'xxx';
-const PRIVATE_KEY = 'yyy';
-const useLivenet = false;
-
-const client = new LinearClient(
-  API_KEY,
-  PRIVATE_KEY,
-
-  // optional, uses testnet by default. Set to 'true' to use livenet.
-  useLivenet,
-
-  // restClientOptions,
-  // requestLibraryOptions
-);
-
-client.getApiKeyInfo()
-  .then(result => {
-    console.log(result);
-  })
-  .catch(err => {
-    console.error(err);
-  });
-
-client.getOrderBook({ symbol: 'BTCUSDT' })
-  .then(result => {
-    console.log("getOrderBook linear result: ", result);
-  })
-  .catch(err => {
-    console.error("getOrderBook linear error: ", err);
-  });
-```
-
-See [linear-client.ts](./src/linear-client.ts) for further information.
-
-### REST Spot
-To use the Spot REST APIs, import the `SpotClient`:
-
-```javascript
-const { SpotClient } = require('bybit-api');
-
-const API_KEY = 'xxx';
-const PRIVATE_KEY = 'yyy';
-const useLivenet = false;
-
-const client = new SpotClient(
-  API_KEY,
-  PRIVATE_KEY,
-
-  // optional, uses testnet by default. Set to 'true' to use livenet.
-  useLivenet,
-
-  // restClientOptions,
-  // requestLibraryOptions
-);
-
-client.getSymbols()
-  .then(result => {
-    console.log(result);
-  })
-  .catch(err => {
-    console.error(err);
-  });
-
-client.getBalances()
-  .then(result => {
-    console.log("getBalances result: ", result);
+    console.log("getOrderBook result: ", result);
   })
   .catch(err => {
-    console.error("getBalances error: ", err);
+    console.error("getOrderBook error: ", err);
   });
 ```
 
-See [spot-client.ts](./src/spot-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):
+All API groups can be used via a shared `WebsocketClient`. However, make sure to make one instance of the WebsocketClient per API group (spot vs inverse vs linear vs linearfutures etc):
+
+The WebsocketClient can be configured to a specific API group using the market parameter. These are the currently available API groups:
+|         API Category         	|        Market       	| Description                                                                                                                                                                                            	|
+|:----------------------------:	|:-------------------:	|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------	|
+| Unified Margin               	| TBC                 	| The [derivatives v3](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websocket) category for unified margin.                                                                     	|
+| Futures v2 - Inverse Perps   	| `market: 'inverse'` 	| The [inverse v2 perps](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocket) category.                                                                                                 	|
+| Futures v2 - USDT Perps      	| `market: 'linear'`  	| The [USDT/linear v2 perps](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocket) category.                                                                                              	|
+| Futures v2 - Inverse Futures 	| `market: 'inverse'` 	| The [inverse futures v2](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-websocket) category uses the same market as inverse perps.                                                 	|
+| Spot v3                      	| `market: 'spotv3'`  	| The [spot v3](https://bybit-exchange.github.io/docs/spot/v3/#t-websocket) category.                                                                                                                    	|
+| Spot v1                      	| `market: 'spot'`    	| The older [spot v1](https://bybit-exchange.github.io/docs/spot/v1/#t-websocket) category. Use the `spotv3` market if possible, as the v1 category does not have automatic re-subscribe if reconnected. 	|
+| Copy Trading                 	| `market: 'linear'`  	| The [copy trading](https://bybit-exchange.github.io/docs/copy_trading/#t-websocket) category. Use the linear market to listen to all copy trading topics.                                                       	|
+| USDC Perps                   	| TBC                 	| The [USDC perps](https://bybit-exchange.github.io/docs/usdc/perpetual/#t-websocket) category.                                                                                                          	|
+| USDC Options                 	| TBC                 	| The [USDC options](https://bybit-exchange.github.io/docs/usdc/option/#t-websocket) category.                                                                                                           	|
 
 ```javascript
 const { WebsocketClient } = require('bybit-api');
@@ -316,11 +240,8 @@ ws.on('error', 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.
-
 ---
 
 ## Customise Logging
@@ -362,7 +283,7 @@ Or buy me a coffee using any of these:
 - ETH (ERC20): `0xd773d8e6a50758e1ada699bb6c4f98bb4abf82da`
 
 #### pixtron
-The original library was started by @pixtron. If this library helps you to trade better on bybit, feel free to donate a coffee to @pixtron:
+An early generation of this library was started by @pixtron. If this library helps you to trade better on bybit, feel free to donate a coffee to @pixtron:
 - BTC `1Fh1158pXXudfM6ZrPJJMR7Y5SgZUz4EdF`
 - ETH `0x21aEdeC53ab7593b77C9558942f0c9E78131e8d7`
 - LTC `LNdHSVtG6UWsriMYLJR3qLdfVNKwJ6GSLF`

package/lib/account-asset-client.d.ts

@@ -0,0 +1,42 @@
+import { AccountAssetInformationRequest, APIResponseWithTime, DepositRecordsRequest, EnableUniversalTransferRequest, InternalTransferRequest, SubAccountTransferRequest, SupportedDepositListRequest, TransferQueryRequest, UniversalTransferRequest, WithdrawalRecordsRequest, WithdrawalRequest } from './types';
+import BaseRestClient from './util/BaseRestClient';
+/**
+ * REST API client for Account Asset APIs
+ */
+export declare class AccountAssetClient extends BaseRestClient {
+    getClientType(): "accountAsset";
+    fetchServerTime(): Promise<number>;
+    /**
+     *
+     * Transfer Data Endpoints
+     *
+     */
+    createInternalTransfer(params: InternalTransferRequest): Promise<APIResponseWithTime<any>>;
+    createSubAccountTransfer(params: SubAccountTransferRequest): Promise<APIResponseWithTime<any>>;
+    getInternalTransfers(params?: TransferQueryRequest): Promise<APIResponseWithTime<any>>;
+    getSubAccountTransfers(params?: TransferQueryRequest): Promise<APIResponseWithTime<any>>;
+    getSubAccounts(): Promise<APIResponseWithTime<any>>;
+    enableUniversalTransfer(params?: EnableUniversalTransferRequest): Promise<APIResponseWithTime<any>>;
+    createUniversalTransfer(params: UniversalTransferRequest): Promise<APIResponseWithTime<any>>;
+    getUniversalTransfers(params?: TransferQueryRequest): Promise<APIResponseWithTime<any>>;
+    /**
+     *
+     * Wallet & Deposit Endpoints
+     *
+     */
+    getSupportedDepositList(params?: SupportedDepositListRequest): Promise<APIResponseWithTime<any>>;
+    getDepositRecords(params?: DepositRecordsRequest): Promise<APIResponseWithTime<any>>;
+    getWithdrawRecords(params?: WithdrawalRecordsRequest): Promise<APIResponseWithTime<any>>;
+    getCoinInformation(coin?: string): Promise<APIResponseWithTime<any>>;
+    getAssetInformation(params?: AccountAssetInformationRequest): Promise<APIResponseWithTime<any>>;
+    submitWithdrawal(params: WithdrawalRequest): Promise<APIResponseWithTime<any>>;
+    cancelWithdrawal(withdrawalId: number): Promise<APIResponseWithTime<any>>;
+    getDepositAddress(coin: string): Promise<APIResponseWithTime<any>>;
+    /**
+     *
+     * API Data Endpoints
+     *
+     */
+    getServerTime(): Promise<APIResponseWithTime>;
+    getApiAnnouncements(): Promise<APIResponseWithTime<any[]>>;
+}

package/lib/account-asset-client.js

@@ -0,0 +1,104 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountAssetClient = void 0;
+const util_1 = require("./util");
+const BaseRestClient_1 = __importDefault(require("./util/BaseRestClient"));
+/**
+ * REST API client for Account Asset APIs
+ */
+class AccountAssetClient extends BaseRestClient_1.default {
+    getClientType() {
+        return util_1.REST_CLIENT_TYPE_ENUM.accountAsset;
+    }
+    fetchServerTime() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this.getServerTime();
+            return Number(res.time_now);
+        });
+    }
+    /**
+     *
+     * Transfer Data Endpoints
+     *
+     */
+    createInternalTransfer(params) {
+        return this.postPrivate('/asset/v1/private/transfer', params);
+    }
+    createSubAccountTransfer(params) {
+        return this.postPrivate('/asset/v1/private/sub-member/transfer', params);
+    }
+    getInternalTransfers(params) {
+        return this.getPrivate('/asset/v1/private/transfer/list', params);
+    }
+    getSubAccountTransfers(params) {
+        return this.getPrivate('/asset/v1/private/sub-member/transfer/list', params);
+    }
+    getSubAccounts() {
+        return this.getPrivate('/asset/v1/private/sub-member/member-ids');
+    }
+    enableUniversalTransfer(params) {
+        return this.postPrivate('/asset/v1/private/transferable-subs/save', params);
+    }
+    createUniversalTransfer(params) {
+        return this.postPrivate('/asset/v1/private/universal/transfer', params);
+    }
+    getUniversalTransfers(params) {
+        return this.getPrivate('/asset/v1/private/universal/transfer/list', params);
+    }
+    /**
+     *
+     * Wallet & Deposit Endpoints
+     *
+     */
+    getSupportedDepositList(params) {
+        return this.get('/asset/v1/public/deposit/allowed-deposit-list', params);
+    }
+    getDepositRecords(params) {
+        return this.getPrivate('/asset/v1/private/deposit/record/query', params);
+    }
+    getWithdrawRecords(params) {
+        return this.getPrivate('/asset/v1/private/withdraw/record/query', params);
+    }
+    getCoinInformation(coin) {
+        return this.getPrivate('/asset/v1/private/coin-info/query', { coin });
+    }
+    getAssetInformation(params) {
+        return this.getPrivate('/asset/v1/private/asset-info/query', params);
+    }
+    submitWithdrawal(params) {
+        return this.postPrivate('/asset/v1/private/withdraw', params);
+    }
+    cancelWithdrawal(withdrawalId) {
+        return this.postPrivate('/asset/v1/private/withdraw/cancel', {
+            id: withdrawalId,
+        });
+    }
+    getDepositAddress(coin) {
+        return this.getPrivate('/asset/v1/private/deposit/address', { coin });
+    }
+    /**
+     *
+     * API Data Endpoints
+     *
+     */
+    getServerTime() {
+        return this.get('/v2/public/time');
+    }
+    getApiAnnouncements() {
+        return this.get('/v2/public/announcement');
+    }
+}
+exports.AccountAssetClient = AccountAssetClient;
+//# sourceMappingURL=account-asset-client.js.map

package/lib/account-asset-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"account-asset-client.js","sourceRoot":"","sources":["../src/account-asset-client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAaA,iCAA+C;AAC/C,2EAAmD;AAEnD;;GAEG;AACH,MAAa,kBAAmB,SAAQ,wBAAc;IACpD,aAAa;QACX,OAAO,4BAAqB,CAAC,YAAY,CAAC;IAC5C,CAAC;IAEK,eAAe;;YACnB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YACvC,OAAO,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC9B,CAAC;KAAA;IAED;;;;OAIG;IAEH,sBAAsB,CACpB,MAA+B;QAE/B,OAAO,IAAI,CAAC,WAAW,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;IAChE,CAAC;IAED,wBAAwB,CACtB,MAAiC;QAEjC,OAAO,IAAI,CAAC,WAAW,CAAC,uCAAuC,EAAE,MAAM,CAAC,CAAC;IAC3E,CAAC;IAED,oBAAoB,CAClB,MAA6B;QAE7B,OAAO,IAAI,CAAC,UAAU,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED,sBAAsB,CACpB,MAA6B;QAE7B,OAAO,IAAI,CAAC,UAAU,CACpB,4CAA4C,EAC5C,MAAM,CACP,CAAC;IACJ,CAAC;IAED,cAAc;QACZ,OAAO,IAAI,CAAC,UAAU,CAAC,yCAAyC,CAAC,CAAC;IACpE,CAAC;IAED,uBAAuB,CACrB,MAAuC;QAEvC,OAAO,IAAI,CAAC,WAAW,CAAC,0CAA0C,EAAE,MAAM,CAAC,CAAC;IAC9E,CAAC;IAED,uBAAuB,CACrB,MAAgC;QAEhC,OAAO,IAAI,CAAC,WAAW,CAAC,sCAAsC,EAAE,MAAM,CAAC,CAAC;IAC1E,CAAC;IAED,qBAAqB,CACnB,MAA6B;QAE7B,OAAO,IAAI,CAAC,UAAU,CAAC,2CAA2C,EAAE,MAAM,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IAEH,uBAAuB,CACrB,MAAoC;QAEpC,OAAO,IAAI,CAAC,GAAG,CAAC,+CAA+C,EAAE,MAAM,CAAC,CAAC;IAC3E,CAAC;IAED,iBAAiB,CACf,MAA8B;QAE9B,OAAO,IAAI,CAAC,UAAU,CAAC,wCAAwC,EAAE,MAAM,CAAC,CAAC;IAC3E,CAAC;IAED,kBAAkB,CAChB,MAAiC;QAEjC,OAAO,IAAI,CAAC,UAAU,CAAC,yCAAyC,EAAE,MAAM,CAAC,CAAC;IAC5E,CAAC;IAED,kBAAkB,CAAC,IAAa;QAC9B,OAAO,IAAI,CAAC,UAAU,CAAC,mCAAmC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IACxE,CAAC;IAED,mBAAmB,CACjB,MAAuC;QAEvC,OAAO,IAAI,CAAC,UAAU,CAAC,oCAAoC,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED,gBAAgB,CACd,MAAyB;QAEzB,OAAO,IAAI,CAAC,WAAW,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;IAChE,CAAC;IAED,gBAAgB,CAAC,YAAoB;QACnC,OAAO,IAAI,CAAC,WAAW,CAAC,mCAAmC,EAAE;YAC3D,EAAE,EAAE,YAAY;SACjB,CAAC,CAAC;IACL,CAAC;IAED,iBAAiB,CAAC,IAAY;QAC5B,OAAO,IAAI,CAAC,UAAU,CAAC,mCAAmC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;OAIG;IAEH,aAAa;QACX,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IAED,mBAAmB;QACjB,OAAO,IAAI,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;CACF;AAhID,gDAgIC"}

package/lib/constants/enum.d.ts

@@ -11,8 +11,20 @@ export declare const positionTpSlModeEnum: {
 export declare const API_ERROR_CODE: {
     readonly BALANCE_INSUFFICIENT_SPOT: -1131;
     readonly ORDER_NOT_FOUND_OR_TOO_LATE_SPOT: -2013;
+    readonly SUCCESS: 0;
     /** This could mean bad request, incorrect value types or even incorrect/missing values */
     readonly PARAMS_MISSING_OR_WRONG: 10001;
+    readonly INVALID_API_KEY_OR_PERMISSIONS: 10003;
+    readonly INCORRECT_API_KEY_PERMISSIONS: 10005;
+    /** Account not unified margin, update required */
+    readonly ACCOUNT_NOT_UNIFIED: 10020;
+    readonly BALANCE_INSUFFICIENT_SPOT_V3: 12131;
+    readonly ORDER_NOT_FOUND_SPOT_V3: 12213;
+    readonly ORDER_NOT_FOUND_LEVERAGED_TOKEN: 12407;
+    readonly EXCEEDED_UPPER_LIMIT_LEVERAGED_TOKEN: 12409;
+    readonly QUERY_ACCOUNT_INFO_ERROR: 12602;
+    readonly CROSS_MARGIN_USER_NOT_FOUND: 12607;
+    readonly CROSS_MARGIN_REPAYMENT_NOT_REQUIRED: 12616;
     readonly ORDER_NOT_FOUND_OR_TOO_LATE: 20001;
     readonly POSITION_STATUS_NOT_NORMAL: 30013;
     readonly CANNOT_SET_TRADING_STOP_FOR_ZERO_POS: 30024;
@@ -37,6 +49,12 @@ export declare const API_ERROR_CODE: {
     readonly INSUFFICIENT_BALANCE_FOR_ORDER_COST_LINEAR: 130080;
     readonly SAME_SLTP_MODE_LINEAR: 130150;
     readonly RISK_ID_NOT_MODIFIED: 134026;
+    readonly ORDER_NOT_EXIST: 3100136;
+    readonly NO_ACTIVE_ORDER: 3100205;
+    /** E.g. USDC Options trading when the account hasn't been opened for USDC Options yet */
+    readonly ACCOUNT_NOT_EXIST: 3200200;
+    readonly INCORRECT_MMP_PARAMETERS: 3500712;
+    readonly INSTITION_MMP_PROFILE_NOT_FOUND: 3500713;
 };
 /**
  * Position idx, used to identify positions in different position modes.

package/lib/constants/enum.js

@@ -14,8 +14,20 @@ exports.positionTpSlModeEnum = {
 exports.API_ERROR_CODE = {
     BALANCE_INSUFFICIENT_SPOT: -1131,
     ORDER_NOT_FOUND_OR_TOO_LATE_SPOT: -2013,
+    SUCCESS: 0,
     /** This could mean bad request, incorrect value types or even incorrect/missing values */
     PARAMS_MISSING_OR_WRONG: 10001,
+    INVALID_API_KEY_OR_PERMISSIONS: 10003,
+    INCORRECT_API_KEY_PERMISSIONS: 10005,
+    /** Account not unified margin, update required */
+    ACCOUNT_NOT_UNIFIED: 10020,
+    BALANCE_INSUFFICIENT_SPOT_V3: 12131,
+    ORDER_NOT_FOUND_SPOT_V3: 12213,
+    ORDER_NOT_FOUND_LEVERAGED_TOKEN: 12407,
+    EXCEEDED_UPPER_LIMIT_LEVERAGED_TOKEN: 12409,
+    QUERY_ACCOUNT_INFO_ERROR: 12602,
+    CROSS_MARGIN_USER_NOT_FOUND: 12607,
+    CROSS_MARGIN_REPAYMENT_NOT_REQUIRED: 12616,
     ORDER_NOT_FOUND_OR_TOO_LATE: 20001,
     POSITION_STATUS_NOT_NORMAL: 30013,
     CANNOT_SET_TRADING_STOP_FOR_ZERO_POS: 30024,
@@ -40,6 +52,12 @@ exports.API_ERROR_CODE = {
     INSUFFICIENT_BALANCE_FOR_ORDER_COST_LINEAR: 130080,
     SAME_SLTP_MODE_LINEAR: 130150,
     RISK_ID_NOT_MODIFIED: 134026,
+    ORDER_NOT_EXIST: 3100136,
+    NO_ACTIVE_ORDER: 3100205,
+    /** E.g. USDC Options trading when the account hasn't been opened for USDC Options yet */
+    ACCOUNT_NOT_EXIST: 3200200,
+    INCORRECT_MMP_PARAMETERS: 3500712,
+    INSTITION_MMP_PROFILE_NOT_FOUND: 3500713,
 };
 /**
  * Position idx, used to identify positions in different position modes.

package/lib/constants/enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"enum.js","sourceRoot":"","sources":["../../src/constants/enum.ts"],"names":[],"mappings":";;;AAAa,QAAA,sBAAsB,GAAG;IACpC,UAAU,EAAE,cAAc;IAC1B,SAAS,EAAE,UAAU;CACb,CAAC;AAEE,QAAA,oBAAoB,GAAG;IAClC,4HAA4H;IAC5H,IAAI,EAAE,MAAM;IACZ,sHAAsH;IACtH,OAAO,EAAE,SAAS;CACV,CAAC;AAEE,QAAA,cAAc,GAAG;IAC5B,yBAAyB,EAAE,CAAC,IAAI;IAChC,gCAAgC,EAAE,CAAC,IAAI;IACvC,0FAA0F;IAC1F,uBAAuB,EAAE,KAAK;IAC9B,2BAA2B,EAAE,KAAK;IAClC,0BAA0B,EAAE,KAAK;IACjC,oCAAoC,EAAE,KAAK;IAC3C,iCAAiC;IACjC,mCAAmC,EAAE,KAAK;IAC1C,oCAAoC,EAAE,KAAK;IAC3C,+CAA+C;IAC/C,oBAAoB,EAAE,KAAK;IAC3B,2DAA2D;IAC3D,wBAAwB,EAAE,KAAK;IAC/B,0BAA0B,EAAE,KAAK;IACjC,qBAAqB,EAAE,KAAK;IAC5B,qBAAqB,EAAE,KAAK;IAC5B,qBAAqB,EAAE,KAAK;IAC5B,cAAc,EAAE,KAAK;IACrB,kCAAkC,EAAE,MAAM;IAC1C,wBAAwB,EAAE,MAAM;IAChC,2CAA2C,EAAE,MAAM;IACnD,4BAA4B,EAAE,MAAM;IACpC,qBAAqB,EAAE,MAAM;IAC7B,4BAA4B,EAAE,MAAM;IACpC,0CAA0C,EAAE,MAAM;IAClD,qBAAqB,EAAE,MAAM;IAC7B,oBAAoB,EAAE,MAAM;CACpB,CAAC;AAEX;;;GAGG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,qEAAc,CAAA;IACd,+DAAW,CAAA;IACX,iEAAY,CAAA;AACd,CAAC,EAJW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAI5B"}
+{"version":3,"file":"enum.js","sourceRoot":"","sources":["../../src/constants/enum.ts"],"names":[],"mappings":";;;AAAa,QAAA,sBAAsB,GAAG;IACpC,UAAU,EAAE,cAAc;IAC1B,SAAS,EAAE,UAAU;CACb,CAAC;AAEE,QAAA,oBAAoB,GAAG;IAClC,4HAA4H;IAC5H,IAAI,EAAE,MAAM;IACZ,sHAAsH;IACtH,OAAO,EAAE,SAAS;CACV,CAAC;AAEE,QAAA,cAAc,GAAG;IAC5B,yBAAyB,EAAE,CAAC,IAAI;IAChC,gCAAgC,EAAE,CAAC,IAAI;IACvC,OAAO,EAAE,CAAC;IACV,0FAA0F;IAC1F,uBAAuB,EAAE,KAAK;IAC9B,8BAA8B,EAAE,KAAK;IACrC,6BAA6B,EAAE,KAAK;IACpC,kDAAkD;IAClD,mBAAmB,EAAE,KAAK;IAC1B,4BAA4B,EAAE,KAAK;IACnC,uBAAuB,EAAE,KAAK;IAC9B,+BAA+B,EAAE,KAAK;IACtC,oCAAoC,EAAE,KAAK;IAC3C,wBAAwB,EAAE,KAAK;IAC/B,2BAA2B,EAAE,KAAK;IAClC,mCAAmC,EAAE,KAAK;IAC1C,2BAA2B,EAAE,KAAK;IAClC,0BAA0B,EAAE,KAAK;IACjC,oCAAoC,EAAE,KAAK;IAC3C,iCAAiC;IACjC,mCAAmC,EAAE,KAAK;IAC1C,oCAAoC,EAAE,KAAK;IAC3C,+CAA+C;IAC/C,oBAAoB,EAAE,KAAK;IAC3B,2DAA2D;IAC3D,wBAAwB,EAAE,KAAK;IAC/B,0BAA0B,EAAE,KAAK;IACjC,qBAAqB,EAAE,KAAK;IAC5B,qBAAqB,EAAE,KAAK;IAC5B,qBAAqB,EAAE,KAAK;IAC5B,cAAc,EAAE,KAAK;IACrB,kCAAkC,EAAE,MAAM;IAC1C,wBAAwB,EAAE,MAAM;IAChC,2CAA2C,EAAE,MAAM;IACnD,4BAA4B,EAAE,MAAM;IACpC,qBAAqB,EAAE,MAAM;IAC7B,4BAA4B,EAAE,MAAM;IACpC,0CAA0C,EAAE,MAAM;IAClD,qBAAqB,EAAE,MAAM;IAC7B,oBAAoB,EAAE,MAAM;IAC5B,eAAe,EAAE,OAAO;IACxB,eAAe,EAAE,OAAO;IACxB,yFAAyF;IACzF,iBAAiB,EAAE,OAAO;IAC1B,wBAAwB,EAAE,OAAO;IACjC,+BAA+B,EAAE,OAAO;CAChC,CAAC;AAEX;;;GAGG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,qEAAc,CAAA;IACd,+DAAW,CAAA;IACX,iEAAY,CAAA;AACd,CAAC,EAJW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAI5B"}

package/lib/copy-trading-client.d.ts

@@ -0,0 +1,54 @@
+import { APIResponseWithTime, CopyTradingCancelOrderRequest, CopyTradingCloseOrderRequest, CopyTradingOrderListRequest, CopyTradingOrderRequest, CopyTradingTradingStopRequest, CopyTradingTransferRequest, APIResponseV3 } from './types';
+import BaseRestClient from './util/BaseRestClient';
+/**
+ * REST API client for USDC Perpetual APIs
+ */
+export declare class CopyTradingClient extends BaseRestClient {
+    getClientType(): "v3";
+    fetchServerTime(): Promise<number>;
+    /**
+     *
+     * Market Data Endpoints
+     *
+     */
+    getSymbols(): Promise<APIResponseV3<any>>;
+    /**
+     *
+     * Account Data Endpoints
+     *
+     */
+    /** -> Order API */
+    /** Create order */
+    submitOrder(params: CopyTradingOrderRequest): Promise<APIResponseV3<any>>;
+    /** Set Trading Stop */
+    setTradingStop(params: CopyTradingTradingStopRequest): Promise<APIResponseV3<any>>;
+    /** Query Order List */
+    getActiveOrders(params?: CopyTradingOrderListRequest): Promise<APIResponseV3<any>>;
+    /** Cancel order */
+    cancelOrder(params: CopyTradingCancelOrderRequest): Promise<APIResponseV3<any>>;
+    /** Close Order.  This endpoint's rate_limit will decrease by 10 per request; ie, one request to this endpoint consumes 10 from the limit allowed per minute. */
+    closeOrder(params: CopyTradingCloseOrderRequest): Promise<APIResponseV3<any>>;
+    /** -> Positions API */
+    /** Position List */
+    getPositions(symbol?: string): Promise<APIResponseV3<any>>;
+    /** Close Position */
+    closePosition(symbol: string, positionIdx: string): Promise<APIResponseV3<any>>;
+    /** Only integers can be set to set the leverage */
+    setLeverage(symbol: string, buyLeverage: string, sellLeverage: string): Promise<APIResponseV3<any>>;
+    /**
+     *
+     * Wallet Data Endpoints
+     *
+     */
+    /** Get Wallet Balance */
+    getBalances(): Promise<APIResponseV3<any>>;
+    /** Transfer */
+    transfer(params: CopyTradingTransferRequest): Promise<APIResponseV3<any>>;
+    /**
+     *
+     * API Data Endpoints
+     *
+     */
+    getServerTime(): Promise<APIResponseWithTime>;
+    getAnnouncements(): Promise<APIResponseWithTime<any[]>>;
+}