kucoin-universal-sdk
Version:
Official KuCoin Universal SDK.
307 lines (306 loc) • 15.7 kB
TypeScript
import { Transport } from '../../../internal/interfaces/transport';
import { GetPremiumIndexResp } from './model_get_premium_index_resp';
import { GetMarkPriceResp } from './model_get_mark_price_resp';
import { GetTradeHistoryResp } from './model_get_trade_history_resp';
import { GetServiceStatusResp } from './model_get_service_status_resp';
import { GetTickerReq } from './model_get_ticker_req';
import { GetInterestRateIndexReq } from './model_get_interest_rate_index_req';
import { GetSpotIndexPriceReq } from './model_get_spot_index_price_req';
import { GetMarkPriceReq } from './model_get_mark_price_req';
import { GetPrivateTokenResp } from './model_get_private_token_resp';
import { GetPartOrderBookReq } from './model_get_part_order_book_req';
import { GetPremiumIndexReq } from './model_get_premium_index_req';
import { GetSymbolReq } from './model_get_symbol_req';
import { GetSymbolResp } from './model_get_symbol_resp';
import { GetFullOrderBookResp } from './model_get_full_order_book_resp';
import { GetTickerResp } from './model_get_ticker_resp';
import { GetFullOrderBookReq } from './model_get_full_order_book_req';
import { GetAllSymbolsResp } from './model_get_all_symbols_resp';
import { GetPublicTokenResp } from './model_get_public_token_resp';
import { GetTradeHistoryReq } from './model_get_trade_history_req';
import { GetInterestRateIndexResp } from './model_get_interest_rate_index_resp';
import { Get24hrStatsResp } from './model_get24hr_stats_resp';
import { GetKlinesReq } from './model_get_klines_req';
import { GetPartOrderBookResp } from './model_get_part_order_book_resp';
import { GetAllTickersResp } from './model_get_all_tickers_resp';
import { GetServerTimeResp } from './model_get_server_time_resp';
import { GetSpotIndexPriceResp } from './model_get_spot_index_price_resp';
import { GetKlinesResp } from './model_get_klines_resp';
export interface MarketAPI {
/**
* getSymbol Get Symbol
* Description: 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.
* Documentation: https://www.kucoin.com/docs-new/api-3470221
* +-----------------------+---------+
* | Extra API Info | Value |
* +-----------------------+---------+
* | API-DOMAIN | FUTURES |
* | API-CHANNEL | PUBLIC |
* | API-PERMISSION | NULL |
* | API-RATE-LIMIT-POOL | PUBLIC |
* | API-RATE-LIMIT-WEIGHT | 3 |
* +-----------------------+---------+
*/
getSymbol(req: GetSymbolReq): Promise<GetSymbolResp>;
/**
* getAllSymbols Get All Symbols
* Description: Get detailed information of all 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.
* Documentation: https://www.kucoin.com/docs-new/api-3470220
* +-----------------------+---------+
* | Extra API Info | Value |
* +-----------------------+---------+
* | API-DOMAIN | FUTURES |
* | API-CHANNEL | PUBLIC |
* | API-PERMISSION | NULL |
* | API-RATE-LIMIT-POOL | PUBLIC |
* | API-RATE-LIMIT-WEIGHT | 3 |
* +-----------------------+---------+
*/
getAllSymbols(): Promise<GetAllSymbolsResp>;
/**
* getTicker Get Ticker
* Description: This endpoint returns \"last traded price/size\", \"best bid/ask price/size\" etc. of a single symbol. These messages can also be obtained through Websocket.
* Documentation: https://www.kucoin.com/docs-new/api-3470222
* +-----------------------+---------+
* | Extra API Info | Value |
* +-----------------------+---------+
* | API-DOMAIN | FUTURES |
* | API-CHANNEL | PUBLIC |
* | API-PERMISSION | NULL |
* | API-RATE-LIMIT-POOL | PUBLIC |
* | API-RATE-LIMIT-WEIGHT | 2 |
* +-----------------------+---------+
*/
getTicker(req: GetTickerReq): Promise<GetTickerResp>;
/**
* getAllTickers Get All Tickers
* Description: This endpoint returns \"last traded price/size\", \"best bid/ask price/size\" etc. of a single symbol. These messages can also be obtained through Websocket.
* Documentation: https://www.kucoin.com/docs-new/api-3470223
* +-----------------------+---------+
* | Extra API Info | Value |
* +-----------------------+---------+
* | API-DOMAIN | FUTURES |
* | API-CHANNEL | PUBLIC |
* | API-PERMISSION | NULL |
* | API-RATE-LIMIT-POOL | PUBLIC |
* | API-RATE-LIMIT-WEIGHT | 5 |
* +-----------------------+---------+
*/
getAllTickers(): Promise<GetAllTickersResp>;
/**
* getFullOrderBook Get Full OrderBook
* Description: Query for Full orderbook depth data (aggregated by price). It is generally used by professional traders because it uses more server resources and traffic, and we have strict access rate limit control. To maintain an up-to-date Order Book, please use Websocket incremental feed after retrieving the OrderBook.
* Documentation: https://www.kucoin.com/docs-new/api-3470224
* +-----------------------+---------+
* | Extra API Info | Value |
* +-----------------------+---------+
* | API-DOMAIN | FUTURES |
* | API-CHANNEL | PUBLIC |
* | API-PERMISSION | NULL |
* | API-RATE-LIMIT-POOL | PUBLIC |
* | API-RATE-LIMIT-WEIGHT | 3 |
* +-----------------------+---------+
*/
getFullOrderBook(req: GetFullOrderBookReq): Promise<GetFullOrderBookResp>;
/**
* getPartOrderBook Get Part OrderBook
* Description: Query for part orderbook depth data. (aggregated by price). It is recommended that you request via this endpoint, as the system response will be faster and consume less traffic.
* Documentation: https://www.kucoin.com/docs-new/api-3470225
* +-----------------------+---------+
* | Extra API Info | Value |
* +-----------------------+---------+
* | API-DOMAIN | FUTURES |
* | API-CHANNEL | PUBLIC |
* | API-PERMISSION | NULL |
* | API-RATE-LIMIT-POOL | PUBLIC |
* | API-RATE-LIMIT-WEIGHT | 5 |
* +-----------------------+---------+
*/
getPartOrderBook(req: GetPartOrderBookReq): Promise<GetPartOrderBookResp>;
/**
* getTradeHistory Get Trade History
* Description: Request the trade history of the specified symbol via this endpoint. The returned quantity is the last 100 transaction records.
* Documentation: https://www.kucoin.com/docs-new/api-3470232
* +-----------------------+---------+
* | Extra API Info | Value |
* +-----------------------+---------+
* | API-DOMAIN | FUTURES |
* | API-CHANNEL | PUBLIC |
* | API-PERMISSION | NULL |
* | API-RATE-LIMIT-POOL | PUBLIC |
* | API-RATE-LIMIT-WEIGHT | 5 |
* +-----------------------+---------+
*/
getTradeHistory(req: GetTradeHistoryReq): Promise<GetTradeHistoryResp>;
/**
* getKlines Get Klines
* Description: Get the symbol’s candlestick chart. Data are returned in grouped buckets based on requested type. For each query, the system will return at most 500 pieces of data. To obtain more data, please page the data by time.
* Documentation: https://www.kucoin.com/docs-new/api-3470234
* +-----------------------+---------+
* | Extra API Info | Value |
* +-----------------------+---------+
* | API-DOMAIN | FUTURES |
* | API-CHANNEL | PUBLIC |
* | API-PERMISSION | NULL |
* | API-RATE-LIMIT-POOL | PUBLIC |
* | API-RATE-LIMIT-WEIGHT | 3 |
* +-----------------------+---------+
*/
getKlines(req: GetKlinesReq): Promise<GetKlinesResp>;
/**
* getMarkPrice Get Mark Price
* Description: Get the current mark price (Update snapshots once per second, real-time query).
* Documentation: https://www.kucoin.com/docs-new/api-3470233
* +-----------------------+---------+
* | Extra API Info | Value |
* +-----------------------+---------+
* | API-DOMAIN | FUTURES |
* | API-CHANNEL | PUBLIC |
* | API-PERMISSION | NULL |
* | API-RATE-LIMIT-POOL | PUBLIC |
* | API-RATE-LIMIT-WEIGHT | 3 |
* +-----------------------+---------+
*/
getMarkPrice(req: GetMarkPriceReq): Promise<GetMarkPriceResp>;
/**
* getSpotIndexPrice Get Spot Index Price
* Description: Get Spot Index Price (Update snapshots once per second, and there is a 5s cache when querying).
* Documentation: https://www.kucoin.com/docs-new/api-3470231
* +-----------------------+---------+
* | Extra API Info | Value |
* +-----------------------+---------+
* | API-DOMAIN | FUTURES |
* | API-CHANNEL | PUBLIC |
* | API-PERMISSION | NULL |
* | API-RATE-LIMIT-POOL | PUBLIC |
* | API-RATE-LIMIT-WEIGHT | 2 |
* +-----------------------+---------+
*/
getSpotIndexPrice(req: GetSpotIndexPriceReq): Promise<GetSpotIndexPriceResp>;
/**
* getInterestRateIndex Get Interest Rate Index
* Description: Get interest rate Index (real-time query).
* Documentation: https://www.kucoin.com/docs-new/api-3470226
* +-----------------------+---------+
* | Extra API Info | Value |
* +-----------------------+---------+
* | API-DOMAIN | FUTURES |
* | API-CHANNEL | PUBLIC |
* | API-PERMISSION | NULL |
* | API-RATE-LIMIT-POOL | PUBLIC |
* | API-RATE-LIMIT-WEIGHT | 5 |
* +-----------------------+---------+
*/
getInterestRateIndex(req: GetInterestRateIndexReq): Promise<GetInterestRateIndexResp>;
/**
* getPremiumIndex Get Premium Index
* Description: Submit request to get premium index (Update snapshots once per second, real-time query).
* Documentation: https://www.kucoin.com/docs-new/api-3470227
* +-----------------------+---------+
* | Extra API Info | Value |
* +-----------------------+---------+
* | API-DOMAIN | FUTURES |
* | API-CHANNEL | PUBLIC |
* | API-PERMISSION | NULL |
* | API-RATE-LIMIT-POOL | PUBLIC |
* | API-RATE-LIMIT-WEIGHT | 3 |
* +-----------------------+---------+
*/
getPremiumIndex(req: GetPremiumIndexReq): Promise<GetPremiumIndexResp>;
/**
* get24hrStats Get 24hr stats
* Description: Get the statistics of the platform futures trading volume in the last 24 hours.
* Documentation: https://www.kucoin.com/docs-new/api-3470228
* +-----------------------+---------+
* | Extra API Info | Value |
* +-----------------------+---------+
* | API-DOMAIN | FUTURES |
* | API-CHANNEL | PUBLIC |
* | API-PERMISSION | NULL |
* | API-RATE-LIMIT-POOL | FUTURES |
* | API-RATE-LIMIT-WEIGHT | 3 |
* +-----------------------+---------+
*/
get24hrStats(): Promise<Get24hrStatsResp>;
/**
* getServerTime Get Server Time
* Description: Get the API server time. This is the Unix timestamp.
* Documentation: https://www.kucoin.com/docs-new/api-3470229
* +-----------------------+---------+
* | Extra API Info | Value |
* +-----------------------+---------+
* | API-DOMAIN | FUTURES |
* | API-CHANNEL | PUBLIC |
* | API-PERMISSION | NULL |
* | API-RATE-LIMIT-POOL | PUBLIC |
* | API-RATE-LIMIT-WEIGHT | 2 |
* +-----------------------+---------+
*/
getServerTime(): Promise<GetServerTimeResp>;
/**
* getServiceStatus Get Service Status
* Description: Get the service status.
* Documentation: https://www.kucoin.com/docs-new/api-3470230
* +-----------------------+---------+
* | Extra API Info | Value |
* +-----------------------+---------+
* | API-DOMAIN | FUTURES |
* | API-CHANNEL | PUBLIC |
* | API-PERMISSION | NULL |
* | API-RATE-LIMIT-POOL | PUBLIC |
* | API-RATE-LIMIT-WEIGHT | 4 |
* +-----------------------+---------+
*/
getServiceStatus(): Promise<GetServiceStatusResp>;
/**
* getPublicToken Get Public Token - Futures
* Description: This interface can obtain the token required for Websocket to establish a Futures connection. If you need use public channels (e.g. all public market data), please make request as follows to obtain the server list and public token
* Documentation: https://www.kucoin.com/docs-new/api-3470297
* +-----------------------+---------+
* | Extra API Info | Value |
* +-----------------------+---------+
* | API-DOMAIN | FUTURES |
* | API-CHANNEL | PUBLIC |
* | API-PERMISSION | NULL |
* | API-RATE-LIMIT-POOL | PUBLIC |
* | API-RATE-LIMIT-WEIGHT | 10 |
* +-----------------------+---------+
*/
getPublicToken(): Promise<GetPublicTokenResp>;
/**
* getPrivateToken Get Private Token - Futures
* Description: This interface can obtain the token required for Websocket to establish a Futures private connection. If you need use private channels (e.g. account balance notice), please make request as follows to obtain the server list and private token
* Documentation: https://www.kucoin.com/docs-new/api-3470296
* +-----------------------+---------+
* | Extra API Info | Value |
* +-----------------------+---------+
* | API-DOMAIN | FUTURES |
* | API-CHANNEL | PRIVATE |
* | API-PERMISSION | GENERAL |
* | API-RATE-LIMIT-POOL | FUTURES |
* | API-RATE-LIMIT-WEIGHT | 10 |
* +-----------------------+---------+
*/
getPrivateToken(): Promise<GetPrivateTokenResp>;
}
export declare class MarketAPIImpl implements MarketAPI {
private transport;
constructor(transport: Transport);
getSymbol(req: GetSymbolReq): Promise<GetSymbolResp>;
getAllSymbols(): Promise<GetAllSymbolsResp>;
getTicker(req: GetTickerReq): Promise<GetTickerResp>;
getAllTickers(): Promise<GetAllTickersResp>;
getFullOrderBook(req: GetFullOrderBookReq): Promise<GetFullOrderBookResp>;
getPartOrderBook(req: GetPartOrderBookReq): Promise<GetPartOrderBookResp>;
getTradeHistory(req: GetTradeHistoryReq): Promise<GetTradeHistoryResp>;
getKlines(req: GetKlinesReq): Promise<GetKlinesResp>;
getMarkPrice(req: GetMarkPriceReq): Promise<GetMarkPriceResp>;
getSpotIndexPrice(req: GetSpotIndexPriceReq): Promise<GetSpotIndexPriceResp>;
getInterestRateIndex(req: GetInterestRateIndexReq): Promise<GetInterestRateIndexResp>;
getPremiumIndex(req: GetPremiumIndexReq): Promise<GetPremiumIndexResp>;
get24hrStats(): Promise<Get24hrStatsResp>;
getServerTime(): Promise<GetServerTimeResp>;
getServiceStatus(): Promise<GetServiceStatusResp>;
getPublicToken(): Promise<GetPublicTokenResp>;
getPrivateToken(): Promise<GetPrivateTokenResp>;
}