UNPKG

kucoin-universal-sdk

Version:
113 lines (112 loc) 5.31 kB
import { Transport } from '../../../internal/interfaces/transport'; import { GetMarkPriceDetailReq } from './model_get_mark_price_detail_req'; import { GetCrossMarginSymbolsResp } from './model_get_cross_margin_symbols_resp'; import { GetMarkPriceListResp } from './model_get_mark_price_list_resp'; import { GetIsolatedMarginSymbolsResp } from './model_get_isolated_margin_symbols_resp'; import { GetCrossMarginSymbolsReq } from './model_get_cross_margin_symbols_req'; import { GetMarkPriceDetailResp } from './model_get_mark_price_detail_resp'; import { GetMarginConfigResp } from './model_get_margin_config_resp'; import { GetETFInfoResp } from './model_get_etf_info_resp'; import { GetETFInfoReq } from './model_get_etf_info_req'; export interface MarketAPI { /** * getCrossMarginSymbols Get Symbols - Cross Margin * Description: This endpoint allows querying the configuration of cross margin symbol. * Documentation: https://www.kucoin.com/docs-new/api-3470189 * +-----------------------+--------+ * | Extra API Info | Value | * +-----------------------+--------+ * | API-DOMAIN | SPOT | * | API-CHANNEL | PUBLIC | * | API-PERMISSION | NULL | * | API-RATE-LIMIT-POOL | PUBLIC | * | API-RATE-LIMIT-WEIGHT | 3 | * +-----------------------+--------+ */ getCrossMarginSymbols(req: GetCrossMarginSymbolsReq): Promise<GetCrossMarginSymbolsResp>; /** * getETFInfo Get ETF Info * Description: This interface returns leveraged token information. * Documentation: https://www.kucoin.com/docs-new/api-3470191 * +-----------------------+--------+ * | Extra API Info | Value | * +-----------------------+--------+ * | API-DOMAIN | SPOT | * | API-CHANNEL | PUBLIC | * | API-PERMISSION | NULL | * | API-RATE-LIMIT-POOL | PUBLIC | * | API-RATE-LIMIT-WEIGHT | 3 | * +-----------------------+--------+ */ getETFInfo(req: GetETFInfoReq): Promise<GetETFInfoResp>; /** * getMarkPriceDetail Get Mark Price Detail * Description: This endpoint returns the current Mark price for specified margin trading pairs. * Documentation: https://www.kucoin.com/docs-new/api-3470193 * +-----------------------+--------+ * | Extra API Info | Value | * +-----------------------+--------+ * | API-DOMAIN | SPOT | * | API-CHANNEL | PUBLIC | * | API-PERMISSION | NULL | * | API-RATE-LIMIT-POOL | PUBLIC | * | API-RATE-LIMIT-WEIGHT | 2 | * +-----------------------+--------+ */ getMarkPriceDetail(req: GetMarkPriceDetailReq): Promise<GetMarkPriceDetailResp>; /** * getMarginConfig Get Margin Config * Description: Request the configure info of the cross margin via this endpoint. * Documentation: https://www.kucoin.com/docs-new/api-3470190 * +-----------------------+--------+ * | Extra API Info | Value | * +-----------------------+--------+ * | API-DOMAIN | SPOT | * | API-CHANNEL | PUBLIC | * | API-PERMISSION | NULL | * | API-RATE-LIMIT-POOL | SPOT | * | API-RATE-LIMIT-WEIGHT | 25 | * +-----------------------+--------+ */ getMarginConfig(): Promise<GetMarginConfigResp>; /** * getMarkPriceList Get Mark Price List * Description: This endpoint returns the current Mark price for all margin trading pairs. * Documentation: https://www.kucoin.com/docs-new/api-3470192 * +-----------------------+--------+ * | Extra API Info | Value | * +-----------------------+--------+ * | API-DOMAIN | SPOT | * | API-CHANNEL | PUBLIC | * | API-PERMISSION | NULL | * | API-RATE-LIMIT-POOL | PUBLIC | * | API-RATE-LIMIT-WEIGHT | 10 | * +-----------------------+--------+ */ getMarkPriceList(): Promise<GetMarkPriceListResp>; /** * getIsolatedMarginSymbols Get Symbols - Isolated Margin * Description: This endpoint allows querying the configuration of isolated margin symbol. * Documentation: https://www.kucoin.com/docs-new/api-3470194 * +-----------------------+--------+ * | Extra API Info | Value | * +-----------------------+--------+ * | API-DOMAIN | SPOT | * | API-CHANNEL | PUBLIC | * | API-PERMISSION | NULL | * | API-RATE-LIMIT-POOL | PUBLIC | * | API-RATE-LIMIT-WEIGHT | 3 | * +-----------------------+--------+ */ getIsolatedMarginSymbols(): Promise<GetIsolatedMarginSymbolsResp>; } export declare class MarketAPIImpl implements MarketAPI { private transport; constructor(transport: Transport); getCrossMarginSymbols(req: GetCrossMarginSymbolsReq): Promise<GetCrossMarginSymbolsResp>; getETFInfo(req: GetETFInfoReq): Promise<GetETFInfoResp>; getMarkPriceDetail(req: GetMarkPriceDetailReq): Promise<GetMarkPriceDetailResp>; getMarginConfig(): Promise<GetMarginConfigResp>; getMarkPriceList(): Promise<GetMarkPriceListResp>; getIsolatedMarginSymbols(): Promise<GetIsolatedMarginSymbolsResp>; }