@exchange-connect/coinex/build/stream/futures/kline.d.ts

Coinex ( https://www.coinex.com ) SDK

/**
 * klines' Realtime Data
 * @namespace Streams.futures.kline
 */
/**
 * Subscribe to Klines' Realtime Data
 * @async
 * @function subscribe
 * @memberof Streams.futures.kline
 * @param {String} market Market Name
 * @param {"1min"|"5min"|"15min"|"30min"|"1hour"|"2hour"|"4hour"|"6hour"|"12hour"|"1day"|"3day"|"1week"} period Period
 * @param {function} onData On Data Incomming Callback
 */
export declare function futuresKlineSubscribe(market: string, period: "1min" | "5min" | "15min" | "30min" | "1hour" | "2hour" | "4hour" | "6hour" | "12hour" | "1day" | "3day" | "1week", onData: () => any): void;
/**
 * Unsubscribe from Klines' Realtime Data
 * @async
 * @function unsubscribe
 * @memberof Streams.futures.kline
 */
export declare function futuresKlineUnsubscribe(): void;
/**
 * Query the Klines' Data on specific market
 * @async
 * @function query
 * @memberof Streams.futures.kline
 * @param {String} market Market name
 * @param {"1min"|"5min"|"15min"|"30min"|"1hour"|"2hour"|"4hour"|"6hour"|"12hour"|"1day"|"3day"|"1week"} period Period
 * @returns {Promise<Object>} Promise object represents the result of the request
 */
export declare function futuresKlineQuery(market: string, period: "1min" | "5min" | "15min" | "30min" | "1hour" | "2hour" | "4hour" | "6hour" | "12hour" | "1day" | "3day" | "1week"): Promise<any>;