kucoin-api 2.2.0 → 2.3.0

package/llms.txt

@@ -93,6 +93,7 @@ src/
       spot-margin-trading.ts
       spot-misc.ts
       spot-trading.ts
+      uta-types.ts
     response/
       broker.types.ts
       futures.types.ts
@@ -106,6 +107,7 @@ src/
       spot-misc.ts
       spot-trading.ts
       spot-vip.ts
+      uta-types.ts
       ws.ts
     websockets/
       ws-api.ts
@@ -115,6 +117,7 @@ src/
   FuturesClient.ts
   index.ts
   SpotClient.ts
+  UnifiedAPIClient.ts
   WebsocketAPIClient.ts
   WebsocketClient.ts
 .eslintrc.cjs
@@ -1336,6 +1339,116 @@ export interface GetAnnouncementsRequest {
   endTime?: number;
 }
 
+================
+File: src/types/request/uta-types.ts
+================
+/**
+ * Unified Trading Account Request Types
+ */
+⋮----
+export interface GetAnnouncementsRequestUTA {
+  language?:
+    | 'zh_HK'
+    | 'ja_JP'
+    | 'ko_KR'
+    | 'en_US'
+    | 'pl_PL'
+    | 'es_ES'
+    | 'fr_FR'
+    | 'ar_AE'
+    | 'it_IT'
+    | 'id_ID'
+    | 'nl_NL'
+    | 'pt_PT'
+    | 'vi_VN'
+    | 'de_DE'
+    | 'tr_TR'
+    | 'ms_MY'
+    | 'ru_RU'
+    | 'th_TH'
+    | 'hi_IN'
+    | 'bn_BD'
+    | 'fil_PH'
+    | 'ur_PK';
+  type?:
+    | 'latest-announcements'
+    | 'activities'
+    | 'product-updates'
+    | 'vip'
+    | 'maintenance-updates'
+    | 'delistings'
+    | 'others'
+    | 'api-campaigns'
+    | 'new-listings'
+    | 'futures-announcements';
+  pageNumber?: number;
+  pageSize?: number;
+  startTime?: number;
+  endTime?: number;
+}
+⋮----
+export interface GetCurrencyRequestUTA {
+  currency?: string;
+  chain?: string;
+}
+⋮----
+export interface GetSymbolRequestUTA {
+  tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS';
+  symbol?: string;
+}
+⋮----
+export interface GetTickerRequestUTA {
+  tradeType: 'SPOT' | 'FUTURES';
+  symbol?: string;
+}
+⋮----
+export interface GetTradesRequestUTA {
+  tradeType: 'SPOT' | 'FUTURES';
+  symbol: string;
+}
+⋮----
+export interface GetOrderBookRequestUTA {
+  tradeType: 'SPOT' | 'FUTURES';
+  symbol: string;
+  limit: '20' | '50' | '100' | 'FULL';
+}
+⋮----
+export interface GetKlinesRequestUTA {
+  tradeType: 'SPOT' | 'FUTURES';
+  symbol: string;
+  interval:
+    | '1min'
+    | '3min'
+    | '5min'
+    | '15min'
+    | '30min'
+    | '1hour'
+    | '2hour'
+    | '4hour'
+    | '6hour'
+    | '8hour'
+    | '12hour'
+    | '1day'
+    | '1week'
+    | '1month';
+  startAt?: number;
+  endAt?: number;
+}
+⋮----
+export interface GetCurrentFundingRateRequestUTA {
+  symbol: string;
+}
+⋮----
+export interface GetHistoryFundingRateRequestUTA {
+  symbol: string;
+  startAt: number;
+  endAt: number;
+}
+⋮----
+export interface GetServiceStatusRequestUTA {
+  tradeType: 'SPOT' | 'FUTURES';
+}
+
 ================
 File: src/types/response/shared.types.ts
 ================
@@ -1377,6 +1490,202 @@ export interface Announcements {
   items: Announcement[];
 }
 
+================
+File: src/types/response/uta-types.ts
+================
+/**
+ * Unified Trading Account Response Types
+ */
+⋮----
+export interface AnnouncementItemUTA {
+  id: number;
+  title: string;
+  type: string[];
+  description: string;
+  releaseTime: number;
+  language: string;
+  url: string;
+}
+⋮----
+export interface GetAnnouncementsResponseUTA {
+  totalNumber: number;
+  totalPage: number;
+  pageNumber: number;
+  pageSize: number;
+  list: AnnouncementItemUTA[];
+}
+⋮----
+export interface CurrencyChainUTA {
+  chainName: string;
+  minWithdrawSize: string | null;
+  minDepositSize: string | null;
+  withdrawFeeRate: string;
+  minWithdrawFee: string;
+  isWithdrawEnabled: boolean;
+  isDepositEnabled: boolean;
+  confirms: number;
+  preConfirms: number;
+  contractAddress: string;
+  withdrawPrecision: number;
+  maxWithdrawSize: string | null;
+  maxDepositSize: string | null;
+  needTag: boolean;
+  chainId: string;
+}
+⋮----
+export interface GetCurrencyResponseUTA {
+  currency: string;
+  name: string;
+  fullName: string;
+  precision: number;
+  confirms: number | null;
+  contractAddress: string | null;
+  isMarginEnabled: boolean;
+  isDebitEnabled: boolean;
+  list: CurrencyChainUTA[];
+}
+⋮----
+export interface SymbolUTA {
+  symbol: string;
+  name?: string;
+  baseCurrency: string;
+  quoteCurrency: string;
+  market?: string;
+  minBaseOrderSize?: string;
+  minQuoteOrderSize?: string;
+  maxBaseOrderSize?: string | number;
+  maxQuoteOrderSize?: string;
+  baseOrderStep?: string;
+  quoteOrderStep?: string;
+  tickSize?: string | number;
+  feeCurrency?: string;
+  tradingStatus?: string;
+  marginMode?: string;
+  priceLimitRatio?: string;
+  feeCategory?: number;
+  makerFeeCoefficient?: string;
+  takerFeeCoefficient?: string;
+  st?: boolean;
+  settlementCurrency?: string;
+  contractType?: string;
+  isInverse?: boolean;
+  launchTime?: number;
+  expiryTime?: number | null;
+  settlementTime?: number | null;
+  maxPrice?: string | number;
+  lotSize?: string | number;
+  unitSize?: string | number;
+  makerFeeRate?: string | number;
+  takerFeeRate?: string | number;
+  settlementFeeRate?: string | number | null;
+  maxLeverage?: number;
+  indexSourceExchanges?: string[];
+  k?: string | number;
+  m?: string | number;
+  f?: string | number;
+  mmrLimit?: string | number;
+  mmrLevConstant?: string | number;
+  alertRiskRatio?: string;
+  liquidationRiskRatio?: string;
+  baseBorrowEnable?: boolean | string;
+  quoteBorrowEnable?: boolean | string;
+  baseTransferInEnable?: boolean | string;
+  quoteTransferInEnable?: boolean | string;
+}
+⋮----
+export interface GetSymbolResponseUTA {
+  tradeType: string;
+  list: SymbolUTA[];
+}
+⋮----
+export interface TickerUTA {
+  symbol: string;
+  name?: string;
+  bestBidPrice: string;
+  bestBidSize: string;
+  bestAskPrice: string;
+  bestAskSize: string;
+  high: string;
+  low: string;
+  baseVolume: string;
+  quoteVolume: string;
+  lastPrice: string;
+  open: string;
+  size: string;
+}
+⋮----
+export interface GetTickerResponseUTA {
+  tradeType: string;
+  ts: number;
+  list: TickerUTA[];
+}
+⋮----
+export interface TradeUTA {
+  sequence: string;
+  tradeId: string;
+  price: string;
+  size: string;
+  side: 'buy' | 'sell';
+  ts: number;
+}
+⋮----
+export interface GetTradesResponseUTA {
+  tradeType: string;
+  list: TradeUTA[];
+}
+⋮----
+export interface OrderBookLevelUTA {
+  price: string;
+  size: string;
+}
+⋮----
+export interface GetOrderBookResponseUTA {
+  tradeType: string;
+  symbol: string;
+  sequence: string;
+  bids: OrderBookLevelUTA[];
+  asks: OrderBookLevelUTA[];
+}
+⋮----
+export interface GetKlinesResponseUTA {
+  tradeType: string;
+  symbol: string;
+  list: string[][]; // [time, open, close, high, low, volume, turnover]
+}
+⋮----
+list: string[][]; // [time, open, close, high, low, volume, turnover]
+⋮----
+export interface GetCurrentFundingRateResponseUTA {
+  symbol: string;
+  nextFundingRate: number;
+  fundingTime: number;
+  fundingRateCap: number;
+  fundingRateFloor: number;
+}
+⋮----
+export interface FundingRateHistoryItemUTA {
+  fundingRate: number;
+  ts: number;
+}
+⋮----
+export interface GetHistoryFundingRateResponseUTA {
+  symbol: string;
+  list: FundingRateHistoryItemUTA[];
+}
+⋮----
+export interface GetCrossMarginConfigResponseUTA {
+  maxLeverage: number;
+  alertRiskRatio: string;
+  liquidationRiskRatio: string;
+  currencyList: string[];
+}
+⋮----
+export interface GetServiceStatusResponseUTA {
+  tradeType: string;
+  serverStatus: 'open' | 'close' | 'cancelonly';
+  msg: string;
+}
+
 ================
 File: src/types/response/ws.ts
 ================
@@ -1393,6 +1702,155 @@ export interface WsConnectionInfo {
   instanceServers: WsServerInfo[];
 }
 
+================
+File: src/UnifiedAPIClient.ts
+================
+import { AxiosRequestConfig } from 'axios';
+⋮----
+import { BaseRestClient } from './lib/BaseRestClient.js';
+import {
+  REST_CLIENT_TYPE_ENUM,
+  RestClientOptions,
+  RestClientType,
+} from './lib/requestUtils.js';
+import {
+  GetAnnouncementsRequestUTA,
+  GetCurrencyRequestUTA,
+  GetCurrentFundingRateRequestUTA,
+  GetHistoryFundingRateRequestUTA,
+  GetKlinesRequestUTA,
+  GetOrderBookRequestUTA,
+  GetServiceStatusRequestUTA,
+  GetSymbolRequestUTA,
+  GetTickerRequestUTA,
+  GetTradesRequestUTA,
+} from './types/request/uta-types.js';
+import { APISuccessResponse } from './types/response/shared.types.js';
+import {
+  GetAnnouncementsResponseUTA,
+  GetCrossMarginConfigResponseUTA,
+  GetCurrencyResponseUTA,
+  GetCurrentFundingRateResponseUTA,
+  GetHistoryFundingRateResponseUTA,
+  GetKlinesResponseUTA,
+  GetOrderBookResponseUTA,
+  GetServiceStatusResponseUTA,
+  GetSymbolResponseUTA,
+  GetTickerResponseUTA,
+  GetTradesResponseUTA,
+} from './types/response/uta-types.js';
+⋮----
+/**
+ * Unified Trading Account Client
+ *
+ * This client provides access to the Unified Trading Account API endpoints
+ * that unify market data access across Spot, Futures, and Margin trading.
+ */
+export class UnifiedAPIClient extends BaseRestClient
+⋮----
+constructor(
+    restClientOptions: RestClientOptions = {},
+    requestOptions: AxiosRequestConfig = {},
+)
+⋮----
+getClientType(): RestClientType
+⋮----
+/**
+   *
+   * REST - Unified Trading Account - Market Data
+   *
+   */
+⋮----
+/**
+   * Get Announcements
+   * This interface can obtain the latest news announcements, and the default
+   * page search is for announcements within a month.
+   */
+getAnnouncements(
+    params?: GetAnnouncementsRequestUTA,
+): Promise<APISuccessResponse<GetAnnouncementsResponseUTA>>
+⋮----
+/**
+   * Get Currency
+   * Request the currency details of a specified currency via this endpoint.
+   */
+getCurrency(
+    params?: GetCurrencyRequestUTA,
+): Promise<APISuccessResponse<GetCurrencyResponseUTA>>
+⋮----
+/**
+   * Get Symbol
+   * Request a list of available currency pairs for trading via this endpoint.
+   */
+getSymbol(
+    params: GetSymbolRequestUTA,
+): Promise<APISuccessResponse<GetSymbolResponseUTA>>
+⋮----
+/**
+   * Get Ticker
+   * Request market tickers for the trading pairs in the market (including 24h volume).
+   */
+getTicker(
+    params: GetTickerRequestUTA,
+): Promise<APISuccessResponse<GetTickerResponseUTA>>
+⋮----
+/**
+   * Get Trades
+   * Request via this endpoint to get the latest 100 public trades of the specified symbol.
+   */
+getTrades(
+    params: GetTradesRequestUTA,
+): Promise<APISuccessResponse<GetTradesResponseUTA>>
+⋮----
+/**
+   * Get OrderBook
+   * Query order book depth information (aggregated by price).
+   */
+getOrderBook(
+    params: GetOrderBookRequestUTA,
+): Promise<APISuccessResponse<GetOrderBookResponseUTA>>
+⋮----
+/**
+   * Get Klines
+   * Get the Kline of the symbol. Data are returned in grouped buckets based on requested type.
+   */
+getKlines(
+    params: GetKlinesRequestUTA,
+): Promise<APISuccessResponse<GetKlinesResponseUTA>>
+⋮----
+/**
+   * Get Current Funding Rate
+   * Get current Futures funding fee rate.
+   */
+getCurrentFundingRate(
+    params: GetCurrentFundingRateRequestUTA,
+): Promise<APISuccessResponse<GetCurrentFundingRateResponseUTA>>
+⋮----
+/**
+   * Get History Funding Rate
+   * Query the Futures funding rate at each settlement time point within a certain time range.
+   */
+getHistoryFundingRate(
+    params: GetHistoryFundingRateRequestUTA,
+): Promise<APISuccessResponse<GetHistoryFundingRateResponseUTA>>
+⋮----
+/**
+   * Get Cross Margin Config
+   * Request the configure info of the 'spot cross margin' via this endpoint.
+   */
+getCrossMarginConfig(): Promise<
+    APISuccessResponse<GetCrossMarginConfigResponseUTA>
+  > {
+    return this.get('api/ua/v1/market/cross-config');
+⋮----
+/**
+   * Get Service Status
+   * Get the service status.
+   */
+getServiceStatus(
+    params: GetServiceStatusRequestUTA,
+): Promise<APISuccessResponse<GetServiceStatusResponseUTA>>
+
 ================
 File: .prettierrc
 ================
@@ -6680,6 +7138,8 @@ File: src/lib/requestUtils.ts
 ⋮----
 /** Broker */
 ⋮----
+/** Unified Trading Account */
+⋮----
 export type RestClientType =
   (typeof REST_CLIENT_TYPE_ENUM)[keyof typeof REST_CLIENT_TYPE_ENUM];
 ⋮----
@@ -6843,6 +7303,7 @@ import {
   FuturesRiskLimit,
   FuturesSubAccount,
   FuturesSymbolInfo,
+  GetPositionModeResponse,
   IndexListItem,
   InterestRateItem,
   MarketTradeDetail,
@@ -7294,11 +7755,20 @@ getMaxOpenSize(
 /**
    * Get Position Details
    * Get the position details of a specified position.
+   * @deprecated Use getPositionV2 instead
    */
 getPosition(params: {
     symbol: string;
 }): Promise<APISuccessResponse<FuturesPosition>>
 ⋮----
+/**
+   * Get Position Details
+   * Get the position details of a specified position.
+   */
+getPositionV2(params: {
+    symbol: string;
+}): Promise<APISuccessResponse<FuturesPosition>>
+⋮----
 /**
    * Get Position List
    * Get the position details of a specified position.
@@ -7410,6 +7880,12 @@ updateRiskLimitLevel(params: {
     level: number;
 }): Promise<boolean>
 ⋮----
+/**
+   * Get Position Mode
+   * This interface can query the position mode of this account.
+   */
+getPositionMode(): Promise<APISuccessResponse<GetPositionModeResponse>>
+⋮----
 /**
    * Switch Position Mode
    * This endpoint can switch the position mode of the current symbol.
@@ -7593,6 +8069,7 @@ updateCopyTradeAutoDepositStatus(params: {
    * Get download link for broker rebate orders
    *
    * trade type 1 = spot, trade type 2 = futures
+   * @deprecated Use getBrokerRebateOrderDownloadLinkV2 instead
    */
 getBrokerRebateOrderDownloadLink(params: {
     begin: string;
@@ -7600,6 +8077,17 @@ getBrokerRebateOrderDownloadLink(params: {
     tradeType: 1 | 2;
 }): Promise<APISuccessResponse<any>>
 ⋮----
+/**
+   * Get download link for broker rebate orders
+   *
+   * trade type SPOT = spot, FUTURE = futures
+   */
+getBrokerRebateOrderDownloadLinkV2(params: {
+    begin: string;
+    end: string;
+    tradeType: 'SPOT' | 'FUTURE';
+}): Promise<APISuccessResponse<any>>
+⋮----
 /**
    *
    * WebSockets
@@ -8432,6 +8920,12 @@ export interface BatchMarginModeUpdateResponse {
   }[];
 }
 ⋮----
+export interface GetPositionModeResponse {
+  positionMode: 0 | 1; // 0 = one-way mode, 1 = hedge mode
+}
+⋮----
+positionMode: 0 | 1; // 0 = one-way mode, 1 = hedge mode
+⋮----
 export interface MaxOpenSize {
   symbol: string;
   maxBuyOpenSize: number;
@@ -9004,22 +9498,223 @@ orderIdsList: ['order-id-1', 'order-id-2'], // Replace with actual order IDs
 // Start executing the example workflow
 
 ================
-File: README.md
+File: src/lib/BaseRestClient.ts
 ================
-# Node.js & JavaScript SDK for Kucoin REST APIs, Websockets & WebSocket API
-
-[![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)
-[![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]
-[![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)
-
-<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">
+import axios, { AxiosRequestConfig, AxiosResponse, Method } from 'axios';
+import https from 'https';
+⋮----
+import { neverGuard } from './misc-util.js';
+import {
+  APIIDFutures,
+  APIIDFuturesSign,
+  APIIDMain,
+  APIIDMainSign,
+  getRestBaseUrl,
+  REST_CLIENT_TYPE_ENUM,
+  RestClientOptions,
+  RestClientType,
+  serializeParams,
+} from './requestUtils.js';
+import {
+  checkWebCryptoAPISupported,
+  SignAlgorithm,
+  SignEncodeMethod,
+  signMessage,
+} from './webCryptoAPI.js';
+⋮----
+export 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
+⋮----
+private hasValidCredentials()
+⋮----
+setAccessToken(newAccessToken: string)
+⋮----
+hasAccessToken(): boolean
+⋮----
+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 async signMessage(
+    paramsStr: string,
+    secret: string,
+    method: SignEncodeMethod,
+    algorithm: SignAlgorithm,
+): Promise<string>
+⋮----
+/**
+   * @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>>
+⋮----
+// Only sign when no access token is provided
+⋮----
+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>
+⋮----
+// Support for Authorization header, if provided:
+// https://github.com/tiagosiebler/kucoin-api/issues/2
+// Use restClient.setAccessToken(newToken), if you need to store a new access token
+
+================
+File: src/index.ts
+================
+
+
+================
+File: README.md
+================
+# Node.js & JavaScript SDK for Kucoin REST APIs, Websockets & WebSocket API
+
+[![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)
+[![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]
+[![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)
+
+<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>
@@ -9064,6 +9759,7 @@ Updated & performant JavaScript & Node.js SDK for the Kucoin REST APIs and WebSo
     - [Spot & Margin Trading](#spot--margin-trading)
     - [Futures Trading](#futures-trading)
     - [Broker Operations](#broker-operations)
+    - [Unified Trading Account API](#unified-trading-account-api)
   - [WebSockets](#websockets)
     - [WebSocket Consumers](#websocket-consumers)
       - [Public WebSocket Streams](#public-websocket-streams)
@@ -9150,6 +9846,7 @@ 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
+- **UnifiedAPIClient** - for unified market data access across all trading products
 
 ### Spot & Margin Trading
 
@@ -9197,6 +9894,10 @@ Use the `FuturesClient` for futures trading operations. See [FuturesClient](./sr
 
 Use the `BrokerClient` for broker and sub-account management operations. See [BrokerClient](./src/BrokerClient.ts) for complete API coverage.
 
+### Unified Trading Account API
+
+The `UnifiedAPIClient` provides access to KuCoin's Unified Trading Account API endpoints, which offer streamlined market data access across Spot, Futures, and Margin trading products.
+
 ## 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.
@@ -9355,12 +10056,12 @@ const wsClient = new WebsocketAPIClient(
 // Make WebSocket API calls, very similar to a REST API:
 
 wsClient
-  .submitSyncSpotOrder({
+  .submitNewSpotOrder({
     side: 'buy',
     symbol: 'BTC-USDT',
     type: 'limit',
-    price: '1000', // Very high price to avoid accidental execution
-    size: '0.01',
+    price: '150000',
+    size: '0.0001',
   })
   .then((syncSpotOrderResponse) => {
     console.log('Sync spot order response:', syncSpotOrderResponse);
@@ -9376,7 +10077,7 @@ wsClient
     symbol: 'XBTUSDTM',
     marginMode: 'CROSS',
     type: 'limit',
-    price: '1000', // Very low price to avoid accidental execution
+    price: '1000',
     qty: '0.01',
     leverage: 10,
     positionSide: 'LONG', // needed if trading two-way (hedge) position mode
@@ -9406,8 +10107,8 @@ const logger = {
   trace: (...params) => {
     if (
       [
+        // Selectively prevent some traces from logging
         'Sending ping',
-        // 'Sending upstream ws message: ',
         'Received pong',
       ].includes(params[0])
     ) {
@@ -9474,207 +10175,6 @@ Contributions are encouraged, I will review any incoming pull requests. See the
 
 <!-- template_star_history_end -->
 
-================
-File: src/lib/BaseRestClient.ts
-================
-import axios, { AxiosRequestConfig, AxiosResponse, Method } from 'axios';
-import https from 'https';
-⋮----
-import { neverGuard } from './misc-util.js';
-import {
-  APIIDFutures,
-  APIIDFuturesSign,
-  APIIDMain,
-  APIIDMainSign,
-  getRestBaseUrl,
-  REST_CLIENT_TYPE_ENUM,
-  RestClientOptions,
-  RestClientType,
-  serializeParams,
-} from './requestUtils.js';
-import {
-  checkWebCryptoAPISupported,
-  SignAlgorithm,
-  SignEncodeMethod,
-  signMessage,
-} from './webCryptoAPI.js';
-⋮----
-export 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
-⋮----
-private hasValidCredentials()
-⋮----
-setAccessToken(newAccessToken: string)
-⋮----
-hasAccessToken(): boolean
-⋮----
-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 async signMessage(
-    paramsStr: string,
-    secret: string,
-    method: SignEncodeMethod,
-    algorithm: SignAlgorithm,
-): Promise<string>
-⋮----
-/**
-   * @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>>
-⋮----
-// Only sign when no access token is provided
-⋮----
-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>
-⋮----
-// Support for Authorization header, if provided:
-// https://github.com/tiagosiebler/kucoin-api/issues/2
-// Use restClient.setAccessToken(newToken), if you need to store a new access token
-
-================
-File: src/index.ts
-================
-
-
 ================
 File: src/lib/BaseWSClient.ts
 ================
@@ -12533,6 +13033,7 @@ getAffiliateTransaction(
    * Get download link for broker rebate orders
    *
    * trade type 1 = spot, trade type 2 = futures
+   * @deprecated Use getBrokerRebateOrderDownloadLinkV2 instead
    */
 getBrokerRebateOrderDownloadLink(params: {
     begin: string;
@@ -12540,6 +13041,17 @@ getBrokerRebateOrderDownloadLink(params: {
     tradeType: 1 | 2;
 }): Promise<APISuccessResponse<any>>
 ⋮----
+/**
+   * Get download link for broker rebate orders
+   *
+   * trade type SPOT = spot, FUTURE = futures
+   */
+getBrokerRebateOrderDownloadLinkV2(params: {
+    begin: string;
+    end: string;
+    tradeType: 'SPOT' | 'FUTURE';
+}): Promise<APISuccessResponse<any>>
+⋮----
 /**
    *
    * WebSockets
@@ -12846,7 +13358,7 @@ File: package.json
 ================
 {
   "name": "kucoin-api",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "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",