kucoin-api 2.0.2 → 2.1.0

package/dist/cjs/BrokerClient.d.ts

@@ -0,0 +1,162 @@
+import { BaseRestClient } from './lib/BaseRestClient.js';
+import { 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';
+/**
+ *
+ */
+export declare class BrokerClient extends BaseRestClient {
+    getClientType(): RestClientType;
+    /**
+     * Get Broker Info
+     *
+     * This endpoint supports querying the basic information of the current Broker
+     */
+    getBrokerInfo(params: GetBrokerInfoRequest): Promise<APISuccessResponse<BrokerInfo>>;
+    /**
+     * 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>>;
+    /**
+     * 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>>;
+    /**
+     * 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>>;
+    /**
+     * 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[]>>;
+    /**
+     * 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>>;
+    /**
+     * Delete SubAccount API
+     *
+     * This interface supports deleting Broker's sub-account APIKEY.
+     */
+    deleteSubAccountApi(params: DeleteBrokerSubAccountApiRequest): Promise<APISuccessResponse<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
+     */
+    submitTransfer(params: BrokerTransferRequest): Promise<APISuccessResponse<{
+        orderId: string;
+    }>>;
+    /**
+     * 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
+     *
+     * Status:
+     * - PROCESSING: Processing
+     * - SUCCESS: Successful
+     * - FAILURE: Failed
+     */
+    getTransferHistory(params: {
+        orderId: string;
+    }): Promise<APISuccessResponse<BrokerTransferHistory>>;
+    /**
+     * 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
+     */
+    getDeposits(params?: GetBrokerDepositListRequest): Promise<APISuccessResponse<BrokerDepositRecord[]>>;
+    /**
+     * 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>>;
+    /**
+     * 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>>;
+    /**
+     * 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;
+    }>>;
+}

package/dist/cjs/BrokerClient.js

@@ -0,0 +1,175 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BrokerClient = void 0;
+const BaseRestClient_js_1 = require("./lib/BaseRestClient.js");
+const requestUtils_js_1 = require("./lib/requestUtils.js");
+/**
+ *
+ */
+class BrokerClient extends BaseRestClient_js_1.BaseRestClient {
+    getClientType() {
+        return requestUtils_js_1.REST_CLIENT_TYPE_ENUM.broker;
+    }
+    /**
+     * Get Broker Info
+     *
+     * This endpoint supports querying the basic information of the current Broker
+     */
+    getBrokerInfo(params) {
+        return this.getPrivate('api/v1/broker/nd/info', params);
+    }
+    /**
+     * 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) {
+        return this.postPrivate('api/v1/broker/nd/account', params);
+    }
+    /**
+     * Get SubAccount
+     *
+     * This interface supports querying sub-accounts created by Broker.
+     * Returns paginated results with default page size of 20 (max 100).
+     */
+    getSubAccounts(params) {
+        return this.getPrivate('api/v1/broker/nd/account', params);
+    }
+    /**
+     * 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) {
+        return this.postPrivate('api/v1/broker/nd/account/apikey', params);
+    }
+    /**
+     * Get SubAccount API
+     *
+     * This interface supports querying the Broker's sub-account APIKEYs.
+     * Can optionally filter by specific apiKey.
+     */
+    getSubAccountApis(params) {
+        return this.getPrivate('api/v1/broker/nd/account/apikey', params);
+    }
+    /**
+     * 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) {
+        return this.postPrivate('api/v1/broker/nd/account/update-apikey', params);
+    }
+    /**
+     * Delete SubAccount API
+     *
+     * This interface supports deleting Broker's sub-account APIKEY.
+     */
+    deleteSubAccountApi(params) {
+        return this.deletePrivate('api/v1/broker/nd/account/apikey', params);
+    }
+    /**
+     * 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
+     */
+    submitTransfer(params) {
+        return this.postPrivate('api/v1/broker/nd/transfer', params);
+    }
+    /**
+     * 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
+     *
+     * Status:
+     * - PROCESSING: Processing
+     * - SUCCESS: Successful
+     * - FAILURE: Failed
+     */
+    getTransferHistory(params) {
+        return this.getPrivate('api/v3/broker/nd/transfer/detail', params);
+    }
+    /**
+     * 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
+     */
+    getDeposits(params) {
+        return this.getPrivate('api/v1/asset/ndbroker/deposit/list', params);
+    }
+    /**
+     * 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) {
+        return this.getPrivate('api/v3/broker/nd/deposit/detail', params);
+    }
+    /**
+     * 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) {
+        return this.getPrivate('api/v3/broker/nd/withdraw/detail', params);
+    }
+    /**
+     * 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) {
+        return this.getPrivate('api/v1/broker/nd/rebase/download', params);
+    }
+}
+exports.BrokerClient = BrokerClient;
+//# sourceMappingURL=BrokerClient.js.map

package/dist/cjs/BrokerClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BrokerClient.js","sourceRoot":"","sources":["../../src/BrokerClient.ts"],"names":[],"mappings":";;;AAAA,+DAAyD;AACzD,2DAA8E;AAuB9E;;GAEG;AACH,MAAa,YAAa,SAAQ,kCAAc;IAC9C,aAAa;QACX,OAAO,uCAAqB,CAAC,MAAM,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACH,aAAa,CACX,MAA4B;QAE5B,OAAO,IAAI,CAAC,UAAU,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CAAC,MAEhB;QACC,OAAO,IAAI,CAAC,WAAW,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;OAKG;IACH,cAAc,CACZ,MAAmC;QAEnC,OAAO,IAAI,CAAC,UAAU,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;OAOG;IACH,mBAAmB,CACjB,MAAwC;QAExC,OAAO,IAAI,CAAC,WAAW,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;IAED;;;;;OAKG;IACH,iBAAiB,CACf,MAAsC;QAEtC,OAAO,IAAI,CAAC,UAAU,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;OAOG;IACH,mBAAmB,CACjB,MAAwC;QAExC,OAAO,IAAI,CAAC,WAAW,CAAC,wCAAwC,EAAE,MAAM,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACH,mBAAmB,CACjB,MAAwC;QAExC,OAAO,IAAI,CAAC,aAAa,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,MAA6B;QAK1C,OAAO,IAAI,CAAC,WAAW,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,kBAAkB,CAAC,MAElB;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,kCAAkC,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,WAAW,CACT,MAAoC;QAEpC,OAAO,IAAI,CAAC,UAAU,CAAC,oCAAoC,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;OAUG;IACH,UAAU,CAAC,MAGV;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,aAAa,CAAC,MAEb;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,kCAAkC,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;OAOG;IACH,eAAe,CAAC,MAIf;QAKC,OAAO,IAAI,CAAC,UAAU,CAAC,kCAAkC,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;CACF;AApND,oCAoNC"}

package/dist/cjs/index.d.ts

@@ -1,7 +1,9 @@
+export * from './BrokerClient.js';
 export * from './FuturesClient.js';
 export * from './lib/websocket/logger.js';
 export * from './lib/websocket/websocket-util.js';
 export * from './SpotClient.js';
+export * from './types/request/broker.types.js';
 export * from './types/request/futures.types.js';
 export * from './types/request/spot-account.js';
 export * from './types/request/spot-earn.js';
@@ -9,6 +11,7 @@ export * from './types/request/spot-funding.js';
 export * from './types/request/spot-margin-trading.js';
 export * from './types/request/spot-misc.js';
 export * from './types/request/spot-trading.js';
+export * from './types/response/broker.types.js';
 export * from './types/response/futures.types.js';
 export * from './types/response/shared.types.js';
 export * from './types/response/spot-account.js';

package/dist/cjs/index.js

@@ -14,10 +14,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./BrokerClient.js"), exports);
 __exportStar(require("./FuturesClient.js"), exports);
 __exportStar(require("./lib/websocket/logger.js"), exports);
 __exportStar(require("./lib/websocket/websocket-util.js"), exports);
 __exportStar(require("./SpotClient.js"), exports);
+__exportStar(require("./types/request/broker.types.js"), exports);
 __exportStar(require("./types/request/futures.types.js"), exports);
 __exportStar(require("./types/request/spot-account.js"), exports);
 __exportStar(require("./types/request/spot-earn.js"), exports);
@@ -25,6 +27,7 @@ __exportStar(require("./types/request/spot-funding.js"), exports);
 __exportStar(require("./types/request/spot-margin-trading.js"), exports);
 __exportStar(require("./types/request/spot-misc.js"), exports);
 __exportStar(require("./types/request/spot-trading.js"), exports);
+__exportStar(require("./types/response/broker.types.js"), exports);
 __exportStar(require("./types/response/futures.types.js"), exports);
 __exportStar(require("./types/response/shared.types.js"), exports);
 __exportStar(require("./types/response/spot-account.js"), exports);

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAmC;AACnC,4DAA0C;AAC1C,oEAAkD;AAClD,kDAAgC;AAChC,mEAAiD;AACjD,kEAAgD;AAChD,+DAA6C;AAC7C,kEAAgD;AAChD,yEAAuD;AACvD,+DAA6C;AAC7C,kEAAgD;AAChD,oEAAkD;AAClD,mEAAiD;AACjD,mEAAiD;AACjD,gEAA8C;AAC9C,mEAAiD;AACjD,0EAAwD;AACxD,gEAA8C;AAC9C,mEAAiD;AACjD,+DAA6C;AAC7C,+DAA6C;AAC7C,+DAA6C;AAC7C,iEAA+C;AAC/C,uDAAqC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,qDAAmC;AACnC,4DAA0C;AAC1C,oEAAkD;AAClD,kDAAgC;AAChC,kEAAgD;AAChD,mEAAiD;AACjD,kEAAgD;AAChD,+DAA6C;AAC7C,kEAAgD;AAChD,yEAAuD;AACvD,+DAA6C;AAC7C,kEAAgD;AAChD,mEAAiD;AACjD,oEAAkD;AAClD,mEAAiD;AACjD,mEAAiD;AACjD,gEAA8C;AAC9C,mEAAiD;AACjD,0EAAwD;AACxD,gEAA8C;AAC9C,mEAAiD;AACjD,+DAA6C;AAC7C,+DAA6C;AAC7C,+DAA6C;AAC7C,iEAA+C;AAC/C,uDAAqC"}

package/dist/cjs/lib/requestUtils.d.ts

@@ -6,6 +6,8 @@ export declare const REST_CLIENT_TYPE_ENUM: {
     readonly main: "main";
     /** Futures */
     readonly futures: "futures";
+    /** Broker */
+    readonly broker: "broker";
 };
 export type RestClientType = (typeof REST_CLIENT_TYPE_ENUM)[keyof typeof REST_CLIENT_TYPE_ENUM];
 export interface RestClientOptions {

package/dist/cjs/lib/requestUtils.js

@@ -9,10 +9,13 @@ exports.REST_CLIENT_TYPE_ENUM = {
     main: 'main',
     /** Futures */
     futures: 'futures',
+    /** Broker */
+    broker: 'broker',
 };
 const kucoinURLMap = {
     [exports.REST_CLIENT_TYPE_ENUM.main]: 'https://api.kucoin.com',
     [exports.REST_CLIENT_TYPE_ENUM.futures]: 'https://api-futures.kucoin.com',
+    [exports.REST_CLIENT_TYPE_ENUM.broker]: 'https://api-broker.kucoin.com',
 };
 function serializeParams(params, strict_validation, encodeValues, prefixWith) {
     if (!params) {

package/dist/cjs/lib/requestUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"requestUtils.js","sourceRoot":"","sources":["../../../src/lib/requestUtils.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACU,QAAA,qBAAqB,GAAG;IACnC,oBAAoB;IACpB,IAAI,EAAE,MAAM;IACZ,cAAc;IACd,OAAO,EAAE,SAAS;CACV,CAAC;AAKX,MAAM,YAAY,GAAG;IACnB,CAAC,6BAAqB,CAAC,IAAI,CAAC,EAAE,wBAAwB;IACtD,CAAC,6BAAqB,CAAC,OAAO,CAAC,EAAE,gCAAgC;CACzD,CAAC;AA8BX,SAAgB,eAAe,CAC7B,MAAS,EACT,iBAAsC,EACtC,YAAqB,EACrB,UAAkB;IAElB,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;SACpC,IAAI,EAAE;SACN,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACX,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,iBAAiB,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE,CAAC;YAC/D,MAAM,IAAI,KAAK,CACb,uDAAuD,CACxD,CAAC;QACJ,CAAC;QACD,MAAM,YAAY,GAAG,YAAY,CAAC,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACtE,OAAO,GAAG,GAAG,IAAI,YAAY,EAAE,CAAC;IAClC,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,CAAC,CAAC;IAEb,iCAAiC;IACjC,OAAO,WAAW,CAAC,CAAC,CAAC,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC;AAC9D,CAAC;AA1BD,0CA0BC;AAEY,QAAA,SAAS,GAAG,SAAS,CAAC;AACtB,QAAA,aAAa,GAAG,sCAAsC,CAAC;AAEvD,QAAA,YAAY,GAAG,gBAAgB,CAAC;AAChC,QAAA,gBAAgB,GAAG,sCAAsC,CAAC;AAEvE,SAAgB,cAAc,CAC5B,UAAmB,EACnB,kBAAqC,EACrC,cAA8B;IAE9B,MAAM,gBAAgB,GAAG;QACvB,OAAO,EAAE,YAAY,CAAC,cAAc,CAAC;QACrC,OAAO,EAAE,mBAAmB;KAC7B,CAAC;IAEF,IAAI,kBAAkB,CAAC,OAAO,EAAE,CAAC;QAC/B,OAAO,kBAAkB,CAAC,OAAO,CAAC;IACpC,CAAC;IAED,IAAI,UAAU,EAAE,CAAC;QACf,OAAO,gBAAgB,CAAC,OAAO,CAAC;IAClC,CAAC;IAED,OAAO,gBAAgB,CAAC,OAAO,CAAC;AAClC,CAAC;AAnBD,wCAmBC"}
+{"version":3,"file":"requestUtils.js","sourceRoot":"","sources":["../../../src/lib/requestUtils.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACU,QAAA,qBAAqB,GAAG;IACnC,oBAAoB;IACpB,IAAI,EAAE,MAAM;IACZ,cAAc;IACd,OAAO,EAAE,SAAS;IAClB,aAAa;IACb,MAAM,EAAE,QAAQ;CACR,CAAC;AAKX,MAAM,YAAY,GAAG;IACnB,CAAC,6BAAqB,CAAC,IAAI,CAAC,EAAE,wBAAwB;IACtD,CAAC,6BAAqB,CAAC,OAAO,CAAC,EAAE,gCAAgC;IACjE,CAAC,6BAAqB,CAAC,MAAM,CAAC,EAAE,+BAA+B;CACvD,CAAC;AA8BX,SAAgB,eAAe,CAC7B,MAAS,EACT,iBAAsC,EACtC,YAAqB,EACrB,UAAkB;IAElB,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;SACpC,IAAI,EAAE;SACN,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACX,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,iBAAiB,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE,CAAC;YAC/D,MAAM,IAAI,KAAK,CACb,uDAAuD,CACxD,CAAC;QACJ,CAAC;QACD,MAAM,YAAY,GAAG,YAAY,CAAC,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACtE,OAAO,GAAG,GAAG,IAAI,YAAY,EAAE,CAAC;IAClC,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,CAAC,CAAC;IAEb,iCAAiC;IACjC,OAAO,WAAW,CAAC,CAAC,CAAC,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC;AAC9D,CAAC;AA1BD,0CA0BC;AAEY,QAAA,SAAS,GAAG,SAAS,CAAC;AACtB,QAAA,aAAa,GAAG,sCAAsC,CAAC;AAEvD,QAAA,YAAY,GAAG,gBAAgB,CAAC;AAChC,QAAA,gBAAgB,GAAG,sCAAsC,CAAC;AAEvE,SAAgB,cAAc,CAC5B,UAAmB,EACnB,kBAAqC,EACrC,cAA8B;IAE9B,MAAM,gBAAgB,GAAG;QACvB,OAAO,EAAE,YAAY,CAAC,cAAc,CAAC;QACrC,OAAO,EAAE,mBAAmB;KAC7B,CAAC;IAEF,IAAI,kBAAkB,CAAC,OAAO,EAAE,CAAC;QAC/B,OAAO,kBAAkB,CAAC,OAAO,CAAC;IACpC,CAAC;IAED,IAAI,UAAU,EAAE,CAAC;QACf,OAAO,gBAAgB,CAAC,OAAO,CAAC;IAClC,CAAC;IAED,OAAO,gBAAgB,CAAC,OAAO,CAAC;AAClC,CAAC;AAnBD,wCAmBC"}

package/dist/cjs/types/request/broker.types.d.ts

@@ -0,0 +1,52 @@
+export interface GetBrokerInfoRequest {
+    begin: string;
+    end: string;
+    tradeType: '1' | '2';
+}
+export interface GetBrokerSubAccountsRequest {
+    uid: string;
+    currentPage?: number;
+    pageSize?: number;
+}
+export type BrokerSubAccountPermission = 'general' | 'spot' | 'futures';
+export interface CreateBrokerSubAccountApiRequest {
+    uid: string;
+    passphrase: string;
+    ipWhitelist: string[];
+    permissions: BrokerSubAccountPermission[];
+    label: string;
+}
+export interface GetBrokerSubAccountApisRequest {
+    uid: string;
+    apiKey?: string;
+}
+export interface UpdateBrokerSubAccountApiRequest {
+    uid: string;
+    apiKey: string;
+    ipWhitelist: string[];
+    permissions: BrokerSubAccountPermission[];
+    label: string;
+}
+export interface DeleteBrokerSubAccountApiRequest {
+    uid: string;
+    apiKey: string;
+}
+export type BrokerTransferDirection = 'OUT' | 'IN';
+export type BrokerAccountType = 'MAIN' | 'TRADE';
+export interface BrokerTransferRequest {
+    currency: string;
+    amount: string;
+    clientOid: string;
+    direction: BrokerTransferDirection;
+    accountType: BrokerAccountType;
+    specialUid: string;
+    specialAccountType: BrokerAccountType;
+}
+export interface GetBrokerDepositListRequest {
+    currency?: string;
+    status?: 'PROCESSING' | 'SUCCESS' | 'FAILURE';
+    hash?: string;
+    startTimestamp?: number;
+    endTimestamp?: number;
+    limit?: number;
+}

package/dist/cjs/types/request/broker.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=broker.types.js.map

package/dist/cjs/types/request/broker.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"broker.types.js","sourceRoot":"","sources":["../../../../src/types/request/broker.types.ts"],"names":[],"mappings":""}

package/dist/cjs/types/response/broker.types.d.ts

@@ -0,0 +1,92 @@
+export interface BrokerInfo {
+    accountSize: number;
+    maxAccountSize: number | null;
+    level: number;
+}
+export interface CreateBrokerSubAccountResponse {
+    accountName: string;
+    uid: string;
+    createdAt: number;
+    level: number;
+}
+export interface BrokerSubAccount {
+    accountName: string;
+    uid: string;
+    createdAt: number;
+    level: number;
+}
+export interface GetBrokerSubAccountsResponse {
+    currentPage: number;
+    pageSize: number;
+    totalNum: number;
+    totalPage: number;
+    items: BrokerSubAccount[];
+}
+export interface CreateBrokerSubAccountApiResponse {
+    uid: string;
+    label: string;
+    apiKey: string;
+    secretKey: string;
+    apiVersion: number;
+    permissions: string[];
+    ipWhitelist: string[];
+    createdAt: number;
+}
+export interface BrokerSubAccountApi {
+    uid: string;
+    label: string;
+    apiKey: string;
+    apiVersion: number;
+    permissions: ('General' | 'Spot' | 'Futures')[];
+    ipWhitelist: string[];
+    createdAt: number;
+}
+export type BrokerTransferAccountType = 'MAIN' | 'TRADE' | 'CONTRACT' | 'MARGIN' | 'ISOLATED';
+export type BrokerTransferStatus = 'PROCESSING' | 'SUCCESS' | 'FAILURE';
+export interface BrokerTransferHistory {
+    orderId: string;
+    currency: string;
+    amount: string;
+    fromUid: number;
+    fromAccountType: BrokerTransferAccountType;
+    fromAccountTag: string;
+    toUid: number;
+    toAccountType: BrokerTransferAccountType;
+    toAccountTag: string;
+    status: BrokerTransferStatus;
+    reason: string | null;
+    createdAt: number;
+}
+export interface BrokerDepositRecord {
+    uid: number;
+    hash: string;
+    address: string;
+    memo: string;
+    amount: string;
+    fee: string;
+    currency: string;
+    isInner: boolean;
+    walletTxId: string;
+    status: BrokerTransferStatus;
+    remark: string;
+    chain: string;
+    createdAt: number;
+    updatedAt: number;
+}
+export type BrokerWithdrawalStatus = 'PROCESSING' | 'WALLET_PROCESSING' | 'REVIEW' | 'SUCCESS' | 'FAILURE';
+export interface BrokerWithdrawalRecord {
+    id: string;
+    chain: string;
+    walletTxId: string;
+    uid: number;
+    amount: string;
+    memo: string;
+    fee: string;
+    address: string;
+    remark: string;
+    isInner: boolean;
+    currency: string;
+    status: BrokerWithdrawalStatus;
+    createdAt: number;
+    updatedAt: number;
+}

package/dist/cjs/types/response/broker.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=broker.types.js.map

package/dist/cjs/types/response/broker.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"broker.types.js","sourceRoot":"","sources":["../../../../src/types/response/broker.types.ts"],"names":[],"mappings":""}

package/dist/mjs/BrokerClient.d.ts

@@ -0,0 +1,162 @@
+import { BaseRestClient } from './lib/BaseRestClient.js';
+import { 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';
+/**
+ *
+ */
+export declare class BrokerClient extends BaseRestClient {
+    getClientType(): RestClientType;
+    /**
+     * Get Broker Info
+     *
+     * This endpoint supports querying the basic information of the current Broker
+     */
+    getBrokerInfo(params: GetBrokerInfoRequest): Promise<APISuccessResponse<BrokerInfo>>;
+    /**
+     * 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>>;
+    /**
+     * 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>>;
+    /**
+     * 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>>;
+    /**
+     * 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[]>>;
+    /**
+     * 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>>;
+    /**
+     * Delete SubAccount API
+     *
+     * This interface supports deleting Broker's sub-account APIKEY.
+     */
+    deleteSubAccountApi(params: DeleteBrokerSubAccountApiRequest): Promise<APISuccessResponse<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
+     */
+    submitTransfer(params: BrokerTransferRequest): Promise<APISuccessResponse<{
+        orderId: string;
+    }>>;
+    /**
+     * 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
+     *
+     * Status:
+     * - PROCESSING: Processing
+     * - SUCCESS: Successful
+     * - FAILURE: Failed
+     */
+    getTransferHistory(params: {
+        orderId: string;
+    }): Promise<APISuccessResponse<BrokerTransferHistory>>;
+    /**
+     * 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
+     */
+    getDeposits(params?: GetBrokerDepositListRequest): Promise<APISuccessResponse<BrokerDepositRecord[]>>;
+    /**
+     * 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>>;
+    /**
+     * 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>>;
+    /**
+     * 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;
+    }>>;
+}

package/dist/mjs/BrokerClient.js

@@ -0,0 +1,171 @@
+import { BaseRestClient } from './lib/BaseRestClient.js';
+import { REST_CLIENT_TYPE_ENUM } from './lib/requestUtils.js';
+/**
+ *
+ */
+export class BrokerClient extends BaseRestClient {
+    getClientType() {
+        return REST_CLIENT_TYPE_ENUM.broker;
+    }
+    /**
+     * Get Broker Info
+     *
+     * This endpoint supports querying the basic information of the current Broker
+     */
+    getBrokerInfo(params) {
+        return this.getPrivate('api/v1/broker/nd/info', params);
+    }
+    /**
+     * 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) {
+        return this.postPrivate('api/v1/broker/nd/account', params);
+    }
+    /**
+     * Get SubAccount
+     *
+     * This interface supports querying sub-accounts created by Broker.
+     * Returns paginated results with default page size of 20 (max 100).
+     */
+    getSubAccounts(params) {
+        return this.getPrivate('api/v1/broker/nd/account', params);
+    }
+    /**
+     * 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) {
+        return this.postPrivate('api/v1/broker/nd/account/apikey', params);
+    }
+    /**
+     * Get SubAccount API
+     *
+     * This interface supports querying the Broker's sub-account APIKEYs.
+     * Can optionally filter by specific apiKey.
+     */
+    getSubAccountApis(params) {
+        return this.getPrivate('api/v1/broker/nd/account/apikey', params);
+    }
+    /**
+     * 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) {
+        return this.postPrivate('api/v1/broker/nd/account/update-apikey', params);
+    }
+    /**
+     * Delete SubAccount API
+     *
+     * This interface supports deleting Broker's sub-account APIKEY.
+     */
+    deleteSubAccountApi(params) {
+        return this.deletePrivate('api/v1/broker/nd/account/apikey', params);
+    }
+    /**
+     * 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
+     */
+    submitTransfer(params) {
+        return this.postPrivate('api/v1/broker/nd/transfer', params);
+    }
+    /**
+     * 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
+     *
+     * Status:
+     * - PROCESSING: Processing
+     * - SUCCESS: Successful
+     * - FAILURE: Failed
+     */
+    getTransferHistory(params) {
+        return this.getPrivate('api/v3/broker/nd/transfer/detail', params);
+    }
+    /**
+     * 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
+     */
+    getDeposits(params) {
+        return this.getPrivate('api/v1/asset/ndbroker/deposit/list', params);
+    }
+    /**
+     * 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) {
+        return this.getPrivate('api/v3/broker/nd/deposit/detail', params);
+    }
+    /**
+     * 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) {
+        return this.getPrivate('api/v3/broker/nd/withdraw/detail', params);
+    }
+    /**
+     * 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) {
+        return this.getPrivate('api/v1/broker/nd/rebase/download', params);
+    }
+}
+//# sourceMappingURL=BrokerClient.js.map

package/dist/mjs/BrokerClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BrokerClient.js","sourceRoot":"","sources":["../../src/BrokerClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,qBAAqB,EAAkB,MAAM,uBAAuB,CAAC;AAuB9E;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,cAAc;IAC9C,aAAa;QACX,OAAO,qBAAqB,CAAC,MAAM,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACH,aAAa,CACX,MAA4B;QAE5B,OAAO,IAAI,CAAC,UAAU,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CAAC,MAEhB;QACC,OAAO,IAAI,CAAC,WAAW,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;OAKG;IACH,cAAc,CACZ,MAAmC;QAEnC,OAAO,IAAI,CAAC,UAAU,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;OAOG;IACH,mBAAmB,CACjB,MAAwC;QAExC,OAAO,IAAI,CAAC,WAAW,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;IAED;;;;;OAKG;IACH,iBAAiB,CACf,MAAsC;QAEtC,OAAO,IAAI,CAAC,UAAU,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;OAOG;IACH,mBAAmB,CACjB,MAAwC;QAExC,OAAO,IAAI,CAAC,WAAW,CAAC,wCAAwC,EAAE,MAAM,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACH,mBAAmB,CACjB,MAAwC;QAExC,OAAO,IAAI,CAAC,aAAa,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,MAA6B;QAK1C,OAAO,IAAI,CAAC,WAAW,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,kBAAkB,CAAC,MAElB;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,kCAAkC,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,WAAW,CACT,MAAoC;QAEpC,OAAO,IAAI,CAAC,UAAU,CAAC,oCAAoC,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;OAUG;IACH,UAAU,CAAC,MAGV;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,aAAa,CAAC,MAEb;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,kCAAkC,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;OAOG;IACH,eAAe,CAAC,MAIf;QAKC,OAAO,IAAI,CAAC,UAAU,CAAC,kCAAkC,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;CACF"}

package/dist/mjs/index.d.ts

@@ -1,7 +1,9 @@
+export * from './BrokerClient.js';
 export * from './FuturesClient.js';
 export * from './lib/websocket/logger.js';
 export * from './lib/websocket/websocket-util.js';
 export * from './SpotClient.js';
+export * from './types/request/broker.types.js';
 export * from './types/request/futures.types.js';
 export * from './types/request/spot-account.js';
 export * from './types/request/spot-earn.js';
@@ -9,6 +11,7 @@ export * from './types/request/spot-funding.js';
 export * from './types/request/spot-margin-trading.js';
 export * from './types/request/spot-misc.js';
 export * from './types/request/spot-trading.js';
+export * from './types/response/broker.types.js';
 export * from './types/response/futures.types.js';
 export * from './types/response/shared.types.js';
 export * from './types/response/spot-account.js';

package/dist/mjs/index.js

@@ -1,7 +1,9 @@
+export * from './BrokerClient.js';
 export * from './FuturesClient.js';
 export * from './lib/websocket/logger.js';
 export * from './lib/websocket/websocket-util.js';
 export * from './SpotClient.js';
+export * from './types/request/broker.types.js';
 export * from './types/request/futures.types.js';
 export * from './types/request/spot-account.js';
 export * from './types/request/spot-earn.js';
@@ -9,6 +11,7 @@ export * from './types/request/spot-funding.js';
 export * from './types/request/spot-margin-trading.js';
 export * from './types/request/spot-misc.js';
 export * from './types/request/spot-trading.js';
+export * from './types/response/broker.types.js';
 export * from './types/response/futures.types.js';
 export * from './types/response/shared.types.js';
 export * from './types/response/spot-account.js';

package/dist/mjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mCAAmC,CAAC;AAClD,cAAc,iBAAiB,CAAC;AAChC,cAAc,kCAAkC,CAAC;AACjD,cAAc,iCAAiC,CAAC;AAChD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iCAAiC,CAAC;AAChD,cAAc,wCAAwC,CAAC;AACvD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iCAAiC,CAAC;AAChD,cAAc,mCAAmC,CAAC;AAClD,cAAc,kCAAkC,CAAC;AACjD,cAAc,kCAAkC,CAAC;AACjD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kCAAkC,CAAC;AACjD,cAAc,yCAAyC,CAAC;AACxD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kCAAkC,CAAC;AACjD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sBAAsB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mCAAmC,CAAC;AAClD,cAAc,iBAAiB,CAAC;AAChC,cAAc,iCAAiC,CAAC;AAChD,cAAc,kCAAkC,CAAC;AACjD,cAAc,iCAAiC,CAAC;AAChD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iCAAiC,CAAC;AAChD,cAAc,wCAAwC,CAAC;AACvD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iCAAiC,CAAC;AAChD,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAClD,cAAc,kCAAkC,CAAC;AACjD,cAAc,kCAAkC,CAAC;AACjD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kCAAkC,CAAC;AACjD,cAAc,yCAAyC,CAAC;AACxD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kCAAkC,CAAC;AACjD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sBAAsB,CAAC"}

package/dist/mjs/lib/requestUtils.d.ts

@@ -6,6 +6,8 @@ export declare const REST_CLIENT_TYPE_ENUM: {
     readonly main: "main";
     /** Futures */
     readonly futures: "futures";
+    /** Broker */
+    readonly broker: "broker";
 };
 export type RestClientType = (typeof REST_CLIENT_TYPE_ENUM)[keyof typeof REST_CLIENT_TYPE_ENUM];
 export interface RestClientOptions {

package/dist/mjs/lib/requestUtils.js

@@ -6,10 +6,13 @@ export const REST_CLIENT_TYPE_ENUM = {
     main: 'main',
     /** Futures */
     futures: 'futures',
+    /** Broker */
+    broker: 'broker',
 };
 const kucoinURLMap = {
     [REST_CLIENT_TYPE_ENUM.main]: 'https://api.kucoin.com',
     [REST_CLIENT_TYPE_ENUM.futures]: 'https://api-futures.kucoin.com',
+    [REST_CLIENT_TYPE_ENUM.broker]: 'https://api-broker.kucoin.com',
 };
 export function serializeParams(params, strict_validation, encodeValues, prefixWith) {
     if (!params) {

package/dist/mjs/lib/requestUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"requestUtils.js","sourceRoot":"","sources":["../../../src/lib/requestUtils.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,oBAAoB;IACpB,IAAI,EAAE,MAAM;IACZ,cAAc;IACd,OAAO,EAAE,SAAS;CACV,CAAC;AAKX,MAAM,YAAY,GAAG;IACnB,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,wBAAwB;IACtD,CAAC,qBAAqB,CAAC,OAAO,CAAC,EAAE,gCAAgC;CACzD,CAAC;AA8BX,MAAM,UAAU,eAAe,CAC7B,MAAS,EACT,iBAAsC,EACtC,YAAqB,EACrB,UAAkB;IAElB,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;SACpC,IAAI,EAAE;SACN,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACX,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,iBAAiB,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE,CAAC;YAC/D,MAAM,IAAI,KAAK,CACb,uDAAuD,CACxD,CAAC;QACJ,CAAC;QACD,MAAM,YAAY,GAAG,YAAY,CAAC,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACtE,OAAO,GAAG,GAAG,IAAI,YAAY,EAAE,CAAC;IAClC,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,CAAC,CAAC;IAEb,iCAAiC;IACjC,OAAO,WAAW,CAAC,CAAC,CAAC,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC;AAC9D,CAAC;AAED,MAAM,CAAC,MAAM,SAAS,GAAG,SAAS,CAAC;AACnC,MAAM,CAAC,MAAM,aAAa,GAAG,sCAAsC,CAAC;AAEpE,MAAM,CAAC,MAAM,YAAY,GAAG,gBAAgB,CAAC;AAC7C,MAAM,CAAC,MAAM,gBAAgB,GAAG,sCAAsC,CAAC;AAEvE,MAAM,UAAU,cAAc,CAC5B,UAAmB,EACnB,kBAAqC,EACrC,cAA8B;IAE9B,MAAM,gBAAgB,GAAG;QACvB,OAAO,EAAE,YAAY,CAAC,cAAc,CAAC;QACrC,OAAO,EAAE,mBAAmB;KAC7B,CAAC;IAEF,IAAI,kBAAkB,CAAC,OAAO,EAAE,CAAC;QAC/B,OAAO,kBAAkB,CAAC,OAAO,CAAC;IACpC,CAAC;IAED,IAAI,UAAU,EAAE,CAAC;QACf,OAAO,gBAAgB,CAAC,OAAO,CAAC;IAClC,CAAC;IAED,OAAO,gBAAgB,CAAC,OAAO,CAAC;AAClC,CAAC"}
+{"version":3,"file":"requestUtils.js","sourceRoot":"","sources":["../../../src/lib/requestUtils.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,oBAAoB;IACpB,IAAI,EAAE,MAAM;IACZ,cAAc;IACd,OAAO,EAAE,SAAS;IAClB,aAAa;IACb,MAAM,EAAE,QAAQ;CACR,CAAC;AAKX,MAAM,YAAY,GAAG;IACnB,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,wBAAwB;IACtD,CAAC,qBAAqB,CAAC,OAAO,CAAC,EAAE,gCAAgC;IACjE,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,+BAA+B;CACvD,CAAC;AA8BX,MAAM,UAAU,eAAe,CAC7B,MAAS,EACT,iBAAsC,EACtC,YAAqB,EACrB,UAAkB;IAElB,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;SACpC,IAAI,EAAE;SACN,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACX,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,iBAAiB,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE,CAAC;YAC/D,MAAM,IAAI,KAAK,CACb,uDAAuD,CACxD,CAAC;QACJ,CAAC;QACD,MAAM,YAAY,GAAG,YAAY,CAAC,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACtE,OAAO,GAAG,GAAG,IAAI,YAAY,EAAE,CAAC;IAClC,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,CAAC,CAAC;IAEb,iCAAiC;IACjC,OAAO,WAAW,CAAC,CAAC,CAAC,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC;AAC9D,CAAC;AAED,MAAM,CAAC,MAAM,SAAS,GAAG,SAAS,CAAC;AACnC,MAAM,CAAC,MAAM,aAAa,GAAG,sCAAsC,CAAC;AAEpE,MAAM,CAAC,MAAM,YAAY,GAAG,gBAAgB,CAAC;AAC7C,MAAM,CAAC,MAAM,gBAAgB,GAAG,sCAAsC,CAAC;AAEvE,MAAM,UAAU,cAAc,CAC5B,UAAmB,EACnB,kBAAqC,EACrC,cAA8B;IAE9B,MAAM,gBAAgB,GAAG;QACvB,OAAO,EAAE,YAAY,CAAC,cAAc,CAAC;QACrC,OAAO,EAAE,mBAAmB;KAC7B,CAAC;IAEF,IAAI,kBAAkB,CAAC,OAAO,EAAE,CAAC;QAC/B,OAAO,kBAAkB,CAAC,OAAO,CAAC;IACpC,CAAC;IAED,IAAI,UAAU,EAAE,CAAC;QACf,OAAO,gBAAgB,CAAC,OAAO,CAAC;IAClC,CAAC;IAED,OAAO,gBAAgB,CAAC,OAAO,CAAC;AAClC,CAAC"}

package/dist/mjs/types/request/broker.types.d.ts

@@ -0,0 +1,52 @@
+export interface GetBrokerInfoRequest {
+    begin: string;
+    end: string;
+    tradeType: '1' | '2';
+}
+export interface GetBrokerSubAccountsRequest {
+    uid: string;
+    currentPage?: number;
+    pageSize?: number;
+}
+export type BrokerSubAccountPermission = 'general' | 'spot' | 'futures';
+export interface CreateBrokerSubAccountApiRequest {
+    uid: string;
+    passphrase: string;
+    ipWhitelist: string[];
+    permissions: BrokerSubAccountPermission[];
+    label: string;
+}
+export interface GetBrokerSubAccountApisRequest {
+    uid: string;
+    apiKey?: string;
+}
+export interface UpdateBrokerSubAccountApiRequest {
+    uid: string;
+    apiKey: string;
+    ipWhitelist: string[];
+    permissions: BrokerSubAccountPermission[];
+    label: string;
+}
+export interface DeleteBrokerSubAccountApiRequest {
+    uid: string;
+    apiKey: string;
+}
+export type BrokerTransferDirection = 'OUT' | 'IN';
+export type BrokerAccountType = 'MAIN' | 'TRADE';
+export interface BrokerTransferRequest {
+    currency: string;
+    amount: string;
+    clientOid: string;
+    direction: BrokerTransferDirection;
+    accountType: BrokerAccountType;
+    specialUid: string;
+    specialAccountType: BrokerAccountType;
+}
+export interface GetBrokerDepositListRequest {
+    currency?: string;
+    status?: 'PROCESSING' | 'SUCCESS' | 'FAILURE';
+    hash?: string;
+    startTimestamp?: number;
+    endTimestamp?: number;
+    limit?: number;
+}

package/dist/mjs/types/request/broker.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=broker.types.js.map

package/dist/mjs/types/request/broker.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"broker.types.js","sourceRoot":"","sources":["../../../../src/types/request/broker.types.ts"],"names":[],"mappings":""}

package/dist/mjs/types/response/broker.types.d.ts

@@ -0,0 +1,92 @@
+export interface BrokerInfo {
+    accountSize: number;
+    maxAccountSize: number | null;
+    level: number;
+}
+export interface CreateBrokerSubAccountResponse {
+    accountName: string;
+    uid: string;
+    createdAt: number;
+    level: number;
+}
+export interface BrokerSubAccount {
+    accountName: string;
+    uid: string;
+    createdAt: number;
+    level: number;
+}
+export interface GetBrokerSubAccountsResponse {
+    currentPage: number;
+    pageSize: number;
+    totalNum: number;
+    totalPage: number;
+    items: BrokerSubAccount[];
+}
+export interface CreateBrokerSubAccountApiResponse {
+    uid: string;
+    label: string;
+    apiKey: string;
+    secretKey: string;
+    apiVersion: number;
+    permissions: string[];
+    ipWhitelist: string[];
+    createdAt: number;
+}
+export interface BrokerSubAccountApi {
+    uid: string;
+    label: string;
+    apiKey: string;
+    apiVersion: number;
+    permissions: ('General' | 'Spot' | 'Futures')[];
+    ipWhitelist: string[];
+    createdAt: number;
+}
+export type BrokerTransferAccountType = 'MAIN' | 'TRADE' | 'CONTRACT' | 'MARGIN' | 'ISOLATED';
+export type BrokerTransferStatus = 'PROCESSING' | 'SUCCESS' | 'FAILURE';
+export interface BrokerTransferHistory {
+    orderId: string;
+    currency: string;
+    amount: string;
+    fromUid: number;
+    fromAccountType: BrokerTransferAccountType;
+    fromAccountTag: string;
+    toUid: number;
+    toAccountType: BrokerTransferAccountType;
+    toAccountTag: string;
+    status: BrokerTransferStatus;
+    reason: string | null;
+    createdAt: number;
+}
+export interface BrokerDepositRecord {
+    uid: number;
+    hash: string;
+    address: string;
+    memo: string;
+    amount: string;
+    fee: string;
+    currency: string;
+    isInner: boolean;
+    walletTxId: string;
+    status: BrokerTransferStatus;
+    remark: string;
+    chain: string;
+    createdAt: number;
+    updatedAt: number;
+}
+export type BrokerWithdrawalStatus = 'PROCESSING' | 'WALLET_PROCESSING' | 'REVIEW' | 'SUCCESS' | 'FAILURE';
+export interface BrokerWithdrawalRecord {
+    id: string;
+    chain: string;
+    walletTxId: string;
+    uid: number;
+    amount: string;
+    memo: string;
+    fee: string;
+    address: string;
+    remark: string;
+    isInner: boolean;
+    currency: string;
+    status: BrokerWithdrawalStatus;
+    createdAt: number;
+    updatedAt: number;
+}

package/dist/mjs/types/response/broker.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=broker.types.js.map

package/dist/mjs/types/response/broker.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"broker.types.js","sourceRoot":"","sources":["../../../../src/types/response/broker.types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kucoin-api",
-  "version": "2.0.2",
+  "version": "2.1.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",