kucoin-api 2.1.21 → 2.1.22

package/llms.txt

@@ -1653,37 +1653,6 @@ File: src/lib/misc-util.ts
 ================
 export function neverGuard(x: never, msg: string): Error
 
-================
-File: src/lib/webCryptoAPI.ts
-================
-import { neverGuard } from './misc-util.js';
-⋮----
-function bufferToB64(buffer: ArrayBuffer): string
-⋮----
-export type SignEncodeMethod = 'hex' | 'base64';
-export type SignAlgorithm = 'SHA-256' | 'SHA-512';
-⋮----
-/**
- * Similar to node crypto's `createHash()` function
- */
-export async function hashMessage(
-  message: string,
-  method: SignEncodeMethod,
-  algorithm: SignAlgorithm,
-): Promise<string>
-⋮----
-/**
- * Sign a message, with a secret, using the Web Crypto API
- */
-export async function signMessage(
-  message: string,
-  secret: string,
-  method: SignEncodeMethod,
-  algorithm: SignAlgorithm,
-): Promise<string>
-⋮----
-export function checkWebCryptoAPISupported()
-
 ================
 File: src/types/request/spot-margin-trading.ts
 ================
@@ -1877,6 +1846,174 @@ export interface GetLendingSubscriptionOrdersV3Request {
   currentPage?: number;
   pageSize?: number;
 }
+⋮----
+export interface GetBorrowInterestRateRequest {
+  vipLevel?: number; // optional - If empty, default to current user vip level (0-12)
+  currency?: string; // optional - Supports multiple currencies (up to 50), comma-separated
+}
+⋮----
+vipLevel?: number; // optional - If empty, default to current user vip level (0-12)
+currency?: string; // optional - Supports multiple currencies (up to 50), comma-separated
+⋮----
+/**
+ * Margin Stop Order Requests
+ */
+export interface SubmitMarginStopOrderRequest {
+  clientOid: string; // Client Order ID
+  side: 'buy' | 'sell'; // Order side
+  symbol: string; // Trading symbol
+  type?: 'limit' | 'market'; // Order type, default: limit
+  remark?: string; // Order note, max 100 characters
+  stop?: string; // Stop condition, default: loss
+  stopPrice: string; // Trigger price (required)
+  stp?: 'DC' | 'CO' | 'CN' | 'CB'; // Self Trade Prevention
+  isIsolated: boolean; // True - isolated margin; false - cross margin
+  autoRepay: boolean; // AutoPay for borrowed assets
+  autoBorrow: boolean; // Auto borrow for insufficient balance
+  price?: string; // Order price (required for limit orders)
+  size?: string; // Order quantity (required for limit orders)
+  timeInForce?: 'GTC' | 'GTT' | 'IOC' | 'FOK'; // Time in force
+  cancelAfter?: number; // Cancel after n seconds (GTT strategy)
+  postOnly?: boolean; // Passive order labels
+  hidden?: boolean; // Hidden order
+  iceberg?: boolean; // Iceberg order
+  visibleSize?: string; // Visible size for iceberg orders
+  funds?: string; // Order funds (for market orders)
+}
+⋮----
+clientOid: string; // Client Order ID
+side: 'buy' | 'sell'; // Order side
+symbol: string; // Trading symbol
+type?: 'limit' | 'market'; // Order type, default: limit
+remark?: string; // Order note, max 100 characters
+stop?: string; // Stop condition, default: loss
+stopPrice: string; // Trigger price (required)
+stp?: 'DC' | 'CO' | 'CN' | 'CB'; // Self Trade Prevention
+isIsolated: boolean; // True - isolated margin; false - cross margin
+autoRepay: boolean; // AutoPay for borrowed assets
+autoBorrow: boolean; // Auto borrow for insufficient balance
+price?: string; // Order price (required for limit orders)
+size?: string; // Order quantity (required for limit orders)
+timeInForce?: 'GTC' | 'GTT' | 'IOC' | 'FOK'; // Time in force
+cancelAfter?: number; // Cancel after n seconds (GTT strategy)
+postOnly?: boolean; // Passive order labels
+hidden?: boolean; // Hidden order
+iceberg?: boolean; // Iceberg order
+visibleSize?: string; // Visible size for iceberg orders
+funds?: string; // Order funds (for market orders)
+⋮----
+export interface CancelMarginStopOrderByClientOidRequest {
+  clientOid: string; // Client order ID
+}
+⋮----
+clientOid: string; // Client order ID
+⋮----
+export interface BatchCancelMarginStopOrdersRequest {
+  symbol?: string; // Trading symbol
+  tradeType: 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE'; // Margin type (required)
+  orderIds?: string; // Comma separated order IDs
+}
+⋮----
+symbol?: string; // Trading symbol
+tradeType: 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE'; // Margin type (required)
+orderIds?: string; // Comma separated order IDs
+⋮----
+export interface GetMarginStopOrdersListRequest {
+  symbol?: string; // Trading symbol
+  side?: string; // Order side (buy/sell)
+  type?: 'limit' | 'market' | 'limit_stop' | 'market_stop'; // Order type
+  tradeType?: 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE'; // Margin type
+  startAt?: number; // Start time (millisecond)
+  endAt?: number; // End time (millisecond)
+  currentPage?: number; // Current page (>=1, default: 1)
+  orderIds?: string; // Comma separated order IDs
+  pageSize?: number; // Page size (>=10, <=500, default: 50)
+  stop?: 'stop' | 'oco'; // Order type
+}
+⋮----
+symbol?: string; // Trading symbol
+side?: string; // Order side (buy/sell)
+type?: 'limit' | 'market' | 'limit_stop' | 'market_stop'; // Order type
+tradeType?: 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE'; // Margin type
+startAt?: number; // Start time (millisecond)
+endAt?: number; // End time (millisecond)
+currentPage?: number; // Current page (>=1, default: 1)
+orderIds?: string; // Comma separated order IDs
+pageSize?: number; // Page size (>=10, <=500, default: 50)
+stop?: 'stop' | 'oco'; // Order type
+⋮----
+export interface GetMarginStopOrderByOrderIdRequest {
+  orderId: string; // Order ID
+}
+⋮----
+orderId: string; // Order ID
+⋮----
+export interface GetMarginStopOrderByClientOidRequest {
+  clientOid: string; // Client order ID
+}
+⋮----
+clientOid: string; // Client order ID
+⋮----
+/**
+ * Margin OCO Order Requests
+ */
+export interface SubmitMarginOcoOrderRequest {
+  symbol: string; // Trading symbol (required)
+  side: 'buy' | 'sell'; // Order side (required)
+  price: string; // Order price (required)
+  size: string; // Order quantity (required)
+  stopPrice: string; // Trigger price (required)
+  limitPrice: string; // Limit order price after trigger (required)
+  clientOid: string; // Client Order ID (required)
+  isIsolated: boolean; // true - isolated, false - cross (required)
+  autoRepay?: boolean; // Auto repay
+  autoBorrow?: boolean; // Auto borrow
+}
+⋮----
+symbol: string; // Trading symbol (required)
+side: 'buy' | 'sell'; // Order side (required)
+price: string; // Order price (required)
+size: string; // Order quantity (required)
+stopPrice: string; // Trigger price (required)
+limitPrice: string; // Limit order price after trigger (required)
+clientOid: string; // Client Order ID (required)
+isIsolated: boolean; // true - isolated, false - cross (required)
+autoRepay?: boolean; // Auto repay
+autoBorrow?: boolean; // Auto borrow
+⋮----
+export interface CancelMarginOcoOrderByOrderIdRequest {
+  orderId: string; // Order ID
+}
+⋮----
+orderId: string; // Order ID
+⋮----
+export interface CancelMarginOcoOrderByClientOidRequest {
+  clientOid: string; // Client order ID
+}
+⋮----
+clientOid: string; // Client order ID
+⋮----
+export interface BatchCancelMarginOcoOrdersRequest {
+  orderIds?: string; // Comma separated order IDs
+  symbol?: string; // Trading symbol
+  tradeType?: 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE'; // Margin type
+}
+⋮----
+orderIds?: string; // Comma separated order IDs
+symbol?: string; // Trading symbol
+tradeType?: 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE'; // Margin type
+⋮----
+export interface GetMarginOcoOrderByClientOidRequest {
+  clientOid: string; // Client order ID
+}
+⋮----
+clientOid: string; // Client order ID
+⋮----
+export interface GetMarginOcoOrderDetailByOrderIdRequest {
+  orderId: string; // Order ID
+}
+⋮----
+orderId: string; // Order ID
 
 ================
 File: src/types/request/spot-misc.ts
@@ -2468,6 +2605,37 @@ deleteTopic(key: WsKey, topic: TWSTopicSubscribeEventArgs)
 ⋮----
 // Check if we're subscribed to a topic like this
 
+================
+File: src/lib/webCryptoAPI.ts
+================
+import { neverGuard } from './misc-util.js';
+⋮----
+function bufferToB64(buffer: ArrayBuffer): string
+⋮----
+export type SignEncodeMethod = 'hex' | 'base64';
+export type SignAlgorithm = 'SHA-256' | 'SHA-512';
+⋮----
+/**
+ * Similar to node crypto's `createHash()` function
+ */
+export async function hashMessage(
+  message: string,
+  method: SignEncodeMethod,
+  algorithm: SignAlgorithm,
+): Promise<string>
+⋮----
+/**
+ * Sign a message, with a secret, using the Web Crypto API
+ */
+export async function signMessage(
+  message: string,
+  secret: string,
+  method: SignEncodeMethod,
+  algorithm: SignAlgorithm,
+): Promise<string>
+⋮----
+export function checkWebCryptoAPISupported()
+
 ================
 File: src/types/request/broker.types.ts
 ================
@@ -2585,6 +2753,24 @@ registrationStartAt?: number; // optional - Registration start timestamp
 registrationEndAt?: number; // optional - Registration end timestamp
 page?: number; // optional - Page number >= 1, default: 1
 pageSize?: number; // optional - Max number of records per page >= 1, <= 500, default: 10
+⋮----
+export interface GetAffiliateTransactionRequest {
+  uid?: string; // optional - The uid of the invitee
+  tradeType?: 'SPOT' | 'FEATURE'; // optional - Trade type
+  tradeStartAt: number; // required - Transaction start time (13-digit timestamp)
+  tradeEndAt: number; // required - Transaction end time (13-digit timestamp)
+  lastId?: number; // optional - The offset ID of the query
+  direction?: 'PRE' | 'NEXT'; // optional - Page direction, default: 'NEXT'
+  pageSize?: number; // optional - Page size >= 1, <= 500, default: 10
+}
+⋮----
+uid?: string; // optional - The uid of the invitee
+tradeType?: 'SPOT' | 'FEATURE'; // optional - Trade type
+tradeStartAt: number; // required - Transaction start time (13-digit timestamp)
+tradeEndAt: number; // required - Transaction end time (13-digit timestamp)
+lastId?: number; // optional - The offset ID of the query
+direction?: 'PRE' | 'NEXT'; // optional - Page direction, default: 'NEXT'
+pageSize?: number; // optional - Page size >= 1, <= 500, default: 10
 
 ================
 File: src/types/request/spot-convert.ts
@@ -2994,6 +3180,36 @@ pageSize: number; // Page size
 totalNum: number; // Total number of records
 totalPage: number; // Total number of pages
 items: AffiliateInviteeItem[]; // Array of invited user items
+⋮----
+export interface AffiliateTransactionItem {
+  uid: string; // The uid of the invitee
+  tradeTime: number; // Trade time (13-digit timestamp)
+  tradeType: 'SPOT' | 'FEATURE'; // Trade type
+  tradeCurrency: string; // Trade currency
+  tradeAmount: string; // Trade amount
+  tradeAmountU: string; // Trade amount transfer to U(USDT or usdt)
+  feeU: string; // Fee transfer to U(USDT or usdt)
+  commission: string; // Trade commission
+  currency: 'USDT' | 'USDC'; // Transaction volume or amount converted to U
+}
+⋮----
+uid: string; // The uid of the invitee
+tradeTime: number; // Trade time (13-digit timestamp)
+tradeType: 'SPOT' | 'FEATURE'; // Trade type
+tradeCurrency: string; // Trade currency
+tradeAmount: string; // Trade amount
+tradeAmountU: string; // Trade amount transfer to U(USDT or usdt)
+feeU: string; // Fee transfer to U(USDT or usdt)
+commission: string; // Trade commission
+currency: 'USDT' | 'USDC'; // Transaction volume or amount converted to U
+⋮----
+export interface AffiliateTransaction {
+  items: AffiliateTransactionItem[]; // Array of transaction items
+  lastId: string; // The offset ID for pagination
+}
+⋮----
+items: AffiliateTransactionItem[]; // Array of transaction items
+lastId: string; // The offset ID for pagination
 
 ================
 File: src/types/response/spot-convert.ts
@@ -3459,1105 +3675,1105 @@ File: tsconfig.json
 }
 
 ================
-File: src/lib/BaseWSClient.ts
+File: src/types/request/spot-account.ts
 ================
-import EventEmitter from 'events';
-import WebSocket from 'isomorphic-ws';
-⋮----
-import {
-  WebsocketClientOptions,
-  WSClientConfigurableOptions,
-} from '../types/websockets/client.js';
-import { WsOperation } from '../types/websockets/requests.js';
-import { WS_LOGGER_CATEGORY } from '../WebsocketClient.js';
-import { checkWebCryptoAPISupported } from './webCryptoAPI.js';
-import { DefaultLogger } from './websocket/logger.js';
-import {
-  isMessageEvent,
-  MessageEventLike,
-  safeTerminateWs,
-  WsTopicRequest,
-  WsTopicRequestOrStringTopic,
-} from './websocket/websocket-util.js';
-import { WsStore } from './websocket/WsStore.js';
-import {
-  WSConnectedResult,
-  WsConnectionStateEnum,
-} from './websocket/WsStore.types.js';
+export interface GetBalancesRequest {
+  currency?: string;
+  type?: 'main' | 'trade';
+}
 ⋮----
-interface WSClientEventMap<WsKey extends string> {
-  /** Connection opened. If this connection was previously opened and reconnected, expect the reconnected event instead */
-  open: (evt: { wsKey: WsKey; event: any }) => void;
-  /** Reconnecting a dropped connection */
-  reconnect: (evt: { wsKey: WsKey; event: any }) => void;
-  /** Successfully reconnected a connection that dropped */
-  reconnected: (evt: { wsKey: WsKey; event: any }) => void;
-  /** Connection closed */
-  close: (evt: { wsKey: WsKey; event: any }) => void;
-  /** Received reply to websocket command (e.g. after subscribing to topics) */
-  response: (response: any & { wsKey: WsKey }) => void;
-  /** Received data for topic */
-  update: (response: any & { wsKey: WsKey }) => void;
-  /** Exception from ws client OR custom listeners (e.g. if you throw inside your event handler) */
-  exception: (response: any & { wsKey: WsKey }) => void;
-  error: (response: any & { wsKey: WsKey }) => void;
-  /** Confirmation that a connection successfully authenticated */
-  authenticated: (event: { wsKey: WsKey; event: any }) => void;
+export interface GetSpotTransactionsRequest {
+  currency?: string;
+  direction?: 'in' | 'out';
+  bizType?:
+    | 'DEPOSIT'
+    | 'WITHDRAW'
+    | 'TRANSFER'
+    | 'SUB_TRANSFER'
+    | 'TRADE_EXCHANGE'
+    | 'MARGIN_EXCHANGE'
+    | 'KUCOIN_BONUS'
+    | 'BROKER_TRANSFER'
+    | 'REBATE';
+  startAt?: number;
+  endAt?: number;
+  currentPage?: number;
+  pageSize?: number;
 }
 ⋮----
-/** Connection opened. If this connection was previously opened and reconnected, expect the reconnected event instead */
+export interface AccountHFTransactionsRequest {
+  currency?: string;
+  direction?: 'in' | 'out';
+  bizType?:
+    | 'TRANSFER'
+    | 'TRADE_EXCHANGE'
+    | 'RETURNED_FEES'
+    | 'DEDUCTION_FEES'
+    | 'OTHER';
+  lastId?: number;
+  limit?: number;
+  startAt?: number;
+  endAt?: number;
+}
 ⋮----
-/** Reconnecting a dropped connection */
+export interface AccountHFMarginTransactionsRequest {
+  currency?: string;
+  direction?: 'in' | 'out';
+  bizType?:
+    | 'TRANSFER'
+    | 'MARGIN_EXCHANGE'
+    | 'ISOLATED_EXCHANGE'
+    | 'LIQUIDATION'
+    | 'ASSERT_RETURN';
+  lastId?: number;
+  limit?: number;
+  startAt?: number;
+  endAt?: number;
+}
 ⋮----
-/** Successfully reconnected a connection that dropped */
+export interface CreateSubAccountRequest {
+  password: string;
+  remarks?: string;
+  subName: string;
+  access: string;
+}
 ⋮----
-/** Connection closed */
+export interface CreateSubAccountAPIRequest {
+  subName: string;
+  passphrase: string;
+  remark: string;
+  permission?: string;
+  ipWhitelist?: string;
+  expire?: string;
+}
 ⋮----
-/** Received reply to websocket command (e.g. after subscribing to topics) */
+export interface UpdateSubAccountAPIRequest {
+  subName: string;
+  apiKey: string;
+  passphrase: string;
+  permission?: string;
+  ipWhitelist?: string;
+  expire?: string;
+}
 ⋮----
-/** Received data for topic */
+export interface DeleteSubAccountAPIRequest {
+  apiKey: string;
+  passphrase: string;
+  subName: string;
+}
+
+================
+File: src/types/request/spot-funding.ts
+================
+/**
+ *
+ ***********
+ * Funding
+ ***********
+ *
+ */
 ⋮----
-/** Exception from ws client OR custom listeners (e.g. if you throw inside your event handler) */
+export interface CreateDepositAddressV3Request {
+  currency: string;
+  chain?: string;
+  to?: 'main' | 'trade';
+  amount?: string;
+}
 ⋮----
-/** Confirmation that a connection successfully authenticated */
-⋮----
-export interface EmittableEvent<TEvent = any> {
-  eventType:
-    | 'response'
-    | 'update'
-    | 'exception'
-    | 'authenticated'
-    | 'connectionReady'; // tied to "requireConnectionReadyConfirmation"
-  event: TEvent;
+export interface GetMarginBalanceRequest {
+  quoteCurrency?: string;
+  queryType?: 'MARGIN' | 'MARGIN_V2' | 'ALL';
 }
 ⋮----
-| 'connectionReady'; // tied to "requireConnectionReadyConfirmation"
-⋮----
-// Type safety for on and emit handlers: https://stackoverflow.com/a/61609010/880837
-export interface BaseWebsocketClient<TWSKey extends string> {
-  on<U extends keyof WSClientEventMap<TWSKey>>(
-    event: U,
-    listener: WSClientEventMap<TWSKey>[U],
-  ): this;
-
-  emit<U extends keyof WSClientEventMap<TWSKey>>(
-    event: U,
-    ...args: Parameters<WSClientEventMap<TWSKey>[U]>
-  ): boolean;
+export interface GetIsolatedMarginBalanceRequest {
+  symbol?: string;
+  quoteCurrency?: string;
+  queryType?: 'ISOLATED' | 'ISOLATED_V2' | 'ALL';
 }
 ⋮----
-on<U extends keyof WSClientEventMap<TWSKey>>(
-    event: U,
-    listener: WSClientEventMap<TWSKey>[U],
-  ): this;
+/**
+ *
+ * Deposit
+ *
+ */
 ⋮----
-emit<U extends keyof WSClientEventMap<TWSKey>>(
-    event: U,
-    ...args: Parameters<WSClientEventMap<TWSKey>[U]>
-  ): boolean;
+export interface GetDepositsRequest {
+  currency?: string;
+  startAt?: number;
+  endAt?: number;
+  status?: 'PROCESSING' | 'SUCCESS' | 'FAILURE';
+  currentPage?: number;
+  pageSize?: number;
+}
 ⋮----
 /**
- * Users can conveniently pass topics as strings or objects (object has topic name + optional params).
  *
- * This method normalises topics into objects (object has topic name + optional params).
+ * Withdrawals
+ *
  */
-function getNormalisedTopicRequests(
-  wsTopicRequests: WsTopicRequestOrStringTopic<string>[],
-): WsTopicRequest<string>[]
-⋮----
-// passed as string, convert to object
 ⋮----
-// already a normalised object, thanks to user
+export interface GetWithdrawalsRequest {
+  currency?: string;
+  status?: 'PROCESSING' | 'WALLET_PROCESSING' | 'SUCCESS' | 'FAILURE';
+  startAt?: number;
+  endAt?: number;
+  currentPage?: number;
+  pageSize?: number;
+}
 ⋮----
-type WSTopic = string;
+export interface ApplyWithdrawRequest {
+  currency: string;
+  address: string;
+  amount: number;
+  memo?: string;
+  isInner?: boolean;
+  remark?: string;
+  chain?: string;
+  feeDeductType?: 'INTERNAL' | 'EXTERNAL';
+}
 ⋮----
-// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging
-export abstract class BaseWebsocketClient<
-TWSKey extends string,
+export interface SubmitWithdrawV3Request {
+  currency: string;
+  toAddress: string;
+  amount: number;
+  memo?: string;
+  isInner?: boolean;
+  remark?: string;
+  chain?: string;
+  feeDeductType?: 'INTERNAL' | 'EXTERNAL';
+  withdrawType: 'ADDRESS' | 'UID' | 'MAIL' | 'PHONE';
+}
 ⋮----
-constructor(
-    options?: WSClientConfigurableOptions,
-    logger?: typeof DefaultLogger,
-)
+/**
+ *
+ * Transfer
+ *
+ */
 ⋮----
-// Requires a confirmation "response" from the ws connection before assuming it is ready
+export interface GetTransferableRequest {
+  currency: string;
+  type:
+    | 'MAIN'
+    | 'TRADE'
+    | 'TRADE_HF'
+    | 'MARGIN'
+    | 'ISOLATED'
+    | 'OPTION'
+    | 'MARGIN_V2'
+    | 'ISOLATED_V2';
+  tag?: string;
+}
 ⋮----
-// Automatically auth after opening a connection?
+export interface FlexTransferRequest {
+  clientOid: string;
+  currency?: string;
+  amount: string;
+  fromUserId?: string;
+  fromAccountType:
+    | 'MAIN'
+    | 'TRADE'
+    | 'CONTRACT'
+    | 'MARGIN'
+    | 'ISOLATED'
+    | 'TRADE_HF'
+    | 'MARGIN_V2'
+    | 'ISOLATED_V2'
+    | 'OPTION';
+  fromAccountTag?: string;
+  type: 'INTERNAL' | 'PARENT_TO_SUB' | 'SUB_TO_PARENT';
+  toUserId?: string;
+  toAccountType:
+    | 'MAIN'
+    | 'TRADE'
+    | 'CONTRACT'
+    | 'MARGIN'
+    | 'ISOLATED'
+    | 'TRADE_HF'
+    | 'MARGIN_V2'
+    | 'ISOLATED_V2'
+    | 'OPTION';
+  toAccountTag?: string;
+}
 ⋮----
-// Automatically include auth/sign with every WS request
+export interface submitTransferMasterSubRequest {
+  clientOid: string;
+  currency: string;
+  amount: string;
+  direction: 'OUT' | 'IN';
+  accountType?:
+    | 'MAIN'
+    | 'TRADE'
+    | 'TRADE_HF'
+    | 'MARGIN'
+    | 'CONTRACT'
+    | 'OPTION';
+  subAccountType?:
+    | 'MAIN'
+    | 'TRADE'
+    | 'TRADE_HF'
+    | 'MARGIN'
+    | 'CONTRACT'
+    | 'OPTION';
+  subUserId: string;
+}
 ⋮----
-// Automatically re-auth WS API, if we were auth'd before and get reconnected
+export interface InnerTransferRequest {
+  clientOid: string;
+  currency: string;
+  from:
+    | 'main'
+    | 'trade'
+    | 'trade_hf'
+    | 'margin'
+    | 'isolated'
+    | 'margin_v2'
+    | 'isolated_v2'
+    | 'contract'
+    | 'option';
+  to:
+    | 'main'
+    | 'trade'
+    | 'trade_hf'
+    | 'margin'
+    | 'isolated'
+    | 'margin_v2'
+    | 'isolated_v2'
+    | 'contract'
+    | 'option';
+  amount: string;
+  fromTag?: string;
+  toTag?: string;
+}
+
+================
+File: src/types/response/spot-account.ts
+================
+export interface SpotAccountSummary {
+  level: number;
+  subQuantity: number;
+  spotSubQuantity: number;
+  marginSubQuantity: number;
+  futuresSubQuantity: number;
+  optionSubQuantity: number;
+  maxSubQuantity: number;
+  maxDefaultSubQuantity: number;
+  maxSpotSubQuantity: number;
+  maxMarginSubQuantity: number;
+  maxFuturesSubQuantity: number;
+  maxOptionSubQuantity: number;
+}
 ⋮----
-// Check Web Crypto API support when credentials are provided and no custom sign function is used
+export interface Balances {
+  id: string;
+  currency: string;
+  type: 'main' | 'trade';
+  balance: string;
+  available: string;
+  holds: string;
+}
 ⋮----
-protected abstract sendPingEvent(wsKey: TWSKey, ws: WebSocket): void;
+export interface Account {
+  currency: string;
+  balance: string;
+  available: string;
+  holds: string;
+}
 ⋮----
-protected abstract sendPongEvent(wsKey: TWSKey, ws: WebSocket): void;
+export interface SpotAccountTransaction {
+  id: string;
+  currency: string;
+  amount: string;
+  fee: string;
+  tax: string;
+  balance: string;
+  accountType: string; // 'TRADE_HF'
+  bizType: string;
+  direction: 'out' | 'in';
+  createdAt: string;
+  context: string;
+}
 ⋮----
-protected abstract isWsPong(data: any): boolean;
+accountType: string; // 'TRADE_HF'
 ⋮----
-protected abstract isWsPing(data: any): boolean;
+export interface SpotAccountTransactions {
+  currentPage: number;
+  pageSize: number;
+  totalNum: number;
+  totalPage: number;
+  items: SpotAccountTransaction[];
+}
 ⋮----
-protected abstract getWsAuthRequestEvent(wsKey: TWSKey): Promise<object>;
-⋮----
-protected abstract isPrivateTopicRequest(
-    request: WsTopicRequest<WSTopic>,
-    wsKey: TWSKey,
-  ): boolean;
+export interface AccountHFMarginTransactions {
+  id: string;
+  currency: string;
+  amount: string;
+  fee: string;
+  balance: string;
+  accountType: 'MARGIN_V2' | 'ISOLATED_V2';
+  bizType:
+    | 'TRANSFER'
+    | 'MARGIN_EXCHANGE'
+    | 'ISOLATED_EXCHANGE'
+    | 'LIQUIDATION'
+    | 'ASSERT_RETURN';
+  direction: 'out' | 'in';
+  createdAt: string;
+  tax: string;
+  context: string;
+}
 ⋮----
 /**
-   * Returns a list of string events that can be individually sent upstream to complete subscribing/unsubscribing/etc to these topics
-   */
-protected abstract getWsOperationEventsForTopics(
-    topics: WsTopicRequest<WSTopic>[],
-    wsKey: TWSKey,
-    operation: WsOperation,
-  ): Promise<string[]>;
+ *
+ * Sub-Account
+ *
+ */
 ⋮----
-protected abstract getPrivateWSKeys(): TWSKey[];
+export interface SubAccountInfo {
+  userId: string;
+  uid: number;
+  subName: string;
+  status: number;
+  type: number;
+  access: string;
+  createdAt: number;
+  remarks: string;
+  tradeTypes: string[];
+  openedTradeTypes: string[];
+  hostedStatus: null | string;
+}
 ⋮----
-protected abstract getWsUrl(wsKey: TWSKey): Promise<string>;
+export interface SubAccountsV2 {
+  currentPage: number;
+  pageSize: number;
+  totalNum: number;
+  totalPage: number;
+  items: SubAccountInfo[];
+}
 ⋮----
-protected abstract getMaxTopicsPerSubscribeEvent(
-    wsKey: TWSKey,
-  ): number | null;
+export interface SubAccountItem {
+  userId: string;
+  uid: number;
+  subName: string;
+  status: number;
+  type: number;
+  access: string;
+  createdAt: number;
+  remarks: string;
+  tradeTypes: string[];
+  openedTradeTypes: string[];
+  hostedStatus: null | string;
+}
 ⋮----
-/**
-   * Abstraction called to sort ws events into emittable event types (response to a request, data update, etc)
-   */
-protected abstract resolveEmittableEvents(
-    wsKey: TWSKey,
-    event: MessageEventLike,
-  ): EmittableEvent[];
+export interface CreateSubAccount {
+  currentPage: number;
+  pageSize: number;
+  totalNum: number;
+  totalPage: number;
+  items: SubAccountItem[];
+}
 ⋮----
-/**
-   * Request connection of all dependent (public & private) websockets, instead of waiting for automatic connection by library
-   */
-protected abstract connectAll(): Promise<(WSConnectedResult | undefined)[]>;
+export interface SubAccountBalance {
+  currency: string;
+  balance: string;
+  available: string;
+  holds: string;
+  baseCurrency: string;
+  baseCurrencyPrice: string;
+  baseAmount: string;
+}
 ⋮----
-protected isPrivateWsKey(wsKey: TWSKey): boolean
+// deprecated
+export interface SubAccountBalances {
+  subUserId: string;
+  subName: string;
+  mainAccounts: SubAccountBalance[];
+  tradeAccounts: SubAccountBalance[];
+  marginAccounts: SubAccountBalance[];
+}
 ⋮----
-/** Returns auto-incrementing request ID, used to track promise references for async requests */
-protected getNewRequestId(): string
+export interface SubAccountBalancesV2 {
+  currentPage: number;
+  pageSize: number;
+  totalNum: number;
+  totalPage: number;
+  items: {
+    subUserId: string;
+    subName: string;
+    mainAccounts: SubAccountBalance[];
+  }[];
+}
+export interface SubAccountV2Details {
+  currency?: string;
+  balance?: string;
+  available?: string;
+  holds?: string;
+  baseCurrency?: string;
+  baseCurrencyPrice?: string;
+  baseAmount?: string;
+  tag?: string;
+}
 ⋮----
-protected abstract sendWSAPIRequest(
-    wsKey: TWSKey,
-    channel: WSTopic,
-    params?: any,
-  ): Promise<unknown>;
+export interface SubAccountBalanceItemV2 {
+  subUserId: string;
+  subName: string;
+  mainAccounts: SubAccountV2Details[]; // Funding Account
+  tradeAccounts: SubAccountV2Details[]; // Spot Account
+  marginAccounts: SubAccountV2Details[]; // Margin Account
+  tradeHFAccounts: string[]; // Deprecated, only for old users
+}
 ⋮----
-protected abstract sendWSAPIRequest(
-    wsKey: TWSKey,
-    channel: WSTopic,
-    params: any,
-  ): Promise<unknown>;
+mainAccounts: SubAccountV2Details[]; // Funding Account
+tradeAccounts: SubAccountV2Details[]; // Spot Account
+marginAccounts: SubAccountV2Details[]; // Margin Account
+tradeHFAccounts: string[]; // Deprecated, only for old users
 ⋮----
 /**
-   * Subscribe to one or more topics on a WS connection (identified by WS Key).
-   *
-   * - Topics are automatically cached
-   * - Connections are automatically opened, if not yet connected
-   * - Authentication is automatically handled
-   * - Topics are automatically resubscribed to, if something happens to the connection, unless you call unsubsribeTopicsForWsKey(topics, key).
-   *
-   * @param wsTopicRequests array of topics to subscribe to
-   * @param wsKey ws key referring to the ws connection these topics should be subscribed on
-   */
-public subscribeTopicsForWsKey(
-    wsTopicRequests: WsTopicRequestOrStringTopic<WSTopic>[],
-    wsKey: TWSKey,
-)
+ *
+ * Sub-Account API
+ *
+ *
+ */
 ⋮----
-// Store topics, so future automation (post-auth, post-reconnect) has everything needed to resubscribe automatically
+export interface SubAccountAPIInfo {
+  subName: string;
+  remark: string;
+  apiKey: string;
+  apiVersion: number;
+  permission: string;
+  ipWhitelist: string;
+  createdAt: number;
+  uid: number;
+  isMaster: boolean;
+}
 ⋮----
-// start connection process if it hasn't yet begun. Topics are automatically subscribed to on-connect
+export interface CreateSubAPI {
+  subName: string;
+  remark: string;
+  apiKey: string;
+  apiSecret: string;
+  apiVersion: number;
+  passphrase: string;
+  permission: string;
+  createdAt: number;
+}
 ⋮----
-// Subscribe should happen automatically once connected, nothing to do here after topics are added to wsStore.
+export interface UpdateSubAPI {
+  apiKey: string;
+  ipWhitelist: string;
+  permission: string;
+  subName: string;
+}
+⋮----
+export interface DeleteSubAccountAPI {
+  subName: string;
+  apiKey: string;
+}
+
+================
+File: src/BrokerClient.ts
+================
+import { BaseRestClient } from './lib/BaseRestClient.js';
+import { REST_CLIENT_TYPE_ENUM, RestClientType } from './lib/requestUtils.js';
+import {
+  BrokerTransferRequest,
+  CreateBrokerSubAccountApiRequest,
+  DeleteBrokerSubAccountApiRequest,
+  GetBrokerDepositListRequest,
+  GetBrokerInfoRequest,
+  GetBrokerSubAccountApisRequest,
+  GetBrokerSubAccountsRequest,
+  UpdateBrokerSubAccountApiRequest,
+} from './types/request/broker.types.js';
+import {
+  BrokerDepositRecord,
+  BrokerInfo,
+  BrokerSubAccountApi,
+  BrokerTransferHistory,
+  BrokerWithdrawalRecord,
+  CreateBrokerSubAccountApiResponse,
+  CreateBrokerSubAccountResponse,
+  GetBrokerSubAccountsResponse,
+} from './types/response/broker.types.js';
+import { APISuccessResponse } from './types/response/shared.types.js';
 ⋮----
 /**
-       * Are we in the process of connection? Nothing to send yet.
-       */
+ *
+ */
+export class BrokerClient extends BaseRestClient
 ⋮----
-// We're connected. Check if auth is needed and if already authenticated
+getClientType(): RestClientType
 ⋮----
 /**
-       * If not authenticated yet and auth is required, don't request topics yet.
-       *
-       * Auth should already automatically be in progress, so no action needed from here. Topics will automatically subscribe post-auth success.
-       */
-⋮----
-// Finally, request subscription to topics if the connection is healthy and ready
-⋮----
-protected unsubscribeTopicsForWsKey(
-    wsTopicRequests: WsTopicRequestOrStringTopic<string>[],
-    wsKey: TWSKey,
-)
-⋮----
-// Store topics, so future automation (post-auth, post-reconnect) has everything needed to resubscribe automatically
-⋮----
-// If not connected, don't need to do anything.
-// Removing the topic from the store is enough to stop it from being resubscribed to on reconnect.
-⋮----
-// We're connected. Check if auth is needed and if already authenticated
+   * Get Broker Info
+   *
+   * This endpoint supports querying the basic information of the current Broker
+   */
+getBrokerInfo(
+    params: GetBrokerInfoRequest,
+): Promise<APISuccessResponse<BrokerInfo>>
 ⋮----
 /**
-       * If not authenticated yet and auth is required, don't need to do anything.
-       * We don't subscribe to topics until auth is complete anyway.
-       */
-⋮----
-// Finally, request subscription to topics if the connection is healthy and ready
+   * Add SubAccount
+   *
+   * This endpoint supports Broker users to create sub-accounts.
+   * Note that the account name is unique across the exchange.
+   * It is recommended to add a special identifier to prevent name duplication.
+   */
+createSubAccount(params: {
+    accountName: string;
+}): Promise<APISuccessResponse<CreateBrokerSubAccountResponse>>
 ⋮----
 /**
-   * Splits topic requests into two groups, public & private topic requests
+   * Get SubAccount
+   *
+   * This interface supports querying sub-accounts created by Broker.
+   * Returns paginated results with default page size of 20 (max 100).
    */
-private sortTopicRequestsIntoPublicPrivate(
-    wsTopicRequests: WsTopicRequest<string>[],
-    wsKey: TWSKey,
-):
-⋮----
-/** Get the WsStore that tracks websockets & topics */
-public getWsStore(): WsStore<TWSKey, WsTopicRequest<string>>
-⋮----
-public close(wsKey: TWSKey, force?: boolean)
-⋮----
-public closeAll(force?: boolean)
-⋮----
-public isConnected(wsKey: TWSKey): boolean
+getSubAccounts(
+    params: GetBrokerSubAccountsRequest,
+): Promise<APISuccessResponse<GetBrokerSubAccountsResponse>>
 ⋮----
 /**
-   * Request connection to a specific websocket, instead of waiting for automatic connection.
+   * Add SubAccount API
+   *
+   * This interface supports the creation of Broker sub-account APIKEY.
+   * Supports up to 20 IPs in the whitelist.
+   * Only General, Spot, and Futures permissions can be set.
+   * Label must be between 4 and 32 characters.
    */
-public async connect(wsKey: TWSKey): Promise<WSConnectedResult | undefined>
-⋮----
-private connectToWsUrl(url: string, wsKey: TWSKey): WebSocket
-⋮----
-private parseWsError(context: string, error: any, wsKey: TWSKey)
-⋮----
-/** Get a signature, build the auth request and send it */
-private async sendAuthRequest(wsKey: TWSKey): Promise<void>
-⋮----
-private reconnectWithDelay(wsKey: TWSKey, connectionDelayMs: number)
-⋮----
-private ping(wsKey: TWSKey)
-⋮----
-private clearTimers(wsKey: TWSKey)
-⋮----
-// Send a ping at intervals
-private clearPingTimer(wsKey: TWSKey)
-⋮----
-// Expect a pong within a time limit
-private clearPongTimer(wsKey: TWSKey)
-⋮----
-// this.logger.trace(`Cleared pong timeout for "${wsKey}"`);
-⋮----
-// this.logger.trace(`No active pong timer for "${wsKey}"`);
+createSubAccountApi(
+    params: CreateBrokerSubAccountApiRequest,
+): Promise<APISuccessResponse<CreateBrokerSubAccountApiResponse>>
 ⋮----
 /**
-   * Simply builds and sends subscribe events for a list of topics for a ws key
+   * Get SubAccount API
    *
-   * @private Use the `subscribe(topics)` or `subscribeTopicsForWsKey(topics, wsKey)` method to subscribe to topics. Send WS message to subscribe to topics.
+   * This interface supports querying the Broker's sub-account APIKEYs.
+   * Can optionally filter by specific apiKey.
    */
-private async requestSubscribeTopics(
-    wsKey: TWSKey,
-    topics: WsTopicRequest<string>[],
-)
-⋮----
-// Automatically splits requests into smaller batches, if needed
-⋮----
-`Subscribing to ${topics.length} "${wsKey}" topics in ${subscribeWsMessages.length} batches.`, // Events: "${JSON.stringify(topics)}"
-⋮----
-// this.logger.trace(`Sending batch via message: "${wsMessage}"`);
+getSubAccountApis(
+    params: GetBrokerSubAccountApisRequest,
+): Promise<APISuccessResponse<BrokerSubAccountApi[]>>
 ⋮----
 /**
-   * Simply builds and sends unsubscribe events for a list of topics for a ws key
+   * Modify SubAccount API
    *
-   * @private Use the `unsubscribe(topics)` method to unsubscribe from topics. Send WS message to unsubscribe from topics.
+   * This interface supports modifying the Broker's sub-account APIKEY.
+   * Supports up to 20 IPs in the whitelist.
+   * Only General, Spot, and Futures permissions can be set.
+   * Label must be between 4 and 32 characters.
    */
-private async requestUnsubscribeTopics(
-    wsKey: TWSKey,
-    wsTopicRequests: WsTopicRequest<string>[],
-)
+updateSubAccountApi(
+    params: UpdateBrokerSubAccountApiRequest,
+): Promise<APISuccessResponse<BrokerSubAccountApi>>
 ⋮----
 /**
-   * Try sending a string event on a WS connection (identified by the WS Key)
+   * Delete SubAccount API
+   *
+   * This interface supports deleting Broker's sub-account APIKEY.
    */
-public tryWsSend(wsKey: TWSKey, wsMessage: string)
-⋮----
-private async onWsOpen(event: any, wsKey: TWSKey)
+deleteSubAccountApi(
+    params: DeleteBrokerSubAccountApiRequest,
+): Promise<APISuccessResponse<boolean>>
 ⋮----
 /**
-   * Called automatically once a connection is ready.
-   * - Some exchanges are ready immediately after the connections open.
-   * - Some exchanges send an event to confirm the connection is ready for us.
+   * Transfer
    *
-   * This method is called to act when the connection is ready. Use `requireConnectionReadyConfirmation` to control how this is called.
+   * This endpoint supports fund transfer between Broker account and Broker sub-accounts.
+   * Please be aware that withdrawal from sub-account is not directly supported.
+   * Broker has to transfer funds from broker sub-account to broker account to initiate the withdrawals.
+   *
+   * Direction:
+   * - OUT: Broker account is transferred to Broker sub-account
+   * - IN: Broker sub-account is transferred to Broker account
+   *
+   * Account Types:
+   * - MAIN: Funding account
+   * - TRADE: Spot trading account
    */
-private async onWsReadyForEvents(wsKey: TWSKey)
-⋮----
-// Resolve & cleanup deferred "connection attempt in progress" promise
-⋮----
-// Remove before resolving, in case there's more requests queued
-⋮----
-// Some websockets require an auth packet to be sent after opening the connection
-⋮----
-// Reconnect to topics known before it connected
-⋮----
-// Request sub to public topics, if any
-⋮----
-// Request sub to private topics, if auth on connect isn't needed
+submitTransfer(params: BrokerTransferRequest): Promise<
+    APISuccessResponse<{
+      orderId: string;
+    }>
+  > {
+    return this.postPrivate('api/v1/broker/nd/transfer', params);
 ⋮----
 /**
-   * Handle subscription to private topics _after_ authentication successfully completes asynchronously.
+   * Get Transfer History
    *
-   * Only used for exchanges that require auth before sending private topic subscription requests
+   * This endpoint supports querying transfer records of the broker itself and its created sub-accounts.
+   *
+   * Account Types:
+   * - MAIN: Funding account
+   * - TRADE: Spot trading account
+   * - CONTRACT: Contract account
+   * - MARGIN: Margin account
+   * - ISOLATED: Isolated margin account
+   *
+   * Status:
+   * - PROCESSING: Processing
+   * - SUCCESS: Successful
+   * - FAILURE: Failed
    */
-private onWsAuthenticated(
-    wsKey: TWSKey,
-    event: { isWSAPI?: boolean; WSAPIAuthChannel?: string },
-)
-⋮----
-private onWsMessage(event: unknown, wsKey: TWSKey, ws: WebSocket)
-⋮----
-// any message can clear the pong timer - wouldn't get a message if the ws wasn't working
-⋮----
-// console.log(`raw event: `, { data, dataType, emittableEvents });
-⋮----
-private onWsClose(event: unknown, wsKey: TWSKey)
-⋮----
-// clean up any pending promises for this connection
-⋮----
-// clean up any pending promises for this connection
-⋮----
-private getWs(wsKey: TWSKey)
-⋮----
-private setWsState(wsKey: TWSKey, state: WsConnectionStateEnum)
+getTransferHistory(params: {
+    orderId: string;
+}): Promise<APISuccessResponse<BrokerTransferHistory>>
 ⋮----
 /**
-   * Promise-driven method to assert that a ws has successfully connected (will await until connection is open)
+   * Get Deposit List
+   *
+   * This endpoint can obtain the deposit records of each sub-account under the ND Broker.
+   * Default limit is 1000 records (max 1000).
+   * Results are sorted in descending order by default.
+   *
+   * Status:
+   * - PROCESSING: Processing
+   * - SUCCESS: Successful
+   * - FAILURE: Failed
    */
-protected async assertIsConnected(wsKey: TWSKey): Promise<unknown>
+getDeposits(
+    params?: GetBrokerDepositListRequest,
+): Promise<APISuccessResponse<BrokerDepositRecord[]>>
 ⋮----
-// Already in progress? Await shared promise and retry
+/**
+   * Get Deposit Detail
+   *
+   * This endpoint supports querying the deposit record of sub-accounts created by a Broker
+   * (excluding main account of nd broker).
+   *
+   * Status:
+   * - PROCESSING: Processing
+   * - SUCCESS: Successful
+   * - FAILURE: Failed
+   */
+getDeposit(params: {
+    currency: string;
+    hash: string;
+}): Promise<APISuccessResponse<BrokerDepositRecord>>
 ⋮----
-// Start connection, it should automatically store/return a promise.
-
-================
-File: src/types/request/spot-account.ts
-================
-export interface GetBalancesRequest {
-  currency?: string;
-  type?: 'main' | 'trade';
-}
+/**
+   * Get Withdrawal Detail
+   *
+   * This endpoint supports querying the withdrawal records of sub-accounts created by a Broker
+   * (excluding main account of nd broker).
+   *
+   * Status:
+   * - PROCESSING: Processing
+   * - WALLET_PROCESSING: Wallet Processing
+   * - REVIEW: Under Review
+   * - SUCCESS: Successful
+   * - FAILURE: Failed
+   */
+getWithdrawal(params: {
+    withdrawalId: string;
+}): Promise<APISuccessResponse<BrokerWithdrawalRecord>>
 ⋮----
-export interface GetSpotTransactionsRequest {
-  currency?: string;
-  direction?: 'in' | 'out';
-  bizType?:
-    | 'DEPOSIT'
-    | 'WITHDRAW'
-    | 'TRANSFER'
-    | 'SUB_TRANSFER'
-    | 'TRADE_EXCHANGE'
-    | 'MARGIN_EXCHANGE'
-    | 'KUCOIN_BONUS'
-    | 'BROKER_TRANSFER'
-    | 'REBATE';
-  startAt?: number;
-  endAt?: number;
-  currentPage?: number;
-  pageSize?: number;
-}
+/**
+   * Get Broker Rebate
+   *
+   * This interface supports downloading Broker rebate orders.
+   * Returns a URL to download a CSV file containing the rebate data.
+   * The URL is valid for 1 day.
+   * Maximum interval between begin and end dates is 6 months.
+   */
+getBrokerRebate(params: {
+    begin: string;
+    end: string;
+    tradeType: '1' | '2';
+  }): Promise<
+    APISuccessResponse<{
+      url: string;
+    }>
+  > {
+    return this.getPrivate('api/v1/broker/nd/rebase/download', params);
+
+================
+File: .eslintrc.cjs
+================
+// 'no-unused-vars': ['warn'],
+
+================
+File: src/lib/BaseWSClient.ts
+================
+import EventEmitter from 'events';
+import WebSocket from 'isomorphic-ws';
 ⋮----
-export interface AccountHFTransactionsRequest {
-  currency?: string;
-  direction?: 'in' | 'out';
-  bizType?:
-    | 'TRANSFER'
-    | 'TRADE_EXCHANGE'
-    | 'RETURNED_FEES'
-    | 'DEDUCTION_FEES'
-    | 'OTHER';
-  lastId?: number;
-  limit?: number;
-  startAt?: number;
-  endAt?: number;
-}
+import {
+  WebsocketClientOptions,
+  WSClientConfigurableOptions,
+} from '../types/websockets/client.js';
+import { WsOperation } from '../types/websockets/requests.js';
+import { WS_LOGGER_CATEGORY } from '../WebsocketClient.js';
+import { checkWebCryptoAPISupported } from './webCryptoAPI.js';
+import { DefaultLogger } from './websocket/logger.js';
+import {
+  isMessageEvent,
+  MessageEventLike,
+  safeTerminateWs,
+  WsTopicRequest,
+  WsTopicRequestOrStringTopic,
+} from './websocket/websocket-util.js';
+import { WsStore } from './websocket/WsStore.js';
+import {
+  WSConnectedResult,
+  WsConnectionStateEnum,
+} from './websocket/WsStore.types.js';
 ⋮----
-export interface AccountHFMarginTransactionsRequest {
-  currency?: string;
-  direction?: 'in' | 'out';
-  bizType?:
-    | 'TRANSFER'
-    | 'MARGIN_EXCHANGE'
-    | 'ISOLATED_EXCHANGE'
-    | 'LIQUIDATION'
-    | 'ASSERT_RETURN';
-  lastId?: number;
-  limit?: number;
-  startAt?: number;
-  endAt?: number;
+interface WSClientEventMap<WsKey extends string> {
+  /** Connection opened. If this connection was previously opened and reconnected, expect the reconnected event instead */
+  open: (evt: { wsKey: WsKey; event: any }) => void;
+  /** Reconnecting a dropped connection */
+  reconnect: (evt: { wsKey: WsKey; event: any }) => void;
+  /** Successfully reconnected a connection that dropped */
+  reconnected: (evt: { wsKey: WsKey; event: any }) => void;
+  /** Connection closed */
+  close: (evt: { wsKey: WsKey; event: any }) => void;
+  /** Received reply to websocket command (e.g. after subscribing to topics) */
+  response: (response: any & { wsKey: WsKey }) => void;
+  /** Received data for topic */
+  update: (response: any & { wsKey: WsKey }) => void;
+  /** Exception from ws client OR custom listeners (e.g. if you throw inside your event handler) */
+  exception: (response: any & { wsKey: WsKey }) => void;
+  error: (response: any & { wsKey: WsKey }) => void;
+  /** Confirmation that a connection successfully authenticated */
+  authenticated: (event: { wsKey: WsKey; event: any }) => void;
 }
 ⋮----
-export interface CreateSubAccountRequest {
-  password: string;
-  remarks?: string;
-  subName: string;
-  access: string;
-}
+/** Connection opened. If this connection was previously opened and reconnected, expect the reconnected event instead */
 ⋮----
-export interface CreateSubAccountAPIRequest {
-  subName: string;
-  passphrase: string;
-  remark: string;
-  permission?: string;
-  ipWhitelist?: string;
-  expire?: string;
-}
+/** Reconnecting a dropped connection */
 ⋮----
-export interface UpdateSubAccountAPIRequest {
-  subName: string;
-  apiKey: string;
-  passphrase: string;
-  permission?: string;
-  ipWhitelist?: string;
-  expire?: string;
-}
+/** Successfully reconnected a connection that dropped */
 ⋮----
-export interface DeleteSubAccountAPIRequest {
-  apiKey: string;
-  passphrase: string;
-  subName: string;
-}
-
-================
-File: src/types/request/spot-funding.ts
-================
-/**
- *
- ***********
- * Funding
- ***********
- *
- */
+/** Connection closed */
 ⋮----
-export interface CreateDepositAddressV3Request {
-  currency: string;
-  chain?: string;
-  to?: 'main' | 'trade';
-  amount?: string;
-}
+/** Received reply to websocket command (e.g. after subscribing to topics) */
 ⋮----
-export interface GetMarginBalanceRequest {
-  quoteCurrency?: string;
-  queryType?: 'MARGIN' | 'MARGIN_V2' | 'ALL';
-}
+/** Received data for topic */
 ⋮----
-export interface GetIsolatedMarginBalanceRequest {
-  symbol?: string;
-  quoteCurrency?: string;
-  queryType?: 'ISOLATED' | 'ISOLATED_V2' | 'ALL';
-}
+/** Exception from ws client OR custom listeners (e.g. if you throw inside your event handler) */
 ⋮----
-/**
- *
- * Deposit
- *
- */
+/** Confirmation that a connection successfully authenticated */
 ⋮----
-export interface GetDepositsRequest {
-  currency?: string;
-  startAt?: number;
-  endAt?: number;
-  status?: 'PROCESSING' | 'SUCCESS' | 'FAILURE';
-  currentPage?: number;
-  pageSize?: number;
+export interface EmittableEvent<TEvent = any> {
+  eventType:
+    | 'response'
+    | 'update'
+    | 'exception'
+    | 'authenticated'
+    | 'connectionReady'; // tied to "requireConnectionReadyConfirmation"
+  event: TEvent;
 }
 ⋮----
-/**
- *
- * Withdrawals
- *
- */
+| 'connectionReady'; // tied to "requireConnectionReadyConfirmation"
 ⋮----
-export interface GetWithdrawalsRequest {
-  currency?: string;
-  status?: 'PROCESSING' | 'WALLET_PROCESSING' | 'SUCCESS' | 'FAILURE';
-  startAt?: number;
-  endAt?: number;
-  currentPage?: number;
-  pageSize?: number;
+// Type safety for on and emit handlers: https://stackoverflow.com/a/61609010/880837
+export interface BaseWebsocketClient<TWSKey extends string> {
+  on<U extends keyof WSClientEventMap<TWSKey>>(
+    event: U,
+    listener: WSClientEventMap<TWSKey>[U],
+  ): this;
+
+  emit<U extends keyof WSClientEventMap<TWSKey>>(
+    event: U,
+    ...args: Parameters<WSClientEventMap<TWSKey>[U]>
+  ): boolean;
 }
 ⋮----
-export interface ApplyWithdrawRequest {
-  currency: string;
-  address: string;
-  amount: number;
-  memo?: string;
-  isInner?: boolean;
-  remark?: string;
-  chain?: string;
-  feeDeductType?: 'INTERNAL' | 'EXTERNAL';
-}
+on<U extends keyof WSClientEventMap<TWSKey>>(
+    event: U,
+    listener: WSClientEventMap<TWSKey>[U],
+  ): this;
 ⋮----
-export interface SubmitWithdrawV3Request {
-  currency: string;
-  toAddress: string;
-  amount: number;
-  memo?: string;
-  isInner?: boolean;
-  remark?: string;
-  chain?: string;
-  feeDeductType?: 'INTERNAL' | 'EXTERNAL';
-  withdrawType: 'ADDRESS' | 'UID' | 'MAIL' | 'PHONE';
-}
+emit<U extends keyof WSClientEventMap<TWSKey>>(
+    event: U,
+    ...args: Parameters<WSClientEventMap<TWSKey>[U]>
+  ): boolean;
 ⋮----
 /**
+ * Users can conveniently pass topics as strings or objects (object has topic name + optional params).
  *
- * Transfer
- *
+ * This method normalises topics into objects (object has topic name + optional params).
  */
+function getNormalisedTopicRequests(
+  wsTopicRequests: WsTopicRequestOrStringTopic<string>[],
+): WsTopicRequest<string>[]
 ⋮----
-export interface GetTransferableRequest {
-  currency: string;
-  type:
-    | 'MAIN'
-    | 'TRADE'
-    | 'TRADE_HF'
-    | 'MARGIN'
-    | 'ISOLATED'
-    | 'OPTION'
-    | 'MARGIN_V2'
-    | 'ISOLATED_V2';
-  tag?: string;
-}
+// passed as string, convert to object
 ⋮----
-export interface FlexTransferRequest {
-  clientOid: string;
-  currency?: string;
-  amount: string;
-  fromUserId?: string;
-  fromAccountType:
-    | 'MAIN'
-    | 'TRADE'
-    | 'CONTRACT'
-    | 'MARGIN'
-    | 'ISOLATED'
-    | 'TRADE_HF'
-    | 'MARGIN_V2'
-    | 'ISOLATED_V2'
-    | 'OPTION';
-  fromAccountTag?: string;
-  type: 'INTERNAL' | 'PARENT_TO_SUB' | 'SUB_TO_PARENT';
-  toUserId?: string;
-  toAccountType:
-    | 'MAIN'
-    | 'TRADE'
-    | 'CONTRACT'
-    | 'MARGIN'
-    | 'ISOLATED'
-    | 'TRADE_HF'
-    | 'MARGIN_V2'
-    | 'ISOLATED_V2'
-    | 'OPTION';
-  toAccountTag?: string;
-}
+// already a normalised object, thanks to user
 ⋮----
-export interface submitTransferMasterSubRequest {
-  clientOid: string;
-  currency: string;
-  amount: string;
-  direction: 'OUT' | 'IN';
-  accountType?:
-    | 'MAIN'
-    | 'TRADE'
-    | 'TRADE_HF'
-    | 'MARGIN'
-    | 'CONTRACT'
-    | 'OPTION';
-  subAccountType?:
-    | 'MAIN'
-    | 'TRADE'
-    | 'TRADE_HF'
-    | 'MARGIN'
-    | 'CONTRACT'
-    | 'OPTION';
-  subUserId: string;
-}
+type WSTopic = string;
 ⋮----
-export interface InnerTransferRequest {
-  clientOid: string;
-  currency: string;
-  from:
-    | 'main'
-    | 'trade'
-    | 'trade_hf'
-    | 'margin'
-    | 'isolated'
-    | 'margin_v2'
-    | 'isolated_v2'
-    | 'contract'
-    | 'option';
-  to:
-    | 'main'
-    | 'trade'
-    | 'trade_hf'
-    | 'margin'
-    | 'isolated'
-    | 'margin_v2'
-    | 'isolated_v2'
-    | 'contract'
-    | 'option';
-  amount: string;
-  fromTag?: string;
-  toTag?: string;
-}
-
-================
-File: src/types/response/spot-account.ts
-================
-export interface SpotAccountSummary {
-  level: number;
-  subQuantity: number;
-  spotSubQuantity: number;
-  marginSubQuantity: number;
-  futuresSubQuantity: number;
-  optionSubQuantity: number;
-  maxSubQuantity: number;
-  maxDefaultSubQuantity: number;
-  maxSpotSubQuantity: number;
-  maxMarginSubQuantity: number;
-  maxFuturesSubQuantity: number;
-  maxOptionSubQuantity: number;
-}
+// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging
+export abstract class BaseWebsocketClient<
+TWSKey extends string,
 ⋮----
-export interface Balances {
-  id: string;
-  currency: string;
-  type: 'main' | 'trade';
-  balance: string;
-  available: string;
-  holds: string;
-}
+constructor(
+    options?: WSClientConfigurableOptions,
+    logger?: typeof DefaultLogger,
+)
 ⋮----
-export interface Account {
-  currency: string;
-  balance: string;
-  available: string;
-  holds: string;
-}
+// Requires a confirmation "response" from the ws connection before assuming it is ready
 ⋮----
-export interface SpotAccountTransaction {
-  id: string;
-  currency: string;
-  amount: string;
-  fee: string;
-  tax: string;
-  balance: string;
-  accountType: string; // 'TRADE_HF'
-  bizType: string;
-  direction: 'out' | 'in';
-  createdAt: string;
-  context: string;
-}
+// Automatically auth after opening a connection?
 ⋮----
-accountType: string; // 'TRADE_HF'
+// Automatically include auth/sign with every WS request
 ⋮----
-export interface SpotAccountTransactions {
-  currentPage: number;
-  pageSize: number;
-  totalNum: number;
-  totalPage: number;
-  items: SpotAccountTransaction[];
-}
+// Automatically re-auth WS API, if we were auth'd before and get reconnected
 ⋮----
-export interface AccountHFMarginTransactions {
-  id: string;
-  currency: string;
-  amount: string;
-  fee: string;
-  balance: string;
-  accountType: 'MARGIN_V2' | 'ISOLATED_V2';
-  bizType:
-    | 'TRANSFER'
-    | 'MARGIN_EXCHANGE'
-    | 'ISOLATED_EXCHANGE'
-    | 'LIQUIDATION'
-    | 'ASSERT_RETURN';
-  direction: 'out' | 'in';
-  createdAt: string;
-  tax: string;
-  context: string;
-}
+// Check Web Crypto API support when credentials are provided and no custom sign function is used
 ⋮----
-/**
- *
- * Sub-Account
- *
- */
+protected abstract sendPingEvent(wsKey: TWSKey, ws: WebSocket): void;
 ⋮----
-export interface SubAccountInfo {
-  userId: string;
-  uid: number;
-  subName: string;
-  status: number;
-  type: number;
-  access: string;
-  createdAt: number;
-  remarks: string;
-  tradeTypes: string[];
-  openedTradeTypes: string[];
-  hostedStatus: null | string;
-}
+protected abstract sendPongEvent(wsKey: TWSKey, ws: WebSocket): void;
 ⋮----
-export interface SubAccountsV2 {
-  currentPage: number;
-  pageSize: number;
-  totalNum: number;
-  totalPage: number;
-  items: SubAccountInfo[];
-}
+protected abstract isWsPong(data: any): boolean;
 ⋮----
-export interface SubAccountItem {
-  userId: string;
-  uid: number;
-  subName: string;
-  status: number;
-  type: number;
-  access: string;
-  createdAt: number;
-  remarks: string;
-  tradeTypes: string[];
-  openedTradeTypes: string[];
-  hostedStatus: null | string;
-}
+protected abstract isWsPing(data: any): boolean;
 ⋮----
-export interface CreateSubAccount {
-  currentPage: number;
-  pageSize: number;
-  totalNum: number;
-  totalPage: number;
-  items: SubAccountItem[];
-}
+protected abstract getWsAuthRequestEvent(wsKey: TWSKey): Promise<object>;
 ⋮----
-export interface SubAccountBalance {
-  currency: string;
-  balance: string;
-  available: string;
-  holds: string;
-  baseCurrency: string;
-  baseCurrencyPrice: string;
-  baseAmount: string;
-}
+protected abstract isPrivateTopicRequest(
+    request: WsTopicRequest<WSTopic>,
+    wsKey: TWSKey,
+  ): boolean;
 ⋮----
-// deprecated
-export interface SubAccountBalances {
-  subUserId: string;
-  subName: string;
-  mainAccounts: SubAccountBalance[];
-  tradeAccounts: SubAccountBalance[];
-  marginAccounts: SubAccountBalance[];
-}
+/**
+   * Returns a list of string events that can be individually sent upstream to complete subscribing/unsubscribing/etc to these topics
+   */
+protected abstract getWsOperationEventsForTopics(
+    topics: WsTopicRequest<WSTopic>[],
+    wsKey: TWSKey,
+    operation: WsOperation,
+  ): Promise<string[]>;
 ⋮----
-export interface SubAccountBalancesV2 {
-  currentPage: number;
-  pageSize: number;
-  totalNum: number;
-  totalPage: number;
-  items: {
-    subUserId: string;
-    subName: string;
-    mainAccounts: SubAccountBalance[];
-  }[];
-}
-export interface SubAccountV2Details {
-  currency?: string;
-  balance?: string;
-  available?: string;
-  holds?: string;
-  baseCurrency?: string;
-  baseCurrencyPrice?: string;
-  baseAmount?: string;
-  tag?: string;
-}
+protected abstract getPrivateWSKeys(): TWSKey[];
 ⋮----
-export interface SubAccountBalanceItemV2 {
-  subUserId: string;
-  subName: string;
-  mainAccounts: SubAccountV2Details[]; // Funding Account
-  tradeAccounts: SubAccountV2Details[]; // Spot Account
-  marginAccounts: SubAccountV2Details[]; // Margin Account
-  tradeHFAccounts: string[]; // Deprecated, only for old users
-}
+protected abstract getWsUrl(wsKey: TWSKey): Promise<string>;
 ⋮----
-mainAccounts: SubAccountV2Details[]; // Funding Account
-tradeAccounts: SubAccountV2Details[]; // Spot Account
-marginAccounts: SubAccountV2Details[]; // Margin Account
-tradeHFAccounts: string[]; // Deprecated, only for old users
+protected abstract getMaxTopicsPerSubscribeEvent(
+    wsKey: TWSKey,
+  ): number | null;
 ⋮----
 /**
- *
- * Sub-Account API
- *
- *
- */
-⋮----
-export interface SubAccountAPIInfo {
-  subName: string;
-  remark: string;
-  apiKey: string;
-  apiVersion: number;
-  permission: string;
-  ipWhitelist: string;
-  createdAt: number;
-  uid: number;
-  isMaster: boolean;
-}
+   * Abstraction called to sort ws events into emittable event types (response to a request, data update, etc)
+   */
+protected abstract resolveEmittableEvents(
+    wsKey: TWSKey,
+    event: MessageEventLike,
+  ): EmittableEvent[];
 ⋮----
-export interface CreateSubAPI {
-  subName: string;
-  remark: string;
-  apiKey: string;
-  apiSecret: string;
-  apiVersion: number;
-  passphrase: string;
-  permission: string;
-  createdAt: number;
-}
+/**
+   * Request connection of all dependent (public & private) websockets, instead of waiting for automatic connection by library
+   */
+protected abstract connectAll(): Promise<(WSConnectedResult | undefined)[]>;
 ⋮----
-export interface UpdateSubAPI {
-  apiKey: string;
-  ipWhitelist: string;
-  permission: string;
-  subName: string;
-}
+protected isPrivateWsKey(wsKey: TWSKey): boolean
 ⋮----
-export interface DeleteSubAccountAPI {
-  subName: string;
-  apiKey: string;
-}
-
-================
-File: src/BrokerClient.ts
-================
-import { BaseRestClient } from './lib/BaseRestClient.js';
-import { REST_CLIENT_TYPE_ENUM, RestClientType } from './lib/requestUtils.js';
-import {
-  BrokerTransferRequest,
-  CreateBrokerSubAccountApiRequest,
-  DeleteBrokerSubAccountApiRequest,
-  GetBrokerDepositListRequest,
-  GetBrokerInfoRequest,
-  GetBrokerSubAccountApisRequest,
-  GetBrokerSubAccountsRequest,
-  UpdateBrokerSubAccountApiRequest,
-} from './types/request/broker.types.js';
-import {
-  BrokerDepositRecord,
-  BrokerInfo,
-  BrokerSubAccountApi,
-  BrokerTransferHistory,
-  BrokerWithdrawalRecord,
-  CreateBrokerSubAccountApiResponse,
-  CreateBrokerSubAccountResponse,
-  GetBrokerSubAccountsResponse,
-} from './types/response/broker.types.js';
-import { APISuccessResponse } from './types/response/shared.types.js';
+/** Returns auto-incrementing request ID, used to track promise references for async requests */
+protected getNewRequestId(): string
 ⋮----
-/**
- *
- */
-export class BrokerClient extends BaseRestClient
+protected abstract sendWSAPIRequest(
+    wsKey: TWSKey,
+    channel: WSTopic,
+    params?: any,
+  ): Promise<unknown>;
 ⋮----
-getClientType(): RestClientType
+protected abstract sendWSAPIRequest(
+    wsKey: TWSKey,
+    channel: WSTopic,
+    params: any,
+  ): Promise<unknown>;
 ⋮----
 /**
-   * Get Broker Info
+   * Subscribe to one or more topics on a WS connection (identified by WS Key).
    *
-   * This endpoint supports querying the basic information of the current Broker
-   */
-getBrokerInfo(
-    params: GetBrokerInfoRequest,
-): Promise<APISuccessResponse<BrokerInfo>>
-⋮----
-/**
-   * Add SubAccount
+   * - Topics are automatically cached
+   * - Connections are automatically opened, if not yet connected
+   * - Authentication is automatically handled
+   * - Topics are automatically resubscribed to, if something happens to the connection, unless you call unsubsribeTopicsForWsKey(topics, key).
    *
-   * This endpoint supports Broker users to create sub-accounts.
-   * Note that the account name is unique across the exchange.
-   * It is recommended to add a special identifier to prevent name duplication.
+   * @param wsTopicRequests array of topics to subscribe to
+   * @param wsKey ws key referring to the ws connection these topics should be subscribed on
    */
-createSubAccount(params: {
-    accountName: string;
-}): Promise<APISuccessResponse<CreateBrokerSubAccountResponse>>
+public subscribeTopicsForWsKey(
+    wsTopicRequests: WsTopicRequestOrStringTopic<WSTopic>[],
+    wsKey: TWSKey,
+)
 ⋮----
-/**
-   * Get SubAccount
-   *
-   * This interface supports querying sub-accounts created by Broker.
-   * Returns paginated results with default page size of 20 (max 100).
-   */
-getSubAccounts(
-    params: GetBrokerSubAccountsRequest,
-): Promise<APISuccessResponse<GetBrokerSubAccountsResponse>>
+// Store topics, so future automation (post-auth, post-reconnect) has everything needed to resubscribe automatically
+⋮----
+// start connection process if it hasn't yet begun. Topics are automatically subscribed to on-connect
+⋮----
+// Subscribe should happen automatically once connected, nothing to do here after topics are added to wsStore.
 ⋮----
 /**
-   * Add SubAccount API
-   *
-   * This interface supports the creation of Broker sub-account APIKEY.
-   * Supports up to 20 IPs in the whitelist.
-   * Only General, Spot, and Futures permissions can be set.
-   * Label must be between 4 and 32 characters.
-   */
-createSubAccountApi(
-    params: CreateBrokerSubAccountApiRequest,
-): Promise<APISuccessResponse<CreateBrokerSubAccountApiResponse>>
+       * Are we in the process of connection? Nothing to send yet.
+       */
+⋮----
+// We're connected. Check if auth is needed and if already authenticated
 ⋮----
 /**
-   * Get SubAccount API
-   *
-   * This interface supports querying the Broker's sub-account APIKEYs.
-   * Can optionally filter by specific apiKey.
-   */
-getSubAccountApis(
-    params: GetBrokerSubAccountApisRequest,
-): Promise<APISuccessResponse<BrokerSubAccountApi[]>>
+       * If not authenticated yet and auth is required, don't request topics yet.
+       *
+       * Auth should already automatically be in progress, so no action needed from here. Topics will automatically subscribe post-auth success.
+       */
+⋮----
+// Finally, request subscription to topics if the connection is healthy and ready
+⋮----
+protected unsubscribeTopicsForWsKey(
+    wsTopicRequests: WsTopicRequestOrStringTopic<string>[],
+    wsKey: TWSKey,
+)
+⋮----
+// Store topics, so future automation (post-auth, post-reconnect) has everything needed to resubscribe automatically
+⋮----
+// If not connected, don't need to do anything.
+// Removing the topic from the store is enough to stop it from being resubscribed to on reconnect.
+⋮----
+// We're connected. Check if auth is needed and if already authenticated
 ⋮----
 /**
-   * Modify SubAccount API
-   *
-   * This interface supports modifying the Broker's sub-account APIKEY.
-   * Supports up to 20 IPs in the whitelist.
-   * Only General, Spot, and Futures permissions can be set.
-   * Label must be between 4 and 32 characters.
-   */
-updateSubAccountApi(
-    params: UpdateBrokerSubAccountApiRequest,
-): Promise<APISuccessResponse<BrokerSubAccountApi>>
+       * If not authenticated yet and auth is required, don't need to do anything.
+       * We don't subscribe to topics until auth is complete anyway.
+       */
+⋮----
+// Finally, request subscription to topics if the connection is healthy and ready
 ⋮----
 /**
-   * Delete SubAccount API
-   *
-   * This interface supports deleting Broker's sub-account APIKEY.
+   * Splits topic requests into two groups, public & private topic requests
    */
-deleteSubAccountApi(
-    params: DeleteBrokerSubAccountApiRequest,
-): Promise<APISuccessResponse<boolean>>
+private sortTopicRequestsIntoPublicPrivate(
+    wsTopicRequests: WsTopicRequest<string>[],
+    wsKey: TWSKey,
+):
+⋮----
+/** Get the WsStore that tracks websockets & topics */
+public getWsStore(): WsStore<TWSKey, WsTopicRequest<string>>
+⋮----
+public close(wsKey: TWSKey, force?: boolean)
+⋮----
+public closeAll(force?: boolean)
+⋮----
+public isConnected(wsKey: TWSKey): boolean
 ⋮----
 /**
-   * Transfer
-   *
-   * This endpoint supports fund transfer between Broker account and Broker sub-accounts.
-   * Please be aware that withdrawal from sub-account is not directly supported.
-   * Broker has to transfer funds from broker sub-account to broker account to initiate the withdrawals.
-   *
-   * Direction:
-   * - OUT: Broker account is transferred to Broker sub-account
-   * - IN: Broker sub-account is transferred to Broker account
-   *
-   * Account Types:
-   * - MAIN: Funding account
-   * - TRADE: Spot trading account
+   * Request connection to a specific websocket, instead of waiting for automatic connection.
    */
-submitTransfer(params: BrokerTransferRequest): Promise<
-    APISuccessResponse<{
-      orderId: string;
-    }>
-  > {
-    return this.postPrivate('api/v1/broker/nd/transfer', params);
+public async connect(wsKey: TWSKey): Promise<WSConnectedResult | undefined>
+⋮----
+private connectToWsUrl(url: string, wsKey: TWSKey): WebSocket
+⋮----
+private parseWsError(context: string, error: any, wsKey: TWSKey)
+⋮----
+/** Get a signature, build the auth request and send it */
+private async sendAuthRequest(wsKey: TWSKey): Promise<void>
+⋮----
+private reconnectWithDelay(wsKey: TWSKey, connectionDelayMs: number)
+⋮----
+private ping(wsKey: TWSKey)
+⋮----
+private clearTimers(wsKey: TWSKey)
+⋮----
+// Send a ping at intervals
+private clearPingTimer(wsKey: TWSKey)
+⋮----
+// Expect a pong within a time limit
+private clearPongTimer(wsKey: TWSKey)
+⋮----
+// this.logger.trace(`Cleared pong timeout for "${wsKey}"`);
+⋮----
+// this.logger.trace(`No active pong timer for "${wsKey}"`);
 ⋮----
 /**
-   * Get Transfer History
-   *
-   * This endpoint supports querying transfer records of the broker itself and its created sub-accounts.
-   *
-   * Account Types:
-   * - MAIN: Funding account
-   * - TRADE: Spot trading account
-   * - CONTRACT: Contract account
-   * - MARGIN: Margin account
-   * - ISOLATED: Isolated margin account
+   * Simply builds and sends subscribe events for a list of topics for a ws key
    *
-   * Status:
-   * - PROCESSING: Processing
-   * - SUCCESS: Successful
-   * - FAILURE: Failed
+   * @private Use the `subscribe(topics)` or `subscribeTopicsForWsKey(topics, wsKey)` method to subscribe to topics. Send WS message to subscribe to topics.
    */
-getTransferHistory(params: {
-    orderId: string;
-}): Promise<APISuccessResponse<BrokerTransferHistory>>
+private async requestSubscribeTopics(
+    wsKey: TWSKey,
+    topics: WsTopicRequest<string>[],
+)
+⋮----
+// Automatically splits requests into smaller batches, if needed
+⋮----
+`Subscribing to ${topics.length} "${wsKey}" topics in ${subscribeWsMessages.length} batches.`, // Events: "${JSON.stringify(topics)}"
+⋮----
+// this.logger.trace(`Sending batch via message: "${wsMessage}"`);
 ⋮----
 /**
-   * Get Deposit List
-   *
-   * This endpoint can obtain the deposit records of each sub-account under the ND Broker.
-   * Default limit is 1000 records (max 1000).
-   * Results are sorted in descending order by default.
+   * Simply builds and sends unsubscribe events for a list of topics for a ws key
    *
-   * Status:
-   * - PROCESSING: Processing
-   * - SUCCESS: Successful
-   * - FAILURE: Failed
+   * @private Use the `unsubscribe(topics)` method to unsubscribe from topics. Send WS message to unsubscribe from topics.
    */
-getDeposits(
-    params?: GetBrokerDepositListRequest,
-): Promise<APISuccessResponse<BrokerDepositRecord[]>>
+private async requestUnsubscribeTopics(
+    wsKey: TWSKey,
+    wsTopicRequests: WsTopicRequest<string>[],
+)
 ⋮----
 /**
-   * Get Deposit Detail
-   *
-   * This endpoint supports querying the deposit record of sub-accounts created by a Broker
-   * (excluding main account of nd broker).
-   *
-   * Status:
-   * - PROCESSING: Processing
-   * - SUCCESS: Successful
-   * - FAILURE: Failed
+   * Try sending a string event on a WS connection (identified by the WS Key)
    */
-getDeposit(params: {
-    currency: string;
-    hash: string;
-}): Promise<APISuccessResponse<BrokerDepositRecord>>
+public tryWsSend(wsKey: TWSKey, wsMessage: string)
+⋮----
+private async onWsOpen(event: any, wsKey: TWSKey)
 ⋮----
 /**
-   * Get Withdrawal Detail
-   *
-   * This endpoint supports querying the withdrawal records of sub-accounts created by a Broker
-   * (excluding main account of nd broker).
+   * Called automatically once a connection is ready.
+   * - Some exchanges are ready immediately after the connections open.
+   * - Some exchanges send an event to confirm the connection is ready for us.
    *
-   * Status:
-   * - PROCESSING: Processing
-   * - WALLET_PROCESSING: Wallet Processing
-   * - REVIEW: Under Review
-   * - SUCCESS: Successful
-   * - FAILURE: Failed
+   * This method is called to act when the connection is ready. Use `requireConnectionReadyConfirmation` to control how this is called.
    */
-getWithdrawal(params: {
-    withdrawalId: string;
-}): Promise<APISuccessResponse<BrokerWithdrawalRecord>>
+private async onWsReadyForEvents(wsKey: TWSKey)
+⋮----
+// Resolve & cleanup deferred "connection attempt in progress" promise
+⋮----
+// Remove before resolving, in case there's more requests queued
+⋮----
+// Some websockets require an auth packet to be sent after opening the connection
+⋮----
+// Reconnect to topics known before it connected
+⋮----
+// Request sub to public topics, if any
+⋮----
+// Request sub to private topics, if auth on connect isn't needed
 ⋮----
 /**
-   * Get Broker Rebate
+   * Handle subscription to private topics _after_ authentication successfully completes asynchronously.
    *
-   * This interface supports downloading Broker rebate orders.
-   * Returns a URL to download a CSV file containing the rebate data.
-   * The URL is valid for 1 day.
-   * Maximum interval between begin and end dates is 6 months.
+   * Only used for exchanges that require auth before sending private topic subscription requests
    */
-getBrokerRebate(params: {
-    begin: string;
-    end: string;
-    tradeType: '1' | '2';
-  }): Promise<
-    APISuccessResponse<{
-      url: string;
-    }>
-  > {
-    return this.getPrivate('api/v1/broker/nd/rebase/download', params);
-
-================
-File: .eslintrc.cjs
-================
-// 'no-unused-vars': ['warn'],
+private onWsAuthenticated(
+    wsKey: TWSKey,
+    event: { isWSAPI?: boolean; WSAPIAuthChannel?: string },
+)
+⋮----
+private onWsMessage(event: unknown, wsKey: TWSKey, ws: WebSocket)
+⋮----
+// any message can clear the pong timer - wouldn't get a message if the ws wasn't working
+⋮----
+// console.log(`raw event: `, { data, dataType, emittableEvents });
+⋮----
+private onWsClose(event: unknown, wsKey: TWSKey)
+⋮----
+// clean up any pending promises for this connection
+⋮----
+// clean up any pending promises for this connection
+⋮----
+private getWs(wsKey: TWSKey)
+⋮----
+private setWsState(wsKey: TWSKey, state: WsConnectionStateEnum)
+⋮----
+/**
+   * Promise-driven method to assert that a ws has successfully connected (will await until connection is open)
+   */
+protected async assertIsConnected(wsKey: TWSKey): Promise<unknown>
+⋮----
+// Already in progress? Await shared promise and retry
+⋮----
+// Start connection, it should automatically store/return a promise.
 
 ================
 File: src/lib/requestUtils.ts
@@ -5298,6 +5514,7 @@ export interface HFMarginOrder {
   active: boolean;
   createdAt: number;
   lastUpdatedAt: number;
+  cancelReason?: number;
 }
 ⋮----
 /** @deprecated not used anymore **/
@@ -5670,6 +5887,186 @@ export interface LendingRedemption {
   totalPage: number;
   items: LendingOrder[];
 }
+⋮----
+export interface BorrowInterestRateItem {
+  currency: string; // Currency
+  hourlyBorrowRate: string; // Hourly borrow rate
+  annualizedBorrowRate: string; // Annualized borrow rate
+}
+⋮----
+currency: string; // Currency
+hourlyBorrowRate: string; // Hourly borrow rate
+annualizedBorrowRate: string; // Annualized borrow rate
+⋮----
+export interface BorrowInterestRate {
+  vipLevel: number; // The VIP level (0-12)
+  items: BorrowInterestRateItem[]; // Array of currency borrow rates
+}
+⋮----
+vipLevel: number; // The VIP level (0-12)
+items: BorrowInterestRateItem[]; // Array of currency borrow rates
+⋮----
+/**
+ * Margin Stop Order Response Types
+ */
+export interface MarginStopOrderResponse {
+  orderId: string; // The unique order ID generated by the trading system
+  clientOid: string; // The user self-defined order ID
+}
+⋮----
+orderId: string; // The unique order ID generated by the trading system
+clientOid: string; // The user self-defined order ID
+⋮----
+export interface CancelMarginOrdersResponse {
+  cancelledOrderIds: string[]; // Array of cancelled order IDs
+}
+⋮----
+cancelledOrderIds: string[]; // Array of cancelled order IDs
+⋮----
+export interface MarginStopOrderItem {
+  id?: string; // Order ID
+  symbol?: string; // Symbol name
+  userId?: string; // User ID
+  status?: 'NEW' | 'TRIGGERED'; // Order status
+  type?: 'limit' | 'market'; // Order type
+  side?: 'buy' | 'sell'; // Transaction direction
+  price?: string; // Order price
+  size?: string; // Order quantity
+  funds?: string | null; // Order funds
+  stp?: string | null; // Self Trade Prevention
+  timeInForce?: 'GTC' | 'GTT' | 'IOC' | 'FOK'; // Time in force
+  cancelAfter?: number; // Cancel after seconds
+  postOnly?: boolean; // Post only
+  hidden?: boolean; // Hidden order
+  iceberg?: boolean; // Iceberg order
+  visibleSize?: string | null; // Visible size for iceberg orders
+  channel?: string; // Order source
+  clientOid?: string; // Client order ID
+  remark?: string | null; // Remarks
+  tags?: string | null; // Tag order source
+  relatedNo?: string | null; // Related number
+  orderTime?: number; // Order time (nanoseconds)
+  domainId?: string; // Domain ID
+  tradeSource?: 'USER' | 'MARGIN_SYSTEM'; // Trade source
+  tradeType?: 'TRADE' | 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE'; // Trade type
+  feeCurrency?: string; // Fee currency
+  takerFeeRate?: string; // Taker fee rate
+  makerFeeRate?: string; // Maker fee rate
+  createdAt?: number; // Order creation time
+  stop?: 'loss' | 'entry'; // Stop order type
+  stopTriggerTime?: number | null; // Stop trigger time
+  stopPrice?: string; // Stop price
+  limitPrice?: string | null; // Limit price
+  pop?: string | null; // POP
+  activateCondition?: string | null; // Activate condition
+}
+⋮----
+id?: string; // Order ID
+symbol?: string; // Symbol name
+userId?: string; // User ID
+status?: 'NEW' | 'TRIGGERED'; // Order status
+type?: 'limit' | 'market'; // Order type
+side?: 'buy' | 'sell'; // Transaction direction
+price?: string; // Order price
+size?: string; // Order quantity
+funds?: string | null; // Order funds
+stp?: string | null; // Self Trade Prevention
+timeInForce?: 'GTC' | 'GTT' | 'IOC' | 'FOK'; // Time in force
+cancelAfter?: number; // Cancel after seconds
+postOnly?: boolean; // Post only
+hidden?: boolean; // Hidden order
+iceberg?: boolean; // Iceberg order
+visibleSize?: string | null; // Visible size for iceberg orders
+channel?: string; // Order source
+clientOid?: string; // Client order ID
+remark?: string | null; // Remarks
+tags?: string | null; // Tag order source
+relatedNo?: string | null; // Related number
+orderTime?: number; // Order time (nanoseconds)
+domainId?: string; // Domain ID
+tradeSource?: 'USER' | 'MARGIN_SYSTEM'; // Trade source
+tradeType?: 'TRADE' | 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE'; // Trade type
+feeCurrency?: string; // Fee currency
+takerFeeRate?: string; // Taker fee rate
+makerFeeRate?: string; // Maker fee rate
+createdAt?: number; // Order creation time
+stop?: 'loss' | 'entry'; // Stop order type
+stopTriggerTime?: number | null; // Stop trigger time
+stopPrice?: string; // Stop price
+limitPrice?: string | null; // Limit price
+pop?: string | null; // POP
+activateCondition?: string | null; // Activate condition
+⋮----
+export interface MarginStopOrdersList {
+  currentPage: number; // Current page
+  pageSize: number; // Page size
+  totalNum: number; // Total number of stop orders
+  totalPage: number; // Total pages
+  items: MarginStopOrderItem[]; // Array of stop orders
+}
+⋮----
+currentPage: number; // Current page
+pageSize: number; // Page size
+totalNum: number; // Total number of stop orders
+totalPage: number; // Total pages
+items: MarginStopOrderItem[]; // Array of stop orders
+⋮----
+/**
+ * Margin OCO Order Response Types
+ */
+export interface MarginOcoOrderResponse {
+  orderId: string; // The unique order ID generated by the trading system
+}
+⋮----
+orderId: string; // The unique order ID generated by the trading system
+⋮----
+export interface MarginOcoOrderItem {
+  orderId: string; // Order ID
+  symbol: string; // Symbol
+  clientOid: string; // Client Order ID
+  orderTime: number; // Order placement time (milliseconds)
+  status: 'NEW' | 'DONE' | 'TRIGGERED' | 'CANCELLED'; // Order status
+}
+⋮----
+orderId: string; // Order ID
+symbol: string; // Symbol
+clientOid: string; // Client Order ID
+orderTime: number; // Order placement time (milliseconds)
+status: 'NEW' | 'DONE' | 'TRIGGERED' | 'CANCELLED'; // Order status
+⋮----
+export interface MarginOcoOrderSubOrder {
+  id: string; // Sub-order ID
+  symbol: string; // Symbol of the sub-order
+  side: 'buy' | 'sell'; // Side of the sub-order
+  price: string; // Price of the sub-order
+  stopPrice: string; // Stop price of the sub-order
+  size: string; // Size of the sub-order
+  status: 'NEW' | 'DONE' | 'TRIGGERED' | 'CANCELLED'; // Status of the sub-order
+}
+⋮----
+id: string; // Sub-order ID
+symbol: string; // Symbol of the sub-order
+side: 'buy' | 'sell'; // Side of the sub-order
+price: string; // Price of the sub-order
+stopPrice: string; // Stop price of the sub-order
+size: string; // Size of the sub-order
+status: 'NEW' | 'DONE' | 'TRIGGERED' | 'CANCELLED'; // Status of the sub-order
+⋮----
+export interface MarginOcoOrderDetails {
+  orderId: string; // Order ID
+  symbol: string; // Symbol
+  clientOid: string; // Client Order ID
+  orderTime: number; // Order placement time (milliseconds)
+  status: 'NEW' | 'DONE' | 'TRIGGERED' | 'CANCELLED'; // Order status
+  orders: MarginOcoOrderSubOrder[]; // Sub-orders array
+}
+⋮----
+orderId: string; // Order ID
+symbol: string; // Symbol
+clientOid: string; // Client Order ID
+orderTime: number; // Order placement time (milliseconds)
+status: 'NEW' | 'DONE' | 'TRIGGERED' | 'CANCELLED'; // Order status
+orders: MarginOcoOrderSubOrder[]; // Sub-orders array
 
 ================
 File: src/types/websockets/client.ts
@@ -5772,193 +6169,21 @@ export interface WebsocketClientOptions extends WSClientConfigurableOptions {
 export type WsMarket = 'spot' | 'futures';
 
 ================
-File: src/lib/BaseRestClient.ts
+File: src/types/response/spot-trading.ts
 ================
-import axios, { AxiosRequestConfig, AxiosResponse, Method } from 'axios';
-import https from 'https';
+/**
+ *
+ ***********
+ * Spot Trading
+ ***********
+ *
+ */
 ⋮----
-import { neverGuard } from './misc-util.js';
-import {
-  APIIDFutures,
-  APIIDFuturesSign,
-  APIIDMain,
-  APIIDMainSign,
-  getRestBaseUrl,
-  REST_CLIENT_TYPE_ENUM,
-  RestClientOptions,
-  RestClientType,
-  serializeParams,
-} from './requestUtils.js';
-import { checkWebCryptoAPISupported, signMessage } from './webCryptoAPI.js';
-⋮----
-interface SignedRequest<T extends object | undefined = {}> {
-  originalParams: T;
-  paramsWithSign?: T & { sign: string };
-  serializedParams: string;
-  sign: string;
-  queryParamsWithSign: string;
-  timestamp: number;
-  recvWindow: number;
-}
-⋮----
-interface UnsignedRequest<T extends object | undefined = {}> {
-  originalParams: T;
-  paramsWithSign: T;
-}
-⋮----
-type SignMethod = 'kucoin';
-⋮----
-// request: {
-//   url: response.config.url,
-//   method: response.config.method,
-//   data: response.config.data,
-//   headers: response.config.headers,
-// },
-⋮----
-export abstract class BaseRestClient
-⋮----
-/** Defines the client type (affecting how requests & signatures behave) */
-abstract getClientType(): RestClientType;
-⋮----
-/**
-   * Create an instance of the REST client. Pass API credentials in the object in the first parameter.
-   * @param {RestClientOptions} [restClientOptions={}] options to configure REST API connectivity
-   * @param {AxiosRequestConfig} [networkOptions={}] HTTP networking options for axios
-   */
-constructor(
-    restClientOptions: RestClientOptions = {},
-    networkOptions: AxiosRequestConfig = {},
-)
-⋮----
-/** Throw errors if any request params are empty */
-⋮----
-/** in ms == 5 minutes by default */
-⋮----
-/** inject custom rquest options based on axios specs - see axios docs for more guidance on AxiosRequestConfig: https://github.com/axios/axios#request-config */
-⋮----
-// If enabled, configure a https agent with keepAlive enabled
-⋮----
-// Extract existing https agent parameters, if provided, to prevent the keepAlive flag from overwriting an existing https agent completely
-⋮----
-// For more advanced configuration, raise an issue on GitHub or use the "networkOptions"
-// parameter to define a custom httpsAgent with the desired properties
-⋮----
-// Check Web Crypto API support when credentials are provided
-⋮----
-// Throw if one of the 3 values is missing, but at least one of them is set
-⋮----
-/**
-   * Generates a timestamp for signing API requests.
-   *
-   * This method can be overridden or customized using `customTimestampFn`
-   * to implement a custom timestamp synchronization mechanism.
-   * If no custom function is provided, it defaults to the current system time.
-   */
-private getSignTimestampMs(): number
-⋮----
-get(endpoint: string, params?: any)
-⋮----
-post(endpoint: string, params?: any)
-⋮----
-getPrivate(endpoint: string, params?: any)
-⋮----
-postPrivate(endpoint: string, params?: any)
-⋮----
-deletePrivate(endpoint: string, params?: any)
-⋮----
-/**
-   * @private Make a HTTP request to a specific endpoint. Private endpoint API calls are automatically signed.
-   */
-private async _call(
-    method: Method,
-    endpoint: string,
-    params?: any,
-    isPublicApi?: boolean,
-): Promise<any>
-⋮----
-// Sanity check to make sure it's only ever prefixed by one forward slash
-⋮----
-// Build a request and handle signature process
-⋮----
-// Dispatch request
-⋮----
-// Throw if API returns an error (e.g. insufficient balance)
-⋮----
-/**
-   * @private generic handler to parse request exceptions
-   */
-parseException(e: any, requestParams: any): unknown
-⋮----
-// Something happened in setting up the request that triggered an error
-⋮----
-// request made but no response received
-⋮----
-// The request was made and the server responded with a status code
-// that falls out of the range of 2xx
-⋮----
-// console.error('err: ', response?.data);
-⋮----
-// Prevent credentials from leaking into error messages
-⋮----
-/**
-   * @private sign request and set recv window
-   */
-private async signRequest<T extends object | undefined = {}>(
-    data: T,
-    endpoint: string,
-    method: Method,
-    signMethod: SignMethod,
-): Promise<SignedRequest<T>>
-⋮----
-private async prepareSignParams<TParams extends object | undefined>(
-    method: Method,
-    endpoint: string,
-    signMethod: SignMethod,
-    params?: TParams,
-    isPublicApi?: true,
-  ): Promise<UnsignedRequest<TParams>>;
-⋮----
-private async prepareSignParams<TParams extends object | undefined>(
-    method: Method,
-    endpoint: string,
-    signMethod: SignMethod,
-    params?: TParams,
-    isPublicApi?: false | undefined,
-  ): Promise<SignedRequest<TParams>>;
-⋮----
-private async prepareSignParams<TParams extends object | undefined>(
-    method: Method,
-    endpoint: string,
-    signMethod: SignMethod,
-    params?: TParams,
-    isPublicApi?: boolean,
-)
-⋮----
-/** Returns an axios request object. Handles signing process automatically if this is a private API call */
-private async buildRequest(
-    method: Method,
-    endpoint: string,
-    url: string,
-    params?: any,
-    isPublicApi?: boolean,
-): Promise<AxiosRequestConfig>
-
-================
-File: src/types/response/spot-trading.ts
-================
-/**
- *
- ***********
- * Spot Trading
- ***********
- *
- */
-⋮----
-/**
- *
- * Market data
- *
- */
+/**
+ *
+ * Market data
+ *
+ */
 ⋮----
 interface Chain {
   chainName: string;
@@ -6275,6 +6500,7 @@ export interface HFOrder {
   tax: string;
   createdAt: number;
   lastUpdatedAt: number;
+  cancelReason: number;
 }
 ⋮----
 /**
@@ -6697,75 +6923,247 @@ protected async getWsOperationEventsForTopics(
 protected async getWsAuthRequestEvent(wsKey: WsKey): Promise<object>
 
 ================
-File: src/types/response/spot-funding.ts
+File: src/lib/BaseRestClient.ts
 ================
-/**
- *
- ***********
- * Funding
- ***********
- *
- */
-⋮----
-export interface MarginAccountBalance {
-  currency: string;
-  totalBalance: string;
-  availableBalance: string;
-  holdBalance: string;
-  liability: string;
-  maxBorrowSize: string;
-}
-⋮----
-export interface MarginAccountDetail {
-  currency: string;
-  total: string;
-  available: string;
-  hold: string;
-  liability: string;
-  liabilityPrincipal: string;
-  liabilityInterest: string;
-  maxBorrowSize: string;
-  borrowEnabled: boolean;
-  transferInEnabled: boolean;
-}
+import axios, { AxiosRequestConfig, AxiosResponse, Method } from 'axios';
+import https from 'https';
 ⋮----
-export interface MarginBalance {
-  totalAssetOfQuoteCurrency: string;
-  totalLiabilityOfQuoteCurrency: string;
-  debtRatio: string;
-  status: 'EFFECTIVE' | 'BANKRUPTCY' | 'LIQUIDATION' | 'REPAY' | 'BORROW';
-  accounts: MarginAccountDetail[];
-}
-export interface IsolatedMarginAssetDetail {
-  symbol: string;
-  debtRatio: string;
-  status: 'EFFECTIVE' | 'BANKRUPTCY' | 'LIQUIDATION' | 'REPAY' | 'BORROW';
-  baseAsset: MarginAccountDetail;
-  quoteAsset: MarginAccountDetail;
-}
+import { neverGuard } from './misc-util.js';
+import {
+  APIIDFutures,
+  APIIDFuturesSign,
+  APIIDMain,
+  APIIDMainSign,
+  getRestBaseUrl,
+  REST_CLIENT_TYPE_ENUM,
+  RestClientOptions,
+  RestClientType,
+  serializeParams,
+} from './requestUtils.js';
+import { checkWebCryptoAPISupported, signMessage } from './webCryptoAPI.js';
 ⋮----
-export interface IsolatedMarginBalance {
-  totalAssetOfQuoteCurrency: string;
-  totalLiabilityOfQuoteCurrency: string;
+interface SignedRequest<T extends object | undefined = {}> {
+  originalParams: T;
+  paramsWithSign?: T & { sign: string };
+  serializedParams: string;
+  sign: string;
+  queryParamsWithSign: string;
   timestamp: number;
-  assets: IsolatedMarginAssetDetail[];
+  recvWindow: number;
 }
 ⋮----
-/**
- *
- * Deposit
- *
- */
-⋮----
-export interface DepositAddress {
-  address: string;
-  memo: string;
-  chain: string;
+interface UnsignedRequest<T extends object | undefined = {}> {
+  originalParams: T;
+  paramsWithSign: T;
 }
 ⋮----
-export type DepositAddressV2 = DepositAddress & {
-  contractAddress: string;
-};
+type SignMethod = 'kucoin';
+⋮----
+// request: {
+//   url: response.config.url,
+//   method: response.config.method,
+//   data: response.config.data,
+//   headers: response.config.headers,
+// },
+⋮----
+export abstract class BaseRestClient
+⋮----
+/** Defines the client type (affecting how requests & signatures behave) */
+abstract getClientType(): RestClientType;
+⋮----
+/**
+   * Create an instance of the REST client. Pass API credentials in the object in the first parameter.
+   * @param {RestClientOptions} [restClientOptions={}] options to configure REST API connectivity
+   * @param {AxiosRequestConfig} [networkOptions={}] HTTP networking options for axios
+   */
+constructor(
+    restClientOptions: RestClientOptions = {},
+    networkOptions: AxiosRequestConfig = {},
+)
+⋮----
+/** Throw errors if any request params are empty */
+⋮----
+/** in ms == 5 minutes by default */
+⋮----
+/** inject custom rquest options based on axios specs - see axios docs for more guidance on AxiosRequestConfig: https://github.com/axios/axios#request-config */
+⋮----
+// If enabled, configure a https agent with keepAlive enabled
+⋮----
+// Extract existing https agent parameters, if provided, to prevent the keepAlive flag from overwriting an existing https agent completely
+⋮----
+// For more advanced configuration, raise an issue on GitHub or use the "networkOptions"
+// parameter to define a custom httpsAgent with the desired properties
+⋮----
+// Check Web Crypto API support when credentials are provided
+⋮----
+// Throw if one of the 3 values is missing, but at least one of them is set
+⋮----
+/**
+   * Generates a timestamp for signing API requests.
+   *
+   * This method can be overridden or customized using `customTimestampFn`
+   * to implement a custom timestamp synchronization mechanism.
+   * If no custom function is provided, it defaults to the current system time.
+   */
+private getSignTimestampMs(): number
+⋮----
+get(endpoint: string, params?: any)
+⋮----
+post(endpoint: string, params?: any)
+⋮----
+getPrivate(endpoint: string, params?: any)
+⋮----
+postPrivate(endpoint: string, params?: any)
+⋮----
+deletePrivate(endpoint: string, params?: any)
+⋮----
+/**
+   * @private Make a HTTP request to a specific endpoint. Private endpoint API calls are automatically signed.
+   */
+private async _call(
+    method: Method,
+    endpoint: string,
+    params?: any,
+    isPublicApi?: boolean,
+): Promise<any>
+⋮----
+// Sanity check to make sure it's only ever prefixed by one forward slash
+⋮----
+// Build a request and handle signature process
+⋮----
+// Dispatch request
+⋮----
+// Throw if API returns an error (e.g. insufficient balance)
+⋮----
+/**
+   * @private generic handler to parse request exceptions
+   */
+parseException(e: any, requestParams: any): unknown
+⋮----
+// Something happened in setting up the request that triggered an error
+⋮----
+// request made but no response received
+⋮----
+// The request was made and the server responded with a status code
+// that falls out of the range of 2xx
+⋮----
+// console.error('err: ', response?.data);
+⋮----
+// Prevent credentials from leaking into error messages
+⋮----
+/**
+   * @private sign request and set recv window
+   */
+private async signRequest<T extends object | undefined = {}>(
+    data: T,
+    endpoint: string,
+    method: Method,
+    signMethod: SignMethod,
+): Promise<SignedRequest<T>>
+⋮----
+private async prepareSignParams<TParams extends object | undefined>(
+    method: Method,
+    endpoint: string,
+    signMethod: SignMethod,
+    params?: TParams,
+    isPublicApi?: true,
+  ): Promise<UnsignedRequest<TParams>>;
+⋮----
+private async prepareSignParams<TParams extends object | undefined>(
+    method: Method,
+    endpoint: string,
+    signMethod: SignMethod,
+    params?: TParams,
+    isPublicApi?: false | undefined,
+  ): Promise<SignedRequest<TParams>>;
+⋮----
+private async prepareSignParams<TParams extends object | undefined>(
+    method: Method,
+    endpoint: string,
+    signMethod: SignMethod,
+    params?: TParams,
+    isPublicApi?: boolean,
+)
+⋮----
+/** Returns an axios request object. Handles signing process automatically if this is a private API call */
+private async buildRequest(
+    method: Method,
+    endpoint: string,
+    url: string,
+    params?: any,
+    isPublicApi?: boolean,
+): Promise<AxiosRequestConfig>
+
+================
+File: src/types/response/spot-funding.ts
+================
+/**
+ *
+ ***********
+ * Funding
+ ***********
+ *
+ */
+⋮----
+export interface MarginAccountBalance {
+  currency: string;
+  totalBalance: string;
+  availableBalance: string;
+  holdBalance: string;
+  liability: string;
+  maxBorrowSize: string;
+}
+⋮----
+export interface MarginAccountDetail {
+  currency: string;
+  total: string;
+  available: string;
+  hold: string;
+  liability: string;
+  liabilityPrincipal: string;
+  liabilityInterest: string;
+  maxBorrowSize: string;
+  borrowEnabled: boolean;
+  transferInEnabled: boolean;
+}
+⋮----
+export interface MarginBalance {
+  totalAssetOfQuoteCurrency: string;
+  totalLiabilityOfQuoteCurrency: string;
+  debtRatio: string;
+  status: 'EFFECTIVE' | 'BANKRUPTCY' | 'LIQUIDATION' | 'REPAY' | 'BORROW';
+  accounts: MarginAccountDetail[];
+}
+export interface IsolatedMarginAssetDetail {
+  symbol: string;
+  debtRatio: string;
+  status: 'EFFECTIVE' | 'BANKRUPTCY' | 'LIQUIDATION' | 'REPAY' | 'BORROW';
+  baseAsset: MarginAccountDetail;
+  quoteAsset: MarginAccountDetail;
+}
+⋮----
+export interface IsolatedMarginBalance {
+  totalAssetOfQuoteCurrency: string;
+  totalLiabilityOfQuoteCurrency: string;
+  timestamp: number;
+  assets: IsolatedMarginAssetDetail[];
+}
+⋮----
+/**
+ *
+ * Deposit
+ *
+ */
+⋮----
+export interface DepositAddress {
+  address: string;
+  memo: string;
+  chain: string;
+}
+⋮----
+export type DepositAddressV2 = DepositAddress & {
+  contractAddress: string;
+};
 ⋮----
 export interface DepositAddressV3 {
   address: string;
@@ -6888,435 +7286,61 @@ export interface WithdrawalQuotas {
   remainAmount: string;
   availableAmount: string;
   withdrawMinFee: string;
-  innerWithdrawMinFee: string;
-  withdrawMinSize: string;
-  isWithdrawEnabled: boolean;
-  precision: number;
-  chain: string;
-  reason: string | null;
-  lockedAmount: string;
-}
-⋮----
-export interface WithdrawalById {
-  id: string;
-  uid: number;
-  currency: string;
-  chainId: string;
-  chainName: string;
-  currencyName: string;
-  status: string;
-  failureReason: string;
-  failureReasonMsg: string | null;
-  address: string;
-  memo: string;
-  isInner: boolean;
-  amount: string;
-  fee: string;
-  walletTxId: string | null;
-  addressRemark: string | null;
-  remark: string;
-  createdAt: number;
-  cancelType: string;
-  taxes: string | null;
-  taxDescription: string | null;
-  returnStatus: string;
-  returnAmount: string | null;
-  returnCurrency: string;
-}
-⋮----
-/**
- *
- * Transfer
- *
- */
-⋮----
-export interface TransferableFunds {
-  currency: string; // Currency
-  balance: string; // Total funds in an account.
-  available: string; // Funds available to withdraw or trade.
-  holds: string; // Funds on hold (not available for use).
-  transferable: string; // Funds available to transfer.
-}
-⋮----
-currency: string; // Currency
-balance: string; // Total funds in an account.
-available: string; // Funds available to withdraw or trade.
-holds: string; // Funds on hold (not available for use).
-transferable: string; // Funds available to transfer.
-
-================
-File: README.md
-================
-# Node.js & JavaScript SDK for Kucoin REST APIs & Websockets
-
-<p align="center">
-  <a href="https://www.npmjs.com/package/kucoin-api">
-    <picture>
-      <source media="(prefers-color-scheme: dark)" srcset="https://github.com/tiagosiebler/kucoin-api/blob/master/docs/images/logoDarkMode2.svg?raw=true#gh-dark-mode-only">
-      <img alt="SDK Logo" src="https://github.com/tiagosiebler/kucoin-api/blob/master/docs/images/logoBrightMode2.svg?raw=true#gh-light-mode-only">
-    </picture>
-  </a>
-</p>
-
-[![npm version](https://img.shields.io/npm/v/kucoin-api)][1]
-[![npm size](https://img.shields.io/bundlephobia/min/kucoin-api/latest)][1]
-[![npm downloads](https://img.shields.io/npm/dt/kucoin-api)][1]
-[![Build & Test](https://github.com/tiagosiebler/kucoin-api/actions/workflows/e2etest.yml/badge.svg?branch=master)](https://github.com/tiagosiebler/kucoin-api/actions/workflows/e2etest.yml)
-[![last commit](https://img.shields.io/github/last-commit/tiagosiebler/kucoin-api)][1]
-[![Telegram](https://img.shields.io/badge/chat-on%20telegram-blue.svg)](https://t.me/nodetraders)
-
-[1]: https://www.npmjs.com/package/kucoin-api
-
-Updated & performant JavaScript & Node.js SDK for the Kucoin REST APIs and WebSockets:
-
-- Professional, robust & performant Kucoin SDK with extensive production use in live trading environments.
-- Complete integration with all Kucoin REST APIs and WebSockets.
-  - Dedicated REST clients for Spot, Futures, and Broker operations
-  - Unified WebSocket client for all markets
-- Complete TypeScript support (with type declarations for most API requests & responses).
-  - Strongly typed requests and responses.
-  - Automated end-to-end tests ensuring reliability.
-- Actively maintained with a modern, promise-driven interface.
-- Robust WebSocket integration with configurable connection heartbeats & automatic reconnect then resubscribe workflows.
-  - Event driven messaging.
-  - Smart WebSocket persistence with automatic reconnection handling.
-  - Emit `reconnected` event when dropped connection is restored.
-  - Support for both public and private WebSocket streams.
-- Browser-friendly HMAC signature mechanism.
-- Automatically supports both ESM and CJS projects.
-- Heavy automated end-to-end testing with real API calls.
-- Proxy support via axios integration.
-- Active community support & collaboration in telegram: [Node.js Algo Traders](https://t.me/nodetraders).
-
-## Table of Contents
-
-- [Installation](#installation)
-- [Examples](#examples)
-- [Issues & Discussion](#issues--discussion)
-- [Related Projects](#related-projects)
-- [Documentation](#documentation)
-- [Structure](#structure)
-- [Usage](#usage)
-  - [REST API Clients](#rest-api)
-    - [Spot & Margin Trading](#spot--margin-trading)
-    - [Futures Trading](#futures-trading)
-    - [Broker Operations](#broker-operations)
-  - [WebSocket Client](#websockets)
-    - [Public WebSocket Streams](#public-websocket-streams)
-    - [Private WebSocket Streams](#private-websocket-streams)
-- [Customise Logging](#customise-logging)
-- [LLMs & AI](#use-with-llms--ai)
-- [Used By](#used-by)
-- [Contributions & Thanks](#contributions--thanks)
-
-## Installation
-
-`npm install --save kucoin-api`
-
-## Examples
-
-Refer to the [examples](./examples) folder for implementation demos.
-
-## Issues & Discussion
-
-- Issues? Check the [issues tab](https://github.com/tiagosiebler/kucoin-api/issues).
-- Discuss & collaborate with other node devs? Join our [Node.js Algo Traders](https://t.me/nodetraders) engineering community on telegram.
-- Follow our announcement channel for real-time updates on [X/Twitter](https://x.com/sieblyio)
-
-<!-- template_related_projects -->
-
-## Related projects
-
-Check out my related JavaScript/TypeScript/Node.js projects:
-
-- Try my REST API & WebSocket SDKs:
-  - [Bybit-api Node.js SDK](https://www.npmjs.com/package/bybit-api)
-  - [Okx-api Node.js SDK](https://www.npmjs.com/package/okx-api)
-  - [Binance Node.js SDK](https://www.npmjs.com/package/binance)
-  - [Gateio-api Node.js SDK](https://www.npmjs.com/package/gateio-api)
-  - [Bitget-api Node.js SDK](https://www.npmjs.com/package/bitget-api)
-  - [Kucoin-api Node.js SDK](https://www.npmjs.com/package/kucoin-api)
-  - [Coinbase-api Node.js SDK](https://www.npmjs.com/package/coinbase-api)
-  - [Bitmart-api Node.js SDK](https://www.npmjs.com/package/bitmart-api)
-- Try my misc utilities:
-  - [OrderBooks Node.js](https://www.npmjs.com/package/orderbooks)
-  - [Crypto Exchange Account State Cache](https://www.npmjs.com/package/accountstate)
-- Check out my examples:
-  - [awesome-crypto-examples Node.js](https://github.com/tiagosiebler/awesome-crypto-examples)
-  <!-- template_related_projects_end -->
-
-## Documentation
-
-Most methods accept JS objects. These can be populated using parameters specified by Kucoin's API documentation, or check the type definition in each class within this repository.
-
-### API Documentation Links
-
-- [Kucoin API Documentation](https://www.kucoin.com/docs-new/introduction)
-
-### SDK Documentation & Guides
-
-- Node.js Quick Start Guides
-  - [Spot Node.js Kucoin Quick Start Guide](./examples/kucoin-SPOT-examples-nodejs.md)
-  - [Futures Node.js Kucoin Quick Start Guide](./examples/kucoin-FUTURES-examples-nodejs.md)
-- [Futures Node.js Kucoin Order Placement Guide](./examples/rest-futures-orders-guide.ts)
-- [REST Endpoint Function List](./docs/endpointFunctionList.md)
-
-## Structure
-
-This project uses typescript. Resources are stored in 2 key structures:
-
-- [src](./src) - the whole connector written in typescript
-- [examples](./examples) - some implementation examples & demonstrations. Contributions are welcome!
-
----
-
-# Usage
-
-Create API credentials on Kucoin's website:
-
-- [Kucoin API Key Management](https://www.kucoin.com/account/api)
-
-## REST API
-
-The SDK provides dedicated REST clients for different trading products:
-
-- **SpotClient** - for spot trading and margin operations
-- **FuturesClient** - for futures trading operations
-- **BrokerClient** - for broker and sub-account management
-
-### Spot & Margin Trading
-
-To use Kucoin's Spot and Margin APIs, import (or require) the `SpotClient`:
-
-```javascript
-const { SpotClient, FuturesClient } = require('kucoin-api');
-
-const client = new SpotClient({
-  apiKey: 'apiKeyHere',
-  apiSecret: 'apiSecretHere',
-  apiPassphrase: 'apiPassPhraseHere',
-});
-
-try {
-  const spotBuyResult = await client.submitHFOrder({
-    clientOid: client.generateNewOrderID(),
-    side: 'buy',
-    type: 'market',
-    symbol: 'BTC-USDT',
-    size: '0.00001',
-  });
-  console.log('spotBuy ', JSON.stringify(spotBuyResult, null, 2));
-
-  const spotSellResult = await client.submitHFOrder({
-    clientOid: client.generateNewOrderID(),
-    side: 'sell',
-    type: 'market',
-    symbol: 'BTC-USDT',
-    size: '0.00001',
-  });
-  console.log('spotSellResult ', JSON.stringify(spotSellResult, null, 2));
-} catch (e) {
-  console.error(`Req error: `, e);
-}
-```
-
-See [SpotClient](./src/SpotClient.ts) for further information, or the [examples](./examples/) for lots of usage examples.
-
-### Futures Trading
-
-Use the `FuturesClient` for futures trading operations. See [FuturesClient](./src/FuturesClient.ts) for complete API coverage.
-
-### Broker Operations
-
-Use the `BrokerClient` for broker and sub-account management operations. See [BrokerClient](./src/BrokerClient.ts) for complete API coverage.
-
-## WebSockets
-
-All WebSocket functionality is supported via the unified `WebsocketClient`. This client handles both spot and futures WebSocket streams with automatic connection management and reconnection.
-
-Key WebSocket features:
-
-- Event driven messaging
-- Smart WebSocket persistence with automatic reconnection
-- Heartbeat mechanisms to detect disconnections
-- Automatic resubscription after reconnection
-- Support for both public and private WebSocket streams
-- Unified client for spot and futures markets
-
-### Public WebSocket Streams
-
-For public market data, API credentials are not required:
-
-All available WebSockets can be used via a shared `WebsocketClient`. The WebSocket client will automatically open/track/manage connections as needed. Each unique connection (one per server URL) is tracked using a WsKey (each WsKey is a string - see [WS_KEY_MAP](src/lib/websocket/websocket-util.ts) for a list of supported values).
-
-Any subscribe/unsubscribe events will need to include a WsKey, so the WebSocket client understands which connection the event should be routed to. See examples below or in the [examples](./examples/) folder on GitHub.
-
-Data events are emitted from the WebsocketClient via the `update` event, see example below:
-
-```javascript
-const { WebsocketClient } = require('kucoin-api');
-
-const client = new WebsocketClient();
-
-client.on('open', (data) => {
-  console.log('open: ', data?.wsKey);
-});
-
-// Data received
-client.on('update', (data) => {
-  console.info('data received: ', JSON.stringify(data));
-});
-
-// Something happened, attempting to reconenct
-client.on('reconnect', (data) => {
-  console.log('reconnect: ', data);
-});
-
-// Reconnect successful
-client.on('reconnected', (data) => {
-  console.log('reconnected: ', data);
-});
-
-// Connection closed. If unexpected, expect reconnect -> reconnected.
-client.on('close', (data) => {
-  console.error('close: ', data);
-});
-
-// Reply to a request, e.g. "subscribe"/"unsubscribe"/"authenticate"
-client.on('response', (data) => {
-  console.info('response: ', data);
-  // throw new Error('res?');
-});
-
-client.on('exception', (data) => {
-  console.error('exception: ', {
-    msg: data.msg,
-    errno: data.errno,
-    code: data.code,
-    syscall: data.syscall,
-    hostname: data.hostname,
-  });
-});
-
-try {
-  // Optional: await a connection to be ready before subscribing (this is not necessary)
-  // await client.connect('futuresPublicV1');
-
-  /**
-   * Examples for public futures websocket topics (that don't require authentication).
-   *
-   * These should all subscribe via the "futuresPublicV1" wsKey. For detailed usage, refer to the ws-spot-public.ts example.
-   */
-  client.subscribe(
-    [
-      '/contractMarket/tickerV2:XBTUSDM',
-      '/contractMarket/ticker:XBTUSDM',
-      '/contractMarket/level2:XBTUSDM',
-      '/contractMarket/execution:XBTUSDM',
-      '/contractMarket/level2Depth5:XBTUSDM',
-      '/contractMarket/level2Depth50:XBTUSDM',
-      '/contractMarket/limitCandle:XBTUSDTM_1hour',
-      '/contract/instrument:XBTUSDM',
-      '/contract/announcement',
-      '/contractMarket/snapshot:XBTUSDM',
-    ],
-    'futuresPublicV1',
-  );
-} catch (e) {
-  console.error(`Subscribe exception: `, e);
-}
-```
-
-### Private WebSocket Streams
-
-For private account data streams, API credentials are required. The WebsocketClient will automatically handle authentication when you provide API credentials.
-
-See [WebsocketClient](./src/WebsocketClient.ts) for further information and make sure to check the [examples](./examples/) folder for much more detail, especially [ws-spot-public.ts](./examples/ws-spot-public.ts), which explains a lot of detail.
-
----
-
-## Customise Logging
-
-Pass a custom logger which supports the log methods `trace`, `info` and `error`, or override methods from the default logger as desired.
-
-```javascript
-const { WebsocketClient, DefaultLogger } = require('kucoin-api');
-
-// E.g. customise logging for only the trace level:
-const logger = {
-  // Inherit existing logger methods, using an object spread
-  ...DefaultLogger,
-  // Define a custom trace function to override only that function
-  trace: (...params) => {
-    if (
-      [
-        'Sending ping',
-        // 'Sending upstream ws message: ',
-        'Received pong',
-      ].includes(params[0])
-    ) {
-      return;
-    }
-    console.log('trace', JSON.stringify(params, null, 2));
-  },
-};
-
-const ws = new WebsocketClient(
-  {
-    apiKey: 'apiKeyHere',
-    apiSecret: 'apiSecretHere',
-    apiPassphrase: 'apiPassPhraseHere',
-  },
-  logger,
-);
-```
-
-## Use with LLMs & AI
-
-This SDK includes a bundled `llms.txt` file in the root of the repository. If you're developing with LLMs, use the included `llms.txt` with your LLM - it will significantly improve the LLMs understanding of how to correctly use this SDK.
-
-This file contains AI optimised structure of all the functions in this package, and their parameters for easier use with any learning models or artificial intelligence.
-
----
-
-## Used By
-
-[![Repository Users Preview Image](https://dependents.info/tiagosiebler/kucoin-api/image)](https://github.com/tiagosiebler/kucoin-api/network/dependents)
-
----
-
-<!-- template_contributions -->
-
-### Contributions & Thanks
-
-Have my projects helped you? Share the love, there are many ways you can show your thanks:
-
-- Star & share my projects.
-- Are my projects useful? Sponsor me on Github and support my effort to maintain & improve them: https://github.com/sponsors/tiagosiebler
-- Have an interesting project? Get in touch & invite me to it.
-- Or buy me all the coffee:
-  - ETH(ERC20): `0xA3Bda8BecaB4DCdA539Dc16F9C54a592553Be06C` <!-- metamask -->
-
-<!---
-old ones:
-  - BTC: `1C6GWZL1XW3jrjpPTS863XtZiXL1aTK7Jk`
-  - BTC(SegWit): `bc1ql64wr9z3khp2gy7dqlmqw7cp6h0lcusz0zjtls`
-  - ETH(ERC20): `0xe0bbbc805e0e83341fadc210d6202f4022e50992`
-  - USDT(TRC20): `TA18VUywcNEM9ahh3TTWF3sFpt9rkLnnQa
--->
-<!-- template_contributions_end -->
-
-### Contributions & Pull Requests
-
-Contributions are encouraged, I will review any incoming pull requests. See the issues tab for todo items.
-
-<!-- template_star_history -->
-
-## Star History
-
-[![Star History Chart](https://api.star-history.com/svg?repos=tiagosiebler/bybit-api,tiagosiebler/okx-api,tiagosiebler/binance,tiagosiebler/bitget-api,tiagosiebler/bitmart-api,tiagosiebler/gateio-api,tiagosiebler/kucoin-api,tiagosiebler/coinbase-api,tiagosiebler/orderbooks,tiagosiebler/accountstate,tiagosiebler/awesome-crypto-examples&type=Date)](https://star-history.com/#tiagosiebler/bybit-api&tiagosiebler/okx-api&tiagosiebler/binance&tiagosiebler/bitget-api&tiagosiebler/bitmart-api&tiagosiebler/gateio-api&tiagosiebler/kucoin-api&tiagosiebler/coinbase-api&tiagosiebler/orderbooks&tiagosiebler/accountstate&tiagosiebler/awesome-crypto-examples&Date)
-
-<!-- template_star_history_end -->
+  innerWithdrawMinFee: string;
+  withdrawMinSize: string;
+  isWithdrawEnabled: boolean;
+  precision: number;
+  chain: string;
+  reason: string | null;
+  lockedAmount: string;
+}
+⋮----
+export interface WithdrawalById {
+  id: string;
+  uid: number;
+  currency: string;
+  chainId: string;
+  chainName: string;
+  currencyName: string;
+  status: string;
+  failureReason: string;
+  failureReasonMsg: string | null;
+  address: string;
+  memo: string;
+  isInner: boolean;
+  amount: string;
+  fee: string;
+  walletTxId: string | null;
+  addressRemark: string | null;
+  remark: string;
+  createdAt: number;
+  cancelType: string;
+  taxes: string | null;
+  taxDescription: string | null;
+  returnStatus: string;
+  returnAmount: string | null;
+  returnCurrency: string;
+}
+⋮----
+/**
+ *
+ * Transfer
+ *
+ */
+⋮----
+export interface TransferableFunds {
+  currency: string; // Currency
+  balance: string; // Total funds in an account.
+  available: string; // Funds available to withdraw or trade.
+  holds: string; // Funds on hold (not available for use).
+  transferable: string; // Funds available to transfer.
+}
+⋮----
+currency: string; // Currency
+balance: string; // Total funds in an account.
+available: string; // Funds available to withdraw or trade.
+holds: string; // Funds on hold (not available for use).
+transferable: string; // Funds available to transfer.
 
 ================
 File: src/types/response/futures.types.ts
@@ -8199,6 +8223,380 @@ export interface CopyTradePosition {
   settleCurrency: string;
 }
 
+================
+File: README.md
+================
+# Node.js & JavaScript SDK for Kucoin REST APIs & Websockets
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/kucoin-api">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://github.com/tiagosiebler/kucoin-api/blob/master/docs/images/logoDarkMode2.svg?raw=true#gh-dark-mode-only">
+      <img alt="SDK Logo" src="https://github.com/tiagosiebler/kucoin-api/blob/master/docs/images/logoBrightMode2.svg?raw=true#gh-light-mode-only">
+    </picture>
+  </a>
+</p>
+
+[![npm version](https://img.shields.io/npm/v/kucoin-api)][1]
+[![npm size](https://img.shields.io/bundlephobia/min/kucoin-api/latest)][1]
+[![npm downloads](https://img.shields.io/npm/dt/kucoin-api)][1]
+[![Build & Test](https://github.com/tiagosiebler/kucoin-api/actions/workflows/e2etest.yml/badge.svg?branch=master)](https://github.com/tiagosiebler/kucoin-api/actions/workflows/e2etest.yml)
+[![last commit](https://img.shields.io/github/last-commit/tiagosiebler/kucoin-api)][1]
+[![Telegram](https://img.shields.io/badge/chat-on%20telegram-blue.svg)](https://t.me/nodetraders)
+
+[1]: https://www.npmjs.com/package/kucoin-api
+
+Updated & performant JavaScript & Node.js SDK for the Kucoin REST APIs and WebSockets:
+
+- Professional, robust & performant Kucoin SDK with extensive production use in live trading environments.
+- Complete integration with all Kucoin REST APIs and WebSockets.
+  - Dedicated REST clients for Spot, Futures, and Broker operations
+  - Unified WebSocket client for all markets
+- Complete TypeScript support (with type declarations for most API requests & responses).
+  - Strongly typed requests and responses.
+  - Automated end-to-end tests ensuring reliability.
+- Actively maintained with a modern, promise-driven interface.
+- Robust WebSocket integration with configurable connection heartbeats & automatic reconnect then resubscribe workflows.
+  - Event driven messaging.
+  - Smart WebSocket persistence with automatic reconnection handling.
+  - Emit `reconnected` event when dropped connection is restored.
+  - Support for both public and private WebSocket streams.
+- Browser-friendly HMAC signature mechanism.
+- Automatically supports both ESM and CJS projects.
+- Heavy automated end-to-end testing with real API calls.
+- Proxy support via axios integration.
+- Active community support & collaboration in telegram: [Node.js Algo Traders](https://t.me/nodetraders).
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Examples](#examples)
+- [Issues & Discussion](#issues--discussion)
+- [Related Projects](#related-projects)
+- [Documentation](#documentation)
+- [Structure](#structure)
+- [Usage](#usage)
+  - [REST API Clients](#rest-api)
+    - [Spot & Margin Trading](#spot--margin-trading)
+    - [Futures Trading](#futures-trading)
+    - [Broker Operations](#broker-operations)
+  - [WebSocket Client](#websockets)
+    - [Public WebSocket Streams](#public-websocket-streams)
+    - [Private WebSocket Streams](#private-websocket-streams)
+- [Customise Logging](#customise-logging)
+- [LLMs & AI](#use-with-llms--ai)
+- [Used By](#used-by)
+- [Contributions & Thanks](#contributions--thanks)
+
+## Installation
+
+`npm install --save kucoin-api`
+
+## Examples
+
+Refer to the [examples](./examples) folder for implementation demos.
+
+## Issues & Discussion
+
+- Issues? Check the [issues tab](https://github.com/tiagosiebler/kucoin-api/issues).
+- Discuss & collaborate with other node devs? Join our [Node.js Algo Traders](https://t.me/nodetraders) engineering community on telegram.
+- Follow our announcement channel for real-time updates on [X/Twitter](https://x.com/sieblyio)
+
+<!-- template_related_projects -->
+
+## Related projects
+
+Check out my related JavaScript/TypeScript/Node.js projects:
+
+- Try my REST API & WebSocket SDKs:
+  - [Bybit-api Node.js SDK](https://www.npmjs.com/package/bybit-api)
+  - [Okx-api Node.js SDK](https://www.npmjs.com/package/okx-api)
+  - [Binance Node.js SDK](https://www.npmjs.com/package/binance)
+  - [Gateio-api Node.js SDK](https://www.npmjs.com/package/gateio-api)
+  - [Bitget-api Node.js SDK](https://www.npmjs.com/package/bitget-api)
+  - [Kucoin-api Node.js SDK](https://www.npmjs.com/package/kucoin-api)
+  - [Coinbase-api Node.js SDK](https://www.npmjs.com/package/coinbase-api)
+  - [Bitmart-api Node.js SDK](https://www.npmjs.com/package/bitmart-api)
+- Try my misc utilities:
+  - [OrderBooks Node.js](https://www.npmjs.com/package/orderbooks)
+  - [Crypto Exchange Account State Cache](https://www.npmjs.com/package/accountstate)
+- Check out my examples:
+  - [awesome-crypto-examples Node.js](https://github.com/tiagosiebler/awesome-crypto-examples)
+  <!-- template_related_projects_end -->
+
+## Documentation
+
+Most methods accept JS objects. These can be populated using parameters specified by Kucoin's API documentation, or check the type definition in each class within this repository.
+
+### API Documentation Links
+
+- [Kucoin API Documentation](https://www.kucoin.com/docs-new/introduction)
+
+### SDK Documentation & Guides
+
+- Node.js Quick Start Guides
+  - [Spot Node.js Kucoin Quick Start Guide](./examples/kucoin-SPOT-examples-nodejs.md)
+  - [Futures Node.js Kucoin Quick Start Guide](./examples/kucoin-FUTURES-examples-nodejs.md)
+- [Futures Node.js Kucoin Order Placement Guide](./examples/rest-futures-orders-guide.ts)
+- [REST Endpoint Function List](./docs/endpointFunctionList.md)
+
+## Structure
+
+This project uses typescript. Resources are stored in 2 key structures:
+
+- [src](./src) - the whole connector written in typescript
+- [examples](./examples) - some implementation examples & demonstrations. Contributions are welcome!
+
+---
+
+# Usage
+
+Create API credentials on Kucoin's website:
+
+- [Kucoin API Key Management](https://www.kucoin.com/account/api)
+
+## REST API
+
+The SDK provides dedicated REST clients for different trading products:
+
+- **SpotClient** - for spot trading and margin operations
+- **FuturesClient** - for futures trading operations
+- **BrokerClient** - for broker and sub-account management
+
+### Spot & Margin Trading
+
+To use Kucoin's Spot and Margin APIs, import (or require) the `SpotClient`:
+
+```javascript
+const { SpotClient, FuturesClient } = require('kucoin-api');
+
+const client = new SpotClient({
+  apiKey: 'apiKeyHere',
+  apiSecret: 'apiSecretHere',
+  apiPassphrase: 'apiPassPhraseHere',
+});
+
+try {
+  const spotBuyResult = await client.submitHFOrder({
+    clientOid: client.generateNewOrderID(),
+    side: 'buy',
+    type: 'market',
+    symbol: 'BTC-USDT',
+    size: '0.00001',
+  });
+  console.log('spotBuy ', JSON.stringify(spotBuyResult, null, 2));
+
+  const spotSellResult = await client.submitHFOrder({
+    clientOid: client.generateNewOrderID(),
+    side: 'sell',
+    type: 'market',
+    symbol: 'BTC-USDT',
+    size: '0.00001',
+  });
+  console.log('spotSellResult ', JSON.stringify(spotSellResult, null, 2));
+} catch (e) {
+  console.error(`Req error: `, e);
+}
+```
+
+See [SpotClient](./src/SpotClient.ts) for further information, or the [examples](./examples/) for lots of usage examples.
+
+### Futures Trading
+
+Use the `FuturesClient` for futures trading operations. See [FuturesClient](./src/FuturesClient.ts) for complete API coverage.
+
+### Broker Operations
+
+Use the `BrokerClient` for broker and sub-account management operations. See [BrokerClient](./src/BrokerClient.ts) for complete API coverage.
+
+## WebSockets
+
+All WebSocket functionality is supported via the unified `WebsocketClient`. This client handles both spot and futures WebSocket streams with automatic connection management and reconnection.
+
+Key WebSocket features:
+
+- Event driven messaging
+- Smart WebSocket persistence with automatic reconnection
+- Heartbeat mechanisms to detect disconnections
+- Automatic resubscription after reconnection
+- Support for both public and private WebSocket streams
+- Unified client for spot and futures markets
+
+### Public WebSocket Streams
+
+For public market data, API credentials are not required:
+
+All available WebSockets can be used via a shared `WebsocketClient`. The WebSocket client will automatically open/track/manage connections as needed. Each unique connection (one per server URL) is tracked using a WsKey (each WsKey is a string - see [WS_KEY_MAP](src/lib/websocket/websocket-util.ts) for a list of supported values).
+
+Any subscribe/unsubscribe events will need to include a WsKey, so the WebSocket client understands which connection the event should be routed to. See examples below or in the [examples](./examples/) folder on GitHub.
+
+Data events are emitted from the WebsocketClient via the `update` event, see example below:
+
+```javascript
+const { WebsocketClient } = require('kucoin-api');
+
+const client = new WebsocketClient();
+
+client.on('open', (data) => {
+  console.log('open: ', data?.wsKey);
+});
+
+// Data received
+client.on('update', (data) => {
+  console.info('data received: ', JSON.stringify(data));
+});
+
+// Something happened, attempting to reconenct
+client.on('reconnect', (data) => {
+  console.log('reconnect: ', data);
+});
+
+// Reconnect successful
+client.on('reconnected', (data) => {
+  console.log('reconnected: ', data);
+});
+
+// Connection closed. If unexpected, expect reconnect -> reconnected.
+client.on('close', (data) => {
+  console.error('close: ', data);
+});
+
+// Reply to a request, e.g. "subscribe"/"unsubscribe"/"authenticate"
+client.on('response', (data) => {
+  console.info('response: ', data);
+  // throw new Error('res?');
+});
+
+client.on('exception', (data) => {
+  console.error('exception: ', {
+    msg: data.msg,
+    errno: data.errno,
+    code: data.code,
+    syscall: data.syscall,
+    hostname: data.hostname,
+  });
+});
+
+try {
+  // Optional: await a connection to be ready before subscribing (this is not necessary)
+  // await client.connect('futuresPublicV1');
+
+  /**
+   * Examples for public futures websocket topics (that don't require authentication).
+   *
+   * These should all subscribe via the "futuresPublicV1" wsKey. For detailed usage, refer to the ws-spot-public.ts example.
+   */
+  client.subscribe(
+    [
+      '/contractMarket/tickerV2:XBTUSDM',
+      '/contractMarket/ticker:XBTUSDM',
+      '/contractMarket/level2:XBTUSDM',
+      '/contractMarket/execution:XBTUSDM',
+      '/contractMarket/level2Depth5:XBTUSDM',
+      '/contractMarket/level2Depth50:XBTUSDM',
+      '/contractMarket/limitCandle:XBTUSDTM_1hour',
+      '/contract/instrument:XBTUSDM',
+      '/contract/announcement',
+      '/contractMarket/snapshot:XBTUSDM',
+    ],
+    'futuresPublicV1',
+  );
+} catch (e) {
+  console.error(`Subscribe exception: `, e);
+}
+```
+
+### Private WebSocket Streams
+
+For private account data streams, API credentials are required. The WebsocketClient will automatically handle authentication when you provide API credentials.
+
+See [WebsocketClient](./src/WebsocketClient.ts) for further information and make sure to check the [examples](./examples/) folder for much more detail, especially [ws-spot-public.ts](./examples/ws-spot-public.ts), which explains a lot of detail.
+
+---
+
+## Customise Logging
+
+Pass a custom logger which supports the log methods `trace`, `info` and `error`, or override methods from the default logger as desired.
+
+```javascript
+const { WebsocketClient, DefaultLogger } = require('kucoin-api');
+
+// E.g. customise logging for only the trace level:
+const logger = {
+  // Inherit existing logger methods, using an object spread
+  ...DefaultLogger,
+  // Define a custom trace function to override only that function
+  trace: (...params) => {
+    if (
+      [
+        'Sending ping',
+        // 'Sending upstream ws message: ',
+        'Received pong',
+      ].includes(params[0])
+    ) {
+      return;
+    }
+    console.log('trace', JSON.stringify(params, null, 2));
+  },
+};
+
+const ws = new WebsocketClient(
+  {
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPassphrase: 'apiPassPhraseHere',
+  },
+  logger,
+);
+```
+
+## Use with LLMs & AI
+
+This SDK includes a bundled `llms.txt` file in the root of the repository. If you're developing with LLMs, use the included `llms.txt` with your LLM - it will significantly improve the LLMs understanding of how to correctly use this SDK.
+
+This file contains AI optimised structure of all the functions in this package, and their parameters for easier use with any learning models or artificial intelligence.
+
+---
+
+## Used By
+
+[![Repository Users Preview Image](https://dependents.info/tiagosiebler/kucoin-api/image)](https://github.com/tiagosiebler/kucoin-api/network/dependents)
+
+---
+
+<!-- template_contributions -->
+
+### Contributions & Thanks
+
+Have my projects helped you? Share the love, there are many ways you can show your thanks:
+
+- Star & share my projects.
+- Are my projects useful? Sponsor me on Github and support my effort to maintain & improve them: https://github.com/sponsors/tiagosiebler
+- Have an interesting project? Get in touch & invite me to it.
+- Or buy me all the coffee:
+  - ETH(ERC20): `0xA3Bda8BecaB4DCdA539Dc16F9C54a592553Be06C` <!-- metamask -->
+
+<!---
+old ones:
+  - BTC: `1C6GWZL1XW3jrjpPTS863XtZiXL1aTK7Jk`
+  - BTC(SegWit): `bc1ql64wr9z3khp2gy7dqlmqw7cp6h0lcusz0zjtls`
+  - ETH(ERC20): `0xe0bbbc805e0e83341fadc210d6202f4022e50992`
+  - USDT(TRC20): `TA18VUywcNEM9ahh3TTWF3sFpt9rkLnnQa
+-->
+<!-- template_contributions_end -->
+
+### Contributions & Pull Requests
+
+Contributions are encouraged, I will review any incoming pull requests. See the issues tab for todo items.
+
+<!-- template_star_history -->
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=tiagosiebler/bybit-api,tiagosiebler/okx-api,tiagosiebler/binance,tiagosiebler/bitget-api,tiagosiebler/bitmart-api,tiagosiebler/gateio-api,tiagosiebler/kucoin-api,tiagosiebler/coinbase-api,tiagosiebler/orderbooks,tiagosiebler/accountstate,tiagosiebler/awesome-crypto-examples&type=Date)](https://star-history.com/#tiagosiebler/bybit-api&tiagosiebler/okx-api&tiagosiebler/binance&tiagosiebler/bitget-api&tiagosiebler/bitmart-api&tiagosiebler/gateio-api&tiagosiebler/kucoin-api&tiagosiebler/coinbase-api&tiagosiebler/orderbooks&tiagosiebler/accountstate&tiagosiebler/awesome-crypto-examples&Date)
+
+<!-- template_star_history_end -->
+
 ================
 File: src/FuturesClient.ts
 ================
@@ -9080,6 +9478,7 @@ import {
   GetAffiliateCommissionRequest,
   GetAffiliateInviteesRequest,
   GetAffiliateTradeHistoryRequest,
+  GetAffiliateTransactionRequest,
 } from './types/request/spot-affiliate.js';
 import {
   AddConvertLimitOrderRequest,
@@ -9116,10 +9515,21 @@ import {
   SubmitWithdrawV3Request,
 } from './types/request/spot-funding.js';
 import {
+  BatchCancelMarginOcoOrdersRequest,
+  BatchCancelMarginStopOrdersRequest,
+  CancelMarginOcoOrderByClientOidRequest,
+  CancelMarginOcoOrderByOrderIdRequest,
+  CancelMarginStopOrderByClientOidRequest,
+  GetBorrowInterestRateRequest,
   GetHFMarginFilledRequest,
   getHFMarginFillsRequest,
   GetLendingRedemptionOrdersV3Request,
   GetLendingSubscriptionOrdersV3Request,
+  GetMarginOcoOrderByClientOidRequest,
+  GetMarginOcoOrderDetailByOrderIdRequest,
+  GetMarginStopOrderByClientOidRequest,
+  GetMarginStopOrderByOrderIdRequest,
+  GetMarginStopOrdersListRequest,
   HFMarginRequestOrder,
   InitiateLendingRedemptionV3Request,
   InitiateLendingSubscriptionV3Request,
@@ -9130,7 +9540,9 @@ import {
   MarginRiskLimitRequest,
   ModifyLendingSubscriptionOrdersV3Request,
   SubmitHFMarginOrderRequest,
+  SubmitMarginOcoOrderRequest,
   SubmitMarginOrderRequest,
+  SubmitMarginStopOrderRequest,
 } from './types/request/spot-margin-trading.js';
 import { GetAnnouncementsRequest } from './types/request/spot-misc.js';
 import {
@@ -9176,6 +9588,7 @@ import {
   AffiliateCommissionItem,
   AffiliateInvitees,
   AffiliateTradeHistory,
+  AffiliateTransaction,
 } from './types/response/spot-affiliate.js';
 import {
   ConvertCurrencies,
@@ -9216,6 +9629,8 @@ import {
   Withdrawals,
 } from './types/response/spot-funding.js';
 import {
+  BorrowInterestRate,
+  CancelMarginOrdersResponse,
   HFMarginOrder,
   HFMarginTransactionRecord,
   IsolatedMarginAccountInfo,
@@ -9228,9 +9643,15 @@ import {
   MarginInterestRecords,
   MarginLevTokenInfo,
   MarginMarkPrice,
+  MarginOcoOrderDetails,
+  MarginOcoOrderItem,
+  MarginOcoOrderResponse,
   MarginOrderV3,
   MarginRepayHistoryV3,
   MarginRiskLimit,
+  MarginStopOrderItem,
+  MarginStopOrderResponse,
+  MarginStopOrdersList,
   MarginSubmitOrderV3Response,
   SingleIsolatedMarginAccountInfo,
   SubmitMarginOrderResponse,
@@ -10484,12 +10905,138 @@ getHFMarginOrderByClientOid(params: {
     symbol: string;
 }): Promise<APISuccessResponse<HFMarginOrder>>
 ⋮----
+/**
+   * Add Margin Stop Order
+   *
+   * Place stop order to the margin trading system. The maximum untriggered stop orders for a single trading pair in one account is 20.
+   */
+addMarginStopOrder(
+    params: SubmitMarginStopOrderRequest,
+): Promise<APISuccessResponse<MarginStopOrderResponse>>
+⋮----
+/**
+   * Cancel Margin Stop Order By OrderId
+   *
+   * Request via this endpoint the cancellation of a single stop order previously placed.
+   */
+cancelMarginStopOrderByOrderId(params: {
+    orderId: string;
+}): Promise<APISuccessResponse<CancelMarginOrdersResponse>>
+⋮----
+/**
+   * Cancel Margin Stop Order By ClientOid
+   *
+   * This endpoint can be used to cancel a stop order by clientOid.
+   */
+cancelMarginStopOrderByClientOid(
+    params: CancelMarginStopOrderByClientOidRequest,
+): Promise<APISuccessResponse<CancelMarginOrdersResponse>>
+⋮----
+/**
+   * Batch Cancel Margin Stop Orders
+   *
+   * Request via this interface to cancel a batch of stop orders.
+   */
+batchCancelMarginStopOrder(
+    params: BatchCancelMarginStopOrdersRequest,
+): Promise<APISuccessResponse<CancelMarginOrdersResponse>>
+⋮----
+/**
+   * Get Margin Stop Orders List
+   *
+   * Request via this endpoint to get your current untriggered stop order list.
+   */
+getMarginStopOrdersList(
+    params?: GetMarginStopOrdersListRequest,
+): Promise<APISuccessResponse<MarginStopOrdersList>>
+⋮----
+/**
+   * Get Margin Stop Order By OrderId
+   *
+   * Request via this interface to get a stop order information via the order ID.
+   */
+getMarginStopOrderByOrderId(
+    params: GetMarginStopOrderByOrderIdRequest,
+): Promise<APISuccessResponse<MarginStopOrderItem>>
+⋮----
+/**
+   * Get Margin Stop Order By ClientOid
+   *
+   * Request via this interface to get a stop order information via the clientOid.
+   */
+getMarginStopOrderByClientOid(
+    params: GetMarginStopOrderByClientOidRequest,
+): Promise<APISuccessResponse<MarginStopOrderItem>>
+⋮----
+/**
+   * Add Margin OCO Order
+   *
+   * Place OCO order to the Margin trading system
+   */
+addMarginOcoOrder(
+    params: SubmitMarginOcoOrderRequest,
+): Promise<APISuccessResponse<MarginOcoOrderResponse>>
+⋮----
+/**
+   * Cancel Margin OCO Order By OrderId
+   *
+   * Request via this endpoint the cancellation of a single OCO order previously placed.
+   */
+cancelMarginOcoOrderByOrderId(
+    params: CancelMarginOcoOrderByOrderIdRequest,
+): Promise<APISuccessResponse<CancelMarginOrdersResponse>>
+⋮----
+/**
+   * Cancel Margin OCO Order By ClientOid
+   *
+   * Request via this interface to cancel a stop order via the clientOid.
+   */
+cancelMarginOcoOrderByClientOid(
+    params: CancelMarginOcoOrderByClientOidRequest,
+): Promise<APISuccessResponse<CancelMarginOrdersResponse>>
+⋮----
+/**
+   * Batch Cancel Margin OCO Orders
+   *
+   * This interface can batch cancel OCO orders through orderIds.
+   */
+batchCancelMarginOcoOrders(
+    params?: BatchCancelMarginOcoOrdersRequest,
+): Promise<APISuccessResponse<CancelMarginOrdersResponse>>
+⋮----
+/**
+   * Get Margin OCO Order By ClientOid
+   *
+   * Request via this interface to get a oco order information via the client order ID.
+   */
+getMarginOcoOrderByClientOid(
+    params: GetMarginOcoOrderByClientOidRequest,
+): Promise<APISuccessResponse<MarginOcoOrderItem>>
+⋮----
+/**
+   * Get Margin OCO Order Detail By OrderId
+   *
+   * Request via this interface to get a oco order detail via the order ID.
+   */
+getMarginOcoOrderDetailByOrderId(
+    params: GetMarginOcoOrderDetailByOrderIdRequest,
+): Promise<APISuccessResponse<MarginOcoOrderDetails>>
+⋮----
 /**
    *
    * REST - MARGIN TRADING - Debit
    *
    */
 ⋮----
+/**
+   * Get Borrow Interest Rate
+   *
+   * Query the borrowing interest rate through this interface.
+   */
+getBorrowInterestRate(
+    params?: GetBorrowInterestRateRequest,
+): Promise<APISuccessResponse<BorrowInterestRate>>
+⋮----
 /**
    * Borrow
    *
@@ -10924,13 +11471,13 @@ getOtcLoanAccounts(): Promise<APISuccessResponse<OtcLoanAccount[]>>
 getAffiliateUserRebateInfo(): Promise<APISuccessResponse<any>>
 ⋮----
 /**
-   * Get Trade History
+   * Get Invited
    *
-   * Trade history information can be obtained at this endpoint.
+   * Affiliate user invited information can be obtained at this endpoint.
    */
-getAffiliateTradeHistory(
-    params: GetAffiliateTradeHistoryRequest,
-): Promise<APISuccessResponse<AffiliateTradeHistory>>
+getAffiliateInvitees(
+    params?: GetAffiliateInviteesRequest,
+): Promise<APISuccessResponse<AffiliateInvitees>>
 ⋮----
 /**
    * Get Commission
@@ -10942,13 +11489,22 @@ getAffiliateCommission(
 ): Promise<APISuccessResponse<AffiliateCommissionItem[]>>
 ⋮----
 /**
-   * Get Invited
+   * Get Trade History
    *
-   * Affiliate user invited information can be obtained at this endpoint.
+   * Trade history information can be obtained at this endpoint.
    */
-getAffiliateInvitees(
-    params?: GetAffiliateInviteesRequest,
-): Promise<APISuccessResponse<AffiliateInvitees>>
+getAffiliateTradeHistory(
+    params: GetAffiliateTradeHistoryRequest,
+): Promise<APISuccessResponse<AffiliateTradeHistory>>
+⋮----
+/**
+   * Get Transaction
+   *
+   * Transaction information can be obtained at this endpoint.
+   */
+getAffiliateTransaction(
+    params: GetAffiliateTransactionRequest,
+): Promise<APISuccessResponse<AffiliateTransaction>>
 ⋮----
 /**
    *
@@ -11273,7 +11829,7 @@ File: package.json
 ================
 {
   "name": "kucoin-api",
-  "version": "2.1.20",
+  "version": "2.1.22",
   "description": "Complete & robust Node.js SDK for Kucoin's REST APIs and WebSockets, with TypeScript & strong end to end tests.",
   "scripts": {
     "clean": "rm -rf dist",
@@ -11361,6 +11917,7 @@ File: package.json
 
 
 
+
 ================================================================
 End of Codebase
 ================================================================