kucoin-api/dist/cjs/FuturesClient.d.ts

Complete & robust Node.js SDK for Kucoin's REST APIs and WebSockets, with TypeScript & strong end to end tests.

import { AxiosRequestConfig } from 'axios';
import { BaseRestClient } from './lib/BaseRestClient.js';
import { RestClientOptions, RestClientType } from './lib/requestUtils.js';
import { AccountFillsRequest, BatchCancelOrdersRequest, CopyTradeOrderRequest, CopyTradeSLTPOrderRequest, GetFundingHistoryRequest, GetFundingRatesRequest, GetInterestRatesRequest, GetKlinesRequest, GetOrdersRequest, GetStopOrdersRequest, GetTransactionsRequest, MaxOpenSizeRequest, Order, SLTPOrder } from './types/request/futures.types.js';
import { AccountBalance, AccountSummary, AddMargin, BatchCancelOrderResult, BatchMarginModeUpdateResponse, CopyTradePosition, CrossMarginRiskLimit, FullOrderBookDetail, FuturesAccountFundingRateHistory, FuturesAccountTransaction, FuturesActiveOrder, FuturesClosedPositions, FuturesCurrentFundingRate, FuturesFill, FuturesFills, FuturesHistoricFundingRate, FuturesKline, FuturesMarkPrice, FuturesOrder, FuturesOrders, FuturesPosition, FuturesRiskLimit, FuturesSubAccount, FuturesSymbolInfo, IndexListItem, InterestRateItem, MarketTradeDetail, MaxOpenSize, PremiumIndexItem, SubmitMultipleOrdersFuturesResponse, TickerDetail } from './types/response/futures.types.js';
import { APISuccessResponse, ServiceStatus } from './types/response/shared.types.js';
import { WsConnectionInfo } from './types/response/ws.js';
/**
 *
 */
export declare class FuturesClient extends BaseRestClient {
    constructor(restClientOptions?: RestClientOptions, requestOptions?: AxiosRequestConfig);
    getClientType(): RestClientType;
    /**
     *
     * Misc Utility Methods
     *
     */
    generateNewOrderID(): string;
    /**
     *
     * REST - ACCOUNT INFO - Account & Funding
     *
     */
    /**
     * Get Account - Futures
     * Request via this endpoint to get the info of the futures account.
     */
    getBalance(params?: {
        currency?: string;
    }): Promise<APISuccessResponse<AccountBalance>>;
    /**
     * Get Account Ledgers - Futures
     * This endpoint can query the ledger records of the futures business line
     */
    getTransactions(params: GetTransactionsRequest): Promise<APISuccessResponse<{
        hasMore: boolean;
        dataList: FuturesAccountTransaction[];
    }>>;
    /**
     *
     * REST - ACCOUNT INFO - Sub Account
     *
     */
    /**
     * Get SubAccount List - Futures Balance(V2)
     * This endpoint can be used to get Futures sub-account information.
     */
    getSubBalances(params?: {
        currency?: string;
    }): Promise<APISuccessResponse<{
        summary: AccountSummary;
        accounts: FuturesSubAccount[];
    }>>;
    /**
     *
     * REST - Account Info - Trade Fee
     *
     */
    /**
     * Get Actual Fee - Futures
     * This endpoint is for the actual futures fee rate of the trading pair. The fee rate of your sub-account is the same as that of the master account.
     */
    getTradingPairFee(params: {
        symbol: string;
    }): Promise<APISuccessResponse<{
        symbol: string;
        takerFeeRate: string;
        makerFeeRate: string;
    }>>;
    /**
     *
     * REST - Futures Trading - Market Data
     *
     */
    /**
     * Get Symbol
     * Get information of specified contracts that can be traded.
     * This API will return a list of tradable contracts, including some key parameters of the contract such as the symbol name, tick size, mark price,etc.
     */
    getSymbol(params: {
        symbol: string;
    }): Promise<APISuccessResponse<FuturesSymbolInfo>>;
    /**
     * Get Symbol
     * Get information of specified contracts that can be traded.
     * This API will return a list of tradable contracts, including some key parameters of the contract such as the symbol name, tick size, mark price,etc.
     */
    getSymbols(): Promise<APISuccessResponse<FuturesSymbolInfo[]>>;
    /**
     * Get Ticker
     * This endpoint returns "last traded price/size"、"best bid/ask price/size" etc. of a single symbol.
     */
    getTicker(params: {
        symbol: string;
    }): Promise<APISuccessResponse<TickerDetail>>;
    /**
     * Get All Tickers
     * This endpoint returns "last traded price/size"、"best bid/ask price/size" etc. of all symbol.
     */
    getTickers(): Promise<APISuccessResponse<TickerDetail[]>>;
    /**
     * Get Full OrderBook
     * Query for Full orderbook depth data. (aggregated by price)
     */
    getFullOrderBookLevel2(params: {
        symbol: string;
    }): Promise<APISuccessResponse<FullOrderBookDetail>>;
    /**
     * Get Part OrderBook
     * Query for part orderbook depth data. (aggregated by price)
     */
    getPartOrderBookLevel2Depth20(params: {
        symbol: string;
    }): Promise<APISuccessResponse<FullOrderBookDetail>>;
    /**
     * Get Part OrderBook
     * Query for part orderbook depth data. (aggregated by price)
     */
    getPartOrderBookLevel2Depth100(params: {
        symbol: string;
    }): Promise<APISuccessResponse<FullOrderBookDetail>>;
    /**
     * Get Trade History
     * Request via this endpoint to get the trade history of the specified symbol, the returned quantity is the last 100 transaction records.
     */
    getMarketTrades(params: {
        symbol: string;
    }): Promise<APISuccessResponse<MarketTradeDetail>>;
    /**
     * Get Klines
     * Get the Kline of the symbol. Data are returned in grouped buckets based on requested type.
     */
    getKlines(params: GetKlinesRequest): Promise<APISuccessResponse<FuturesKline[]>>;
    /**
     * Get Mark Price
     * Get the mark price of the symbol.
     */
    getMarkPrice(params: {
        symbol: string;
    }): Promise<APISuccessResponse<FuturesMarkPrice>>;
    /**
     * Get Spot Index Price
     * This endpoint returns the index price of the specified symbol.
     */
    getIndex(params: GetInterestRatesRequest): Promise<APISuccessResponse<{
        dataList: IndexListItem[];
        hasMore: boolean;
    }>>;
    /**
     * Get Interest Rate Index
     * This endpoint returns the interest rate index of the specified symbol.
     */
    getInterestRates(params: GetInterestRatesRequest): Promise<APISuccessResponse<{
        dataList: InterestRateItem[];
        hasMore: boolean;
    }>>;
    /**
     * Get Premium Index
     * This endpoint returns the premium index of the specified symbol.
     */
    getPremiumIndex(params: GetInterestRatesRequest): Promise<APISuccessResponse<{
        dataList: PremiumIndexItem[];
        hasMore: boolean;
    }>>;
    /**
     * Get 24hr Stats
     * Get the statistics of the platform futures trading volume in the last 24 hours.
     */
    get24HourTransactionVolume(): Promise<APISuccessResponse<{
        turnoverOf24h: number;
    }>>;
    /**
     * Get Server Time
     * Get the API server time. This is the Unix timestamp.
     */
    getServerTime(): Promise<APISuccessResponse<number>>;
    /**
     * Get Service Status
     * This endpoint returns the status of the API service.
     */
    getServiceStatus(): Promise<APISuccessResponse<ServiceStatus>>;
    /**
     *
     * REST - Futures Trading - Orders
     *
     */
    /**
     * Add Order
     * Place order to the futures trading system
     */
    submitOrder(params: Order): Promise<APISuccessResponse<{
        orderId?: string;
        clientOid?: string;
    }>>;
    /**
     * Add Order Test
     * Order test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint, and can be used to verify whether the signature is correct and other operations.
     */
    submitNewOrderTest(params: Order): Promise<{
        orderId?: string;
        clientOid?: string;
    }>;
    /**
     * Batch Add Orders
     * Place multiple order to the futures trading system
     */
    submitMultipleOrders(params: Order[]): Promise<APISuccessResponse<SubmitMultipleOrdersFuturesResponse[]>>;
    /**
     * Add Take Profit And Stop Loss Order
     * Place take profit and stop loss order supports both take-profit and stop-loss functions, and other functions are exactly the same as the place order endpoint.
     */
    submitSLTPOrder(params: SLTPOrder): Promise<APISuccessResponse<{
        orderId?: string;
        clientOid?: string;
    }>>;
    /**
     * Cancel Order By OrderId
     * Cancel an order (including a stop order).
     */
    cancelOrderById(params: {
        orderId: string;
    }): Promise<APISuccessResponse<{
        cancelledOrderIds: string[];
    }>>;
    /**
     * Cancel Order By Client Order Id
     * Cancel an order (including a stop order) by client order id.
     */
    cancelOrderByClientOid(params: {
        clientOid: string;
        symbol: string;
    }): Promise<APISuccessResponse<{
        clientOid: string;
    }>>;
    /**
     * Batch Cancel Orders
     * Cancel multiple orders.
     */
    batchCancelOrders(params: BatchCancelOrdersRequest): Promise<APISuccessResponse<BatchCancelOrderResult[]>>;
    /**
     * Cancel All Orders
     * Using this endpoint, all open orders (excluding stop orders) can be canceled in batches.
     */
    cancelAllOrdersV3(params: {
        symbol: string;
    }): Promise<APISuccessResponse<{
        cancelledOrderIds: string[];
    }>>;
    /**
     * Cancel All Stop orders
     * Using this endpoint, all untriggered stop orders can be canceled in batches.
     */
    cancelAllStopOrders(params?: {
        symbol?: string;
    }): Promise<APISuccessResponse<{
        cancelledOrderIds: string[];
    }>>;
    /**
     * Get Order By OrderId
     * Get order details by order id.
     */
    getOrderByOrderId(params: {
        orderId: string;
    }): Promise<APISuccessResponse<FuturesOrder>>;
    /**
     * Get Order By Client Order Id
     * Get order details by client order id.
     */
    getOrderByClientOrderId(params: {
        clientOid: string;
    }): Promise<APISuccessResponse<FuturesOrder>>;
    /**
     * Get Order List
     * List your current orders. Any limit order on the exchange order book is in active status.
     */
    getOrders(params?: GetOrdersRequest): Promise<APISuccessResponse<FuturesOrders>>;
    /**
     * Get Recent Closed Orders
     * Get a list of recent 1000 closed orders in the last 24 hours.
     */
    getRecentOrders(params?: {
        symbol?: string;
    }): Promise<APISuccessResponse<FuturesOrder[]>>;
    /**
     * Get Stop Order List
     * Get the un-triggered stop orders list. Stop orders that have been triggered can be queried through the general order endpoint
     */
    getStopOrders(params?: GetStopOrdersRequest): Promise<APISuccessResponse<FuturesOrders>>;
    /**
     * Get Open Order Value
     * You can query this endpoint to get the the total number and value of the all your active orders.
     */
    getOpenOrderStatistics(params: {
        symbol: string;
    }): Promise<APISuccessResponse<FuturesActiveOrder>>;
    /**
     * Get Recent Trade History
     * Get a list of recent 1000 fills in the last 24 hours.
     */
    getRecentFills(params?: {
        symbol?: string;
    }): Promise<APISuccessResponse<FuturesFill[]>>;
    /**
     * Get Trade History
     * Get a list of recent fills.
     * If you need to get your recent trade history with low latency, please query endpoint Get List of Orders Completed in 24h. The requested data is not real-time.
     */
    getFills(params?: AccountFillsRequest): Promise<APISuccessResponse<FuturesFills>>;
    /**
     *
     * REST - Futures Trading - Positions
     *
     */
    /**
     * Get Margin Mode
     * This endpoint can query the margin mode of the current symbol.
     */
    getMarginMode(params: {
        symbol: string;
    }): Promise<APISuccessResponse<{
        symbol: string;
        marginMode: 'ISOLATED' | 'CROSS';
    }>>;
    /**
     * Switch Margin Mode
     * Modify the margin mode of the current symbol.
     */
    updateMarginMode(params: {
        symbol: string;
        marginMode: 'ISOLATED' | 'CROSS';
    }): Promise<APISuccessResponse<{
        symbol: string;
        marginMode: 'ISOLATED' | 'CROSS';
    }>>;
    /**
     * Batch Switch Margin Mode
     * Batch modify the margin mode of the symbols.
     */
    batchSwitchMarginMode(params: {
        marginMode: 'ISOLATED' | 'CROSS';
        symbols: string[];
    }): Promise<APISuccessResponse<BatchMarginModeUpdateResponse>>;
    /**
     * Get Max Open Size
     * Get Maximum Open Position Size.
     */
    getMaxOpenSize(params: MaxOpenSizeRequest): Promise<APISuccessResponse<MaxOpenSize>>;
    /**
     * Get Position Details
     * Get the position details of a specified position.
     */
    getPosition(params: {
        symbol: string;
    }): Promise<APISuccessResponse<FuturesPosition>>;
    /**
     * Get Position List
     * Get the position details of a specified position.
     */
    getPositions(params?: {
        currency?: string;
    }): Promise<APISuccessResponse<FuturesPosition[]>>;
    /**
     * Get Positions History
     * This endpoint can query position history information records.
     */
    getHistoryPositions(params?: {
        symbol?: string;
        from?: number;
        to?: number;
        limit?: number;
        pageId?: number;
    }): Promise<APISuccessResponse<FuturesClosedPositions>>;
    /**
     * Get Max Withdraw Margin
     * This endpoint can query the maximum amount of margin that the current position supports withdrawal.
     */
    getMaxWithdrawMargin(params: {
        symbol: string;
    }): Promise<APISuccessResponse<string>>;
    /**
     * Get Cross Margin Leverage
     * This endpoint can query the current symbol's cross-margin leverage multiple.
     */
    getCrossMarginLeverage(params: {
        symbol: string;
    }): Promise<APISuccessResponse<{
        symbol: string;
        leverage: string;
    }>>;
    /**
     * Modify Cross Margin Leverage
     * This endpoint can modify the current symbol's cross-margin leverage multiple.
     */
    changeCrossMarginLeverage(params: {
        symbol: string;
        leverage: string;
    }): Promise<APISuccessResponse<{
        symbol: string;
        leverage: string;
    }>>;
    /**
     * Add Isolated Margin
     * Add Isolated Margin Manually.
     */
    depositMargin(params: {
        symbol: string;
        margin: number;
        bizNo: string;
    }): Promise<APISuccessResponse<AddMargin>>;
    /**
     * Get Cross Margin Risk Limit
     * Batch get cross margin risk limit. (It should be noted that the risk limit of cross margin does not have a fixed gear, but is a smooth curve)
     */
    getCrossMarginRiskLimit(params: {
        symbol: string;
        totalMargin?: string;
        leverage?: number;
    }): Promise<APISuccessResponse<CrossMarginRiskLimit[]>>;
    /**
     * Remove Isolated Margin
     * Remove Isolated Margin Manually.
     */
    withdrawMargin(params: {
        symbol: string;
        withdrawAmount: string;
    }): Promise<APISuccessResponse<string>>;
    /**
     * Get Isolated Margin Risk Limit
     * This endpoint can be used to obtain information about risk limit level of a specific contract(Only valid for isolated Margin).
     */
    getRiskLimitLevel(params: {
        symbol: string;
    }): Promise<APISuccessResponse<FuturesRiskLimit[]>>;
    /**
     * Modify Isolated Margin Risk Limit
     * This endpoint is for the adjustment of the risk limit level(Only valid for isolated Margin).
     */
    updateRiskLimitLevel(params: {
        symbol: string;
        level: number;
    }): Promise<boolean>;
    /**
     *
     * REST - Futures Trading - Funding Fees
     *
     */
    /**
     * Get Current Funding Rate
     * This endpoint can be used to obtain the current funding rate of the specified symbol.
     */
    getFundingRate(params: {
        symbol: string;
    }): Promise<APISuccessResponse<FuturesCurrentFundingRate>>;
    /**
     * Get Public Funding History
     * Query the funding rate at each settlement time point within a certain time range of the corresponding contract
     */
    getFundingRates(params: GetFundingRatesRequest): Promise<APISuccessResponse<FuturesHistoricFundingRate[]>>;
    /**
     * Get Private Funding History
     * Submit request to get the funding history.
     */
    getFundingHistory(params: GetFundingHistoryRequest): Promise<APISuccessResponse<{
        dataList: FuturesAccountFundingRateHistory[];
        hasMore: boolean;
    }>>;
    /**
     *
     * REST - Futures Trading - CopyTrading
     *
     */
    /**
     * Add Order
     * Place order to the futures trading system for copy trading
     */
    submitCopyTradeOrder(params: CopyTradeOrderRequest): Promise<APISuccessResponse<{
        orderId: string;
        clientOid: string;
    }>>;
    /**
     * Add Order Test
     * Order test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint,
     * and can be used to verify whether the signature is correct and other operations.
     */
    submitCopyTradeOrderTest(params: CopyTradeOrderRequest): Promise<APISuccessResponse<{
        orderId: string;
        clientOid: string;
    }>>;
    /**
     * Add Take Profit And Stop Loss Order
     * Place take profit and stop loss order supports both take-profit and stop-loss functions, and other functions are exactly the same as the place order endpoint.
     */
    submitCopyTradeSLTPOrder(params: CopyTradeSLTPOrderRequest): Promise<APISuccessResponse<{
        orderId: string;
        clientOid: string;
    }>>;
    /**
     * Cancel Order By OrderId
     * Cancel an order (including a stop order) in copy trading.
     */
    cancelCopyTradeOrderById(params: {
        orderId: string;
    }): Promise<APISuccessResponse<{
        cancelledOrderIds: string[];
    }>>;
    /**
     * Cancel Order By Client Order Id
     * Cancel an order (including a stop order) in copy trading by client order id.
     */
    cancelCopyTradeOrderByClientOid(params: {
        clientOid?: string;
        symbol: string;
    }): Promise<APISuccessResponse<{
        clientOid: string;
    }>>;
    /**
     * Get Max Open Size
     * Get Maximum Open Position Size.
     */
    getCopyTradeMaxOpenSize(params: {
        symbol: string;
        maxBuyOpenSize: string;
        maxSellOpenSize: string;
    }): Promise<APISuccessResponse<{
        symbol: string;
        price: string;
        leverage: number;
    }>>;
    /**
     * Get Max Withdraw Margin
     * This endpoint can query the maximum amount of margin that the current position supports withdrawal.
     */
    getCopyTradeMaxWithdrawMargin(params: {
        symbol: string;
    }): Promise<APISuccessResponse<string>>;
    /**
     * Add Isolated Margin
     * Add Isolated Margin Manually.
     */
    addCopyTradeIsolatedMargin(params: {
        symbol: string;
        margin: number;
        bizNo: string;
    }): Promise<APISuccessResponse<CopyTradePosition>>;
    /**
     * Remove Isolated Margin
     * Remove Isolated Margin Manually.
     */
    removeCopyTradeIsolatedMargin(params: {
        symbol: string;
        withdrawAmount: string;
    }): Promise<APISuccessResponse<string>>;
    /**
     * Modify Isolated Margin Risk Limit
     * This endpoint is for the adjustment of the risk limit level(Only valid for isolated Margin).
     * To adjust the level will cancel the open order, the response can only indicate whether the submit of the adjustment request is successful or not.
     */
    modifyCopyTradeRiskLimitLevel(params: {
        symbol: string;
        level: number;
    }): Promise<APISuccessResponse<boolean>>;
    /**
     * Modify Isolated Margin Auto-Deposit Status
     * This endpoint is only applicable to isolated margin and is no longer recommended. It is recommended to use cross margin instead.
     * @deprecated - It is recommended to use cross margin instead
     */
    updateCopyTradeAutoDepositStatus(params: {
        symbol: string;
        status: boolean;
    }): Promise<APISuccessResponse<boolean>>;
    /**
     *
     * REST - Futures - Broker
     *
     */
    /**
     * Get download link for broker rebate orders
     *
     * trade type 1 = spot, trade type 2 = futures
     */
    getBrokerRebateOrderDownloadLink(params: {
        begin: string;
        end: string;
        tradeType: 1 | 2;
    }): Promise<APISuccessResponse<any>>;
    /**
     *
     * WebSockets
     *
     */
    getPublicWSConnectionToken(): Promise<APISuccessResponse<WsConnectionInfo>>;
    getPrivateWSConnectionToken(): Promise<APISuccessResponse<WsConnectionInfo>>;
    /**
     * @deprecated - please use universal transfer from SpotClient
     */
    submitTransferOut(params: {
        currency: string;
        amount: number;
        recAccountType: 'MAIN' | 'TRADE';
    }): Promise<APISuccessResponse<any>>;
    /**
     * @deprecated - please use universal transfer from SpotClient
     */
    submitTransferIn(params: {
        currency: string;
        amount: number;
        payAccountType: 'MAIN' | 'TRADE';
    }): Promise<APISuccessResponse<any>>;
    /**
     * @deprecated - please use universal transfer from SpotClient
     */
    getTransfers(params?: {
        currency?: string;
        type?: 'MAIN' | 'TRADE' | 'MARGIN' | 'ISOLATED';
        tag?: string[];
        startAt?: number;
        endAt?: number;
        currentPage?: number;
        pageSize?: number;
    }): Promise<APISuccessResponse<any>>;
    /**
     * @deprecated - please use updateMarginMode() instead
     */
    updateAutoDepositStatus(params: {
        symbol: string;
        status: boolean;
    }): Promise<APISuccessResponse<any>>;
}