kucoin-api 0.0.2 → 1.0.0

package/dist/cjs/types/response/spot-margin-trading.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ *
+ ***********
+ * Margin Trading
+ ***********
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=spot-margin-trading.js.map

package/dist/cjs/types/response/spot-margin-trading.js.map

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

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

@@ -0,0 +1,388 @@
+/**
+ *
+ ***********
+ * Spot Trading
+ ***********
+ *
+ */
+/**
+ *
+ * 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;
+    fullName: string;
+    precision: number;
+    confirms: number | null;
+    contractAddress: string | null;
+    isMarginEnabled: boolean;
+    isDebitEnabled: boolean;
+    chains: Chain[];
+}
+export interface SymbolInfo {
+    symbol: string;
+    name: string;
+    baseCurrency: string;
+    quoteCurrency: string;
+    feeCurrency: string;
+    market: string;
+    baseMinSize: string;
+    quoteMinSize: string;
+    baseMaxSize: string;
+    quoteMaxSize: string;
+    baseIncrement: string;
+    quoteIncrement: string;
+    priceIncrement: string;
+    priceLimitRate: string;
+    minFunds: string;
+    isMarginEnabled: boolean;
+    enableTrading: boolean;
+}
+export interface Ticker {
+    sequence: string;
+    price: string;
+    size: string;
+    bestAsk: string;
+    bestAskSize: string;
+    bestBid: string;
+    bestBidSize: string;
+    time: number;
+}
+export interface Symbol24hrStats {
+    time: number;
+    symbol: string;
+    buy: string;
+    sell: 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 OrderBookLevel {
+    sequence: string;
+    time: number;
+    bids: [string, string][];
+    asks: [string, string][];
+}
+export interface TradeHistory {
+    sequence: string;
+    time: number;
+    price: string;
+    size: string;
+    side: string;
+}
+export interface Kline {
+    startAt: string;
+    open: string;
+    close: string;
+    high: string;
+    low: string;
+    volume: string;
+    amount: string;
+}
+/**
+ *
+ * Spot HF trade
+ *
+ */
+export interface SubmitHFOrderSyncResponse {
+    orderId: string;
+    orderTime: number;
+    originSize: string;
+    dealSize: string;
+    remainSize: string;
+    canceledSize: string;
+    status: string;
+    matchTime: number;
+}
+export interface SubmitMultipleHFOrdersResponse {
+    orderId: string;
+    success?: boolean;
+    failMsg?: string;
+}
+export interface SubmitMultipleHFOrdersSyncResponse {
+    orderId: string;
+    orderTime: number;
+    originSize: string;
+    dealSize: string;
+    remainSize: string;
+    canceledSize: string;
+    status: string;
+    matchTime: number;
+    success: boolean;
+}
+export interface SyncCancelHFOrderResponse {
+    orderId: string;
+    originSize: string;
+    dealSize: string;
+    remainSize: string;
+    canceledSize: string;
+    status: string;
+}
+export interface CancelAllHFOrdersResponse {
+    succeedSymbols?: string[];
+    failedSymbols?: {
+        symbol: string;
+        error: string;
+    }[];
+}
+export interface AutoCancelHFOrderSettingQueryResponse {
+    timeout: number;
+    symbols: string;
+    currentTime: number;
+    triggerTime: number;
+}
+export interface HFFilledOrder {
+    id: number;
+    symbol: string;
+    tradeId: number;
+    orderId: string;
+    counterOrderId: string;
+    side: string;
+    liquidity: string;
+    forceTaker: boolean;
+    price: string;
+    size: string;
+    funds: string;
+    fee: string;
+    feeRate: string;
+    feeCurrency: string;
+    stop: string;
+    tradeType: string;
+    type: string;
+    createdAt: number;
+}
+export interface HFOrder {
+    id: string;
+    symbol: string;
+    opType: string;
+    type: string;
+    side: string;
+    price: string;
+    size: string;
+    dealSize: string;
+    cancelledSize: string;
+    remainSize: string;
+    funds: string;
+    dealFunds: string;
+    cancelledFunds: string;
+    remainFunds: string;
+    fee: string;
+    feeCurrency: string;
+    stp: string;
+    timeInForce: string;
+    postOnly: boolean;
+    hidden: boolean;
+    iceberg: boolean;
+    visibleSize: string;
+    cancelAfter: number;
+    channel: string;
+    clientOid: string;
+    remark: string;
+    tags: string;
+    active: boolean;
+    inOrderBook: boolean;
+    cancelExist: boolean;
+    createdAt: number;
+    lastUpdatedAt: number;
+    tradeType: string;
+}
+/**
+ *
+ * Orders
+ *
+ */
+export interface MultipleOrdersResponse {
+    symbol: string;
+    type?: string;
+    side: string;
+    price: string;
+    size: string;
+    funds?: any;
+    stp?: string;
+    stop?: string;
+    stopPrice?: any;
+    timeInForce?: string;
+    cancelAfter?: number;
+    postOnly?: boolean;
+    hidden?: boolean;
+    iceberg?: boolean;
+    visibleSize?: any;
+    channel: string;
+    id: string;
+    status: string;
+    failMsg?: any;
+    clientOid: string;
+}
+export interface SpotOrderList {
+    currentPage: number;
+    pageSize: number;
+    totalNum: number;
+    totalPage: number;
+    items: SpotOrder[];
+}
+export interface SpotOrder {
+    id: string;
+    symbol: string;
+    opType: string;
+    type: string;
+    side: string;
+    price: string;
+    size: string;
+    funds: string;
+    dealFunds: string;
+    dealSize: string;
+    fee: string;
+    feeCurrency: string;
+    stp: string;
+    stop: string;
+    stopTriggered: boolean;
+    stopPrice: string;
+    timeInForce: string;
+    postOnly: boolean;
+    hidden: boolean;
+    iceberg: boolean;
+    visibleSize: string;
+    cancelAfter: number;
+    channel: string;
+    clientOid: string;
+    remark: string;
+    tags: string;
+    isActive: boolean;
+    cancelExist: boolean;
+    createdAt: number;
+    tradeType: string;
+}
+/**
+ *
+ * Fills
+ *
+ */
+export interface SpotOrderFill {
+    symbol: string;
+    tradeId: string;
+    orderId: string;
+    counterOrderId: string;
+    side: 'buy' | 'sell';
+    price: string;
+    size: string;
+    funds: string;
+    type: 'limit' | 'market' | 'limit_stop' | 'market_stop';
+    fee: string;
+    feeCurrency: string;
+    stop: string;
+    liquidity: 'taker' | 'maker';
+    forceTaker: boolean;
+    createdAt: number;
+    tradeType: 'TRADE' | 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE';
+}
+export interface SpotOrderFills {
+    currentPage: number;
+    pageSize: number;
+    totalNum: number;
+    totalPage: number;
+    items: SpotOrderFill[];
+}
+/**
+ *
+ * Stop order
+ *
+ */
+export interface StopOrders {
+    currentPage: number;
+    pageSize: number;
+    totalNum: number;
+    totalPage: number;
+    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;
+}
+/**
+ *
+ * OCO order
+ *
+ */
+export interface OCOOrderDetails {
+    orderId: string;
+    symbol: string;
+    clientOid: string;
+    orderTime: number;
+    status: 'NEW' | 'DONE' | 'TRIGGERED' | 'CANCELLED';
+    orders: OCOOrderSubOrder[];
+}
+export interface OCOOrderSubOrder {
+    id: string;
+    symbol: string;
+    side: 'buy' | 'sell';
+    price: string;
+    stopPrice: string;
+    size: string;
+    status: 'NEW' | 'DONE' | 'TRIGGERED' | 'CANCELLED';
+}
+export interface OCOOrders {
+    currentPage: number;
+    pageSize: number;
+    totalNum: number;
+    totalPage: number;
+    items: OCOOrderListItem[];
+}
+export interface OCOOrderListItem {
+    orderId: string;
+    symbol: string;
+    clientOid: string;
+    orderTime: number;
+    status: 'NEW' | 'DONE' | 'TRIGGERED' | 'CANCELLED';
+}
+export {};

package/dist/cjs/types/response/spot-trading.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ *
+ ***********
+ * Spot Trading
+ ***********
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=spot-trading.js.map

package/dist/cjs/types/response/spot-trading.js.map

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

package/dist/cjs/types/response/spot-vip.d.ts

@@ -0,0 +1,38 @@
+/**
+ *
+ ***********
+ * VIP LENDING
+ ***********
+ *
+ */
+export interface OtcLoan {
+    parentUid: string;
+    orders: {
+        orderId: string;
+        currency: string;
+        principal: string;
+        interest: string;
+    }[];
+    ltv: {
+        transferLtv: string;
+        onlyClosePosLtv: string;
+        delayedLiquidationLtv: string;
+        instantLiquidationLtv: string;
+        currentLtv: string;
+    };
+    totalMarginAmount: string;
+    transferMarginAmount: string;
+    margins: {
+        marginCcy: string;
+        marginQty: string;
+        marginFactor: string;
+    }[];
+}
+export interface OtcLoanAccount {
+    uid: string;
+    marginCcy: string;
+    marginQty: string;
+    marginFactor: string;
+    accountType: 'TRADE' | 'TRADE_HF' | 'CONTRACT';
+    isParent: boolean;
+}

package/dist/cjs/types/response/spot-vip.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ *
+ ***********
+ * VIP LENDING
+ ***********
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=spot-vip.js.map

package/dist/cjs/types/response/spot-vip.js.map

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

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

@@ -0,0 +1,11 @@
+export interface WsServerInfo {
+    endpoint: string;
+    encrypt: boolean;
+    protocol: string;
+    pingInterval: number;
+    pingTimeout: number;
+}
+export interface WsConnectionInfo {
+    token: string;
+    instanceServers: WsServerInfo[];
+}

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

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

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

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

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

@@ -0,0 +1,46 @@
+/** General configuration for the WebsocketClient */
+export interface WSClientConfigurableOptions {
+    /** Your API key */
+    apiKey?: string;
+    /** Your API secret */
+    apiSecret?: string;
+    /** Your API passphrase (can be anything) that you included when creating this API key */
+    apiPassphrase?: string;
+    /** 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 */
+    pingInterval?: number;
+    /** How long to wait for a pong (heartbeat reply) before assuming the connection is dead */
+    pongTimeout?: number;
+    /** Delay in milliseconds before respawning the connection */
+    reconnectTimeout?: number;
+    wsUrl?: string;
+    /**
+     * Allows you to provide a custom "signMessage" function, e.g. to use node's much faster createHmac method
+     *
+     * Look in the examples folder for a demonstration on using node's createHmac instead.
+     */
+    customSignMessageFn?: (message: string, secret: string) => Promise<string>;
+    /**
+     * If you authenticated the WS API before, automatically try to re-authenticate the WS API if you're disconnected/reconnected for any reason.
+     */
+    reauthWSAPIOnReconnect?: boolean;
+}
+/**
+ * WS configuration that's always defined, regardless of user configuration
+ * (usually comes from defaults if there's no user-provided values)
+ */
+export interface WebsocketClientOptions extends WSClientConfigurableOptions {
+    pingInterval: number;
+    pongTimeout: number;
+    reconnectTimeout: number;
+    recvWindow: number;
+    /**
+     * If true, require a "receipt" that the connection is ready for use (e.g. a specific event type)
+     */
+    requireConnectionReadyConfirmation: boolean;
+    authPrivateConnectionsOnConnect: boolean;
+    authPrivateRequests: boolean;
+    reauthWSAPIOnReconnect: boolean;
+}
+export type WsMarket = 'spot' | 'futures';

package/dist/cjs/types/websockets/client.js

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

package/dist/cjs/types/websockets/client.js.map

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

package/dist/cjs/types/websockets/events.d.ts

@@ -0,0 +1,5 @@
+export interface WsDataEvent<TData = any, TWSKey = string> {
+    data: TData;
+    table: string;
+    wsKey: TWSKey;
+}

package/dist/cjs/types/websockets/events.js

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

package/dist/cjs/types/websockets/events.js.map

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

package/dist/cjs/types/websockets/requests.d.ts

@@ -0,0 +1,8 @@
+export type WsOperation = 'subscribe' | 'unsubscribe' | 'login' | 'access' | 'request';
+export interface WsRequestOperation<TWSTopic extends string> {
+    id: number;
+    type: WsOperation;
+    topic: TWSTopic;
+    privateChannel: boolean;
+    response: boolean;
+}

package/dist/cjs/types/websockets/requests.js

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

package/dist/cjs/types/websockets/requests.js.map

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

package/dist/cjs/types/websockets/wsAPI.d.ts

@@ -0,0 +1,9 @@
+export interface WsAPIWsKeyTopicMap {
+    [k: string]: never;
+}
+export interface WsAPITopicRequestParamMap {
+    [k: string]: never;
+}
+export interface WsAPITopicResponseMap {
+    [k: string]: never;
+}

package/dist/cjs/types/websockets/wsAPI.js

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

package/dist/cjs/types/websockets/wsAPI.js.map

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