kucoin-api 2.4.1 → 2.5.0

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

@@ -2,16 +2,19 @@
  * Used to switch how authentication/requests work under the hood
  */
 export declare const REST_CLIENT_TYPE_ENUM: {
-    /** Spot & Margin */
+    /** Global & AU: Spot & Margin */
     readonly main: "main";
-    /** Futures */
+    /** Global & AU: Futures */
     readonly futures: "futures";
-    /** Broker */
+    /** Global: Broker */
     readonly broker: "broker";
-    /** Unified Trading Account */
+    /** Global: Unified Trading Account */
     readonly unifiedTradingAccount: "unifiedTradingAccount";
+    /** Dedicated EU: main (Spot & Margin). No futures at this time. */
+    readonly mainEU: "mainEU";
 };
 export type RestClientType = (typeof REST_CLIENT_TYPE_ENUM)[keyof typeof REST_CLIENT_TYPE_ENUM];
+export type APIRegion = 'global' | 'EU' | 'AU';
 export interface RestClientOptions {
     /** Your API key */
     apiKey?: string;
@@ -26,10 +29,23 @@ export interface RestClientOptions {
     apiAccessToken?: string;
     /** The API key version. Defaults to "2" right now. You can see this in your API management page */
     apiKeyVersion?: number | string;
+    /**
+     * The API region you would like to work with:
+     * - Global (default)
+     *   - API Docs: https://www.kucoin.com/docs-new/introduction
+     * - EU:
+     *   - API Docs: https://www.kucoin.com/en-eu/docs-new/introduction/eu
+     *   - Behaves the same as global, but keep in mind that futures may not be available at this time for EU users.
+     * - AU:
+     *   - API Docs: https://www.kucoin.com/en-au/docs-new/introduction/au
+     *   - Ensures regional market data is retrieved (e.g. correct trading pairs, correct tickers, etc).
+     *   - Also ensures requests for AU users include the required extra header (X-SITE-TYPE: australia).
+     */
+    apiRegion?: APIRegion;
     /** Default: false. If true, we'll throw errors if any params are undefined */
     strictParamValidation?: boolean;
     /**
-     * Optionally override API protocol + domain
+     * Optionally override API protocol + domain. This will override any domain influence from the apiRegion parameter.
      * e.g baseUrl: 'https://api.kucoin.com'
      **/
     baseUrl?: string;
@@ -58,4 +74,4 @@ export declare const APIIDMain = "NODESDK";
 export declare const APIIDMainSign = "d28f5b4a-179d-4fcb-9c00-c8319c0bb82c";
 export declare const APIIDFutures = "NODESDKFUTURES";
 export declare const APIIDFuturesSign = "7f7fb0d6-e600-4ef4-8fe3-41e6aea9af84";
-export declare function getRestBaseUrl(useTestnet: boolean, restInverseOptions: RestClientOptions, restClientType: RestClientType): string;
+export declare function getRestBaseUrl(useTestnet: boolean, restOptions: RestClientOptions, restClientType: RestClientType): string;

package/dist/mjs/lib/requestUtils.js

@@ -1,18 +1,23 @@
+import { neverGuard } from './misc-util.js';
 /**
  * Used to switch how authentication/requests work under the hood
  */
 export const REST_CLIENT_TYPE_ENUM = {
-    /** Spot & Margin */
+    /** Global & AU: Spot & Margin */
     main: 'main',
-    /** Futures */
+    /** Global & AU: Futures */
     futures: 'futures',
-    /** Broker */
+    /** Global: Broker */
     broker: 'broker',
-    /** Unified Trading Account */
+    /** Global: Unified Trading Account */
     unifiedTradingAccount: 'unifiedTradingAccount',
+    /** Dedicated EU: main (Spot & Margin). No futures at this time. */
+    mainEU: 'mainEU',
 };
 const kucoinURLMap = {
     [REST_CLIENT_TYPE_ENUM.main]: 'https://api.kucoin.com',
+    // https://www.kucoin.com/en-eu/docs-new/introduction/eu
+    [REST_CLIENT_TYPE_ENUM.mainEU]: 'https://api.kucoin.eu',
     [REST_CLIENT_TYPE_ENUM.futures]: 'https://api-futures.kucoin.com',
     [REST_CLIENT_TYPE_ENUM.broker]: 'https://api-broker.kucoin.com',
     [REST_CLIENT_TYPE_ENUM.unifiedTradingAccount]: 'https://api.kucoin.com',
@@ -39,14 +44,39 @@ export const APIIDMain = 'NODESDK';
 export const APIIDMainSign = 'd28f5b4a-179d-4fcb-9c00-c8319c0bb82c';
 export const APIIDFutures = 'NODESDKFUTURES';
 export const APIIDFuturesSign = '7f7fb0d6-e600-4ef4-8fe3-41e6aea9af84';
-export function getRestBaseUrl(useTestnet, restInverseOptions, restClientType) {
+export function getRestBaseUrl(useTestnet, restOptions, restClientType) {
+    let resolvedClientType = restClientType;
+    if (restOptions.baseUrl) {
+        return restOptions.baseUrl;
+    }
+    // Override to EU URL for EU regional users
+    if (restOptions.apiRegion === 'EU') {
+        switch (restClientType) {
+            case REST_CLIENT_TYPE_ENUM.main:
+            case REST_CLIENT_TYPE_ENUM.mainEU: {
+                resolvedClientType = REST_CLIENT_TYPE_ENUM.mainEU;
+                break;
+            }
+            case REST_CLIENT_TYPE_ENUM.futures: {
+                console.warn('Futures market is not available for EU users at this time. API requests may not function as expected');
+                break;
+            }
+            case REST_CLIENT_TYPE_ENUM.broker: {
+                break;
+            }
+            case REST_CLIENT_TYPE_ENUM.unifiedTradingAccount: {
+                resolvedClientType = REST_CLIENT_TYPE_ENUM.mainEU;
+                break;
+            }
+            default: {
+                throw neverGuard(restClientType, `Unhandled REST Client Type "${restClientType}"`);
+            }
+        }
+    }
     const exchangeBaseUrls = {
-        livenet: kucoinURLMap[restClientType],
+        livenet: kucoinURLMap[resolvedClientType],
         testnet: 'https://noTestnet',
     };
-    if (restInverseOptions.baseUrl) {
-        return restInverseOptions.baseUrl;
-    }
     if (useTestnet) {
         return exchangeBaseUrls.testnet;
     }

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;IAClB,aAAa;IACb,MAAM,EAAE,QAAQ;IAChB,8BAA8B;IAC9B,qBAAqB,EAAE,uBAAuB;CACtC,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;IAC/D,CAAC,qBAAqB,CAAC,qBAAqB,CAAC,EAAE,wBAAwB;CAC/D,CAAC;AAuDX,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,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAE5C;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,iCAAiC;IACjC,IAAI,EAAE,MAAM;IACZ,2BAA2B;IAC3B,OAAO,EAAE,SAAS;IAClB,qBAAqB;IACrB,MAAM,EAAE,QAAQ;IAChB,sCAAsC;IACtC,qBAAqB,EAAE,uBAAuB;IAC9C,mEAAmE;IACnE,MAAM,EAAE,QAAQ;CACR,CAAC;AAKX,MAAM,YAAY,GAAmC;IACnD,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,wBAAwB;IACtD,wDAAwD;IACxD,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,uBAAuB;IACvD,CAAC,qBAAqB,CAAC,OAAO,CAAC,EAAE,gCAAgC;IACjE,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,+BAA+B;IAC/D,CAAC,qBAAqB,CAAC,qBAAqB,CAAC,EAAE,wBAAwB;CAC/D,CAAC;AAuEX,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,WAA8B,EAC9B,cAA8B;IAE9B,IAAI,kBAAkB,GAAG,cAAc,CAAC;IAExC,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;QACxB,OAAO,WAAW,CAAC,OAAO,CAAC;IAC7B,CAAC;IAED,2CAA2C;IAC3C,IAAI,WAAW,CAAC,SAAS,KAAK,IAAI,EAAE,CAAC;QACnC,QAAQ,cAAc,EAAE,CAAC;YACvB,KAAK,qBAAqB,CAAC,IAAI,CAAC;YAChC,KAAK,qBAAqB,CAAC,MAAM,CAAC,CAAC,CAAC;gBAClC,kBAAkB,GAAG,qBAAqB,CAAC,MAAM,CAAC;gBAClD,MAAM;YACR,CAAC;YACD,KAAK,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC;gBACnC,OAAO,CAAC,IAAI,CACV,sGAAsG,CACvG,CAAC;gBACF,MAAM;YACR,CAAC;YACD,KAAK,qBAAqB,CAAC,MAAM,CAAC,CAAC,CAAC;gBAClC,MAAM;YACR,CAAC;YACD,KAAK,qBAAqB,CAAC,qBAAqB,CAAC,CAAC,CAAC;gBACjD,kBAAkB,GAAG,qBAAqB,CAAC,MAAM,CAAC;gBAClD,MAAM;YACR,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACR,MAAM,UAAU,CACd,cAAc,EACd,+BAA+B,cAAc,GAAG,CACjD,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,gBAAgB,GAAG;QACvB,OAAO,EAAE,YAAY,CAAC,kBAAkB,CAAC;QACzC,OAAO,EAAE,mBAAmB;KAC7B,CAAC;IAEF,IAAI,UAAU,EAAE,CAAC;QACf,OAAO,gBAAgB,CAAC,OAAO,CAAC;IAClC,CAAC;IAED,OAAO,gBAAgB,CAAC,OAAO,CAAC;AAClC,CAAC"}

package/dist/mjs/types/websockets/ws-general.d.ts

@@ -1,7 +1,7 @@
 import { AxiosRequestConfig } from 'axios';
 import type { ClientRequestArgs } from 'http';
 import WebSocket from 'isomorphic-ws';
-import { RestClientOptions } from '../../lib/requestUtils.js';
+import { APIRegion, RestClientOptions } from '../../lib/requestUtils.js';
 /** General configuration for the WebsocketClient */
 export interface WSClientConfigurableOptions {
     /** Your API key */
@@ -10,6 +10,19 @@ export interface WSClientConfigurableOptions {
     apiSecret?: string;
     /** Your API passphrase (can be anything) that you included when creating this API key */
     apiPassphrase?: string;
+    /**
+     * The API region you would like to work with:
+     * - Global (default)
+     *   - API Docs: https://www.kucoin.com/docs-new/introduction
+     * - EU:
+     *   - API Docs: https://www.kucoin.com/en-eu/docs-new/introduction/eu
+     *   - Behaves the same as global, but keep in mind that futures may not be available at this time for EU users.
+     * - AU:
+     *   - API Docs: https://www.kucoin.com/en-au/docs-new/introduction/au
+     *   - Ensures regional market data is retrieved (e.g. correct trading pairs, correct tickers, etc).
+     *   - Also ensures requests for AU users include the required extra header (X-SITE-TYPE: australia).
+     */
+    apiRegion?: APIRegion;
     /** Define a recv window when preparing a private websocket signature. This is in milliseconds, so 5000 == 5 seconds */
     recvWindow?: number;
     /** How often to check if the connection is alive */

package/package.json

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