kucoin-api
Version:
Complete & robust Node.js SDK for Kucoin's REST APIs and WebSockets, with TypeScript & strong end to end tests.
78 lines (77 loc) • 3.87 kB
TypeScript
import { AxiosRequestConfig } from 'axios';
import { BaseRestClient } from './lib/BaseRestClient.js';
import { RestClientOptions, RestClientType } from './lib/requestUtils.js';
import { GetAnnouncementsRequestUTA, GetCurrencyRequestUTA, GetCurrentFundingRateRequestUTA, GetHistoryFundingRateRequestUTA, GetKlinesRequestUTA, GetOrderBookRequestUTA, GetServiceStatusRequestUTA, GetSymbolRequestUTA, GetTickerRequestUTA, GetTradesRequestUTA } from './types/request/uta-types.js';
import { APISuccessResponse } from './types/response/shared.types.js';
import { GetAnnouncementsResponseUTA, GetCrossMarginConfigResponseUTA, GetCurrencyResponseUTA, GetCurrentFundingRateResponseUTA, GetHistoryFundingRateResponseUTA, GetKlinesResponseUTA, GetOrderBookResponseUTA, GetServiceStatusResponseUTA, GetSymbolResponseUTA, GetTickerResponseUTA, GetTradesResponseUTA } from './types/response/uta-types.js';
/**
* Unified Trading Account Client
*
* This client provides access to the Unified Trading Account API endpoints
* that unify market data access across Spot, Futures, and Margin trading.
*/
export declare class UnifiedAPIClient extends BaseRestClient {
constructor(restClientOptions?: RestClientOptions, requestOptions?: AxiosRequestConfig);
getClientType(): RestClientType;
/**
*
* REST - Unified Trading Account - Market Data
*
*/
/**
* Get Announcements
* This interface can obtain the latest news announcements, and the default
* page search is for announcements within a month.
*/
getAnnouncements(params?: GetAnnouncementsRequestUTA): Promise<APISuccessResponse<GetAnnouncementsResponseUTA>>;
/**
* Get Currency
* Request the currency details of a specified currency via this endpoint.
*/
getCurrency(params?: GetCurrencyRequestUTA): Promise<APISuccessResponse<GetCurrencyResponseUTA>>;
/**
* Get Symbol
* Request a list of available currency pairs for trading via this endpoint.
*/
getSymbols(params: GetSymbolRequestUTA): Promise<APISuccessResponse<GetSymbolResponseUTA>>;
/**
* Get Ticker
* Request market tickers for the trading pairs in the market (including 24h volume).
*/
getTickers(params: GetTickerRequestUTA): Promise<APISuccessResponse<GetTickerResponseUTA>>;
/**
* Get Trades
* Request via this endpoint to get the latest 100 public trades of the specified symbol.
*/
getTrades(params: GetTradesRequestUTA): Promise<APISuccessResponse<GetTradesResponseUTA>>;
/**
* Get OrderBook
* Query order book depth information (aggregated by price).
*/
getOrderBook(params: GetOrderBookRequestUTA): Promise<APISuccessResponse<GetOrderBookResponseUTA>>;
/**
* Get Klines
* Get the Kline of the symbol. Data are returned in grouped buckets based on requested type.
*/
getKlines(params: GetKlinesRequestUTA): Promise<APISuccessResponse<GetKlinesResponseUTA>>;
/**
* Get Current Funding Rate
* Get current Futures funding fee rate.
*/
getCurrentFundingRate(params: GetCurrentFundingRateRequestUTA): Promise<APISuccessResponse<GetCurrentFundingRateResponseUTA>>;
/**
* Get History Funding Rate
* Query the Futures funding rate at each settlement time point within a certain time range.
*/
getHistoryFundingRate(params: GetHistoryFundingRateRequestUTA): Promise<APISuccessResponse<GetHistoryFundingRateResponseUTA>>;
/**
* Get Cross Margin Config
* Request the configure info of the 'spot cross margin' via this endpoint.
*/
getCrossMarginConfig(): Promise<APISuccessResponse<GetCrossMarginConfigResponseUTA>>;
/**
* Get Service Status
* Get the service status.
*/
getServiceStatus(params: GetServiceStatusRequestUTA): Promise<APISuccessResponse<GetServiceStatusResponseUTA>>;
}