kucoin-api 2.1.23 → 2.3.0

package/dist/mjs/types/response/uta-types.d.ts

@@ -0,0 +1,172 @@
+/**
+ * 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[][];
+}
+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;
+}

package/dist/mjs/types/response/uta-types.js

@@ -0,0 +1,5 @@
+/**
+ * Unified Trading Account Response Types
+ */
+export {};
+//# sourceMappingURL=uta-types.js.map

package/dist/mjs/types/response/uta-types.js.map

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

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

@@ -0,0 +1,123 @@
+import { WS_KEY_MAP, WsKey } from '../../lib/websocket/websocket-util.js';
+import { BatchCancelOrdersRequest, Order } from '../request/futures.types.js';
+import { SubmitHFMarginOrderRequest } from '../request/spot-margin-trading.js';
+import { ModifyHFOrderRequest, SubmitHFOrderRequest } from '../request/spot-trading.js';
+import { BatchCancelOrderResult, SubmitMultipleOrdersFuturesResponse } from '../response/futures.types.js';
+import { MarginSubmitOrderV3Response } from '../response/spot-margin-trading.js';
+import { SubmitHFOrderSyncResponse, SyncCancelHFOrderResponse } from '../response/spot-trading.js';
+export type WsOperation = 'subscribe' | 'unsubscribe' | 'login' | 'access' | 'request' | 'ping';
+export interface WsRequestOperation<TWSTopic extends string> {
+    id: number;
+    type: WsOperation;
+    topic: TWSTopic;
+    privateChannel: boolean;
+    response: boolean;
+}
+export type Exact<T> = {} & {
+    [K in keyof T]: T[K];
+};
+/**
+ * WS API commands (for sending requests via WS)
+ */
+export declare const WS_API_Operations: readonly ["ping", "spot.order", "spot.modify", "spot.cancel", "spot.sync_order", "spot.sync_cancel", "margin.order", "margin.cancel", "futures.order", "futures.cancel", "futures.multi_order", "futures.multi_cancel"];
+export type WsAPIOperation = (typeof WS_API_Operations)[number];
+export interface WsRequestOperationKucoin<TWSTopic extends string, TWSParams extends object = any> {
+    id: string;
+    op: WsOperation | WsAPIOperation;
+    args?: (TWSTopic | string | number)[] | TWSParams;
+}
+export interface WSAPIResponse<TResponseData extends object = object, TWSAPIOperation = WsAPIOperation> {
+    /** Auto-generated */
+    id: string;
+    op: TWSAPIOperation;
+    msg?: string;
+    code: '200000' | string;
+    data: TResponseData;
+    inTime: number;
+    outTime: number;
+    rateLimit?: {
+        limit: number;
+        reset: number;
+        remaining: number;
+    };
+    wsKey: WsKey;
+    isWSAPIResponse: boolean;
+    request?: any;
+}
+export interface WsAPIWsKeyTopicMap {
+    [WS_KEY_MAP.wsApiSpotV1]: WsAPIOperation;
+    [WS_KEY_MAP.wsApiFuturesV1]: WsAPIOperation;
+}
+export type WSAPICancelOrderRequest = {
+    symbol: string;
+} & ({
+    orderId: string;
+} | {
+    clientOid: string;
+});
+export interface WSAPIOrderResponse {
+    orderId: string;
+    clientOid: string;
+}
+export interface WsAPITopicRequestParamMap {
+    [key: string]: unknown;
+    subscribe: never;
+    unsubscribe: never;
+    login: never;
+    access: never;
+    request: never;
+    ping: void;
+    'spot.order': SubmitHFOrderRequest;
+    'margin.order': SubmitHFMarginOrderRequest;
+    'futures.order': Order;
+    'spot.cancel': WSAPICancelOrderRequest;
+    'margin.cancel': WSAPICancelOrderRequest;
+    'futures.cancel': {
+        orderId: string;
+    } | {
+        clientOid: string;
+        symbol: string;
+    };
+    'futures.multi_cancel': BatchCancelOrdersRequest;
+    'futures.multi_order': Order[];
+    'spot.sync_order': SubmitHFOrderRequest;
+    'spot.modify': ModifyHFOrderRequest;
+    'spot.sync_cancel': WSAPICancelOrderRequest;
+}
+export interface WsAPITopicResponseMap {
+    [key: string]: unknown;
+    subscribe: never;
+    unsubscribe: never;
+    login: never;
+    access: never;
+    request: never;
+    ping: unknown;
+    'spot.order': WSAPIResponse<WSAPIOrderResponse>;
+    'margin.order': WSAPIResponse<MarginSubmitOrderV3Response>;
+    'futures.order': WSAPIResponse<WSAPIOrderResponse>;
+    'spot.cancel': WSAPIResponse<WSAPIOrderResponse>;
+    'margin.cancel': WSAPIResponse<WSAPIOrderResponse>;
+    'futures.cancel': WSAPIResponse<{
+        cancelledOrderIds: string[];
+    } | {
+        clientOid: string;
+    }>;
+    'futures.multi_cancel': WSAPIResponse<BatchCancelOrderResult[]>;
+    'futures.multi_order': WSAPIResponse<SubmitMultipleOrdersFuturesResponse[]>;
+    'spot.sync_order': WSAPIResponse<SubmitHFOrderSyncResponse>;
+    'spot.modify': WSAPIResponse<{
+        newOrderId: string;
+        clientOid: string;
+    }>;
+    'spot.sync_cancel': WSAPIResponse<SyncCancelHFOrderResponse>;
+}
+export interface WSAPIAuthenticationRequestFromServer {
+    timestamp: number;
+    sessionId: string;
+}
+export interface WSAPIAuthenticationConfirmedFromServer {
+    pingInterval: number;
+    sessionId: string;
+    pingTimeout: number;
+    data: 'welcome';
+}

package/dist/mjs/types/websockets/ws-api.js

@@ -0,0 +1,19 @@
+import { WS_KEY_MAP } from '../../lib/websocket/websocket-util.js';
+/**
+ * WS API commands (for sending requests via WS)
+ */
+export const WS_API_Operations = [
+    'ping',
+    'spot.order',
+    'spot.modify',
+    'spot.cancel',
+    'spot.sync_order',
+    'spot.sync_cancel',
+    'margin.order',
+    'margin.cancel',
+    'futures.order',
+    'futures.cancel',
+    'futures.multi_order',
+    'futures.multi_cancel',
+];
+//# sourceMappingURL=ws-api.js.map

package/dist/mjs/types/websockets/ws-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-api.js","sourceRoot":"","sources":["../../../../src/types/websockets/ws-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAS,MAAM,uCAAuC,CAAC;AAyC1E;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,MAAM;IACN,YAAY;IACZ,aAAa;IACb,aAAa;IACb,iBAAiB;IACjB,kBAAkB;IAClB,cAAc;IACd,eAAe;IACf,eAAe;IACf,gBAAgB;IAChB,qBAAqB;IACrB,sBAAsB;CACd,CAAC"}

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

@@ -0,0 +1,11 @@
+export interface WsDataEvent<TData = any, TWSKey = string> {
+    data: TData;
+    table: string;
+    wsKey: TWSKey;
+}
+export interface MessageEventLike {
+    target: WebSocket;
+    type: 'message';
+    data: string;
+}
+export declare function isMessageEvent(msg: unknown): msg is MessageEventLike;

package/dist/mjs/types/websockets/ws-events.js

@@ -0,0 +1,8 @@
+export function isMessageEvent(msg) {
+    if (typeof msg !== 'object' || !msg) {
+        return false;
+    }
+    const message = msg;
+    return message['type'] === 'message' && typeof message['data'] === 'string';
+}
+//# sourceMappingURL=ws-events.js.map

package/dist/mjs/types/websockets/ws-events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-events.js","sourceRoot":"","sources":["../../../../src/types/websockets/ws-events.ts"],"names":[],"mappings":"AAYA,MAAM,UAAU,cAAc,CAAC,GAAY;IACzC,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,GAAG,EAAE,CAAC;QACpC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,OAAO,GAAG,GAAuB,CAAC;IACxC,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,SAAS,IAAI,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,QAAQ,CAAC;AAC9E,CAAC"}

package/dist/mjs/types/websockets/{client.d.ts → ws-general.d.ts}

@@ -50,5 +50,10 @@ export interface WebsocketClientOptions extends WSClientConfigurableOptions {
     authPrivateConnectionsOnConnect: boolean;
     authPrivateRequests: boolean;
     reauthWSAPIOnReconnect: boolean;
+    /**
+     * Whether to use native WebSocket ping/pong frames for heartbeats
+     */
+    useNativeHeartbeats: boolean;
 }
 export type WsMarket = 'spot' | 'futures';
+export type WsEventInternalSrc = 'event' | 'function';

package/dist/mjs/types/websockets/ws-general.js

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

package/dist/mjs/types/websockets/ws-general.js.map

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