okx-api 2.0.6 → 3.0.0-beta.0

package/README.md

@@ -1,6 +1,11 @@
 # Node.js & Typescript OKX (OKEX) API & WebSocket SDK
 
-[![E2E Tests](https://github.com/tiagosiebler/okx-api/actions/workflows/e2etest.yml/badge.svg?branch=master)](https://github.com/tiagosiebler/okx-api/actions/workflows/e2etest.yml) [![npm downloads](https://img.shields.io/npm/dt/okx-api)][1] [![npm version](https://img.shields.io/npm/v/okx-api)][1] [![npm size](https://img.shields.io/bundlephobia/min/okx-api/latest)][1] [![last commit](https://img.shields.io/github/last-commit/tiagosiebler/okx-api)][1] [![CodeFactor](https://www.codefactor.io/repository/github/tiagosiebler/okx-api/badge)](https://www.codefactor.io/repository/github/tiagosiebler/okx-api)
+[![E2E Tests](https://github.com/tiagosiebler/okx-api/actions/workflows/e2etest.yml/badge.svg?branch=master)](https://github.com/tiagosiebler/okx-api/actions/workflows/e2etest.yml)
+[![npm downloads](https://img.shields.io/npm/dt/okx-api)][1]
+[![npm version](https://img.shields.io/npm/v/okx-api)][1]
+[![npm size](https://img.shields.io/bundlephobia/min/okx-api/latest)][1]
+[![last commit](https://img.shields.io/github/last-commit/tiagosiebler/okx-api)][1]
+[![CodeFactor](https://www.codefactor.io/repository/github/tiagosiebler/okx-api/badge)](https://www.codefactor.io/repository/github/tiagosiebler/okx-api)
 
 <p align="center">
   <a href="https://www.npmjs.com/package/okx-api">
@@ -15,15 +20,52 @@
 
 Complete, updated & performant Node.js SDK for the OKX(OKEX) APIs and WebSockets:
 
-- Complete integration with all OKX APIs, including the v5 APIs.
+- Complete integration with OKX REST APIs, WebSockets & WebSocket APIs.
 - TypeScript support (with type declarations for most API requests & responses).
 - Over 100 end-to-end tests making real API calls & WebSocket connections, validating any changes before they reach npm.
+- Supports all available OKX regions:
+  - OKX Global (www.okx.com), by default.
+  - OKX EEA (my.okx.com), by setting `market: 'EEA'`.
+  - OKX US (app.okx.com), by setting `market: 'US'`.
+- Actively maintained with a modern, promise-driven interface.
 - Robust WebSocket integration
   - Configurable connection heartbeats (automatically detect failing connections).
   - Automatic reconnect then resubscribe workflows.
   - Automatic authentication and heartbeat handling.
+- Supports WebSocket API in all supported regions & product groups:
+  - Use the WebsocketClient's event-driven `sendWSAPIRequest()` method, or;
+  - Use the WebsocketAPIClient for a REST-like experience.
+    - Use the WebSocket API like a REST API!
+    - Automatic routing to business vs private WebSocket endpoints.
+    - End to end types.
+    - See [examples/ws-api-client.ts](./examples/ws-api-client.ts) for a demonstration.
 - Browser support (via webpack bundle - see "Browser Usage" below).
 
+## Table of Contents
+
+- [Installation](#installation)
+- [Issues & Discussion](#issues--discussion)
+- [Related Projects](#related-projects)
+- [Documentation](#documentation)
+- [Contributions & Thanks](#contributions--thanks)
+- [Structure](#structure)
+- [Usage](#usage)
+  - [REST Client](#rest-client)
+    - [Requests & Responses](#requests--responses)
+    - [Example](#example)
+  - [WebSockets](#websockets)
+    - [Sending Orders via WebSockets](#sending-orders-via-websockets)
+    - [Receiving Realtime Data](#receiving-realtime-data)
+    - [Public Events](#public-events)
+    - [Private Events](#private-events)
+- [Browser/Frontend Usage](#browserfrontend-usage)
+  - [Import](#import)
+  - [Webpack](#webpack)
+- [Use with LLMs & AI](#use-with-llms--ai)
+- [Contributions & Pull Requests](#contributions--pull-requests)
+- [Used By](#used-by)
+- [Star History](#star-history)
+
 ## Installation
 
 ```bash
@@ -38,7 +80,7 @@ npm install okx-api
 
 <!-- template_related_projects -->
 
-## Related projects
+## Related Projects
 
 Check out my related JavaScript/TypeScript/Node.js projects:
 
@@ -65,7 +107,6 @@ Most methods accept JS objects. These can be populated using parameters specifie
 - [RestClient](src/rest-client.ts)
 - [OKX API Documentation](https://www.okx.com/docs-v5/en/#rest-api)
 - [REST Endpoint Function List](./docs/endpointFunctionList.md)
-- [TSDoc Documentation (generated using typedoc via npm module)](https://tsdocs.dev/docs/okx-api)
 
 ## Contributions & Thanks
 
@@ -88,11 +129,11 @@ This project uses typescript. Resources are stored in 3 key structures:
 
 ---
 
-# Usage
+## Usage
 
 Create API credentials at okx
 
-- [OKX my-api](https://www.okx.com/account/my-api)
+- [OKX/account/API](https://www.okx.com/account/my-api)
 
 ## REST Client
 
@@ -104,15 +145,24 @@ Create API credentials at okx
   - If the response looks successful (HTTP 200 and "code" in the response body === "0"), only the `data` property is directly (without the `code`, `data` & `msg` properties).
   - If the response looks like an error (HTTP error OR the "code" property in the response does not equal "0"), the full response is thrown (including `code` and `msg` properties). See the interface for [APIResponse<T>](./src/types/rest/shared.ts).
 
-### Example 
+### Example
 
 ```ts
 import { RestClient } from 'okx-api';
 
 const client = new RestClient({
-  apiKey: 'apiKeyHere', 
+  apiKey: 'apiKeyHere',
   apiSecret: 'apiSecretHere',
   apiPass: 'apiPassHere',
+  // For Global users (www.okx.com), you don't need to set the market.
+  // It will use global by default.
+  // Not needed: market: 'GLOBAL',
+
+  // For EEA users (my.okx.com), set market to "EEA":
+  // market: 'EEA',
+
+  // For US users (app.okx.com), set market to "US":
+  // market: 'US',
 });
 
 // Submit a buy and sell market order
@@ -146,9 +196,9 @@ const client = new RestClient({
 })();
 ```
 
-## Websocket Client
+## WebSockets
 
-This connector includes a high-performance node.js & typescript websocket client for the OKX public & private websockets.
+This connector includes a high-performance Node.js, TypeScript & JavaScript WebSocket client for the OKX public & private WebSocket, including the OKX WebSocket API for order placement. API credentials are optional unless private streams will be used (such as account order updates).
 
 - If your IDE doesn't have IntelliSense, check the [websocket-client.ts](./src/websocket-client.ts) for a list of methods, params & return types.
 - When subscribing to channels, only the "args" should be passed as an object or array when calling the websocket client subcribe() function: [API docs](https://www.okx.com/docs-v5/en/#websocket-api-subscribe).
@@ -173,13 +223,282 @@ This connector includes a high-performance node.js & typescript websocket client
     - Rename the file to `ws-private.js`
     - And execute with node: `node examples/ws-private.js`
 
-### Public Events
+### Sending orders via WebSockets
+
+OKX supports some order management capabilities via a persisted WebSocket connection. This SDK supports this with two convenient approaches.
+
+The recommended route is to use the dedicated WebsocketAPIClient class, included with this SDK:
+
+- Dedicated functions for every available WebSocket API operation
+- Fully typed requests and responses
+- Asynchronous promisified wrapper around WS API commands.
+
+It looks & feels like a REST API client, but uses WebSockets, via the WebsocketClient's sendWSAPIRequest method (which you can use directly if you prefer).
+
+A simple example is below but for a more thorough example, check the example here: [./examples/ws-api-client.ts](./examples/ws-api-client.ts).
+
+```typescript
+import { WebsocketAPIClient } from 'okx-api';
+// or if you prefer require:
+// const { WebsocketAPIClient } = require("okx-api");
+
+// For private events, all 3 of the following are required (per account):
+const API_KEY = process.env.API_KEY_COM;
+const API_SECRET = process.env.API_SECRET_COM;
+const API_PASSPHRASE = process.env.API_PASSPHRASE_COM;
+
+// If running from CLI in unix, you can pass env vars as such:
+// API_KEY_COM='lkm12n3-2ba3-1mxf-fn13-lkm12n3a' API_SECRET_COM='035B2B9637E1BDFFEE2646BFBDDB8CE4' API_PASSPHRASE_COM='ComplexPa$$!23$5^' ts-node examples/ws-private.ts
+
+const wsClient = new WebsocketAPIClient({
+  // For Global users (www.okx.com), you don't need to set the market.
+  // It will use global by default.
+  // Not needed: market: 'GLOBAL',
+
+  // For EEA users (my.okx.com), set market to "EEA":
+  // market: 'EEA',
+
+  // For US users (app.okx.com), set market to "US":
+  // market: 'US',
+
+  accounts: [
+    {
+      apiKey: API_KEY,
+      apiSecret: API_SECRET,
+      apiPass: API_PASSPHRASE,
+    },
+  ],
+});
+
+async function start() {
+  // Optional: prepare the WebSocket API connection in advance.
+  // This happens automatically but you can do this early before making any API calls, to prevent delays from a cold start.
+  // await wsClient.connectWSAPI();
+
+  /**
+   * OKX's WebSocket API be used like a REST API, through this SDK's WebsocketAPIClient. The WebsocketAPIClient is a utility class wrapped around WebsocketClient's sendWSAPIRequest() capabilities.
+   *
+   * Each request sent via the WebsocketAPIClient will automatically:
+   * - route via the active WS API connection
+   * - return a Promise, which automatically resolves/rejects when a matching response is received
+   */
+
+  /**
+   * Place Order
+   * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-order
+   */
+  try {
+    const res = await wsClient.submitNewOrder({
+      instId: 'BTC-USDT',
+      tdMode: 'cash',
+      side: 'buy',
+      ordType: 'market',
+      sz: '100',
+    });
+    /**
+      const res = {
+        id: '2',
+        op: 'order',
+        code: '1',
+        msg: '',
+        data: [
+          {
+            tag: '159881cb7207BCDE',
+            ts: '1753714603721',
+            ordId: '',
+            clOrdId: '',
+            sCode: '51008',
+            sMsg: 'Order failed. Insufficient USDT balance in account.'
+          }
+        ],
+        inTime: '1753714603720755',
+        outTime: '1753714603721942',
+        wsKey: 'prodPrivate',
+        isWSAPIResponse: false
+      }
+
+      const res =  {
+        id: '2',
+        op: 'order',
+        code: '1',
+        msg: '',
+        data: [
+          {
+            tag: '159881cb7207BCDE',
+            ts: '1753714567149',
+            ordId: '',
+            clOrdId: '',
+            sCode: '51010',
+            sMsg: "You can't complete this request under your current account mode."
+          }
+        ],
+        inTime: '1753714567149196',
+        outTime: '1753714567149913',
+        wsKey: 'prodPrivate',
+        isWSAPIResponse: false
+      }
+     */
+
+    console.log(new Date(), 'WS API "submitNewOrder()" result: ', res);
+  } catch (e) {
+    console.error(new Date(), 'Exception with WS API "submitNewOrder()": ', e);
+  }
+
+  /**
+   * Submit multiple orders in a batch
+   * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-multiple-orders
+   */
+  try {
+    const res = await wsClient.submitMultipleOrders([
+      {
+        instId: 'BTC-USDT',
+        tdMode: 'cash',
+        side: 'buy',
+        ordType: 'market',
+        sz: '100',
+      },
+      {
+        instId: 'BTC-USDT',
+        tdMode: 'cash',
+        side: 'buy',
+        ordType: 'market',
+        sz: '50',
+      },
+    ]);
+    console.log(new Date(), 'WS API "submitMultipleOrders()" result: ', res);
+  } catch (e) {
+    console.error(
+      new Date(),
+      'Exception with WS API "submitMultipleOrders()": ',
+      e,
+    );
+  }
+}
+
+start();
+```
+
+### Receiving realtime data
+
+The below example demonstrates connecting as a consumer, to receive WebSocket events from OKX, using the included WebsocketClient:
+
+```javascript
+import { WebsocketClient } from 'okx-api';
+// or if you prefer require:
+// const { WebsocketClient } = require("okx-api");
+
+// For private events, all 3 of the following are required (per account):
+const API_KEY = process.env.API_KEY_COM;
+const API_SECRET = process.env.API_SECRET_COM;
+const API_PASSPHRASE = process.env.API_PASSPHRASE_COM;
+
+// If running from CLI in unix, you can pass env vars as such:
+// API_KEY_COM='lkm12n3-2ba3-1mxf-fn13-lkm12n3a' API_SECRET_COM='035B2B9637E1BDFFEE2646BFBDDB8CE4' API_PASSPHRASE_COM='ComplexPa$$!23$5^' ts-node examples/ws-private.ts
+
+// Note the single quotes, preventing special characters such as $ from being incorrectly passed
+
+const wsClient = new WebsocketClient({
+  // For Global users (www.okx.com), you don't need to set the market.
+  // It will use global by default.
+  // Not needed: market: 'GLOBAL',
+
+  // For EEA users (my.okx.com), set market to "EEA":
+  // market: 'EEA',
+
+  // For US users (app.okx.com), set market to "US":
+  // market: 'US',
+
+  accounts: [
+    // For private topics, include one or more accounts in an array. Otherwise only public topics will work
+    {
+      apiKey: API_KEY,
+      apiSecret: API_SECRET,
+      apiPass: API_PASSPHRASE,
+    },
+    // {
+    //   apiKey: 'yourApiKeyHere',
+    //   apiSecret: 'yourApiSecretHere',
+    //   apiPass: 'yourApiPassHere',
+    // },
+    // {
+    //   apiKey: 'anotherAccountKey',
+    //   apiSecret: 'anotherAccountSecret',
+    //   apiPass: 'anotherAccountPass',
+    // },
+  ],
+});
+
+// Raw data will arrive on the 'update' event
+wsClient.on('update', (data) => {
+  console.log('ws update (raw data received)', JSON.stringify(data));
+});
+
+wsClient.on('open', (data) => {
+  console.log('connection opened open:', data.wsKey);
+});
+
+// Replies (e.g. authenticating or subscribing to channels) will arrive on the 'response' event
+wsClient.on('response', (data) => {
+  // console.log('ws response: ', JSON.stringify(data, null, 2));
+  console.log('ws response: ', JSON.stringify(data));
+});
+
+wsClient.on('reconnect', ({ wsKey }) => {
+  console.log('ws automatically reconnecting.... ', wsKey);
+});
+wsClient.on('reconnected', (data) => {
+  console.log('ws has reconnected ', data?.wsKey);
+});
+wsClient.on('exception', (data) => {
+  console.error('ws exception: ', data);
+});
+
+/**
+ * Simply call subscribe to request the channels that you're interested in.
+ *
+ * If authentication is required, the WSClient will automatically authenticate with the available credentials.
+ */
+
+// Subscribe one event at a time:
+wsClient.subscribe({
+  channel: 'account',
+});
+
+// OR, combine multiple subscription events into one request using an array instead of an object:
+wsClient.subscribe([
+  {
+    channel: 'account',
+  },
+  {
+    channel: 'positions',
+    instType: 'ANY',
+  },
+]);
+
+// Public topics, for comparison. These do not require authentication / api keys:
+wsClient.subscribe([
+  {
+    channel: 'instruments',
+    instType: 'SPOT',
+  },
+  {
+    channel: 'instruments',
+    instType: 'FUTURES',
+  },
+  {
+    channel: 'tickers',
+    instId: 'LTC-BTC',
+  },
+]);
+```
+
+#### Public Events
 
 See [examples/ws-public.ts](./examples/ws-public.ts) for a full example:
 
 ![typescript-events-public](./docs/images/subscribe-events-public.gif)
 
-### Private Events
+#### Private Events
 
 See [examples/ws-private.ts](./examples/ws-private.ts) for a full example:
 
@@ -225,6 +544,12 @@ Build a bundle using webpack:
 
 The bundle can be found in `dist/`. Altough usage should be largely consistent, smaller differences will exist. Documentation is still TODO.
 
+## Use with LLMs & AI
+
+This SDK includes a bundled `llms.txt` file in the root of the repository. If you're developing with LLMs, use the included `llms.txt` with your LLM - it will significantly improve the LLMs understanding of how to correctly use this SDK.
+
+This file contains AI optimised structure of all the functions in this package, and their parameters for easier use with any learning models or artificial intelligence.
+
 ---
 
 <!-- template_contributions -->
@@ -248,10 +573,16 @@ old ones:
 -->
 <!-- template_contributions_end -->
 
-### Contributions & Pull Requests
+## Contributions & Pull Requests
 
 Contributions are encouraged, I will review any incoming pull requests. See the issues tab for todo items.
 
+## Used By
+
+The following represents some of the known public projects that use this SDK on GitHub:
+
+[![Repository Users Preview Image](https://dependents.info/tiagosiebler/okx-api/image)](https://github.com/tiagosiebler/okx-api/network/dependents)
+
 <!-- template_star_history -->
 
 ## Star History

package/dist/cjs/constants/funding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"funding.js","sourceRoot":"","sources":["../../../src/constants/funding.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,IAAY,eAqIX;AArID,WAAY,eAAe;IACzB,gCAAa,CAAA;IACb,mCAAgB,CAAA;IAChB,6CAA0B,CAAA;IAC1B,iDAA8B,CAAA;IAC9B,mDAAgC,CAAA;IAChC,+BAAY,CAAA;IACZ,yCAAsB,CAAA;IACtB,kDAA+B,CAAA;IAC/B,kDAA+B,CAAA;IAC/B,oDAAiC,CAAA;IACjC,oDAAiC,CAAA;IACjC,yCAAsB,CAAA;IACtB,6CAA0B,CAAA;IAC1B,6CAA0B,CAAA;IAC1B,oCAAiB,CAAA;IACjB,2CAAwB,CAAA;IACxB,gDAA6B,CAAA;IAC7B,wCAAqB,CAAA;IACrB,0CAAuB,CAAA;IACvB,wCAAqB,CAAA;IACrB,iDAA8B,CAAA;IAC9B,+CAA4B,CAAA;IAC5B,oCAAiB,CAAA;IACjB,iCAAc,CAAA;IACd,qCAAkB,CAAA;IAClB,mCAAgB,CAAA;IAChB,yCAAsB,CAAA;IACtB,8CAA2B,CAAA;IAC3B,uCAAoB,CAAA;IACpB,uCAAoB,CAAA;IACpB,0CAAuB,CAAA;IACvB,0CAAuB,CAAA;IACvB,4CAAyB,CAAA;IACzB,iCAAc,CAAA;IACd,mCAAgB,CAAA;IAChB,8CAA2B,CAAA;IAC3B,8CAA2B,CAAA;IAC3B,wCAAqB,CAAA;IACrB,2CAAwB,CAAA;IACxB,oCAAiB,CAAA;IACjB,0CAAuB,CAAA;IACvB,kDAA+B,CAAA;IAC/B,uDAAoC,CAAA;IACpC,2DAAwC,CAAA;IACxC,0DAAuC,CAAA;IACvC,4DAAyC,CAAA;IACzC,6DAA0C,CAAA;IAC1C,6CAA0B,CAAA;IAC1B,8CAA2B,CAAA;IAC3B,qDAAkC,CAAA;IAClC,sDAAmC,CAAA;IACnC,2DAAwC,CAAA;IACxC,0DAAuC,CAAA;IACvC,wEAAqD,CAAA;IACrD,yEAAsD,CAAA;IACtD,oEAAiD,CAAA;IACjD,qEAAkD,CAAA;IAClD,wDAAqC,CAAA;IACrC,0DAAuC,CAAA;IACvC,yCAAsB,CAAA;IACtB,2CAAwB,CAAA;IACxB,0CAAuB,CAAA;IACvB,mDAAgC,CAAA;IAChC,gDAA6B,CAAA;IAC7B,qDAAkC,CAAA;IAClC,sDAAmC,CAAA;IACnC,uDAAoC,CAAA;IACpC,8CAA2B,CAAA;IAC3B,yCAAsB,CAAA;IACtB,2CAAwB,CAAA;IACxB,wDAAqC,CAAA;IACrC,yDAAsC,CAAA;IACtC,iDAA8B,CAAA;IAC9B,2DAAwC,CAAA;IACxC,yDAAsC,CAAA;IACtC,qDAAkC,CAAA;IAClC,uDAAoC,CAAA;IACpC,0DAAuC,CAAA;IACvC,+CAA4B,CAAA;IAC5B,kCAAe,CAAA;IACf,+CAA4B,CAAA;IAC5B,2CAAwB,CAAA;IACxB,2CAAwB,CAAA;IACxB,0CAAuB,CAAA;IACvB,2CAAwB,CAAA;IACxB,yCAAsB,CAAA;IACtB,kEAA+C,CAAA;IAC/C,yCAAsB,CAAA;IACtB,4CAAyB,CAAA;IACzB,+CAA4B,CAAA;IAC5B,+CAA4B,CAAA;IAC5B,0CAAuB,CAAA;IACvB,wCAAqB,CAAA;IACrB,wCAAqB,CAAA;IACrB,6CAA0B,CAAA;IAC1B,2CAAwB,CAAA;IACxB,uCAAoB,CAAA;IACpB,2CAAwB,CAAA;IACxB,oDAAiC,CAAA;IACjC,qDAAkC,CAAA;IAClC,iDAA8B,CAAA;IAC9B,iDAA8B,CAAA;IAC9B,gDAA6B,CAAA;IAC7B,qDAAkC,CAAA;IAClC,gDAA6B,CAAA;IAC7B,mDAAgC,CAAA;IAChC,uCAAoB,CAAA;IACpB,8BAAW,CAAA;IACX,4CAAyB,CAAA;IACzB,+BAAY,CAAA;IACZ,2CAAwB,CAAA;IACxB,8CAA2B,CAAA;IAC3B,oCAAiB,CAAA;IACjB,8CAA2B,CAAA;IAC3B,kDAA+B,CAAA;IAC/B,0CAAuB,CAAA;IACvB,iDAA8B,CAAA;IAC9B,iDAA8B,CAAA;IAC9B,gDAA6B,CAAA;IAC7B,kCAAe,CAAA;IACf,2CAAwB,CAAA;IACxB,kDAA+B,CAAA;IAC/B,4CAAyB,CAAA;IACzB,6CAA0B,CAAA;IAC1B,6CAA0B,CAAA;IAC1B,sDAAmC,CAAA;IACnC,8DAA2C,CAAA;IAC3C,mDAAgC,CAAA;IAChC,wDAAqC,CAAA;IACrC,wDAAqC,CAAA;IACrC,8BAAW,CAAA;IACX,kDAA+B,CAAA;AACjC,CAAC,EArIW,eAAe,+BAAf,eAAe,QAqI1B"}

package/dist/cjs/index.d.ts

@@ -0,0 +1,43 @@
+export * from './constants/funding.js';
+export * from './rest-client.js';
+export * from './types/rest/client.js';
+export * from './types/rest/shared.js';
+export * from './types/rest/request/account.js';
+export * from './types/rest/request/block-trading.js';
+export * from './types/rest/request/convert.js';
+export * from './types/rest/request/copy-trading.js';
+export * from './types/rest/request/funding.js';
+export * from './types/rest/request/grid-trading.js';
+export * from './types/rest/request/public.js';
+export * from './types/rest/request/recurring-buy.js';
+export * from './types/rest/request/shared.js';
+export * from './types/rest/request/signal-bot.js';
+export * from './types/rest/request/simple-earn.js';
+export * from './types/rest/request/spread-trading.js';
+export * from './types/rest/request/subaccount.js';
+export * from './types/rest/request/trade.js';
+export * from './types/rest/response/private-account.js';
+export * from './types/rest/response/private-block-trading.js';
+export * from './types/rest/response/private-copy-trading.js';
+export * from './types/rest/response/private-flexible-loan.js';
+export * from './types/rest/response/private-funding.js';
+export * from './types/rest/response/private-recurring-buy.js';
+export * from './types/rest/response/private-signal-bot.js';
+export * from './types/rest/response/private-spread-trading.js';
+export * from './types/rest/response/private-subaccount.js';
+export * from './types/rest/response/private-trade.js';
+export * from './types/rest/response/public-data.js';
+export * from './types/shared.js';
+export * from './types/websockets/ws-api.js';
+export * from './types/websockets/ws-api-request.js';
+export * from './types/websockets/ws-api-response.js';
+export * from './types/websockets/ws-events.js';
+export * from './types/websockets/ws-general.js';
+export * from './types/websockets/ws-request.js';
+export * from './util/logger.js';
+export * from './util/typeGuards.js';
+export * from './util/websocket-util.js';
+export * from './util/WsStore.js';
+export * from './websocket-api-client.js';
+export * from './websocket-client.js';
+export * from './websocket-client-legacy.js';

package/dist/cjs/index.js

@@ -0,0 +1,64 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./constants/funding.js"), exports);
+__exportStar(require("./rest-client.js"), exports);
+// Top level REST types
+__exportStar(require("./types/rest/client.js"), exports);
+__exportStar(require("./types/rest/shared.js"), exports);
+// REST/request
+__exportStar(require("./types/rest/request/account.js"), exports);
+__exportStar(require("./types/rest/request/block-trading.js"), exports);
+__exportStar(require("./types/rest/request/convert.js"), exports);
+__exportStar(require("./types/rest/request/copy-trading.js"), exports);
+__exportStar(require("./types/rest/request/funding.js"), exports);
+__exportStar(require("./types/rest/request/grid-trading.js"), exports);
+__exportStar(require("./types/rest/request/public.js"), exports);
+__exportStar(require("./types/rest/request/recurring-buy.js"), exports);
+__exportStar(require("./types/rest/request/shared.js"), exports);
+__exportStar(require("./types/rest/request/signal-bot.js"), exports);
+__exportStar(require("./types/rest/request/simple-earn.js"), exports);
+__exportStar(require("./types/rest/request/spread-trading.js"), exports);
+__exportStar(require("./types/rest/request/subaccount.js"), exports);
+__exportStar(require("./types/rest/request/trade.js"), exports);
+// REST/response
+__exportStar(require("./types/rest/response/private-account.js"), exports);
+__exportStar(require("./types/rest/response/private-block-trading.js"), exports);
+__exportStar(require("./types/rest/response/private-copy-trading.js"), exports);
+__exportStar(require("./types/rest/response/private-flexible-loan.js"), exports);
+__exportStar(require("./types/rest/response/private-funding.js"), exports);
+__exportStar(require("./types/rest/response/private-recurring-buy.js"), exports);
+__exportStar(require("./types/rest/response/private-signal-bot.js"), exports);
+__exportStar(require("./types/rest/response/private-spread-trading.js"), exports);
+__exportStar(require("./types/rest/response/private-subaccount.js"), exports);
+__exportStar(require("./types/rest/response/private-trade.js"), exports);
+__exportStar(require("./types/rest/response/public-data.js"), exports);
+//
+__exportStar(require("./types/shared.js"), exports);
+__exportStar(require("./types/websockets/ws-api.js"), exports);
+__exportStar(require("./types/websockets/ws-api-request.js"), exports);
+__exportStar(require("./types/websockets/ws-api-response.js"), exports);
+__exportStar(require("./types/websockets/ws-events.js"), exports);
+__exportStar(require("./types/websockets/ws-general.js"), exports);
+__exportStar(require("./types/websockets/ws-request.js"), exports);
+__exportStar(require("./util/logger.js"), exports);
+__exportStar(require("./util/typeGuards.js"), exports);
+__exportStar(require("./util/websocket-util.js"), exports);
+__exportStar(require("./util/WsStore.js"), exports);
+__exportStar(require("./websocket-api-client.js"), exports);
+__exportStar(require("./websocket-client.js"), exports);
+__exportStar(require("./websocket-client-legacy.js"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAuC;AACvC,mDAAiC;AACjC,uBAAuB;AACvB,yDAAuC;AACvC,yDAAuC;AACvC,eAAe;AACf,kEAAgD;AAChD,wEAAsD;AACtD,kEAAgD;AAChD,uEAAqD;AACrD,kEAAgD;AAChD,uEAAqD;AACrD,iEAA+C;AAC/C,wEAAsD;AACtD,iEAA+C;AAC/C,qEAAmD;AACnD,sEAAoD;AACpD,yEAAuD;AACvD,qEAAmD;AACnD,gEAA8C;AAC9C,gBAAgB;AAChB,2EAAyD;AACzD,iFAA+D;AAC/D,gFAA8D;AAC9D,iFAA+D;AAC/D,2EAAyD;AACzD,iFAA+D;AAC/D,8EAA4D;AAC5D,kFAAgE;AAChE,8EAA4D;AAC5D,yEAAuD;AACvD,uEAAqD;AACrD,EAAE;AACF,oDAAkC;AAClC,+DAA6C;AAC7C,uEAAqD;AACrD,wEAAsD;AACtD,kEAAgD;AAChD,mEAAiD;AACjD,mEAAiD;AACjD,mDAAiC;AACjC,uDAAqC;AACrC,2DAAyC;AACzC,oDAAkC;AAClC,4DAA0C;AAC1C,wDAAsC;AACtC,+DAA6C"}

package/dist/cjs/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "commonjs"
+}

package/{lib → dist/cjs}/rest-client.d.ts

@@ -1,19 +1,32 @@
-import { AxiosRequestConfig } from 'axios';
-import { ASSET_BILL_TYPE } from './constants';
-import { AccountAssetValuation, AccountBalance, AccountBill, AccountChangeMarginResult, AccountConfiguration, AccountFeeRate, AccountHistoryBill, AccountInstrument, AccountIsolatedMode, AccountLevel, AccountLeverage, AccountLeverageResult, AccountMaxLoan, AccountMaxOrderAmount, AccountMaxTradableAmount, AccountModeResult, AccountPosition, AccountPositionModeResult, AccountPositionRisk, AccountRiskState, AdjustLeverageInfo, AdjustMarginBalanceRequest, AlgoLongHistoryRequest, AlgoOrderDetailsRequest, AlgoOrderDetailsResult, AlgoOrderListItem, AlgoOrderRequest, AlgoOrderResult, AlgoRecentHistoryRequest, AmendAlgoOrderRequest, AmendAlgoOrderResult, AmendedOrder, AmendOrderRequest, AmendRecurringBuyOrderRequest, AmendTPSLRequest, Announcement, APICredentials, APIMarket, APIResponse, AssetBillDetails, AutoLoanResult, BlockCounterParty, BlockMakerInstrumentSettings, BlockMMPConfig, BlockRFQResult, BorrowRepayHistoryItem, CancelAlgoOrderRequest, CancelAllAfterResponse, CancelBlockQuoteRequest, CancelBlockQuoteResult, CancelBlockRFQRequest, CancelBlockRFQResult, CancelledOrderResult, CancelMultipleBlockQuoteRequest, CancelMultipleBlockRFQRequest, CancelSignalBotsResult, CancelSpreadOrderResponse, CancelSubOrderRequest, Candle, CandleNoVolume, CandleRequest, ChangePositionMarginRequest, CloseContractGridPositionRequest, ClosedPositions, ClosePositionRequest, CloseSubpositionRequest, ContractGridDirection, ConvertQuoteEstimateRequest, ConvertTradeRequest, CopySettingsRequest, CreateBlockQuoteRequest, CreateBlockQuoteResult, CreateBlockRFQRequest, CreateRFQResult, CreateSignalBotRequest, CreateSignalBotResult, CreateSignalRequest, CreateSignalResult, CurrentSubposition, EconomicCalendarData, EconomicCalendarRequest, ExecuteBlockQuoteRequest, ExecuteBlockQuoteResult, FillsHistoryRequest, FixedLoanBorrowingLimit, FixedLoanBorrowQuote, FundingBalance, FundingCurrency, FundingRateRequest, FundsTransferRequest, FundTransferResult, FundTransferState, GetAccountConfigurationResult, GetActiveSpreadOrdersRequest, GetBlockQuoteParams, GetBlockQuoteResult, GetBlockRFQSParams, GetBorrowRepayHistoryRequest, GetContractOpenInterestHistoryRequest, GetContractTakerVolumeRequest, GetCopySettingsResult, GetCopyTradersRequest, GetCopyTradersResult, GetCopyTradingConfigResult, GetCTBatchLeverageInfoRequest, GetCTBatchLeverageInfoResult, GetCTHistoryLeadTradersRequest, GetCTHistoryLeadTradersResult, GetCTMyLeadTradersResult, GetCTProfitDetailsRequest, GetCTProfitDetailsResult, GetCTTotalProfitResult, GetCTUnrealizedProfitResult, GetCurrentSubpositionsRequest, GetDepositWithdrawStatusRequest, GetFixedLoanBorrowingOrdersListRequest, GetFixedLoanBorrowQuoteRequest, GetGridAlgoOrdersRequest, GetHistoricPositionParams, GetInstrumentsRequest, GetLeadTraderPositionsRequest, GetLeadTraderRanksRequest, GetLeadTraderRanksResult, GetLeadTraderStatsRequest, GetLendingOrderListRequest, GetLendingSubOrderListRequest, GetManagedSubAccountTransferHistoryRequest, GetOptionTradesRequest, GetPositionsParams, GetPremiumHistoryRequest, GetPrivateLeadTraderRanksRequest, GetPrivateLeadTraderRanksResult, GetQuickMarginBorrowRepayHistoryRequest, GetRecurringBuyOrderListRequest, GetRSIBackTestingRequest, GetSignalBotEventHistoryRequest, GetSignalBotPositionHistoryRequest, GetSignalBotRequest, GetSignalBotSubOrdersRequest, GetSignalsRequest, GetSignalsResult, GetSpreadCandlesRequest, GetSpreadOrderHistoryArchiveRequest, GetSpreadOrderHistoryRequest, GetSpreadsRequest, GetSpreadTradesRequest, GetSubAccountMaxWithdrawalsRequest, GetSubpositionsHistoryRequest, GetTopTradersContractLongShortRatioRequest, GetVIPInterestRequest, GetVIPLoanOrderDetailRequest, GetVIPLoanOrderListRequest, Greeks, GridAlgoOrderRequest, GridAlgoOrderType, GridAlgoSubOrderType, HistoricAccountPosition, HistoricAlgoOrder, HistoricOrder, IndexTicker, Instrument, InstrumentType, InterestAccrued, InterestRate, LeadTraderCurrentPosition, LeadTraderPnl, LeadTraderPositionHistory, LeadTraderPreference, LeadTraderStats, LendingOrder, ManagedSubAccountTransfer, MarginMode, MaxGridQuantityRequest, MaxWithdrawal, MMPConfig, NonTradableAsset, numberInString, OptionTrade, OptionTrades, OrderBook, OrderDetails, OrderFill, OrderHistoryRequest, OrderIdRequest, OrderListItem, OrderPrecheckRequest, OrderRequest, OrderResult, PaginatedSymbolRequest, Pagination, PlaceCTAlgoOrderRequest, PlaceCTAlgoOrderResult, PlaceRecurringBuyOrderRequest, PlaceSpreadOrderRequest, PlaceSpreadOrderResponse, PlaceSubOrderRequest, PositionBuilderRequest, PositionSide, PosMode, PublicBlockTrade, PublicSpreadTrade, QuickMarginBorrowRepayRecord, QuickMarginBorrowRepayRequest, QuickMarginBorrowRepayResult, RecurringBuyOrder, RecurringBuyOrderResult, RecurringBuySubOrder, RestClientOptions, SetCTBatchLeverageRequest, SetCTBatchLeverageResult, SetLeverageRequest, SetMMPConfigRequest, SetMmpConfigRequest, SetMMPConfigResult, SetMmpConfigResult, SetQuoteProductsRequest, SetSignalInstrumentsRequest, SetSubAccountLoanAllocationRequest, SpreadCandle, SpreadDetails, SpreadOrder, SpreadOrderBook, SpreadTicker, SpreadTrade, StopGridAlgoOrderRequest, SubAccount, SubAccountAPIReset, SubAccountBalances, SubAccountMaxWithdrawal, SubAccountTransferRequest, SubAccountTransferResult, SubmitFixedLoanBorrowingOrderRequest, SubpositionsHistory, SystemTime, Ticker, TimestampObject, Trade, UnitConvertData, UnitConvertRequest, UpdateFixedLoanBorrowingOrderRequest, UpdateSpreadOrderRequest, UpdateSpreadOrderResponse, VIPInterest, VIPLoanOrder, VIPLoanOrderDetail, WithdrawalHistoryRequest, WithdrawRequest, WithdrawResponse } from './types';
-import { AccruedInterestItem, AccruedInterestRequest, AdjustCollateralRequest, CollateralAssetsResponse, LoanHistoryItem, LoanHistoryRequest, LoanInfo, MaxLoanRequest, MaxLoanResponse } from './types/rest/response/private-flexible-loan';
-import BaseRestClient from './util/BaseRestClient';
+import { ASSET_BILL_TYPE } from './constants/funding.js';
+import { ChangePositionMarginRequest, GetBorrowRepayHistoryRequest, GetFixedLoanBorrowingOrdersListRequest, GetFixedLoanBorrowQuoteRequest, GetHistoricPositionParams, GetInstrumentsRequest, GetPositionsParams, GetQuickMarginBorrowRepayHistoryRequest, GetVIPInterestRequest, GetVIPLoanOrderDetailRequest, GetVIPLoanOrderListRequest, PositionBuilderRequest, QuickMarginBorrowRepayRequest, SetLeverageRequest, SetMMPConfigRequest, SubmitFixedLoanBorrowingOrderRequest, UpdateFixedLoanBorrowingOrderRequest, WithdrawalHistoryRequest } from './types/rest/request/account.js';
+import { CancelBlockQuoteRequest, CancelBlockRFQRequest, CancelMultipleBlockQuoteRequest, CancelMultipleBlockRFQRequest, CreateBlockQuoteRequest, CreateBlockRFQRequest, ExecuteBlockQuoteRequest, GetBlockQuoteParams, GetBlockRFQSParams, SetMmpConfigRequest, SetQuoteProductsRequest } from './types/rest/request/block-trading.js';
+import { ConvertQuoteEstimateRequest, ConvertTradeRequest } from './types/rest/request/convert.js';
+import { CloseSubpositionRequest, CopySettingsRequest, GetCopyTradersRequest, GetCTBatchLeverageInfoRequest, GetCTHistoryLeadTradersRequest, GetCTProfitDetailsRequest, GetCurrentSubpositionsRequest, GetLeadTraderPositionsRequest, GetLeadTraderRanksRequest, GetLeadTraderStatsRequest, GetPrivateLeadTraderRanksRequest, GetSubpositionsHistoryRequest, PlaceCTAlgoOrderRequest, SetCTBatchLeverageRequest } from './types/rest/request/copy-trading.js';
+import { FundingRateRequest, FundsTransferRequest, GetDepositWithdrawStatusRequest, WithdrawRequest } from './types/rest/request/funding.js';
+import { CloseContractGridPositionRequest, GetGridAlgoOrdersRequest, GetRSIBackTestingRequest, GridAlgoOrderRequest, GridAlgoOrderType, MaxGridQuantityRequest, StopGridAlgoOrderRequest } from './types/rest/request/grid-trading.js';
+import { CandleRequest, EconomicCalendarRequest, GetContractOpenInterestHistoryRequest, GetContractTakerVolumeRequest, GetOptionTradesRequest, GetPremiumHistoryRequest, GetTopTradersContractLongShortRatioRequest, UnitConvertRequest } from './types/rest/request/public.js';
+import { AmendRecurringBuyOrderRequest, GetRecurringBuyOrderListRequest, PlaceRecurringBuyOrderRequest } from './types/rest/request/recurring-buy.js';
+import { PaginatedSymbolRequest } from './types/rest/request/shared.js';
+import { AdjustMarginBalanceRequest, AmendTPSLRequest, CancelSubOrderRequest, CreateSignalBotRequest, CreateSignalRequest, GetSignalBotEventHistoryRequest, GetSignalBotPositionHistoryRequest, GetSignalBotRequest, GetSignalBotSubOrdersRequest, GetSignalsRequest, PlaceSubOrderRequest, SetSignalInstrumentsRequest } from './types/rest/request/signal-bot.js';
+import { GetLendingOrderListRequest, GetLendingSubOrderListRequest, LendingOrder } from './types/rest/request/simple-earn.js';
+import { GetActiveSpreadOrdersRequest, GetSpreadCandlesRequest, GetSpreadOrderHistoryArchiveRequest, GetSpreadOrderHistoryRequest, GetSpreadsRequest, GetSpreadTradesRequest, PlaceSpreadOrderRequest, UpdateSpreadOrderRequest } from './types/rest/request/spread-trading.js';
+import { GetManagedSubAccountTransferHistoryRequest, GetSubAccountMaxWithdrawalsRequest, SetSubAccountLoanAllocationRequest, SubAccountTransferRequest } from './types/rest/request/subaccount.js';
+import { AlgoLongHistoryRequest, AlgoOrderDetailsRequest, AlgoOrderRequest, AlgoRecentHistoryRequest, AmendAlgoOrderRequest, AmendOrderRequest, CancelAlgoOrderRequest, ClosePositionRequest, FillsHistoryRequest, OrderHistoryRequest, OrderIdRequest, OrderPrecheckRequest, OrderRequest } from './types/rest/request/trade.js';
+import { AccountBalance, AccountBill, AccountChangeMarginResult, AccountConfiguration, AccountFeeRate, AccountHistoryBill, AccountInstrument, AccountIsolatedMode, AccountLeverage, AccountLeverageResult, AccountMaxLoan, AccountMaxOrderAmount, AccountMaxTradableAmount, AccountModeResult, AccountPosition, AccountPositionModeResult, AccountPositionRisk, AccountRiskState, AdjustLeverageInfo, AutoLoanResult, BorrowRepayHistoryItem, FixedLoanBorrowingLimit, FixedLoanBorrowQuote, Greeks, HistoricAccountPosition, InterestAccrued, InterestRate, MaxWithdrawal, MMPConfig, QuickMarginBorrowRepayRecord, QuickMarginBorrowRepayResult, SetMMPConfigResult, VIPInterest, VIPLoanOrder, VIPLoanOrderDetail } from './types/rest/response/private-account.js';
+import { BlockCounterParty, BlockMakerInstrumentSettings, BlockMMPConfig, BlockRFQResult, CancelBlockQuoteResult, CancelBlockRFQResult, CreateBlockQuoteResult, CreateRFQResult, ExecuteBlockQuoteResult, GetBlockQuoteResult, PublicBlockTrade, SetMmpConfigResult } from './types/rest/response/private-block-trading.js';
+import { CurrentSubposition, GetAccountConfigurationResult, GetCopySettingsResult, GetCopyTradersResult, GetCopyTradingConfigResult, GetCTBatchLeverageInfoResult, GetCTHistoryLeadTradersResult, GetCTMyLeadTradersResult, GetCTProfitDetailsResult, GetCTTotalProfitResult, GetCTUnrealizedProfitResult, GetLeadTraderRanksResult, GetPrivateLeadTraderRanksResult, LeadTraderCurrentPosition, LeadTraderPnl, LeadTraderPositionHistory, LeadTraderPreference, LeadTraderStats, PlaceCTAlgoOrderResult, SetCTBatchLeverageResult, SubpositionsHistory } from './types/rest/response/private-copy-trading.js';
+import { AccruedInterestItem, AccruedInterestRequest, AdjustCollateralRequest, CollateralAssetsResponse, LoanHistoryItem, LoanHistoryRequest, LoanInfo, MaxLoanRequest, MaxLoanResponse } from './types/rest/response/private-flexible-loan.js';
+import { AccountAssetValuation, AssetBillDetails, FundingBalance, FundingCurrency, FundTransferResult, FundTransferState, NonTradableAsset, WithdrawResponse } from './types/rest/response/private-funding.js';
+import { RecurringBuyOrder, RecurringBuyOrderResult, RecurringBuySubOrder } from './types/rest/response/private-recurring-buy.js';
+import { CancelSignalBotsResult, CreateSignalBotResult, CreateSignalResult, GetSignalsResult } from './types/rest/response/private-signal-bot.js';
+import { CancelSpreadOrderResponse, PlaceSpreadOrderResponse, PublicSpreadTrade, SpreadCandle, SpreadDetails, SpreadOrder, SpreadOrderBook, SpreadTicker, SpreadTrade, UpdateSpreadOrderResponse } from './types/rest/response/private-spread-trading.js';
+import { ManagedSubAccountTransfer, SubAccount, SubAccountAPIReset, SubAccountBalances, SubAccountMaxWithdrawal, SubAccountTransferResult } from './types/rest/response/private-subaccount.js';
+import { AlgoOrderDetailsResult, AlgoOrderListItem, AlgoOrderResult, AmendAlgoOrderResult, AmendedOrder, CancelAllAfterResponse, CancelledOrderResult, ClosedPositions, HistoricAlgoOrder, HistoricOrder, OrderDetails, OrderFill, OrderListItem, OrderResult } from './types/rest/response/private-trade.js';
+import { Announcement, Candle, CandleNoVolume, EconomicCalendarData, IndexTicker, Instrument, OptionTrade, OptionTrades, OrderBook, SystemTime, Ticker, Trade, UnitConvertData } from './types/rest/response/public-data.js';
+import { AccountLevel, APIResponse, ContractGridDirection, GridAlgoSubOrderType, InstrumentType, MarginMode, numberInString, Pagination, PositionSide, PosMode, TimestampObject } from './types/rest/shared.js';
+import BaseRestClient from './util/BaseRestClient.js';
 export declare class RestClient extends BaseRestClient {
-    /**
-     * @public Creates an instance of the REST API client.
-     *
-     * @param credentials - Note: This parameter will be removed! Pass `null` here and use the restClientOptions parameter (3rd one) instead!
-     * @param environment - Note: This parameter will be removed! Pass `prod` here and use the restClientOptions parameter (3rd one) instead!
-     * @param restClientOptions
-     * @param requestOptions
-     * @returns
-     */
-    constructor(credentials?: APICredentials | null, environment?: APIMarket, restClientOptions?: RestClientOptions, requestOptions?: AxiosRequestConfig);
     /**
      *
      * Custom SDK functions