kucoin-api 0.0.2 → 1.0.0

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

@@ -0,0 +1,214 @@
+/**
+ *
+ ***********
+ * Spot Trading
+ ***********
+ *
+ */
+/**
+ *
+ * Market data
+ *
+ */
+export interface GetSpotKlinesRequest {
+    symbol: string;
+    startAt?: number;
+    endAt?: number;
+    type: '1min' | '3min' | '5min' | '15min' | '30min' | '1hour' | '2hour' | '4hour' | '6hour' | '8hour' | '12hour' | '1day' | '1week' | '1month';
+}
+/**
+ *
+ * Spot HF trade
+ *
+ */
+export interface SubmitHFOrderRequest {
+    clientOid?: string;
+    symbol: string;
+    type: 'limit' | 'market';
+    side: 'buy' | 'sell';
+    stp?: 'CN' | 'CO' | 'CB' | 'DC';
+    tags?: string;
+    remark?: string;
+}
+export interface SubmitMultipleHFOrdersRequest {
+    clientOid?: string;
+    symbol: string;
+    type: 'limit' | 'market';
+    timeInForce?: 'GTC' | 'GTT' | 'IOC' | 'FOK';
+    stp?: 'CN' | 'CO' | 'CB' | 'DC';
+    side: 'buy' | 'sell';
+    price: string;
+    size: string;
+    cancelAfter?: number;
+    postOnly?: boolean;
+    hidden?: boolean;
+    iceberg?: boolean;
+    visibleSize?: string;
+    tags?: string;
+    remark?: string;
+}
+export interface ModifyHFOrderRequest {
+    symbol: string;
+    clientOid?: string;
+    orderId?: string;
+    newPrice?: string;
+    newSize?: string;
+}
+export interface CancelSpecifiedNumberHFOrdersRequest {
+    orderId: string;
+    symbol: string;
+    cancelSize: string;
+}
+export interface GetHFCompletedOrdersRequest {
+    symbol: string;
+    side?: 'buy' | 'sell';
+    type?: 'limit' | 'market';
+    startAt?: number;
+    endAt?: number;
+    lastId?: number;
+    limit?: number;
+}
+export interface GetHFFilledListRequest {
+    orderId?: string;
+    symbol: string;
+    side?: 'buy' | 'sell';
+    type?: 'limit' | 'market';
+    startAt?: number;
+    endAt?: number;
+    lastId?: number;
+    limit?: number;
+}
+/**
+ *
+ * Orders
+ *
+ */
+export interface SubmitOrderRequest {
+    clientOid: string;
+    side: 'buy' | 'sell';
+    symbol: string;
+    type?: 'limit' | 'market';
+    remark?: string;
+    stp?: 'CN' | 'CO' | 'CB' | 'DC';
+    tradeType?: 'TRADE' | 'MARGIN_TRADE';
+    price?: string;
+    size?: string;
+    timeInForce?: 'GTC' | 'GTT' | 'IOC' | 'FOK';
+    cancelAfter?: number;
+    postOnly?: boolean;
+    hidden?: boolean;
+    iceberg?: boolean;
+    visibleSize?: string;
+    funds?: string;
+}
+export interface SubmitMultipleOrdersRequest {
+    clientOid: string;
+    side: 'buy' | 'sell';
+    type?: 'limit';
+    remark?: string;
+    stop?: 'loss' | 'entry';
+    stopPrice?: string;
+    stp?: 'CN' | 'CO' | 'CB' | 'DC';
+    tradeType?: 'TRADE';
+    price: string;
+    size: string;
+    timeInForce?: 'GTC' | 'GTT' | 'IOC' | 'FOK';
+    cancelAfter?: number;
+    postOnly?: boolean;
+    hidden?: boolean;
+    iceberg?: boolean;
+    visibleSize?: string;
+}
+export interface CancelAllOrdersRequest {
+    symbol?: string;
+    tradeType?: 'TRADE' | 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE';
+}
+export interface GetOrderListRequest {
+    status?: 'active' | 'done';
+    symbol?: string;
+    side?: 'buy' | 'sell';
+    type?: 'limit' | 'market' | 'limit_stop' | 'market_stop';
+    tradeType?: 'TRADE' | 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE';
+    startAt?: number;
+    endAt?: number;
+}
+/**
+ *
+ * Fills
+ *
+ */
+export interface GetFillsRequest {
+    orderId?: string;
+    symbol?: string;
+    side?: 'buy' | 'sell';
+    type?: 'limit' | 'market' | 'limit_stop' | 'market_stop';
+    startAt?: number;
+    endAt?: number;
+    tradeType: 'TRADE' | 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE';
+}
+/**
+ *
+ * Stop order
+ *
+ */
+export interface SubmitStopOrderRequest {
+    clientOid: string;
+    side: 'buy' | 'sell';
+    symbol: string;
+    type?: 'limit' | 'market';
+    remark?: string;
+    stop?: 'loss' | 'entry';
+    stopPrice?: string;
+    stp?: 'CN' | 'CO' | 'CB' | 'DC';
+    tradeType?: 'TRADE' | 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE';
+    price?: string;
+    size?: string;
+    timeInForce?: 'GTC' | 'GTT' | 'IOC' | 'FOK';
+    cancelAfter?: number;
+    postOnly?: boolean;
+    hidden?: boolean;
+    iceberg?: boolean;
+    visibleSize?: string;
+    funds?: string;
+}
+export interface CancelStopOrdersRequest {
+    symbol?: string;
+    tradeType?: 'TRADE' | 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE';
+    orderIds?: string;
+}
+export interface GetStopOrdersListRequest {
+    symbol?: string;
+    side?: 'buy' | 'sell';
+    type?: 'limit' | 'market' | 'limit_stop' | 'market_stop';
+    tradeType?: 'TRADE' | 'MARGIN_TRADE' | 'MARGIN_ISOLATED_TRADE';
+    startAt?: number;
+    endAt?: number;
+    currentPage?: number;
+    orderIds?: string;
+    pageSize?: number;
+    stop?: 'stop' | 'oco';
+}
+/**
+ *
+ * OCO order
+ *
+ */
+export interface SubmitOCOOrderRequest {
+    symbol: string;
+    side: 'buy' | 'sell';
+    price: string;
+    size: string;
+    stopPrice: string;
+    limitPrice: string;
+    tradeType?: 'TRADE';
+    clientOid: string;
+    remark?: string;
+}
+export interface GetOCOOrdersRequest {
+    pageSize: string;
+    currentPage: string;
+    symbol?: string;
+    startAt?: number;
+    endAt?: number;
+    orderIds?: string;
+}

package/dist/cjs/types/request/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/request/spot-trading.js.map

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

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

@@ -0,0 +1,501 @@
+/**
+ * REST - ACCOUNT  - BASIC INFO
+ * Get Account Ledgers - Futures
+ */
+export interface FuturesAccountTransaction {
+    time: number;
+    type: 'RealisedPNL' | 'Deposit' | 'Withdrawal' | 'TransferIn' | 'TransferOut';
+    amount: number;
+    fee: number | null;
+    accountEquity: number;
+    status: 'Completed' | 'Pending';
+    remark: string;
+    offset: number;
+    currency: string;
+}
+/**
+ * REST - ACCOUNT  - SUBACCOUNT API
+ */
+export interface SubAccountAPI {
+    apiKey: string;
+    createdAt: number;
+    ipWhitelist: string;
+    permission: string;
+    remark: string;
+    subName: string;
+}
+export type CreateSubAccountAPI = SubAccountAPI & {
+    apiSecret: string;
+    passphrase: string;
+};
+export interface UpdateSubAccountAPI {
+    apiKey: string;
+    ipWhitelist: string;
+    permission: string;
+    subName: string;
+}
+/**
+ * REST - FUNDING - FUNDING OVERVIEW
+ */
+export interface AccountBalance {
+    accountEquity: number;
+    unrealisedPNL: number;
+    marginBalance: number;
+    positionMargin: number;
+    orderMargin: number;
+    frozenFunds: number;
+    availableBalance: number;
+    currency: string;
+}
+export interface AccountSummary {
+    accountEquityTotal: number;
+    unrealisedPNLTotal: number;
+    marginBalanceTotal: number;
+    positionMarginTotal: number;
+    orderMarginTotal: number;
+    frozenFundsTotal: number;
+    availableBalanceTotal: number;
+    currency: string;
+}
+export type SubBalance = AccountBalance & {
+    accountName: string;
+};
+/**
+ * REST - FUNDING - TRANSFER
+ */
+export interface TransferDetail {
+    applyId: string;
+    bizNo: string;
+    payAccountType: string;
+    payTag: string;
+    remark: string;
+    recAccountType: string;
+    recTag: string;
+    recRemark: string;
+    recSystem: string;
+    status: string;
+    currency: string;
+    amount: string;
+    fee: string;
+    sn: number;
+    reason: string;
+    createdAt: number;
+    updatedAt: number;
+}
+interface TransferOutRequestRecord {
+    applyId: string;
+    currency: string;
+    recRemark: string;
+    recSystem: string;
+    status: string;
+    amount: string;
+    reason: string;
+    offset: number;
+    createdAt: number;
+    remark: string;
+}
+export interface FuturesTransferRecords {
+    currentPage: number;
+    pageSize: number;
+    totalNum: number;
+    totalPage: number;
+    items: TransferOutRequestRecord[];
+}
+/**
+ *
+ * Futures Market Data
+ *
+ */
+export interface FuturesSymbolInfo {
+    symbol: string;
+    rootSymbol: string;
+    type: string;
+    firstOpenDate: number;
+    expireDate: number | null;
+    settleDate: number | null;
+    baseCurrency: string;
+    quoteCurrency: string;
+    settleCurrency: string;
+    maxOrderQty: number;
+    maxPrice: number;
+    lotSize: number;
+    tickSize: number;
+    indexPriceTickSize: number;
+    multiplier: number;
+    initialMargin: number;
+    maintainMargin: number;
+    maxRiskLimit: number;
+    minRiskLimit: number;
+    riskStep: number;
+    makerFeeRate: number;
+    takerFeeRate: number;
+    takerFixFee: number;
+    makerFixFee: number;
+    settlementFee: number | null;
+    isDeleverage: boolean;
+    isQuanto: boolean;
+    isInverse: boolean;
+    markMethod: string;
+    fairMethod: string;
+    fundingBaseSymbol: string;
+    fundingQuoteSymbol: string;
+    fundingRateSymbol: string;
+    indexSymbol: string;
+    settlementSymbol: string;
+    status: string;
+    fundingFeeRate: number;
+    predictedFundingFeeRate: number;
+    openInterest: string;
+    turnoverOf24h: number;
+    volumeOf24h: number;
+    markPrice: number;
+    indexPrice: number;
+    lastTradePrice: number;
+    nextFundingRateTime: number;
+    maxLeverage: number;
+    sourceExchanges: string[];
+    premiumsSymbol1M: string;
+    premiumsSymbol8H: string;
+    fundingBaseSymbol1M: string;
+    fundingQuoteSymbol1M: string;
+    lowPrice: number;
+    highPrice: number;
+    priceChgPct: number;
+    priceChg: number;
+}
+export interface TickerDetail {
+    sequence: number;
+    symbol: string;
+    side: string;
+    size: number;
+    price: string;
+    bestBidSize: number;
+    bestBidPrice: string;
+    bestAskSize: number;
+    bestAskPrice: string;
+    tradeId: string;
+    ts: number;
+}
+export interface MarketTradeDetail {
+    sequence: number;
+    tradeId: string;
+    takerOrderId: string;
+    makerOrderId: string;
+    price: string;
+    size: number;
+    side: string;
+    ts: number;
+}
+export interface FullOrderBookDetail {
+    symbol: string;
+    sequence: number;
+    asks: [string, number][];
+    bids: [string, number][];
+    ts: number;
+}
+export type FuturesKline = [
+    number,
+    number,
+    number,
+    number,
+    number,
+    number
+];
+export interface InterestRateItem {
+    symbol: string;
+    granularity: number;
+    timePoint: number;
+    value: number;
+}
+export interface IndexListItem {
+    symbol: string;
+    granularity: number;
+    timePoint: number;
+    value: number;
+    decomposionList: {
+        exchange: string;
+        price: number;
+        weight: number;
+    }[];
+}
+export interface FuturesMarkPrice {
+    symbol: string;
+    granularity: number;
+    timePoint: number;
+    value: number;
+    indexPrice: number;
+}
+export interface PremiumIndexItem {
+    symbol: string;
+    granularity: number;
+    timePoint: number;
+    value: number;
+}
+/**
+ *
+ ***********
+ * Account
+ ***********
+ *
+ */
+/**
+ *
+ * Orders
+ *
+ */
+export interface FuturesOrder {
+    id: string;
+    symbol: string;
+    type: string;
+    side: string;
+    price: string;
+    size: number;
+    value: string;
+    dealValue: string;
+    dealSize: number;
+    stp: string;
+    stop: string;
+    stopPriceType: string;
+    stopTriggered: boolean;
+    stopPrice: string | null;
+    timeInForce: string;
+    postOnly: boolean;
+    hidden: boolean;
+    iceberg: boolean;
+    leverage: string;
+    forceHold: boolean;
+    closeOrder: boolean;
+    visibleSize: number | null;
+    clientOid: string;
+    remark: string | null;
+    tags: string | null;
+    isActive: boolean;
+    cancelExist: boolean;
+    createdAt: number;
+    updatedAt: number;
+    endAt: number;
+    orderTime: number;
+    settleCurrency: string;
+    status: string;
+    filledSize: number;
+    filledValue: string;
+    reduceOnly: boolean;
+}
+export interface SubmitMultipleOrdersFuturesResponse {
+    orderId: string;
+    clientOid: string;
+    symbol: string;
+    code: string;
+    msg: string;
+}
+export interface FuturesOrders {
+    currentPage: number;
+    pageSize: number;
+    totalNum: number;
+    totalPage: number;
+    items: FuturesOrder[];
+}
+/**
+ *
+ * Futures Fills
+ *
+ */
+export interface FuturesFill {
+    symbol: string;
+    tradeId: string;
+    orderId: string;
+    side: string;
+    liquidity: string;
+    forceTaker: boolean;
+    price: string;
+    size: number;
+    value: string;
+    feeRate: string;
+    fixFee: string;
+    feeCurrency: string;
+    stop: string;
+    fee: string;
+    orderType: string;
+    tradeType: string;
+    createdAt: number;
+    settleCurrency: string;
+    openFeePay: string;
+    closeFeePay: string;
+    tradeTime: number;
+}
+export interface FuturesFills {
+    currentPage: number;
+    pageSize: number;
+    totalNum: number;
+    totalPage: number;
+    items: FuturesFill[];
+}
+export interface FuturesActiveOrder {
+    openOrderBuySize: number;
+    openOrderSellSize: number;
+    openOrderBuyCost: string;
+    openOrderSellCost: string;
+    settleCurrency: string;
+}
+/**
+ *
+ * Futures Positions
+ *
+ */
+export interface MaxOpenSize {
+    symbol: string;
+    maxBuyOpenSize: number;
+    maxSellOpenSize: number;
+}
+export interface FuturesPosition {
+    id: string;
+    symbol: string;
+    autoDeposit: boolean;
+    maintMarginReq: number;
+    riskLimit: number;
+    realLeverage: number;
+    crossMode: boolean;
+    delevPercentage: number;
+    openingTimestamp: number;
+    currentTimestamp: number;
+    currentQty: number;
+    currentCost: number;
+    currentComm: number;
+    unrealisedCost: number;
+    realisedGrossCost: number;
+    realisedCost: number;
+    isOpen: boolean;
+    markPrice: number;
+    markValue: number;
+    posCost: number;
+    posCross: number;
+    posInit: number;
+    posComm: number;
+    posLoss: number;
+    posMargin: number;
+    posMaint: number;
+    maintMargin: number;
+    realisedGrossPnl: number;
+    realisedPnl: number;
+    unrealisedPnl: number;
+    unrealisedPnlPcnt: number;
+    unrealisedRoePcnt: number;
+    avgEntryPrice: number;
+    liquidationPrice: number;
+    bankruptPrice: number;
+    settleCurrency: string;
+    maintainMargin: number;
+    userId: number;
+    riskLimitLevel: number;
+}
+export interface AddMargin {
+    id: string;
+    symbol: string;
+    autoDeposit: boolean;
+    maintMarginReq: number;
+    riskLimit: number;
+    realLeverage: number;
+    crossMode: boolean;
+    delevPercentage: number;
+    openingTimestamp: number;
+    currentTimestamp: number;
+    currentQty: number;
+    currentCost: number;
+    currentComm: number;
+    unrealisedCost: number;
+    realisedGrossCost: number;
+    realisedCost: number;
+    isOpen: boolean;
+    markPrice: number;
+    markValue: number;
+    posCost: number;
+    posCross: number;
+    posInit: number;
+    posComm: number;
+    posLoss: number;
+    posMargin: number;
+    posMaint: number;
+    maintMargin: number;
+    realisedGrossPnl: number;
+    realisedPnl: number;
+    unrealisedPnl: number;
+    unrealisedPnlPcnt: number;
+    unrealisedRoePcnt: number;
+    avgEntryPrice: number;
+    liquidationPrice: number;
+    bankruptPrice: number;
+    settleCurrency: string;
+    userId: number;
+}
+/**
+ *
+ * Futures risk limit
+ *
+ */
+export interface FuturesRiskLimit {
+    symbol: string;
+    level: number;
+    maxRiskLimit: number;
+    minRiskLimit: number;
+    maxLeverage: number;
+    initialMargin: number;
+    maintainMargin: number;
+}
+/**
+ *
+ * Futures funding fees
+ *
+ */
+export interface FuturesCurrentFundingRate {
+    symbol: string;
+    granularity: number;
+    timePoint: number;
+    value: number;
+    predictedValue: number;
+}
+export interface FuturesHistoricFundingRate {
+    symbol: string;
+    timePoint: number;
+    fundingRate: number;
+}
+export interface FuturesAccountFundingRateHistory {
+    id: number;
+    symbol: string;
+    timePoint: number;
+    fundingRate: number;
+    markPrice: number;
+    positionQty: number;
+    positionCost: number;
+    funding: number;
+    settleCurrency: string;
+}
+export interface FuturesClosedPosition {
+    closeId: string;
+    positionId: string;
+    uid: number;
+    userId: string;
+    symbol: string;
+    settleCurrency: string;
+    leverage: string;
+    type: string;
+    side: string | null;
+    closeSize: number | null;
+    pnl: string;
+    realisedGrossCost: string;
+    withdrawPnl: string;
+    roe: number | null;
+    tradeFee: string;
+    fundingFee: string;
+    openTime: number;
+    closeTime: number;
+    openPrice: number | null;
+    closePrice: number | null;
+}
+export interface FuturesClosedPositions {
+    currentPage: number;
+    pageSize: number;
+    totalNum: number;
+    totalPage: number;
+    items: FuturesClosedPosition[];
+}
+export {};