@exchange-connect/coinex
Version:
Coinex ( https://www.coinex.com ) SDK
109 lines (108 loc) • 4.1 kB
TypeScript
/**
* Acquire All Market List
* @async
* @function acquireAllMarketList
* @returns {Promise<MarketListResults>} Promise object represents the result of the request
*/
export declare function acquireAllMarketList(): Promise<string[]>;
/**
* Acquire All Market Info
* @async
* @function acquireAllMarketInfo
* @returns {Promise<MarketInfoResults>} Promise object represents the result of the request
*/
export declare function acquireAllMarketInfo(): any;
/**
* Acquire Single Market Info
* @async
* @function acquireSingleMarketInfo
* @param {String} market Market Name
* @returns {Promise<MarketInfoResult>} Promise object represents the result of the request
*/
export declare function acquireSingleMarketInfo(market: string): any;
/**
* Acquire Market Depth
* @async
* @function acquireMarketDepth
* @param {String} market Market Name
* @param {'0'|'0.1'|'0.01'|'0.001'|'0.0001'|'0.00001'|'0.000001'|'0.0000001'|'0.00000001'} merge Depth Sequence Merge
* @param {Object} options Optional Parameters
* @param {5|10|20|50} [options.limit=20]
* @returns {Promise<MarketDepthResult>} Promise object represents the result of the request
*/
export declare function acquireMarketDepth(market: string, merge: string, { limit }?: {
limit: number;
}): any;
/**
* Acquire Latest Transaction Data
* @async
* @function acquireMarketDepth
* @description Get the latest transaction data of a single market, applicable to spot and margin markets
* @param {String} market Market Name
* @param {Object} [options={}] Optional Parameters
* @param {Number} [options.last_id=0] Transaction ID, 0 means get from the latest record
* @param {Number} [options.limit=1000] ( Max. 1000 )
* @returns {Promise<TransactionDataResults>} Promise object represents the result of the request
*/
export declare function acquireLatestTransactionData(market: string, { last_id, limit }?: {
last_id: number;
limit: number;
}): any;
/**
* Acquire K-Line Data
* @async
* @function acquireKlineData
* @description Get k-line data of a single market, applicable to spot and margin markets
* @param {String} market Market Name
* @param {"1min"|"3min"|"5min"|"15min"|"30min"|"1hour"|"4hour"|"6hour"|"1day"|"3day"|"1week"} type Timeframe
* @param {Object} [options={}] Optional Parameters
* @param {Number} [options.limit=1000] ( Max. 1000 )
* @returns {Promise<KlineDataResults>} Promise object represents the result of the request
*/
export declare function acquireKlineData(market: any, type: any, { limit }?: {
limit: number;
}): any;
/**
* Acquire Single Market Statistics
* @async
* @function acquireSingleMarketStatistics
* @param {String} market Market Name
* @returns {Promise<SingleMarketStatisticsResult>} Promise object represents the result of the request
*/
export declare function acquireSingleMarketStatistics(market: string): any;
/**
* Acquire All Market Statistics
* @async
* @function acquireAllMarketStatistics
* @returns {Promise<AllMarketStatisticsResults>} Promise object represents the result of the request
*/
export declare function acquireAllMarketStatistics(): any;
/**
* Acquire Currency Rate
* @async
* @function acquireCurrencyRate
* @returns {Promise<CurrencyRateResults>} Promise object represents the result of the request
*/
export declare function acquireCurrencyRate(): any;
/**
* Acquire Asset Allocation
* @async
* @function acquireAssetAllocation
* @param {String} coin_type Coin name
* @returns {Promise<AssetAllocationResults>} Promise object represents the result of the request
*/
export declare function acquireAssetAllocation(coin_type: string): any;
/**
* Acquire AMM Market List
* @async
* @function acquireAMMMarketList
* @returns {Promise<AMMMarketResults>} Promise object represents the result of the request
*/
export declare function acquireAMMMarketList(): any;
/**
* Acquire Margin Market List
* @async
* @function acquireMarginMarketList
* @returns {Promise<MarginMarketResults>} Promise object represents the result of the request
*/
export declare function acquireMarginMarketList(): any;