bitget-api 3.1.4 → 3.1.5

package/llms.txt

@@ -141,7 +141,6 @@ LICENSE.md
 package.json
 postBuild.sh
 README.md
-tea.yaml
 tsconfig.cjs.json
 tsconfig.esm.json
 tsconfig.json
@@ -1462,6 +1461,90 @@ export interface BindUidRequestV3 {
 export interface GetLTVConvertRequestV3 {
   riskUnitId?: string;
 }
+⋮----
+/* Unified Account Staking & Lending (Crypto Loans) - /api/v3/loan/* */
+⋮----
+export interface GetLoanCoinsRequestV3 {
+  coin?: string;
+}
+⋮----
+export interface GetLoanInterestRequestV3 {
+  loanCoin: string;
+  pledgeCoin: string;
+  daily: 'SEVEN' | 'THIRTY' | 'FLEXIBLE';
+  pledgeAmount: string;
+}
+⋮----
+export interface LoanBorrowRequestV3 {
+  loanCoin: string;
+  pledgeCoin: string;
+  daily: 'SEVEN' | 'THIRTY' | 'FLEXIBLE';
+  pledgeAmount?: string;
+  loanAmount?: string;
+}
+⋮----
+export interface GetLoanBorrowOngoingRequestV3 {
+  orderId?: string;
+  loanCoin?: string;
+  pledgeCoin?: string;
+}
+⋮----
+export interface GetLoanBorrowHistoryRequestV3 {
+  orderId?: string;
+  loanCoin?: string;
+  pledgeCoin?: string;
+  status?: 'ROLLBACK' | 'FORCE' | 'REPAY';
+  startTime: string;
+  endTime: string;
+  pageNum?: string;
+  pageSize?: string;
+}
+⋮----
+export interface LoanRepayRequestV3 {
+  orderId: string;
+  method: 'borrowed_coin' | 'collateral';
+  repayAll: 'yes' | 'no';
+  amount?: string;
+  repayUnlock?: 'yes' | 'no';
+}
+⋮----
+export interface GetLoanRepayHistoryRequestV3 {
+  orderId?: string;
+  loanCoin?: string;
+  pledgeCoin?: string;
+  startTime: string;
+  endTime: string;
+  pageNum?: string;
+  pageSize?: string;
+}
+⋮----
+export interface LoanRevisePledgeRequestV3 {
+  orderId: string;
+  amount: string;
+  pledgeCoin: string;
+  reviseType?: 'OUT' | 'IN';
+}
+⋮----
+export interface GetLoanPledgeRateHistoryRequestV3 {
+  orderId?: string;
+  reviseSide?: 'down' | 'up';
+  pledgeCoin?: string;
+  startTime: string;
+  endTime: string;
+  pageNum?: string;
+  pageSize?: string;
+}
+⋮----
+export interface GetLoanReducesRequestV3 {
+  orderId?: string;
+  loanCoin?: string;
+  pledgeCoin?: string;
+  status?: 'COMPLETE' | 'WAIT';
+  startTime: string;
+  endTime: string;
+  pageNum?: string;
+  pageSize?: string;
+}
 
 ================
 File: src/types/request/v3/strategy.ts
@@ -4379,6 +4462,8 @@ protected resolveEmittableEvents(
 // messageType: typeof msg,
 // messageString: JSON.stringify(msg),
 ⋮----
+// Service upgrade (30033): Bitget sends this ~60s before disconnect. Proactively close to trigger reconnect.
+⋮----
 // messageType: typeof msg,
 // messageString: JSON.stringify(msg),
 ⋮----
@@ -4422,6 +4507,11 @@ async sendWSAPIRequest<
 ⋮----
 // Return deferred promise, so caller can await this call
 
+================
+File: .eslintrc.cjs
+================
+// 'no-unused-vars': ['warn'],
+
 ================
 File: .jshintrc
 ================
@@ -4446,6 +4536,194 @@ File: .prettierrc
   "trailingComma": "all"
 }
 
+================
+File: jest.config.ts
+================
+/**
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+⋮----
+import type { Config } from 'jest';
+⋮----
+// All imported modules in your tests should be mocked automatically
+// automock: false,
+⋮----
+// Stop running tests after `n` failures
+// bail: 0,
+bail: false, // enable to stop test when an error occur,
+⋮----
+// The directory where Jest should store its cached dependency information
+// cacheDirectory: "/private/var/folders/kf/2k3sz4px6c9cbyzj1h_b192h0000gn/T/jest_dx",
+⋮----
+// Automatically clear mock calls, instances, contexts and results before every test
+⋮----
+// Indicates whether the coverage information should be collected while executing the test
+⋮----
+// An array of glob patterns indicating a set of files for which coverage information should be collected
+⋮----
+// The directory where Jest should output its coverage files
+⋮----
+// An array of regexp pattern strings used to skip coverage collection
+// coveragePathIgnorePatterns: [
+//   "/node_modules/"
+// ],
+⋮----
+// Indicates which provider should be used to instrument code for coverage
+⋮----
+// A list of reporter names that Jest uses when writing coverage reports
+// coverageReporters: [
+//   "json",
+//   "text",
+//   "lcov",
+//   "clover"
+// ],
+⋮----
+// An object that configures minimum threshold enforcement for coverage results
+// coverageThreshold: undefined,
+⋮----
+// A path to a custom dependency extractor
+// dependencyExtractor: undefined,
+⋮----
+// Make calling deprecated APIs throw helpful error messages
+// errorOnDeprecated: false,
+⋮----
+// The default configuration for fake timers
+// fakeTimers: {
+//   "enableGlobally": false
+// },
+⋮----
+// Force coverage collection from ignored files using an array of glob patterns
+// forceCoverageMatch: [],
+⋮----
+// A path to a module which exports an async function that is triggered once before all test suites
+// globalSetup: undefined,
+⋮----
+// A path to a module which exports an async function that is triggered once after all test suites
+// globalTeardown: undefined,
+⋮----
+// A set of global variables that need to be available in all test environments
+// globals: {},
+⋮----
+// The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+// maxWorkers: "50%",
+⋮----
+// An array of directory names to be searched recursively up from the requiring module's location
+// moduleDirectories: [
+//   "node_modules"
+// ],
+⋮----
+// An array of file extensions your modules use
+⋮----
+// modulePaths: ['src'],
+⋮----
+// A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+// moduleNameMapper: {},
+⋮----
+// An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+// modulePathIgnorePatterns: [],
+⋮----
+// Activates notifications for test results
+// notify: false,
+⋮----
+// An enum that specifies notification mode. Requires { notify: true }
+// notifyMode: "failure-change",
+⋮----
+// A preset that is used as a base for Jest's configuration
+// preset: undefined,
+⋮----
+// Run tests from one or more projects
+// projects: undefined,
+⋮----
+// Use this configuration option to add custom reporters to Jest
+// reporters: undefined,
+⋮----
+// Automatically reset mock state before every test
+// resetMocks: false,
+⋮----
+// Reset the module registry before running each individual test
+// resetModules: false,
+⋮----
+// A path to a custom resolver
+// resolver: undefined,
+⋮----
+// Automatically restore mock state and implementation before every test
+// restoreMocks: false,
+⋮----
+// The root directory that Jest should scan for tests and modules within
+// rootDir: undefined,
+⋮----
+// A list of paths to directories that Jest should use to search for files in
+// roots: [
+//   "<rootDir>"
+// ],
+⋮----
+// Allows you to use a custom runner instead of Jest's default test runner
+// runner: "jest-runner",
+⋮----
+// The paths to modules that run some code to configure or set up the testing environment before each test
+// setupFiles: [],
+⋮----
+// A list of paths to modules that run some code to configure or set up the testing framework before each test
+// setupFilesAfterEnv: [],
+⋮----
+// The number of seconds after which a test is considered as slow and reported as such in the results.
+// slowTestThreshold: 5,
+⋮----
+// A list of paths to snapshot serializer modules Jest should use for snapshot testing
+// snapshotSerializers: [],
+⋮----
+// The test environment that will be used for testing
+// testEnvironment: "jest-environment-node",
+⋮----
+// Options that will be passed to the testEnvironment
+// testEnvironmentOptions: {},
+⋮----
+// Adds a location field to test results
+// testLocationInResults: false,
+⋮----
+// The glob patterns Jest uses to detect test files
+⋮----
+// "**/__tests__/**/*.[jt]s?(x)",
+⋮----
+// An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+// testPathIgnorePatterns: [
+//   "/node_modules/"
+// ],
+⋮----
+// The regexp pattern or array of patterns that Jest uses to detect test files
+// testRegex: [],
+⋮----
+// This option allows the use of a custom results processor
+// testResultsProcessor: undefined,
+⋮----
+// This option allows use of a custom test runner
+// testRunner: "jest-circus/runner",
+⋮----
+// A map from regular expressions to paths to transformers
+// transform: undefined,
+⋮----
+// An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+// transformIgnorePatterns: [
+//   "/node_modules/",
+//   "\\.pnp\\.[^\\/]+$"
+// ],
+⋮----
+// Prevents import esm module error from v1 axios release, issue #5026
+⋮----
+// An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+// unmockedModulePathPatterns: undefined,
+⋮----
+// Indicates whether each individual test should be reported during the run
+// verbose: undefined,
+verbose: true, // report individual test
+⋮----
+// An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+// watchPathIgnorePatterns: [],
+⋮----
+// Whether to use watchman for file crawling
+// watchman: true,
+
 ================
 File: LICENSE.md
 ================
@@ -4593,248 +4871,7 @@ import { RestClientV2 } from '../../../src/index.js';
 // import { RestClientV2 } from 'bitget-api';
 
 ================
-File: examples/V2 - Classic/Rest/rest-trade-futures.ts
-================
-import {
-  FuturesPlaceOrderRequestV2,
-  RestClientV2,
-  WebsocketClientV2,
-} from '../../../src/index.js';
-⋮----
-// or
-// import { FuturesPlaceOrderRequestV2, RestClientV2, WebsocketClientV2 } from '../src';
-⋮----
-// read from environmental variables
-⋮----
-// 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/rest-trade-futures.ts
-⋮----
-// note the single quotes, preventing special characters such as $ from being incorrectly passed
-⋮----
-// apiKey: 'apiKeyHere',
-// apiSecret: 'apiSecretHere',
-// apiPass: 'apiPassHere',
-⋮----
-function logWSEvent(type: string, data: any)
-⋮----
-// simple sleep function
-function promiseSleep(milliseconds: number)
-⋮----
-/**
- * This is a simple script wrapped in a immediately invoked function expression (to execute the below workflow immediately).
- *
- * It is designed to:
- * - open a private websocket channel to log account events
- * - check for any available USDT balance in the futures account
- * - immediately open a minimum sized long position on BTCUSDT
- * - check active positions
- * - immediately send closing orders for any active futures positions
- * - check positions again
- *
- */
-⋮----
-// Add event listeners to log websocket events on account
-⋮----
-// futures private
-// : account updates
-⋮----
-// : position updates
-⋮----
-// : order updates
-⋮----
-// wait briefly for ws to be ready (could also use the response or authenticated events, to make sure topics are subscribed to before starting)
-⋮----
-// const balances = allBalances.filter((bal) => Number(bal.available) != 0);
-⋮----
-// Loop through any active positions and send a closing market order on each position
-
-================
-File: examples/V2 - Classic/Rest/rest-trade-spot.ts
-================
-import {
-  RestClientV2,
-  SpotOrderRequestV2,
-  WebsocketClientV2,
-} from '../../../src/index.js';
-⋮----
-// import { RestClientV2, WebsocketClient } from '../src/index';
-⋮----
-// read from environmental variables
-⋮----
-// 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/rest-trade-spot.ts
-⋮----
-// note the single quotes, preventing special characters such as $ from being incorrectly passed
-⋮----
-// apiKey: 'apiKeyHere',
-// apiSecret: 'apiSecretHere',
-// apiPass: 'apiPassHere',
-⋮----
-function logWSEvent(type: string, data: any)
-⋮----
-// simple sleep function
-function promiseSleep(milliseconds: number)
-⋮----
-/** This is a simple script wrapped in a immediately invoked function expression, designed to check for any available BTC balance and immediately sell the full amount for USDT */
-⋮----
-// Add event listeners to log websocket events on account
-⋮----
-// Subscribe to private account topics
-// spot private
-// : account updates
-⋮----
-// : order updates (note: symbol is required)
-⋮----
-// wait briefly for ws to be ready (could also use the response or authenticated events, to make sure topics are subscribed to before starting)
-⋮----
-// console.log('balance: ', JSON.stringify(balances, null, 2));
-
-================
-File: examples/V2 - Classic/Websocket/ws-demo-trading.ts
-================
-import { DefaultLogger, WebsocketClientV2 } from '../../../src/index.js';
-⋮----
-// or
-// import { DefaultLogger, WS_KEY_MAP, WebsocketClientV2 } from 'bitget-api';
-⋮----
-// 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
-⋮----
-// restOptions: {
-// optionally provide rest options, e.g. to pass through a proxy
-// },
-⋮----
-// Set demoTrading to true, to route all connections to the demo trading wss URLs:
-⋮----
-// If using private topics, make sure to include API keys
-⋮----
-// console.log('WS raw message received ', JSON.stringify(data, null, 2));
-⋮----
-/**
-   * Public events
-   */
-
-================
-File: examples/V2 - Classic/Websocket/ws-private.ts
-================
-import { DefaultLogger, WebsocketClientV2 } from '../../../src/index.js';
-⋮----
-// or
-// import { DefaultLogger, WS_KEY_MAP, WebsocketClientV2 } from 'bitget-api';
-⋮----
-// 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
-⋮----
-// restOptions: {
-// optionally provide rest options, e.g. to pass through a proxy
-// },
-⋮----
-// console.log('WS raw message received ', JSON.stringify(data, null, 2));
-⋮----
-// auth happens async after the ws connection opens
-⋮----
-// wsClient.subscribePublicSpotTickers(['BTCUSDT', 'LTCUSDT']);
-⋮----
-/**
-   * Private account updates
-   */
-⋮----
-// spot private
-// : account updates
-⋮----
-// : order updates (note: symbol is required)
-// wsClient.subscribeTopic('SPOT', 'orders', 'BTCUSDT');
-⋮----
-// futures private
-// : account updates
-⋮----
-// : position updates
-// wsClient.subscribeTopic('USDT-FUTURES', 'positions');
-⋮----
-// : order updates
-// wsClient.subscribeTopic('USDT-FUTURES', 'orders');
-⋮----
-// : plan order updates
-// wsClient.subscribeTopic('USDT-FUTURES', 'orders-algo');
-⋮----
-// wsClient
-//   .getWsStore()
-//   .getKeys()
-//   .forEach((wsKey) => {
-//     const state = wsClient.getWsStore().get(wsKey);
-//     console.log(`${wsKey} state: `, state.subscribedTopics.values());
-//   });
-⋮----
-// setTimeout(() => {
-//   wsClient.unsubscribeTopic('USDT-FUTURES', 'account');
-// }, 1000 * 2);
-⋮----
-// setTimeout(() => {
-//   wsClient
-//     .getWsStore()
-//     .getKeys()
-//     .forEach((wsKey) => {
-//       const state = wsClient.getWsStore().get(wsKey);
-//       console.log(`${wsKey} state: `, state.subscribedTopics.values());
-//     });
-// }, 1000 * 5);
-
-================
-File: examples/V2 - Classic/Websocket/ws-public.ts
-================
-import {
-  DefaultLogger,
-  WebsocketClientV2,
-  WS_KEY_MAP,
-} from '../../../src/index.js';
-⋮----
-// or
-// import { DefaultLogger, WS_KEY_MAP, WebsocketClientV2 } from 'bitget-api';
-⋮----
-// restOptions: {
-// optionally provide rest options, e.g. to pass through a proxy
-// },
-⋮----
-// console.log('WS raw message received ', JSON.stringify(data, null, 2));
-⋮----
-/**
-   * Public events
-   */
-⋮----
-// Spot public
-⋮----
-// tickers
-⋮----
-// candles
-// wsClient.subscribeTopic('SPOT', 'candle1m', symbol);
-⋮----
-// orderbook updates
-// wsClient.subscribeTopic('SPOT', 'books', symbol);
-⋮----
-// trades
-// wsClient.subscribeTopic('SPOT', 'trade', symbol);
-⋮----
-// Futures public
-⋮----
-// tickers
-// wsClient.subscribeTopic('USDT-FUTURES', 'ticker', symbol);
-⋮----
-// candles
-// wsClient.subscribeTopic('USDT-FUTURES', 'candle1m', symbol);
-⋮----
-// orderbook updates
-// wsClient.subscribeTopic('USDT-FUTURES', 'books', symbol);
-⋮----
-// trades
-// wsClient.subscribeTopic('USDT-FUTURES', 'trade', symbol);
-⋮----
-// Topics are tracked per websocket type
-// Get a list of subscribed topics (e.g. all  public topics) (after a 5 second delay)
-
-================
-File: examples/V3 - UTA/Rest/rest-private.ts
+File: examples/V3 - UTA/Rest/rest-private.ts
 ================
 import { RestClientV3 } from '../../../src/index.js';
 ⋮----
@@ -4871,1157 +4908,1175 @@ import { RestClientV3 } from '../../../src/index.js';
 // import { RestClientV3 } from 'bitget-api';
 
 ================
-File: examples/V3 - UTA/Rest/rest-trade-UTA-futures.ts
+File: examples/README.md
 ================
-/* eslint-disable @typescript-eslint/no-unused-vars */
-import {
-  PlaceOrderRequestV3,
-  RestClientV3,
-  WebsocketClientV3,
-} from '../../../src/index.js';
-⋮----
-// or
-// import { PlaceOrderRequestV3, RestClientV3, WebsocketClientV3 } from '../src';
-⋮----
-// read from environmental variables
-⋮----
-// 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/V3/rest-trade-futures.ts
-⋮----
-// note the single quotes, preventing special characters such as $ from being incorrectly passed
-⋮----
-// apiKey: 'apiKeyHere',
-// apiSecret: 'apiSecretHere',
-// apiPass: 'apiPassHere',
-⋮----
-function logWSEvent(type: string, data: any)
-⋮----
-// simple sleep function
-function promiseSleep(milliseconds: number)
-⋮----
-/**
- * This is a simple script wrapped in a immediately invoked function expression (to execute the below workflow immediately).
- *
- * It is designed to:
- * - open a private websocket channel to log account events
- * - check for any available USDT balance in the account
- * - immediately open a minimum sized long position on BTCUSDT
- * - check active positions
- * - immediately send closing orders for any active futures positions
- * - check positions again
- *
- */
-⋮----
-// Add event listeners to log websocket events on account
-⋮----
-// Subscribe to private topics for UTA account
-⋮----
-// Subscribe to position updates
-⋮----
-// Subscribe to order updates
-⋮----
-// wait briefly for ws to be ready (could also use the response or authenticated events, to make sure topics are subscribed to before starting)
-⋮----
-// Loop through any active positions and send a closing market order on each position
+# Examples
+
+These samples can be executed using `ts-node`:
+
+```
+ts-node ./examples/rest-spot-public.ts
+```
+
+Samples that require authentication can be edited directly but also support environmental variables. E.g. on mac/unix:
+
+```
+API_KEY_COM='yourkeyhere' API_SECRET_COM='yoursecrethere' API_PASS_COM='yourapipasshere' ts-node examples/rest-trade-futures.ts
+```
+
+They can also be converted to JavaScript by changing the imports to require & removing any type annotations.
+
+## V3 / Unified Trading Account (UTA)
+
+These newer examples are for Bitget's V3 APIs and WebSockets. They can be found in the examples/V3 folder.
+
+Refer to the V3 / UTA API documentation for more information on the V3 APIs:
+https://www.bitget.com/api-doc/uta/intro
+
+These APIs require your account to be upgraded to the Unified Trading Account, if you plan on using the account-level REST APIs and WebSockets. Once upgraded, the V2 APIs are no longer available to you, unless you revert back to Classic Account mode.
+
+### WebSocket API (WS API)
+
+The V3/UTA API introduces order placement via a persisted WebSocket connection. This Bitget Node.js, JavaScript & TypeScript SDK supports Bitget's full V3 API offering, including the WebSocket API.
+
+There are two approaches to placing orders via the Bitget WebSocket APIs
+
+#### WebsocketAPIClient (recommended)
+
+This integration looks & feels like a REST API client, but uses WebSockets, via the WebsocketClient's sendWSAPIRequest method. It returns promises and has end to end types.
+
+This is the recommended approach to easily start sending orders via an automatically persisted WebSocket connection. A simple example is below, but for a more thorough example, check the example here: [./V3/ws-api-client-trade.ts](./V3/ws-api-client-trade.ts)
+
+```typescript
+import { WebsocketAPIClient } from 'bitget-api';
+// or if you prefer require:
+// const { WebsocketAPIClient } = require("bitget-api");
+
+// Make an instance of the WS API Client class with your API keys
+const wsClient = new WebsocketAPIClient({
+  apiKey: API_KEY,
+  apiSecret: API_SECRET,
+  apiPass: API_PASS,
+
+  // Whether to use the demo trading wss connection
+  // demoTrading: true,
+});
+
+async function start() {
+  // Start using it like a REST API. All actions are sent via a persisted WebSocket connection.
+
+  /**
+   * Place Order
+   * https://www.bitget.com/api-doc/uta/websocket/private/Place-Order-Channel#request-parameters
+   */
+  try {
+    const res = await wsClient.submitNewOrder('spot', {
+      orderType: 'limit',
+      price: '100',
+      qty: '0.1',
+      side: 'buy',
+      symbol: 'BTCUSDT',
+      timeInForce: 'gtc',
+    });
+
+    console.log(new Date(), 'WS API "submitNewOrder()" result: ', res);
+  } catch (e) {
+    console.error(new Date(), 'Exception with WS API "submitNewOrder()": ', e);
+  }
+}
+
+start().catch((e) => console.error('Exception in example: '.e));
+```
+
+#### ws.sendWSAPIRequest(wsKey, command, category, operation)
+
+This is the "raw" integration within the existing WebSocket client. It uses an automatically persisted & authenticated connection to send events through Bitget's WebSocket API. It automatically tracks and connects outgoing requests with incoming responses, and returns promises that resolve/reject when a matching response is received.
+
+Refer to [V3/ws-api-trade-raw.ts](./V3/ws-api-trade-raw.ts) to see an example.
+
+Note: The WebsocketClient is built around this. For a more user friendly experience, it is recommended to use the WebsocketClient for WS API requests. It uses this method but has the convenience of behaving similar to a REST API (while all communication automatically happens over a persisted WebSocket connection).
+
+## V2
+
+These examples are for Bitget's V2 APIs and WebSockets. They can be found in the examples/V2 folder.
+
+Refer to the V2 API documentation for more information on the V2 APIs:
+https://www.bitget.com/api-doc/common/intro
 
 ================
-File: examples/V3 - UTA/Rest/rest-trade-UTA-spot.ts
+File: src/constants/enum.ts
 ================
-/* eslint-disable @typescript-eslint/no-unused-vars */
-import {
-  PlaceOrderRequestV3,
-  RestClientV3,
-  WebsocketClientV3,
-} from '../../../src/index.js';
-⋮----
-// import { RestClientV3, WebsocketClientV3 } from '../src/index';
-⋮----
-// read from environmental variables
+/** Parameter verification exception margin mode == FIXED */
+
+================
+File: src/types/request/v3/broker.ts
+================
+export interface CreateBrokerSubAccountRequestV3 {
+  subaccountName: string;
+  label: string;
+}
 ⋮----
-// 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/V3/rest-trade-spot.ts
+export interface GetBrokerSubAccountListRequestV3 {
+  limit?: string;
+  cursor?: string;
+  status?: 'normal' | 'freeze';
+}
 ⋮----
-// note the single quotes, preventing special characters such as $ from being incorrectly passed
+export interface ModifyBrokerSubAccountRequestV3 {
+  subUid: string;
+  status?: 'normal' | 'freeze';
+  permList?: string[];
+}
 ⋮----
-// apiKey: 'apiKeyHere',
-// apiSecret: 'apiSecretHere',
-// apiPass: 'apiPassHere',
+export interface BrokerSubWithdrawalRequestV3 {
+  subUid: string;
+  coin: string;
+  dest: 'on_chain' | 'internal_transfer';
+  address: string;
+  amount: string;
+  chain?: string;
+  tag?: string;
+  clientOid?: string;
+}
 ⋮----
-function logWSEvent(type: string, data: any)
+export interface GetBrokerSubDepositAddressRequestV3 {
+  subUid: string;
+  coin: string;
+  chain?: string;
+}
 ⋮----
-// simple sleep function
-function promiseSleep(milliseconds: number)
+export interface GetBrokerAllSubDepositWithdrawalRequestV3 {
+  startTime?: string;
+  endTime?: string;
+  limit?: string;
+  cursor?: string;
+  status?: 'pending' | 'fail' | 'success';
+}
 ⋮----
-/** This is a simple script wrapped in a immediately invoked function expression, designed to check for any available BTC balance and immediately sell the full amount for USDT */
+export interface GetBrokerCommissionRequestV3 {
+  startTime?: string;
+  endTime?: string;
+  pageSize?: string;
+  pageNo?: string;
+  bizType?: 'spot' | 'futures';
+  subBizType?:
+    | 'spot_trade'
+    | 'spot_margin'
+    | 'usdt_futures'
+    | 'usdc_futures'
+    | 'coin_futures';
+}
 ⋮----
-// Add event listeners to log websocket events on account
+export interface CreateBrokerSubApiKeyRequestV3 {
+  subUid: string;
+  passphrase: string;
+  label: string;
+  ipList?: string[];
+  permType: 'read_and_write' | 'readonly';
+  permList: string[];
+}
 ⋮----
-// Subscribe to private account topics
-// Account updates for UTA (unified trading account)
+export interface ModifyBrokerSubApiKeyRequestV3 {
+  subUid: string;
+  passphrase: string;
+  apiKey: string;
+  label?: string;
+  ipList?: string[];
+  permType?: 'read_and_write' | 'readonly';
+  permList?: string[];
+}
 ⋮----
-// Order updates for spot
+export interface DeleteBrokerSubApiKeyRequestV3 {
+  subUid: string;
+  apiKey: string;
+}
 ⋮----
-// wait briefly for ws to be ready (could also use the response or authenticated events, to make sure topics are subscribed to before starting)
+export interface GetBrokerSubApiKeyRequestV3 {
+  subUid: string;
+}
 
 ================
-File: examples/V3 - UTA/Websocket/ws-private.ts
+File: src/types/request/v3/public.ts
 ================
-import {
-  DefaultLogger,
-  WebsocketClientV3,
-  WS_KEY_MAP,
-} from '../../../src/index.js';
-⋮----
-// or
-// import { DefaultLogger, WS_KEY_MAP, WebsocketClientV2 } from 'bitget-api';
+export interface GetPublicFillsRequestV3 {
+  category:
+    | 'SPOT'
+    | 'MARGIN'
+    | 'USDT-FUTURES'
+    | 'COIN-FUTURES'
+    | 'USDC-FUTURES';
+  symbol?: string;
+  limit?: string;
+}
 ⋮----
-// 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
+export interface GetCandlesRequestV3 {
+  category: 'SPOT' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+  symbol: string;
+  interval:
+    | '1m'
+    | '3m'
+    | '5m'
+    | '15m'
+    | '30m'
+    | '1H'
+    | '4H'
+    | '6H'
+    | '12H'
+    | '1D';
+  startTime?: string;
+  endTime?: string;
+  type?: 'MARKET' | 'MARK' | 'INDEX';
+  limit?: string;
+}
 ⋮----
-// console.log('WS raw message received ', JSON.stringify(data, null, 2));
+export interface GetHistoryCandlesRequestV3 {
+  category: 'SPOT' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+  symbol: string;
+  interval:
+    | '1m'
+    | '3m'
+    | '5m'
+    | '15m'
+    | '30m'
+    | '1H'
+    | '4H'
+    | '6H'
+    | '12H'
+    | '1D';
+  startTime?: string;
+  endTime?: string;
+  type?: 'MARKET' | 'MARK' | 'INDEX';
+  limit?: string;
+}
 ⋮----
-// You can subscribe to one topic at a time
+export interface GetContractsOiRequestV3 {
+  symbol?: string;
+  category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+}
 ⋮----
-instType: 'UTA', // Note: all account events go on the UTA instType
+export interface GetCurrentFundingRateRequestV3 {
+  symbol: string;
+}
 ⋮----
-WS_KEY_MAP.v3Private, // This parameter points to private or public
+export interface GetHistoryFundingRateRequestV3 {
+  category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+  symbol: string;
+  cursor?: string;
+  limit?: string;
+}
 ⋮----
-// Note: all account events go on the UTA instType
+export interface GetMarginLoansRequestV3 {
+  coin: string;
+}
 ⋮----
-// Or multiple at once:
+export interface GetOpenInterestRequestV3 {
+  category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+  symbol?: string;
+}
 ⋮----
-// Topics are tracked per websocket type
-// The below example will pull a list of subscribed topics on that connection (e.g. all private topics), after a 5 second delay:
-
-================
-File: examples/V3 - UTA/Websocket/ws-public.ts
-================
-import {
-  DefaultLogger,
-  WebsocketClientV3,
-  WS_KEY_MAP,
-} from '../../../src/index.js';
+export interface GetPositionTierRequestV3 {
+  category: 'MARGIN' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+  symbol?: string;
+  coin?: string;
+}
 ⋮----
-// or
-// import { DefaultLogger, WS_KEY_MAP, WebsocketClientV2 } from 'bitget-api';
+export interface GetRiskReserveRequestV3 {
+  category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+  symbol: string;
+}
 ⋮----
-// console.log('WS raw message received ', JSON.stringify(data, null, 2));
+export interface GetInstrumentsRequestV3 {
+  category:
+    | 'SPOT'
+    | 'MARGIN'
+    | 'USDT-FUTURES'
+    | 'COIN-FUTURES'
+    | 'USDC-FUTURES';
+  symbol?: string;
+}
 ⋮----
-/**
-   * Public events
-   */
+export interface GetMarketFeeGroupRequestV3 {
+  category: 'SPOT' | 'FUTURES';
+  group?: 'GROUP_A' | 'GROUP_B' | 'GROUP_C';
+}
 ⋮----
-// You can subscribe to one topic at a time
+export interface GetMarketScoreWeightsRequestV3 {
+  category?: 'SPOT' | 'FUTURES';
+}
 ⋮----
-WS_KEY_MAP.v3Public, // This parameter points to private or public
+export interface GetOrderBookRequestV3 {
+  category: 'SPOT' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+  symbol: string;
+  limit?: string;
+}
 ⋮----
-// Or multiple at once:
+export interface GetTickersRequestV3 {
+  category: 'SPOT' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+  symbol?: string;
+}
 ⋮----
-// Topics are tracked per websocket type
-// The below example will pull a list of subscribed topics on that connection (e.g. all public topics), after a 5 second delay:
+export interface GetIndexComponentsRequestV3 {
+  symbol: string;
+}
 
 ================
-File: examples/V3 - UTA/WS-API/ws-api-trade-raw.ts
+File: src/types/response/v3/broker.ts
 ================
-import {
-  DefaultLogger,
-  WebsocketClientV3,
-  WS_KEY_MAP,
-} from '../../../src/index.js';
+export interface CreateBrokerSubAccountResponseV3 {
+  subUid: string;
+  subaccountName: string;
+  subaccountEmail: string;
+  status: 'normal' | 'freeze';
+  permList: string[];
+  label: string;
+  cTime: string;
+}
 ⋮----
-// or
-// import { DefaultLogger, WS_KEY_MAP, WebsocketClientV3 } from 'bitget-api';
+export interface BrokerSubAccountV3 {
+  subUid: string;
+  subaccountName: string;
+  subaccountEmail: string | null;
+  status: 'normal' | 'freeze';
+  permList: string[];
+  label: string;
+  language: string;
+  cTime: string;
+  uTime: string;
+}
 ⋮----
-// 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
+export interface GetBrokerSubAccountListResponseV3 {
+  subList: BrokerSubAccountV3[];
+}
 ⋮----
-// console.log('WS raw message received ', JSON.stringify(data, null, 2));
+export interface ModifyBrokerSubAccountResponseV3 {
+  subUid: string;
+  subaccountName: string;
+  status: 'normal' | 'freeze';
+  permList: string[];
+  label: string;
+  cTime: string;
+  uTime: string;
+}
 ⋮----
-/**
-   * Bitget's WebSocket API can be used via the sendWSAPIRequest() method.
-   *
-   * Use the `WS_KEY_MAP.v3Private` connection key for any requests.
-   *
-   * Note: this requires V3/UTA API keys!
-   * Note: for a better user experience, it is recommended to use the WebsocketAPIClient.
-   */
+export interface BrokerSubWithdrawalResponseV3 {
+  orderId: string;
+  clientOid: string;
+}
 ⋮----
-// Use the V3 private wss connection URL
+export interface BrokerSubDepositAddressV3 {
+  subUid: string;
+  coin: string;
+  address: string;
+  chain: string;
+  tag: string | null;
+  url: string;
+  cTime: string;
+}
 ⋮----
-/**
-   * Place Order
-   * https://www.bitget.com/api-doc/uta/websocket/private/Place-Order-Channel#request-parameters
-   */
+export interface BrokerSubDepositWithdrawalRecordV3 {
+  uid: string;
+  txId: string;
+  type: 'deposit' | 'withdrawal';
+  subType: 'onchain' | 'internal' | 'fast';
+  coin: string;
+  amount: string;
+  status: 'pending' | 'fail' | 'success';
+  ts: string;
+}
 ⋮----
-/**
-      const res = {
-        "event": "trade",
-        "id": "1750034396082",
-        "category": "spot",
-        "topic": "place-order",
-        "args": [
-          {
-            "symbol": "BTCUSDT",
-            "orderId": "xxxxxxxx",
-            "clientOid": "xxxxxxxx",
-            "cTime": "1750034397008"
-          }
-        ],
-        "code": "0",
-        "msg": "success",
-        "ts": "1750034397076"
-      };
-     */
+export interface GetBrokerAllSubDepositWithdrawalResponseV3 {
+  list: BrokerSubDepositWithdrawalRecordV3[];
+  endId: string;
+}
 ⋮----
-/**
-   * Batch Place Order Channel
-   * https://www.bitget.com/api-doc/uta/websocket/private/Batch-Place-Order-Channel
-   */
+export interface BrokerCommissionRecordV3 {
+  uid: string;
+  coin: string;
+  symbol: string;
+  dealtAmount: string;
+  totalFee: string;
+  deductedFee: string;
+  paidFee: string;
+  markUpFee: string;
+  totalCommission: string;
+}
 ⋮----
-/**
-     * Note: batch place will never reject the request, even if all orders were rejected. Check the "code" and "msg" properties for individual orders in the response, to detect batch place errors.
-     */
+export interface CreateBrokerSubApiKeyResponseV3 {
+  subUid: string;
+  label: string;
+  apiKey: string;
+  secretKey: string;
+  permType: 'read_and_write' | 'readonly';
+  permList: string[];
+  ipList: string[] | null;
+}
 ⋮----
-/**
-      const res = {
-        "event": "trade",
-        "id": "1750035029506",
-        "category": "spot",
-        "topic": "batch-place",
-        "args": [
-          {
-            "code": "0",
-            "msg": "Success",
-            "symbol": "BTCUSDT",
-            "orderId": "xxxxxxxx",
-            "clientOid": "xxxxxxxx"
-          },
-          {
-            "code": "0",
-            "msg": "Success",
-            "symbol": "BTCUSDT",
-            "orderId": "xxxxxxxx",
-            "clientOid": "xxxxxxxx"
-          }
-        ],
-        "code": "0",
-        "msg": "Success",
-        "ts": "1750035029925"
-      }
-     */
-⋮----
-/**
-   * Cancel Order
-   * https://www.bitget.com/api-doc/uta/websocket/private/Cancel-Order-Channel
-   */
-⋮----
-/**
-      const res = {
-        "event": "trade",
-        "id": "1750034870205",
-        "topic": "cancel-order",
-        "args": [
-          {
-            "orderId": "xxxxxxxx",
-            "clientOid": "xxxxxxxx"
-          }
-        ],
-        "code": "0",
-        "msg": "Success",
-        "ts": "1750034870597"
-      }
-     */
-⋮----
-/**
-   * Batch Cancel Order
-   * https://www.bitget.com/api-doc/uta/websocket/private/Batch-Cancel-Order-Channel
-   */
+export interface ModifyBrokerSubApiKeyResponseV3 {
+  subUid: string;
+  label: string;
+  apiKey: string;
+  permType: 'read_and_write' | 'readonly';
+  permList: string[];
+  ipList: string[];
+}
 ⋮----
-/**
-      const res = {
-        "event": "trade",
-        "id": "bb553cc0-c1fa-454e-956d-c96c8d715760",
-        "topic": "batch-cancel",
-        "args": [
-          {
-            "code": "0",
-            "msg": "Success",
-            "orderId": "xxxxxxxxxxxxx"
-          },
-          {
-            "code": "25204",
-            "msg": "Order does not exist",
-            "orderId": "xxxxxxxxxxxxx"
-          }
-        ],
-        "code": "0",
-        "msg": "Success",
-        "ts": "1751980011084"
-      }
-     */
-
-================
-File: examples/README.md
-================
-# Examples
-
-These samples can be executed using `ts-node`:
-
-```
-ts-node ./examples/rest-spot-public.ts
-```
-
-Samples that require authentication can be edited directly but also support environmental variables. E.g. on mac/unix:
-
-```
-API_KEY_COM='yourkeyhere' API_SECRET_COM='yoursecrethere' API_PASS_COM='yourapipasshere' ts-node examples/rest-trade-futures.ts
-```
-
-They can also be converted to JavaScript by changing the imports to require & removing any type annotations.
-
-## V3 / Unified Trading Account (UTA)
-
-These newer examples are for Bitget's V3 APIs and WebSockets. They can be found in the examples/V3 folder.
-
-Refer to the V3 / UTA API documentation for more information on the V3 APIs:
-https://www.bitget.com/api-doc/uta/intro
-
-These APIs require your account to be upgraded to the Unified Trading Account, if you plan on using the account-level REST APIs and WebSockets. Once upgraded, the V2 APIs are no longer available to you, unless you revert back to Classic Account mode.
-
-### WebSocket API (WS API)
-
-The V3/UTA API introduces order placement via a persisted WebSocket connection. This Bitget Node.js, JavaScript & TypeScript SDK supports Bitget's full V3 API offering, including the WebSocket API.
-
-There are two approaches to placing orders via the Bitget WebSocket APIs
-
-#### WebsocketAPIClient (recommended)
-
-This integration looks & feels like a REST API client, but uses WebSockets, via the WebsocketClient's sendWSAPIRequest method. It returns promises and has end to end types.
-
-This is the recommended approach to easily start sending orders via an automatically persisted WebSocket connection. A simple example is below, but for a more thorough example, check the example here: [./V3/ws-api-client-trade.ts](./V3/ws-api-client-trade.ts)
-
-```typescript
-import { WebsocketAPIClient } from 'bitget-api';
-// or if you prefer require:
-// const { WebsocketAPIClient } = require("bitget-api");
-
-// Make an instance of the WS API Client class with your API keys
-const wsClient = new WebsocketAPIClient({
-  apiKey: API_KEY,
-  apiSecret: API_SECRET,
-  apiPass: API_PASS,
-
-  // Whether to use the demo trading wss connection
-  // demoTrading: true,
-});
-
-async function start() {
-  // Start using it like a REST API. All actions are sent via a persisted WebSocket connection.
-
-  /**
-   * Place Order
-   * https://www.bitget.com/api-doc/uta/websocket/private/Place-Order-Channel#request-parameters
-   */
-  try {
-    const res = await wsClient.submitNewOrder('spot', {
-      orderType: 'limit',
-      price: '100',
-      qty: '0.1',
-      side: 'buy',
-      symbol: 'BTCUSDT',
-      timeInForce: 'gtc',
-    });
-
-    console.log(new Date(), 'WS API "submitNewOrder()" result: ', res);
-  } catch (e) {
-    console.error(new Date(), 'Exception with WS API "submitNewOrder()": ', e);
-  }
+export interface GetBrokerSubApiKeyResponseV3 {
+  subUid: string;
+  label: string;
+  apiKey: string;
+  secretKey: string;
+  permType: 'read_and_write' | 'readonly';
+  permList: string[];
+  ipList: string[] | null;
 }
 
-start().catch((e) => console.error('Exception in example: '.e));
-```
-
-#### ws.sendWSAPIRequest(wsKey, command, category, operation)
-
-This is the "raw" integration within the existing WebSocket client. It uses an automatically persisted & authenticated connection to send events through Bitget's WebSocket API. It automatically tracks and connects outgoing requests with incoming responses, and returns promises that resolve/reject when a matching response is received.
-
-Refer to [V3/ws-api-trade-raw.ts](./V3/ws-api-trade-raw.ts) to see an example.
-
-Note: The WebsocketClient is built around this. For a more user friendly experience, it is recommended to use the WebsocketClient for WS API requests. It uses this method but has the convenience of behaving similar to a REST API (while all communication automatically happens over a persisted WebSocket connection).
-
-## V2
-
-These examples are for Bitget's V2 APIs and WebSockets. They can be found in the examples/V2 folder.
-
-Refer to the V2 API documentation for more information on the V2 APIs:
-https://www.bitget.com/api-doc/common/intro
-
-================
-File: src/constants/enum.ts
 ================
-/** Parameter verification exception margin mode == FIXED */
-
-================
-File: src/types/request/v3/broker.ts
+File: src/types/response/v3/loan.ts
 ================
-export interface CreateBrokerSubAccountRequestV3 {
-  subaccountName: string;
-  label: string;
+export interface LoanTransfersV3 {
+  coin: string;
+  transfered: string;
+  userId: string;
 }
 ⋮----
-export interface GetBrokerSubAccountListRequestV3 {
-  limit?: string;
-  cursor?: string;
-  status?: 'normal' | 'freeze';
+export interface LoanSymbolSettingV3 {
+  symbol: string;
+  leverage: string;
 }
 ⋮----
-export interface ModifyBrokerSubAccountRequestV3 {
-  subUid: string;
-  status?: 'normal' | 'freeze';
-  permList?: string[];
+export interface LoanSymbolsV3 {
+  productId: string;
+  spotSymbols: string[];
+  marginLeverage: string;
+  usdtContractLeverage: string;
+  coinContractLeverage: string;
+  usdcContractLeverage: string;
+  usdtContractSymbols: LoanSymbolSettingV3[];
+  coinContractSymbols: LoanSymbolSettingV3[];
+  usdcContractSymbols: LoanSymbolSettingV3[];
+}
+⋮----
+export interface RepaidHistoryItemV3 {
+  repayOrderId: string;
+  businessType: 'normal' | 'liquidation';
+  repayType: 'all' | 'part';
+  repaidTime: string;
+  coin: string;
+  repayAmount: string;
+  repayInterest: string;
+}
+⋮----
+export interface LoanProductInfoV3 {
+  productId: string;
+  leverage: string;
+  supportUsdtContract: 'YES' | 'NO';
+  supportCoinContract: 'YES' | 'NO';
+  supportUsdcContract: 'YES' | 'NO';
+  transferLine: string;
+  spotBuyLine: string;
+  usdtContractOpenLine: string;
+  coinContractOpenLine: string;
+  usdcContractOpenLine: string;
+  liquidationLine: string;
+  stopLiquidationLine: string;
+}
+⋮----
+export interface LoanOrderV3 {
+  orderId: string;
+  orderProductId: string;
+  uid: string;
+  loanTime: string;
+  loanCoin: string;
+  loanAmount: string;
+  unpaidAmount: string;
+  unpaidInterest: string;
+  repaidAmount: string;
+  repaidInterest: string;
+  reserve: string;
+  status: 'not_paid_off' | 'paid_off';
+}
+⋮----
+/** Tiered conversion rate item (when Tiered Discount Rate Model is enabled) */
+export interface ConvertRatioListItemV3 {
+  ladder: string;
+  convertRatio: string;
+}
+⋮----
+export interface CoinInfoV3 {
+  coin: string;
+  convertRatio: string;
+  maxConvertValue: string;
+  /** Tiered conversion rate (when margin mode is Tiered Discount Rate Model) */
+  convertRatioList?: ConvertRatioListItemV3[];
+}
+⋮----
+/** Tiered conversion rate (when margin mode is Tiered Discount Rate Model) */
+⋮----
+export interface BindUidResponseV3 {
+  riskUnitId: string;
+  uid: string;
+  operate: 'bind' | 'unbind';
+}
+⋮----
+export interface UnpaidInfoV3 {
+  coin: string;
+  unpaidQty: string;
+  unpaidInterest: string;
 }
 ⋮----
-export interface BrokerSubWithdrawalRequestV3 {
-  subUid: string;
+export interface BalanceInfoV3 {
   coin: string;
-  dest: 'on_chain' | 'internal_transfer';
-  address: string;
+  price: string;
   amount: string;
-  chain?: string;
-  tag?: string;
-  clientOid?: string;
+  convertedUsdtAmount: string;
 }
 ⋮----
-export interface GetBrokerSubDepositAddressRequestV3 {
-  subUid: string;
-  coin: string;
-  chain?: string;
+export interface LTVConvertResponseV3 {
+  ltv: string;
+  subAccountUids: string[];
+  unpaidUsdtAmount: string;
+  usdtBalance: string;
+  unpaidInfo: UnpaidInfoV3[];
+  balanceInfo: BalanceInfoV3[];
 }
 ⋮----
-export interface GetBrokerAllSubDepositWithdrawalRequestV3 {
-  startTime?: string;
-  endTime?: string;
-  limit?: string;
-  cursor?: string;
-  status?: 'pending' | 'fail' | 'success';
-}
+/* Unified Account Staking & Lending (Crypto Loans) - /api/v3/loan/* */
 ⋮----
-export interface GetBrokerCommissionRequestV3 {
-  startTime?: string;
-  endTime?: string;
-  pageSize?: string;
-  pageNo?: string;
-  bizType?: 'spot' | 'futures';
-  subBizType?:
-    | 'spot_trade'
-    | 'spot_margin'
-    | 'usdt_futures'
-    | 'usdc_futures'
-    | 'coin_futures';
+export interface LoanCoinInfoV3 {
+  coin: string;
+  hourRateFlexible: string;
+  rateFlexible: string;
+  hourRate7D: string;
+  rate7D: string;
+  hourRate30D: string;
+  rate30D: string;
+  minBorrowAmount: string;
+  maxBorrowAmount: string;
+  minBorrowLimit: string;
+  maxBorrowLimit: string;
 }
 ⋮----
-export interface CreateBrokerSubApiKeyRequestV3 {
-  subUid: string;
-  passphrase: string;
-  label: string;
-  ipList?: string[];
-  permType: 'read_and_write' | 'readonly';
-  permList: string[];
+export interface LoanPledgeInfoV3 {
+  coin: string;
+  initRate: string;
+  supRate: string;
+  forceRate: string;
+  minPledgeAmount: string;
+  maxPledgeAmount: string;
 }
 ⋮----
-export interface ModifyBrokerSubApiKeyRequestV3 {
-  subUid: string;
-  passphrase: string;
-  apiKey: string;
-  label?: string;
-  ipList?: string[];
-  permType?: 'read_and_write' | 'readonly';
-  permList?: string[];
+export interface GetLoanCoinsResponseV3 {
+  loanInfos: LoanCoinInfoV3[];
+  pledgeInfos: LoanPledgeInfoV3[];
 }
 ⋮----
-export interface DeleteBrokerSubApiKeyRequestV3 {
-  subUid: string;
-  apiKey: string;
+export interface GetLoanInterestResponseV3 {
+  hourInterest: string;
+  loanAmount: string;
 }
 ⋮----
-export interface GetBrokerSubApiKeyRequestV3 {
-  subUid: string;
+export interface LoanBorrowResponseV3 {
+  orderId: string;
 }
-
-================
-File: src/types/request/v3/public.ts
-================
-export interface GetPublicFillsRequestV3 {
-  category:
-    | 'SPOT'
-    | 'MARGIN'
-    | 'USDT-FUTURES'
-    | 'COIN-FUTURES'
-    | 'USDC-FUTURES';
-  symbol?: string;
-  limit?: string;
+⋮----
+export interface LoanBorrowOngoingItemV3 {
+  orderId: string;
+  loanCoin: string;
+  loanAmount: string;
+  interestAmount: string;
+  hourInterestRate: string;
+  pledgeCoin: string;
+  pledgeAmount: string;
+  pledgeRate: string;
+  supRate: string;
+  forceRate: string;
+  borrowTime: string;
+  expireTime: string;
 }
 ⋮----
-export interface GetCandlesRequestV3 {
-  category: 'SPOT' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
-  symbol: string;
-  interval:
-    | '1m'
-    | '3m'
-    | '5m'
-    | '15m'
-    | '30m'
-    | '1H'
-    | '4H'
-    | '6H'
-    | '12H'
-    | '1D';
-  startTime?: string;
-  endTime?: string;
-  type?: 'MARKET' | 'MARK' | 'INDEX';
-  limit?: string;
+export interface LoanBorrowHistoryItemV3 {
+  orderId: string;
+  loanCoin: string;
+  pledgeCoin: string;
+  initPledgeAmount: string;
+  initLoanAmount: string;
+  hourRate: string;
+  daily: string;
+  borrowTime: string;
+  status: string;
 }
 ⋮----
-export interface GetHistoryCandlesRequestV3 {
-  category: 'SPOT' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
-  symbol: string;
-  interval:
-    | '1m'
-    | '3m'
-    | '5m'
-    | '15m'
-    | '30m'
-    | '1H'
-    | '4H'
-    | '6H'
-    | '12H'
-    | '1D';
-  startTime?: string;
-  endTime?: string;
-  type?: 'MARKET' | 'MARK' | 'INDEX';
-  limit?: string;
+export interface LoanRepayResponseV3 {
+  loanCoin: string;
+  pledgeCoin: string;
+  repayAmount: string;
+  payInterest: string;
+  repayLoanAmount: string;
+  repayUnlockAmount: string;
 }
 ⋮----
-export interface GetContractsOiRequestV3 {
-  symbol?: string;
-  category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+export interface LoanRepayHistoryItemV3 {
+  orderId: string;
+  loanCoin: string;
+  pledgeCoin: string;
+  repayAmount: string;
+  payInterest: string;
+  repayLoanAmount: string;
+  repayUnlockAmount: string;
+  repayTime: string;
 }
 ⋮----
-export interface GetCurrentFundingRateRequestV3 {
-  symbol: string;
+export interface LoanRevisePledgeResponseV3 {
+  loanCoin: string;
+  pledgeCoin: string;
+  afterPledgeRate: string;
 }
 ⋮----
-export interface GetHistoryFundingRateRequestV3 {
-  category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
-  symbol: string;
-  cursor?: string;
-  limit?: string;
+export interface LoanPledgeRateHistoryItemV3 {
+  loanCoin: string;
+  pledgeCoin: string;
+  orderId: string;
+  reviseTime: string;
+  reviseSide: string;
+  reviseAmount: string;
+  afterPledgeRate: string;
+  beforePledgeRate: string;
 }
 ⋮----
-export interface GetMarginLoansRequestV3 {
+export interface LoanDebtInfoV3 {
   coin: string;
+  amount: string;
+  amountUsdt: string;
 }
 ⋮----
-export interface GetOpenInterestRequestV3 {
-  category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
-  symbol?: string;
+export interface GetLoanDebtsResponseV3 {
+  pledgeInfos: LoanDebtInfoV3[];
+  loanInfos: LoanDebtInfoV3[];
 }
 ⋮----
-export interface GetPositionTierRequestV3 {
-  category: 'MARGIN' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
-  symbol?: string;
-  coin?: string;
+export interface LoanReduceItemV3 {
+  orderId: string;
+  loanCoin: string;
+  pledgeCoin: string;
+  reduceTime: string;
+  pledgeRate: string;
+  pledgePrice: string;
+  status: string;
+  pledgeAmount: string;
+  reduceFee: string;
+  residueAmount: string;
+  runlockAmount: string;
+  repayLoanAmount: string;
 }
+
+================
+File: src/types/shared.ts
+================
+import { REST_CLIENT_TYPE_ENUM } from '../util/requestUtils.js';
 ⋮----
-export interface GetRiskReserveRequestV3 {
-  category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
-  symbol: string;
-}
+export type numberInString = string;
 ⋮----
-export interface GetInstrumentsRequestV3 {
-  category:
-    | 'SPOT'
-    | 'MARGIN'
-    | 'USDT-FUTURES'
-    | 'COIN-FUTURES'
-    | 'USDC-FUTURES';
-  symbol?: string;
-}
+export type OrderSide = 'Buy' | 'Sell';
 ⋮----
-export interface GetOrderBookRequestV3 {
-  category: 'SPOT' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
-  symbol: string;
-  limit?: string;
-}
+/**
+ * @deprecated use SpotKlineInterval or FuturesKlineInterval, depending on which API group you're using
+ */
+export type KlineInterval =
+  | '1min'
+  | '5min'
+  | '15min'
+  | '30min'
+  | '1h'
+  | '4h'
+  | '6h'
+  | '12h'
+  | '1M'
+  | '1W'
+  | '1week'
+  | '6Hutc'
+  | '12Hutc'
+  | '1Dutc'
+  | '3Dutc'
+  | '1Wutc'
+  | '1Mutc';
 ⋮----
-export interface GetTickersRequestV3 {
-  category: 'SPOT' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
-  symbol?: string;
+export type RestClientType =
+  (typeof REST_CLIENT_TYPE_ENUM)[keyof typeof REST_CLIENT_TYPE_ENUM];
+⋮----
+export interface APIResponse<T> {
+  code: string;
+  requestTime: number;
+  msg: 'success' | string;
+  data: T;
 }
+
+================
+File: webpack/webpack.config.cjs
+================
+function generateConfig(name)
 ⋮----
-export interface GetIndexComponentsRequestV3 {
-  symbol: string;
-}
+// Add '.ts' and '.tsx' as resolvable extensions.
+⋮----
+// Node.js core modules not available in browsers
+// The REST client's https.Agent (for keepAlive) is Node.js-only and won't work in browsers
+⋮----
+// Code is already transpiled from TypeScript, no additional loaders needed
 
 ================
-File: src/types/response/v3/broker.ts
+File: tsconfig.json
 ================
-export interface CreateBrokerSubAccountResponseV3 {
-  subUid: string;
-  subaccountName: string;
-  subaccountEmail: string;
-  status: 'normal' | 'freeze';
-  permList: string[];
-  label: string;
-  cTime: string;
+{
+  "compilerOptions": {
+    "allowSyntheticDefaultImports": true,
+    "baseUrl": ".",
+    "noEmitOnError": true,
+    "declaration": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": false,
+    "inlineSourceMap": false,
+    "lib": ["esnext", "DOM"],
+    "listEmittedFiles": false,
+    "listFiles": false,
+    "moduleResolution": "node",
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitAny": true,
+    "noUnusedParameters": true,
+    "pretty": true,
+    "removeComments": false,
+    "resolveJsonModule": true,
+    "skipLibCheck": false,
+    "sourceMap": true,
+    "strict": true,
+    "strictNullChecks": true,
+    "types": ["node", "jest"],
+    "module": "commonjs",
+    "outDir": "dist/cjs",
+    "target": "esnext"
+  },
+  "compileOnSave": true,
+  "exclude": ["node_modules", "dist"],
+  "include": ["src/**/*.*", "test/**/*.*", ".eslintrc.cjs"]
 }
+
+================
+File: examples/V2 - Classic/Rest/rest-trade-futures.ts
+================
+import {
+  FuturesPlaceOrderRequestV2,
+  RestClientV2,
+  WebsocketClientV2,
+} from '../../../src/index.js';
 ⋮----
-export interface BrokerSubAccountV3 {
-  subUid: string;
-  subaccountName: string;
-  subaccountEmail: string | null;
-  status: 'normal' | 'freeze';
-  permList: string[];
-  label: string;
-  language: string;
-  cTime: string;
-  uTime: string;
-}
+// or
+// import { FuturesPlaceOrderRequestV2, RestClientV2, WebsocketClientV2 } from '../src';
 ⋮----
-export interface GetBrokerSubAccountListResponseV3 {
-  subList: BrokerSubAccountV3[];
-}
+// read from environmental variables
 ⋮----
-export interface ModifyBrokerSubAccountResponseV3 {
-  subUid: string;
-  subaccountName: string;
-  status: 'normal' | 'freeze';
-  permList: string[];
-  label: string;
-  cTime: string;
-  uTime: string;
-}
+// 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/rest-trade-futures.ts
 ⋮----
-export interface BrokerSubWithdrawalResponseV3 {
-  orderId: string;
-  clientOid: string;
-}
+// note the single quotes, preventing special characters such as $ from being incorrectly passed
 ⋮----
-export interface BrokerSubDepositAddressV3 {
-  subUid: string;
-  coin: string;
-  address: string;
-  chain: string;
-  tag: string | null;
-  url: string;
-  cTime: string;
-}
+// apiKey: 'apiKeyHere',
+// apiSecret: 'apiSecretHere',
+// apiPass: 'apiPassHere',
 ⋮----
-export interface BrokerSubDepositWithdrawalRecordV3 {
-  uid: string;
-  txId: string;
-  type: 'deposit' | 'withdrawal';
-  subType: 'onchain' | 'internal' | 'fast';
-  coin: string;
-  amount: string;
-  status: 'pending' | 'fail' | 'success';
-  ts: string;
-}
+function logWSEvent(type: string, data: any)
 ⋮----
-export interface GetBrokerAllSubDepositWithdrawalResponseV3 {
-  list: BrokerSubDepositWithdrawalRecordV3[];
-  endId: string;
-}
+// simple sleep function
+function promiseSleep(milliseconds: number)
 ⋮----
-export interface BrokerCommissionRecordV3 {
-  uid: string;
-  coin: string;
-  symbol: string;
-  dealtAmount: string;
-  totalFee: string;
-  deductedFee: string;
-  paidFee: string;
-  markUpFee: string;
-  totalCommission: string;
-}
+/**
+ * This is a simple script wrapped in a immediately invoked function expression (to execute the below workflow immediately).
+ *
+ * It is designed to:
+ * - open a private websocket channel to log account events
+ * - check for any available USDT balance in the futures account
+ * - immediately open a minimum sized long position on BTCUSDT
+ * - check active positions
+ * - immediately send closing orders for any active futures positions
+ * - check positions again
+ *
+ */
 ⋮----
-export interface CreateBrokerSubApiKeyResponseV3 {
-  subUid: string;
-  label: string;
-  apiKey: string;
-  secretKey: string;
-  permType: 'read_and_write' | 'readonly';
-  permList: string[];
-  ipList: string[] | null;
-}
+// Add event listeners to log websocket events on account
 ⋮----
-export interface ModifyBrokerSubApiKeyResponseV3 {
-  subUid: string;
-  label: string;
-  apiKey: string;
-  permType: 'read_and_write' | 'readonly';
-  permList: string[];
-  ipList: string[];
-}
+// futures private
+// : account updates
 ⋮----
-export interface GetBrokerSubApiKeyResponseV3 {
-  subUid: string;
-  label: string;
-  apiKey: string;
-  secretKey: string;
-  permType: 'read_and_write' | 'readonly';
-  permList: string[];
-  ipList: string[] | null;
-}
+// : position updates
+⋮----
+// : order updates
+⋮----
+// wait briefly for ws to be ready (could also use the response or authenticated events, to make sure topics are subscribed to before starting)
+⋮----
+// const balances = allBalances.filter((bal) => Number(bal.available) != 0);
+⋮----
+// Loop through any active positions and send a closing market order on each position
 
 ================
-File: src/types/response/v3/loan.ts
+File: examples/V2 - Classic/Rest/rest-trade-spot.ts
 ================
-export interface LoanTransfersV3 {
-  coin: string;
-  transfered: string;
-  userId: string;
-}
-⋮----
-export interface LoanSymbolSettingV3 {
-  symbol: string;
-  leverage: string;
-}
-⋮----
-export interface LoanSymbolsV3 {
-  productId: string;
-  spotSymbols: string[];
-  marginLeverage: string;
-  usdtContractLeverage: string;
-  coinContractLeverage: string;
-  usdcContractLeverage: string;
-  usdtContractSymbols: LoanSymbolSettingV3[];
-  coinContractSymbols: LoanSymbolSettingV3[];
-  usdcContractSymbols: LoanSymbolSettingV3[];
-}
+import {
+  RestClientV2,
+  SpotOrderRequestV2,
+  WebsocketClientV2,
+} from '../../../src/index.js';
 ⋮----
-export interface RepaidHistoryItemV3 {
-  repayOrderId: string;
-  businessType: 'normal' | 'liquidation';
-  repayType: 'all' | 'part';
-  repaidTime: string;
-  coin: string;
-  repayAmount: string;
-  repayInterest: string;
-}
+// import { RestClientV2, WebsocketClient } from '../src/index';
 ⋮----
-export interface LoanProductInfoV3 {
-  productId: string;
-  leverage: string;
-  supportUsdtContract: 'YES' | 'NO';
-  supportCoinContract: 'YES' | 'NO';
-  supportUsdcContract: 'YES' | 'NO';
-  transferLine: string;
-  spotBuyLine: string;
-  usdtContractOpenLine: string;
-  coinContractOpenLine: string;
-  usdcContractOpenLine: string;
-  liquidationLine: string;
-  stopLiquidationLine: string;
-}
+// read from environmental variables
 ⋮----
-export interface LoanOrderV3 {
-  orderId: string;
-  orderProductId: string;
-  uid: string;
-  loanTime: string;
-  loanCoin: string;
-  loanAmount: string;
-  unpaidAmount: string;
-  unpaidInterest: string;
-  repaidAmount: string;
-  repaidInterest: string;
-  reserve: string;
-  status: 'not_paid_off' | 'paid_off';
-}
+// 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/rest-trade-spot.ts
 ⋮----
-export interface CoinInfoV3 {
-  coin: string;
-  convertRatio: string;
-  maxConvertValue: string;
-}
+// note the single quotes, preventing special characters such as $ from being incorrectly passed
 ⋮----
-export interface BindUidResponseV3 {
-  riskUnitId: string;
-  uid: string;
-  operate: 'bind' | 'unbind';
-}
+// apiKey: 'apiKeyHere',
+// apiSecret: 'apiSecretHere',
+// apiPass: 'apiPassHere',
 ⋮----
-export interface UnpaidInfoV3 {
-  coin: string;
-  unpaidQty: string;
-  unpaidInterest: string;
-}
+function logWSEvent(type: string, data: any)
 ⋮----
-export interface BalanceInfoV3 {
-  coin: string;
-  price: string;
-  amount: string;
-  convertedUsdtAmount: string;
-}
+// simple sleep function
+function promiseSleep(milliseconds: number)
 ⋮----
-export interface LTVConvertResponseV3 {
-  ltv: string;
-  subAccountUids: string[];
-  unpaidUsdtAmount: string;
-  usdtBalance: string;
-  unpaidInfo: UnpaidInfoV3[];
-  balanceInfo: BalanceInfoV3[];
-}
-
-================
-File: src/types/shared.ts
-================
-import { REST_CLIENT_TYPE_ENUM } from '../util/requestUtils.js';
+/** This is a simple script wrapped in a immediately invoked function expression, designed to check for any available BTC balance and immediately sell the full amount for USDT */
 ⋮----
-export type numberInString = string;
+// Add event listeners to log websocket events on account
 ⋮----
-export type OrderSide = 'Buy' | 'Sell';
+// Subscribe to private account topics
+// spot private
+// : account updates
 ⋮----
-/**
- * @deprecated use SpotKlineInterval or FuturesKlineInterval, depending on which API group you're using
- */
-export type KlineInterval =
-  | '1min'
-  | '5min'
-  | '15min'
-  | '30min'
-  | '1h'
-  | '4h'
-  | '6h'
-  | '12h'
-  | '1M'
-  | '1W'
-  | '1week'
-  | '6Hutc'
-  | '12Hutc'
-  | '1Dutc'
-  | '3Dutc'
-  | '1Wutc'
-  | '1Mutc';
+// : order updates (note: symbol is required)
 ⋮----
-export type RestClientType =
-  (typeof REST_CLIENT_TYPE_ENUM)[keyof typeof REST_CLIENT_TYPE_ENUM];
+// wait briefly for ws to be ready (could also use the response or authenticated events, to make sure topics are subscribed to before starting)
 ⋮----
-export interface APIResponse<T> {
-  code: string;
-  requestTime: number;
-  msg: 'success' | string;
-  data: T;
-}
+// console.log('balance: ', JSON.stringify(balances, null, 2));
 
 ================
-File: webpack/webpack.config.cjs
+File: examples/V2 - Classic/Websocket/ws-demo-trading.ts
 ================
-function generateConfig(name)
+import { DefaultLogger, WebsocketClientV2 } from '../../../src/index.js';
 ⋮----
-// Add '.ts' and '.tsx' as resolvable extensions.
+// or
+// import { DefaultLogger, WS_KEY_MAP, WebsocketClientV2 } from 'bitget-api';
 ⋮----
-// Node.js core modules not available in browsers
-// The REST client's https.Agent (for keepAlive) is Node.js-only and won't work in browsers
+// 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
 ⋮----
-// Code is already transpiled from TypeScript, no additional loaders needed
-
-================
-File: .eslintrc.cjs
-================
-// 'no-unused-vars': ['warn'],
+// restOptions: {
+// optionally provide rest options, e.g. to pass through a proxy
+// },
+⋮----
+// Set demoTrading to true, to route all connections to the demo trading wss URLs:
+⋮----
+// If using private topics, make sure to include API keys
+⋮----
+// console.log('WS raw message received ', JSON.stringify(data, null, 2));
+⋮----
+/**
+   * Public events
+   */
 
 ================
-File: jest.config.ts
+File: examples/V2 - Classic/Websocket/ws-private.ts
 ================
-/**
- * For a detailed explanation regarding each configuration property, visit:
- * https://jestjs.io/docs/configuration
- */
+import { DefaultLogger, WebsocketClientV2 } from '../../../src/index.js';
 ⋮----
-import type { Config } from 'jest';
+// or
+// import { DefaultLogger, WS_KEY_MAP, WebsocketClientV2 } from 'bitget-api';
 ⋮----
-// All imported modules in your tests should be mocked automatically
-// automock: false,
+// 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
 ⋮----
-// Stop running tests after `n` failures
-// bail: 0,
-bail: false, // enable to stop test when an error occur,
+// note the single quotes, preventing special characters such as $ from being incorrectly passed
 ⋮----
-// The directory where Jest should store its cached dependency information
-// cacheDirectory: "/private/var/folders/kf/2k3sz4px6c9cbyzj1h_b192h0000gn/T/jest_dx",
+// restOptions: {
+// optionally provide rest options, e.g. to pass through a proxy
+// },
 ⋮----
-// Automatically clear mock calls, instances, contexts and results before every test
+// console.log('WS raw message received ', JSON.stringify(data, null, 2));
 ⋮----
-// Indicates whether the coverage information should be collected while executing the test
+// auth happens async after the ws connection opens
 ⋮----
-// An array of glob patterns indicating a set of files for which coverage information should be collected
+// wsClient.subscribePublicSpotTickers(['BTCUSDT', 'LTCUSDT']);
 ⋮----
-// The directory where Jest should output its coverage files
+/**
+   * Private account updates
+   */
 ⋮----
-// An array of regexp pattern strings used to skip coverage collection
-// coveragePathIgnorePatterns: [
-//   "/node_modules/"
-// ],
+// spot private
+// : account updates
 ⋮----
-// Indicates which provider should be used to instrument code for coverage
+// : order updates (note: symbol is required)
+// wsClient.subscribeTopic('SPOT', 'orders', 'BTCUSDT');
 ⋮----
-// A list of reporter names that Jest uses when writing coverage reports
-// coverageReporters: [
-//   "json",
-//   "text",
-//   "lcov",
-//   "clover"
-// ],
+// futures private
+// : account updates
 ⋮----
-// An object that configures minimum threshold enforcement for coverage results
-// coverageThreshold: undefined,
+// : position updates
+// wsClient.subscribeTopic('USDT-FUTURES', 'positions');
 ⋮----
-// A path to a custom dependency extractor
-// dependencyExtractor: undefined,
+// : order updates
+// wsClient.subscribeTopic('USDT-FUTURES', 'orders');
 ⋮----
-// Make calling deprecated APIs throw helpful error messages
-// errorOnDeprecated: false,
+// : plan order updates
+// wsClient.subscribeTopic('USDT-FUTURES', 'orders-algo');
 ⋮----
-// The default configuration for fake timers
-// fakeTimers: {
-//   "enableGlobally": false
+// wsClient
+//   .getWsStore()
+//   .getKeys()
+//   .forEach((wsKey) => {
+//     const state = wsClient.getWsStore().get(wsKey);
+//     console.log(`${wsKey} state: `, state.subscribedTopics.values());
+//   });
+⋮----
+// setTimeout(() => {
+//   wsClient.unsubscribeTopic('USDT-FUTURES', 'account');
+// }, 1000 * 2);
+⋮----
+// setTimeout(() => {
+//   wsClient
+//     .getWsStore()
+//     .getKeys()
+//     .forEach((wsKey) => {
+//       const state = wsClient.getWsStore().get(wsKey);
+//       console.log(`${wsKey} state: `, state.subscribedTopics.values());
+//     });
+// }, 1000 * 5);
+
+================
+File: examples/V2 - Classic/Websocket/ws-public.ts
+================
+import {
+  DefaultLogger,
+  WebsocketClientV2,
+  WS_KEY_MAP,
+} from '../../../src/index.js';
+⋮----
+// or
+// import { DefaultLogger, WS_KEY_MAP, WebsocketClientV2 } from 'bitget-api';
+⋮----
+// restOptions: {
+// optionally provide rest options, e.g. to pass through a proxy
 // },
 ⋮----
-// Force coverage collection from ignored files using an array of glob patterns
-// forceCoverageMatch: [],
+// console.log('WS raw message received ', JSON.stringify(data, null, 2));
 ⋮----
-// A path to a module which exports an async function that is triggered once before all test suites
-// globalSetup: undefined,
+/**
+   * Public events
+   */
 ⋮----
-// A path to a module which exports an async function that is triggered once after all test suites
-// globalTeardown: undefined,
+// Spot public
 ⋮----
-// A set of global variables that need to be available in all test environments
-// globals: {},
+// tickers
 ⋮----
-// The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
-// maxWorkers: "50%",
+// candles
+// wsClient.subscribeTopic('SPOT', 'candle1m', symbol);
 ⋮----
-// An array of directory names to be searched recursively up from the requiring module's location
-// moduleDirectories: [
-//   "node_modules"
-// ],
+// orderbook updates
+// wsClient.subscribeTopic('SPOT', 'books', symbol);
 ⋮----
-// An array of file extensions your modules use
+// trades
+// wsClient.subscribeTopic('SPOT', 'trade', symbol);
+⋮----
+// Futures public
+⋮----
+// tickers
+// wsClient.subscribeTopic('USDT-FUTURES', 'ticker', symbol);
+⋮----
+// candles
+// wsClient.subscribeTopic('USDT-FUTURES', 'candle1m', symbol);
+⋮----
+// orderbook updates
+// wsClient.subscribeTopic('USDT-FUTURES', 'books', symbol);
+⋮----
+// trades
+// wsClient.subscribeTopic('USDT-FUTURES', 'trade', symbol);
+⋮----
+// Topics are tracked per websocket type
+// Get a list of subscribed topics (e.g. all  public topics) (after a 5 second delay)
+
+================
+File: examples/V3 - UTA/Rest/rest-trade-UTA-futures.ts
+================
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import {
+  PlaceOrderRequestV3,
+  RestClientV3,
+  WebsocketClientV3,
+} from '../../../src/index.js';
 ⋮----
-// modulePaths: ['src'],
+// or
+// import { PlaceOrderRequestV3, RestClientV3, WebsocketClientV3 } from '../src';
 ⋮----
-// A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
-// moduleNameMapper: {},
+// read from environmental variables
 ⋮----
-// An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
-// modulePathIgnorePatterns: [],
+// 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/V3/rest-trade-futures.ts
 ⋮----
-// Activates notifications for test results
-// notify: false,
+// note the single quotes, preventing special characters such as $ from being incorrectly passed
 ⋮----
-// An enum that specifies notification mode. Requires { notify: true }
-// notifyMode: "failure-change",
+// apiKey: 'apiKeyHere',
+// apiSecret: 'apiSecretHere',
+// apiPass: 'apiPassHere',
 ⋮----
-// A preset that is used as a base for Jest's configuration
-// preset: undefined,
+function logWSEvent(type: string, data: any)
 ⋮----
-// Run tests from one or more projects
-// projects: undefined,
+// simple sleep function
+function promiseSleep(milliseconds: number)
 ⋮----
-// Use this configuration option to add custom reporters to Jest
-// reporters: undefined,
+/**
+ * This is a simple script wrapped in a immediately invoked function expression (to execute the below workflow immediately).
+ *
+ * It is designed to:
+ * - open a private websocket channel to log account events
+ * - check for any available USDT balance in the account
+ * - immediately open a minimum sized long position on BTCUSDT
+ * - check active positions
+ * - immediately send closing orders for any active futures positions
+ * - check positions again
+ *
+ */
 ⋮----
-// Automatically reset mock state before every test
-// resetMocks: false,
+// Add event listeners to log websocket events on account
 ⋮----
-// Reset the module registry before running each individual test
-// resetModules: false,
+// Subscribe to private topics for UTA account
 ⋮----
-// A path to a custom resolver
-// resolver: undefined,
+// Subscribe to position updates
 ⋮----
-// Automatically restore mock state and implementation before every test
-// restoreMocks: false,
+// Subscribe to order updates
 ⋮----
-// The root directory that Jest should scan for tests and modules within
-// rootDir: undefined,
+// wait briefly for ws to be ready (could also use the response or authenticated events, to make sure topics are subscribed to before starting)
 ⋮----
-// A list of paths to directories that Jest should use to search for files in
-// roots: [
-//   "<rootDir>"
-// ],
+// Loop through any active positions and send a closing market order on each position
+
+================
+File: examples/V3 - UTA/Rest/rest-trade-UTA-spot.ts
+================
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import {
+  PlaceOrderRequestV3,
+  RestClientV3,
+  WebsocketClientV3,
+} from '../../../src/index.js';
 ⋮----
-// Allows you to use a custom runner instead of Jest's default test runner
-// runner: "jest-runner",
+// import { RestClientV3, WebsocketClientV3 } from '../src/index';
 ⋮----
-// The paths to modules that run some code to configure or set up the testing environment before each test
-// setupFiles: [],
+// read from environmental variables
 ⋮----
-// A list of paths to modules that run some code to configure or set up the testing framework before each test
-// setupFilesAfterEnv: [],
+// 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/V3/rest-trade-spot.ts
 ⋮----
-// The number of seconds after which a test is considered as slow and reported as such in the results.
-// slowTestThreshold: 5,
+// note the single quotes, preventing special characters such as $ from being incorrectly passed
 ⋮----
-// A list of paths to snapshot serializer modules Jest should use for snapshot testing
-// snapshotSerializers: [],
+// apiKey: 'apiKeyHere',
+// apiSecret: 'apiSecretHere',
+// apiPass: 'apiPassHere',
 ⋮----
-// The test environment that will be used for testing
-// testEnvironment: "jest-environment-node",
+function logWSEvent(type: string, data: any)
 ⋮----
-// Options that will be passed to the testEnvironment
-// testEnvironmentOptions: {},
+// simple sleep function
+function promiseSleep(milliseconds: number)
 ⋮----
-// Adds a location field to test results
-// testLocationInResults: false,
+/** This is a simple script wrapped in a immediately invoked function expression, designed to check for any available BTC balance and immediately sell the full amount for USDT */
 ⋮----
-// The glob patterns Jest uses to detect test files
+// Add event listeners to log websocket events on account
 ⋮----
-// "**/__tests__/**/*.[jt]s?(x)",
+// Subscribe to private account topics
+// Account updates for UTA (unified trading account)
 ⋮----
-// An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
-// testPathIgnorePatterns: [
-//   "/node_modules/"
-// ],
+// Order updates for spot
 ⋮----
-// The regexp pattern or array of patterns that Jest uses to detect test files
-// testRegex: [],
+// wait briefly for ws to be ready (could also use the response or authenticated events, to make sure topics are subscribed to before starting)
+
+================
+File: examples/V3 - UTA/Websocket/ws-private.ts
+================
+import {
+  DefaultLogger,
+  WebsocketClientV3,
+  WS_KEY_MAP,
+} from '../../../src/index.js';
 ⋮----
-// This option allows the use of a custom results processor
-// testResultsProcessor: undefined,
+// or
+// import { DefaultLogger, WS_KEY_MAP, WebsocketClientV2 } from 'bitget-api';
 ⋮----
-// This option allows use of a custom test runner
-// testRunner: "jest-circus/runner",
+// 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
 ⋮----
-// A map from regular expressions to paths to transformers
-// transform: undefined,
+// console.log('WS raw message received ', JSON.stringify(data, null, 2));
 ⋮----
-// An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
-// transformIgnorePatterns: [
-//   "/node_modules/",
-//   "\\.pnp\\.[^\\/]+$"
-// ],
+// You can subscribe to one topic at a time
 ⋮----
-// Prevents import esm module error from v1 axios release, issue #5026
+instType: 'UTA', // Note: all account events go on the UTA instType
 ⋮----
-// An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
-// unmockedModulePathPatterns: undefined,
+WS_KEY_MAP.v3Private, // This parameter points to private or public
 ⋮----
-// Indicates whether each individual test should be reported during the run
-// verbose: undefined,
-verbose: true, // report individual test
+// Note: all account events go on the UTA instType
 ⋮----
-// An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
-// watchPathIgnorePatterns: [],
+// Or multiple at once:
 ⋮----
-// Whether to use watchman for file crawling
-// watchman: true,
-
-================
-File: tea.yaml
-================
-# https://tea.xyz/what-is-this-file
----
-version: 1.0.0
-codeOwners:
-  - '0xeb1a7BF44a801e33a339705A266Afc0Cba3D6D54'
-quorum: 1
-
-================
-File: tsconfig.json
-================
-{
-  "compilerOptions": {
-    "allowSyntheticDefaultImports": true,
-    "baseUrl": ".",
-    "noEmitOnError": true,
-    "declaration": true,
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": false,
-    "inlineSourceMap": false,
-    "lib": ["esnext", "DOM"],
-    "listEmittedFiles": false,
-    "listFiles": false,
-    "moduleResolution": "node",
-    "noFallthroughCasesInSwitch": true,
-    "noImplicitAny": true,
-    "noUnusedParameters": true,
-    "pretty": true,
-    "removeComments": false,
-    "resolveJsonModule": true,
-    "skipLibCheck": false,
-    "sourceMap": true,
-    "strict": true,
-    "strictNullChecks": true,
-    "types": ["node", "jest"],
-    "module": "commonjs",
-    "outDir": "dist/cjs",
-    "target": "esnext"
-  },
-  "compileOnSave": true,
-  "exclude": ["node_modules", "dist"],
-  "include": ["src/**/*.*", "test/**/*.*", ".eslintrc.cjs"]
-}
+// Topics are tracked per websocket type
+// The below example will pull a list of subscribed topics on that connection (e.g. all private topics), after a 5 second delay:
 
 ================
-File: examples/V3 - UTA/WS-API/ws-api-client-trade.ts
+File: examples/V3 - UTA/Websocket/ws-public.ts
 ================
-import { DefaultLogger, WebsocketAPIClient } from '../../../src/index.js';
+import {
+  DefaultLogger,
+  WebsocketClientV3,
+  WS_KEY_MAP,
+} from '../../../src/index.js';
 ⋮----
 // or
-// import { DefaultLogger, WS_KEY_MAP, WebsocketAPIClient } from 'bitget-api';
+// import { DefaultLogger, WS_KEY_MAP, WebsocketClientV2 } from 'bitget-api';
 ⋮----
-// function attachEventHandlers<TWSClient extends WebsocketClientV3>(
-//   wsClient: TWSClient,
-// ): void {
-//   wsClient.on('update', (data) => {
-//     console.log('raw message received ', JSON.stringify(data));
-//   });
-//   wsClient.on('open', (data) => {
-//     console.log('ws connected', data.wsKey);
-//   });
-//   wsClient.on('reconnect', ({ wsKey }) => {
-//     console.log('ws automatically reconnecting.... ', wsKey);
-//   });
-//   wsClient.on('reconnected', (data) => {
-//     console.log('ws has reconnected ', data?.wsKey);
-//   });
-//   wsClient.on('authenticated', (data) => {
-//     console.log('ws has authenticated ', data?.wsKey);
-//   });
-// }
+// console.log('WS raw message received ', JSON.stringify(data, null, 2));
 ⋮----
-// 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
+/**
+   * Public events
+   */
 ⋮----
-// Whether to use the demo trading wss connection
-// demoTrading: true,
+// You can subscribe to one topic at a time
 ⋮----
-// If you want your own event handlers instead of the default ones with logs,
-// disable this setting and see the `attachEventHandlers` example below:
-// attachEventListeners: false
+WS_KEY_MAP.v3Public, // This parameter points to private or public
+⋮----
+// Or multiple at once:
+⋮----
+// Topics are tracked per websocket type
+// The below example will pull a list of subscribed topics on that connection (e.g. all public topics), after a 5 second delay:
+
+================
+File: examples/V3 - UTA/WS-API/ws-api-trade-raw.ts
+================
+import {
+  DefaultLogger,
+  WebsocketClientV3,
+  WS_KEY_MAP,
+} from '../../../src/index.js';
 ⋮----
-logger, // Optional: inject a custom logger
+// or
+// import { DefaultLogger, WS_KEY_MAP, WebsocketClientV3 } from 'bitget-api';
 ⋮----
-// Optional, see above "attachEventListeners". Attach basic event handlers, so nothing is left unhandled
-// attachEventHandlers(wsClient.getWSClient());
+// 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
 ⋮----
-// 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.
+// console.log('WS raw message received ', JSON.stringify(data, null, 2));
 ⋮----
 /**
-   * Bitget's WebSocket API be used like a REST API, through this SDK's WebsocketAPIClient. The WebsocketAPIClient is a utility class wrapped around WebsocketClientV3's sendWSAPIRequest() capabilities.
+   * Bitget's WebSocket API can be used via the sendWSAPIRequest() method.
    *
-   * 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
+   * Use the `WS_KEY_MAP.v3Private` connection key for any requests.
    *
    * Note: this requires V3/UTA API keys!
+   * Note: for a better user experience, it is recommended to use the WebsocketAPIClient.
    */
 ⋮----
+// Use the V3 private wss connection URL
+⋮----
 /**
    * Place Order
    * https://www.bitget.com/api-doc/uta/websocket/private/Place-Order-Channel#request-parameters
@@ -7026,6 +7081,174 @@ dist
 repomix.sh
 coverage
 
+================
+File: examples/V3 - UTA/WS-API/ws-api-client-trade.ts
+================
+import { DefaultLogger, WebsocketAPIClient } from '../../../src/index.js';
+⋮----
+// or
+// import { DefaultLogger, WS_KEY_MAP, WebsocketAPIClient } from 'bitget-api';
+⋮----
+// function attachEventHandlers<TWSClient extends WebsocketClientV3>(
+//   wsClient: TWSClient,
+// ): void {
+//   wsClient.on('update', (data) => {
+//     console.log('raw message received ', JSON.stringify(data));
+//   });
+//   wsClient.on('open', (data) => {
+//     console.log('ws connected', data.wsKey);
+//   });
+//   wsClient.on('reconnect', ({ wsKey }) => {
+//     console.log('ws automatically reconnecting.... ', wsKey);
+//   });
+//   wsClient.on('reconnected', (data) => {
+//     console.log('ws has reconnected ', data?.wsKey);
+//   });
+//   wsClient.on('authenticated', (data) => {
+//     console.log('ws has authenticated ', data?.wsKey);
+//   });
+// }
+⋮----
+// 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
+⋮----
+// Whether to use the demo trading wss connection
+// demoTrading: true,
+⋮----
+// If you want your own event handlers instead of the default ones with logs,
+// disable this setting and see the `attachEventHandlers` example below:
+// attachEventListeners: false
+⋮----
+logger, // Optional: inject a custom logger
+⋮----
+// Optional, see above "attachEventListeners". Attach basic event handlers, so nothing is left unhandled
+// attachEventHandlers(wsClient.getWSClient());
+⋮----
+// 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.
+⋮----
+/**
+   * Bitget's WebSocket API be used like a REST API, through this SDK's WebsocketAPIClient. The WebsocketAPIClient is a utility class wrapped around WebsocketClientV3'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
+   *
+   * Note: this requires V3/UTA API keys!
+   */
+⋮----
+/**
+   * Place Order
+   * https://www.bitget.com/api-doc/uta/websocket/private/Place-Order-Channel#request-parameters
+   */
+⋮----
+/**
+      const res = {
+        "event": "trade",
+        "id": "1750034396082",
+        "category": "spot",
+        "topic": "place-order",
+        "args": [
+          {
+            "symbol": "BTCUSDT",
+            "orderId": "xxxxxxxx",
+            "clientOid": "xxxxxxxx",
+            "cTime": "1750034397008"
+          }
+        ],
+        "code": "0",
+        "msg": "success",
+        "ts": "1750034397076"
+      };
+     */
+⋮----
+/**
+   * Batch Place Order Channel
+   * https://www.bitget.com/api-doc/uta/websocket/private/Batch-Place-Order-Channel
+   */
+⋮----
+/**
+     * Note: batch place will never reject the request, even if all orders were rejected. Check the "code" and "msg" properties for individual orders in the response, to detect batch place errors.
+     */
+⋮----
+/**
+      const res = {
+        "event": "trade",
+        "id": "1750035029506",
+        "category": "spot",
+        "topic": "batch-place",
+        "args": [
+          {
+            "code": "0",
+            "msg": "Success",
+            "symbol": "BTCUSDT",
+            "orderId": "xxxxxxxx",
+            "clientOid": "xxxxxxxx"
+          },
+          {
+            "code": "0",
+            "msg": "Success",
+            "symbol": "BTCUSDT",
+            "orderId": "xxxxxxxx",
+            "clientOid": "xxxxxxxx"
+          }
+        ],
+        "code": "0",
+        "msg": "Success",
+        "ts": "1750035029925"
+      }
+     */
+⋮----
+/**
+   * Cancel Order
+   * https://www.bitget.com/api-doc/uta/websocket/private/Cancel-Order-Channel
+   */
+⋮----
+/**
+      const res = {
+        "event": "trade",
+        "id": "1750034870205",
+        "topic": "cancel-order",
+        "args": [
+          {
+            "orderId": "xxxxxxxx",
+            "clientOid": "xxxxxxxx"
+          }
+        ],
+        "code": "0",
+        "msg": "Success",
+        "ts": "1750034870597"
+      }
+     */
+⋮----
+/**
+   * Batch Cancel Order
+   * https://www.bitget.com/api-doc/uta/websocket/private/Batch-Cancel-Order-Channel
+   */
+⋮----
+/**
+      const res = {
+        "event": "trade",
+        "id": "bb553cc0-c1fa-454e-956d-c96c8d715760",
+        "topic": "batch-cancel",
+        "args": [
+          {
+            "code": "0",
+            "msg": "Success",
+            "orderId": "xxxxxxxxxxxxx"
+          },
+          {
+            "code": "25204",
+            "msg": "Order does not exist",
+            "orderId": "xxxxxxxxxxxxx"
+          }
+        ],
+        "code": "0",
+        "msg": "Success",
+        "ts": "1751980011084"
+      }
+     */
+
 ================
 File: src/types/request/v2/futures.ts
 ================
@@ -7659,8 +7882,12 @@ export interface TransferRequestV3 {
   amount: string;
   coin: string;
   symbol?: string;
+  /** Enable automatic margin borrowing when balance insufficient. yes | no */
+  allowBorrow?: 'yes' | 'no';
 }
 ⋮----
+/** Enable automatic margin borrowing when balance insufficient. yes | no */
+⋮----
 export interface GetTransferableCoinsRequestV3 {
   fromType:
     | 'spot'
@@ -7715,8 +7942,12 @@ export interface SubAccountTransferRequestV3 {
   fromUserId: string;
   toUserId: string;
   clientOid: string;
+  /** Enable automatic margin borrowing when balance insufficient. yes | no */
+  allowBorrow?: 'yes' | 'no';
 }
 ⋮----
+/** Enable automatic margin borrowing when balance insufficient. yes | no */
+⋮----
 export interface GetSubUnifiedAssetsRequestV3 {
   subUid?: string;
   cursor?: string;
@@ -8631,7 +8862,8 @@ export interface InstrumentV3 {
   deliveryTime?: string;
   deliveryStartTime?: string;
   deliveryPeriod?: string;
-  launchTime?: string;
+  /** Launch time - Unix millisecond timestamp. Null for some margin pairs. */
+  launchTime?: string | null;
   fundInterval?: string;
   minLeverage?: string;
   maxLeverage?: string;
@@ -8648,8 +8880,37 @@ export interface InstrumentV3 {
 ⋮----
 // Futures specific fields
 ⋮----
+/** Launch time - Unix millisecond timestamp. Null for some margin pairs. */
+⋮----
 // Margin specific fields
 ⋮----
+export interface MarketFeeGroupLabelV3 {
+  weight: string;
+  label: string;
+  symbols: string[];
+}
+⋮----
+export interface MarketFeeGroupTierV3 {
+  level: string;
+  makerFeeRate: string;
+}
+⋮----
+export interface MarketFeeGroupV3 {
+  category: string;
+  group: string;
+  labelList: MarketFeeGroupLabelV3[];
+  tierList: MarketFeeGroupTierV3[];
+}
+⋮----
+export interface MarketScoreWeightV3 {
+  category: string;
+  label: string;
+  symbol: string;
+  requiredSpread: string;
+  minMakerVolume: string;
+  weight: string;
+}
+⋮----
 export interface OrderBookV3 {
   a: string[][]; // asks - [price, size]
   b: string[][]; // bids - [price, size]
@@ -9258,6 +9519,9 @@ File: README.md
 
 [1]: https://www.npmjs.com/package/bitget-api
 
+> [!TIP]
+> Upcoming change: As part of the [Siebly.io](https://siebly.io/?ref=ghbitget) brand, this SDK will soon be hosted under the [Siebly.io GitHub organisation](https://github.com/sieblyio). The migration is seamless and requires no user changes.
+
 Updated & performant JavaScript & Node.js SDK for the Bitget V2 REST APIs and WebSockets:
 
 - Professional, robust & performant Bitget SDK with extensive production use in live trading environments.
@@ -12402,12 +12666,22 @@ import {
 import {
   BindUidRequestV3,
   GetEnsureCoinsRequestV3,
+  GetLoanBorrowHistoryRequestV3,
+  GetLoanBorrowOngoingRequestV3,
+  GetLoanCoinsRequestV3,
+  GetLoanInterestRequestV3,
   GetLoanOrderRequestV3,
+  GetLoanPledgeRateHistoryRequestV3,
+  GetLoanReducesRequestV3,
+  GetLoanRepayHistoryRequestV3,
   GetLTVConvertRequestV3,
   GetProductInfosRequestV3,
   GetRepaidHistoryRequestV3,
   GetSymbolsRequestV3,
   GetTransferedRequestV3,
+  LoanBorrowRequestV3,
+  LoanRepayRequestV3,
+  LoanRevisePledgeRequestV3,
 } from './types/request/v3/loan.js';
 import {
   GetCandlesRequestV3,
@@ -12418,6 +12692,8 @@ import {
   GetIndexComponentsRequestV3,
   GetInstrumentsRequestV3,
   GetMarginLoansRequestV3,
+  GetMarketFeeGroupRequestV3,
+  GetMarketScoreWeightsRequestV3,
   GetOpenInterestRequestV3,
   GetOrderBookRequestV3,
   GetPositionTierRequestV3,
@@ -12490,8 +12766,19 @@ import {
 import {
   BindUidResponseV3,
   CoinInfoV3,
+  GetLoanCoinsResponseV3,
+  GetLoanDebtsResponseV3,
+  GetLoanInterestResponseV3,
+  LoanBorrowHistoryItemV3,
+  LoanBorrowOngoingItemV3,
+  LoanBorrowResponseV3,
   LoanOrderV3,
+  LoanPledgeRateHistoryItemV3,
   LoanProductInfoV3,
+  LoanReduceItemV3,
+  LoanRepayHistoryItemV3,
+  LoanRepayResponseV3,
+  LoanRevisePledgeResponseV3,
   LoanSymbolsV3,
   LoanTransfersV3,
   LTVConvertResponseV3,
@@ -12506,6 +12793,8 @@ import {
   IndexPriceComponentsV3,
   InstrumentV3,
   MarginLoanV3,
+  MarketFeeGroupV3,
+  MarketScoreWeightV3,
   OpenInterestV3,
   OrderBookV3,
   PositionTierV3,
@@ -12595,6 +12884,20 @@ getInstruments(
     params: GetInstrumentsRequestV3,
 ): Promise<APIResponse<InstrumentV3[]>>
 ⋮----
+/**
+   * Get Market Maker Fee Group - Query fee rate tiers and grouping
+   */
+getMarketFeeGroup(
+    params: GetMarketFeeGroupRequestV3,
+): Promise<APIResponse<MarketFeeGroupV3[]>>
+⋮----
+/**
+   * Get Market Maker Score Weight - Query score weights per symbol
+   */
+getMarketScoreWeights(
+    params?: GetMarketScoreWeightsRequestV3,
+): Promise<APIResponse<MarketScoreWeightV3[]>>
+⋮----
 /**
    * Get Tickers
    */
@@ -13256,6 +13559,87 @@ bindLoanUid(
     params: BindUidRequestV3,
 ): Promise<APIResponse<BindUidResponseV3>>
 ⋮----
+/**
+   *
+   * =====Unified Account Staking & Lending (Crypto Loans)===== /api/v3/loan/*
+   *
+   */
+⋮----
+/**
+   * Get Loan Coins - Query supported collateral currencies and borrowable coins
+   */
+getLoanCoins(
+    params?: GetLoanCoinsRequestV3,
+): Promise<APIResponse<GetLoanCoinsResponseV3>>
+⋮----
+/**
+   * Get Loan Interest - Query estimated interest and borrowable amount
+   */
+getLoanInterest(
+    params: GetLoanInterestRequestV3,
+): Promise<APIResponse<GetLoanInterestResponseV3>>
+⋮----
+/**
+   * Borrow - Borrow coins
+   */
+loanBorrow(
+    params: LoanBorrowRequestV3,
+): Promise<APIResponse<LoanBorrowResponseV3>>
+⋮----
+/**
+   * Get Borrow Ongoing - Query current borrowings
+   */
+getLoanBorrowOngoing(
+    params?: GetLoanBorrowOngoingRequestV3,
+): Promise<APIResponse<LoanBorrowOngoingItemV3[]>>
+⋮----
+/**
+   * Get Borrow History - Query borrowing history
+   */
+getLoanBorrowHistory(
+    params: GetLoanBorrowHistoryRequestV3,
+): Promise<APIResponse<LoanBorrowHistoryItemV3[]>>
+⋮----
+/**
+   * Repay - Repay coins
+   */
+loanRepay(
+    params: LoanRepayRequestV3,
+): Promise<APIResponse<LoanRepayResponseV3>>
+⋮----
+/**
+   * Get Repay History - Query repayment history
+   */
+getLoanRepayHistory(
+    params: GetLoanRepayHistoryRequestV3,
+): Promise<APIResponse<LoanRepayHistoryItemV3[]>>
+⋮----
+/**
+   * Revise Pledge - Adjust collateral ratio
+   */
+loanRevisePledge(
+    params: LoanRevisePledgeRequestV3,
+): Promise<APIResponse<LoanRevisePledgeResponseV3>>
+⋮----
+/**
+   * Get Pledge Rate History - Query collateral ratio history
+   */
+getLoanPledgeRateHistory(
+    params: GetLoanPledgeRateHistoryRequestV3,
+): Promise<APIResponse<LoanPledgeRateHistoryItemV3[]>>
+⋮----
+/**
+   * Get Loan Debts - Query assets and liabilities
+   */
+getLoanDebts(): Promise<APIResponse<GetLoanDebtsResponseV3>>
+⋮----
+/**
+   * Get Loan Reduces - Query liquidation records
+   */
+getLoanReduces(
+    params: GetLoanReducesRequestV3,
+): Promise<APIResponse<LoanReduceItemV3[]>>
+⋮----
 /**
    *
    * =====Strategy======= endpoints
@@ -13429,7 +13813,7 @@ File: package.json
 ================
 {
   "name": "bitget-api",
-  "version": "3.1.2",
+  "version": "3.1.5",
   "description": "Complete Node.js & JavaScript SDK for Bitget V1-V3 REST APIs & WebSockets, with TypeScript & end-to-end tests.",
   "scripts": {
     "test": "jest",
@@ -13460,7 +13844,7 @@ File: package.json
     "llms.txt"
   ],
   "type": "module",
-  "author": "Tiago Siebler (https://github.com/tiagosiebler)",
+  "author": "Tiago Siebler (https://siebly.io)",
   "contributors": [],
   "dependencies": {
     "axios": "^1.13.2",