kucoin-api 2.0.0 → 2.0.2

package/dist/mjs/types/response/spot-trading.d.ts

@@ -10,17 +10,6 @@
  * Market data
  *
  */
-interface Chain {
-    chainName: string;
-    withdrawalMinSize: string;
-    withdrawalMinFee: string;
-    isWithdrawEnabled: boolean;
-    isDepositEnabled: boolean;
-    confirms: number;
-    preConfirms: number;
-    contractAddress: string;
-    chainId: string;
-}
 export interface CurrencyInfo {
     currency: string;
     name: string;
@@ -31,10 +20,23 @@ export interface CurrencyInfo {
     isMarginEnabled: boolean;
     isDebitEnabled: boolean;
     chains: Chain[];
+}
+interface Chain {
+    chainName: string;
+    withdrawalMinSize: string;
+    depositMinSize: string | null;
+    withdrawFeeRate: string;
+    withdrawalMinFee: string;
+    isWithdrawEnabled: boolean;
+    isDepositEnabled: boolean;
+    confirms: number;
+    preConfirms: number;
+    contractAddress: string;
     withdrawPrecision: number;
+    maxWithdraw: string | null;
+    maxDeposit: string | null;
     needTag: boolean;
-    maxWithdraw: string;
-    maxDeposit: string;
+    chainId: string;
 }
 export interface SymbolInfo {
     symbol: string;
@@ -42,7 +44,7 @@ export interface SymbolInfo {
     baseCurrency: string;
     quoteCurrency: string;
     feeCurrency: string;
-    market: string;
+    market: 'USDS' | 'BTC' | 'ALTS';
     baseMinSize: string;
     quoteMinSize: string;
     baseMaxSize: string;
@@ -54,6 +56,10 @@ export interface SymbolInfo {
     minFunds: string;
     isMarginEnabled: boolean;
     enableTrading: boolean;
+    feeCategory: 1 | 2 | 3;
+    makerFeeCoefficient: string;
+    takerFeeCoefficient: string;
+    st: boolean;
 }
 export interface Ticker {
     sequence: string;
@@ -65,6 +71,30 @@ export interface Ticker {
     bestBidSize: string;
     time: number;
 }
+export interface AllTickers {
+    time: number;
+    ticker: Ticker[];
+}
+export interface AllTickersItem {
+    symbol: string;
+    symbolName: string;
+    buy: string;
+    bestBidSize: string;
+    sell: string;
+    bestAskSize: string;
+    changeRate: string;
+    changePrice: string;
+    high: string;
+    low: string;
+    vol: string;
+    volValue: string;
+    last: string;
+    averagePrice: string;
+    takerFeeRate: string;
+    makerFeeRate: string;
+    takerCoefficient: string;
+    makerCoefficient: string;
+}
 export interface Symbol24hrStats {
     time: number;
     symbol: string;
@@ -96,15 +126,7 @@ export interface TradeHistory {
     size: string;
     side: string;
 }
-export interface Kline {
-    startAt: string;
-    open: string;
-    close: string;
-    high: string;
-    low: string;
-    volume: string;
-    amount: string;
-}
+export type Kline = [string, string, string, string, string, string, string];
 /**
  *
  * Spot HF trade
@@ -140,7 +162,8 @@ export interface SubmitMultipleHFOrdersSyncResponse {
     clientOid: string;
 }
 export interface SyncCancelHFOrderResponse {
-    orderId: string;
+    clientOid?: string;
+    orderId?: string;
     originSize: string;
     dealSize: string;
     remainSize: string;
@@ -162,12 +185,13 @@ export interface AutoCancelHFOrderSettingQueryResponse {
 }
 export interface HFFilledOrder {
     id: number;
-    symbol: string;
-    tradeId: number;
     orderId: string;
     counterOrderId: string;
-    side: string;
-    liquidity: string;
+    tradeId: number;
+    symbol: string;
+    side: 'buy' | 'sell';
+    liquidity: 'taker' | 'maker';
+    type: 'limit' | 'market';
     forceTaker: boolean;
     price: string;
     size: string;
@@ -177,43 +201,45 @@ export interface HFFilledOrder {
     feeCurrency: string;
     stop: string;
     tradeType: string;
-    type: string;
+    taxRate: string;
+    tax: string;
     createdAt: number;
 }
 export interface HFOrder {
     id: string;
+    clientOid: string;
     symbol: string;
     opType: string;
-    type: string;
-    side: string;
+    type: 'limit' | 'market';
+    side: 'buy' | 'sell';
     price: string;
     size: string;
-    dealSize: string;
-    cancelledSize: string;
-    remainSize: string;
     funds: string;
+    dealSize: string;
     dealFunds: string;
-    cancelledFunds: string;
+    remainSize: string;
     remainFunds: string;
+    cancelledSize: string;
+    cancelledFunds: string;
     fee: string;
     feeCurrency: string;
-    stp: string;
-    timeInForce: string;
+    stp?: 'DC' | 'CO' | 'CN' | 'CB' | null;
+    timeInForce: 'GTC' | 'GTT' | 'IOC' | 'FOK';
     postOnly: boolean;
     hidden: boolean;
     iceberg: boolean;
     visibleSize: string;
     cancelAfter: number;
     channel: string;
-    clientOid: string;
-    remark: string;
-    tags: string;
-    active: boolean;
-    inOrderBook: boolean;
+    remark?: string | null;
+    tags?: string | null;
     cancelExist: boolean;
+    tradeType: string;
+    inOrderBook: boolean;
+    active: boolean;
+    tax: string;
     createdAt: number;
     lastUpdatedAt: number;
-    tradeType: string;
 }
 /**
  *
@@ -324,37 +350,37 @@ export interface StopOrders {
     items: StopOrderItem[];
 }
 export interface StopOrderItem {
-    id: string;
-    symbol: string;
-    userId: string;
-    status: 'NEW' | 'TRIGGERED';
-    type: 'limit' | 'market';
-    side: 'buy' | 'sell';
-    price: string;
-    size: string;
-    funds: string | null;
-    stp: string | null;
-    timeInForce: 'GTC' | 'GTT' | 'IOC' | 'FOK';
-    cancelAfter: number;
-    postOnly: boolean;
-    hidden: boolean;
-    iceberg: boolean;
-    visibleSize: string | null;
-    channel: string;
-    clientOid: string;
-    remark: string | null;
-    tags: string | null;
-    orderTime: number;
-    domainId: string;
-    tradeSource: 'USER' | 'MARGIN_SYSTEM';
-    tradeType: 'TRADE' | 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE';
-    feeCurrency: string;
-    takerFeeRate: string;
-    makerFeeRate: string;
-    createdAt: number;
-    stop: 'loss' | 'entry';
-    stopTriggerTime: number | null;
-    stopPrice: string;
+    id?: string;
+    symbol?: string;
+    userId?: string;
+    status?: 'NEW' | 'TRIGGERED';
+    type?: 'limit' | 'market' | 'limit_stop' | 'market_stop';
+    side?: 'buy' | 'sell';
+    price?: string;
+    size?: string;
+    funds?: string | null;
+    stp?: string | null;
+    timeInForce?: 'GTC' | 'GTT' | 'IOC' | 'FOK';
+    cancelAfter?: number;
+    postOnly?: boolean;
+    hidden?: boolean;
+    iceberg?: boolean;
+    visibleSize?: string | null;
+    channel?: string;
+    clientOid?: string;
+    remark?: string | null;
+    tags?: string | null;
+    domainId?: string;
+    tradeSource?: 'USER' | 'MARGIN_SYSTEM';
+    tradeType?: 'TRADE' | 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE';
+    feeCurrency?: string;
+    takerFeeRate?: string;
+    makerFeeRate?: string;
+    createdAt?: number;
+    stop?: 'loss' | 'entry';
+    stopTriggerTime?: number | null;
+    stopPrice?: string;
+    orderTime?: number;
 }
 /**
  *

package/dist/mjs/types/websockets/client.d.ts

@@ -1,3 +1,5 @@
+import { AxiosRequestConfig } from 'axios';
+import { RestClientOptions } from '../../lib/requestUtils.js';
 /** General configuration for the WebsocketClient */
 export interface WSClientConfigurableOptions {
     /** Your API key */
@@ -14,6 +16,8 @@ export interface WSClientConfigurableOptions {
     pongTimeout?: number;
     /** Delay in milliseconds before respawning the connection */
     reconnectTimeout?: number;
+    restOptions?: RestClientOptions;
+    requestOptions?: AxiosRequestConfig;
     wsOptions?: {
         protocols?: string[];
         agent?: any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kucoin-api",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "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",
@@ -81,4 +81,4 @@
     "url": "https://github.com/tiagosiebler/kucoin-api/issues"
   },
   "homepage": "https://github.com/tiagosiebler/kucoin-api#readme"
-}
+}