@exchange-connect/coinex
Version:
Coinex ( https://www.coinex.com ) SDK
45 lines (44 loc) • 1.45 kB
TypeScript
/**
* Subscribe to Market Depth Realtime Data
* @async
* @function subscribe
* @memberof Streams.spot.depth
* @param {Array<Object>|Object} markets Market(s) Name ( Would subscribe on one or multi market(s) depending on the parameter)
* @param {function} onData On Data Incomming Callback
*/
export declare function depthSubscribe(markets: {
market: string;
limit: string;
interval: string;
diff: string;
}[] | {
market: string;
limit: string;
interval: string;
diff: string;
}, onData: () => any): Promise<any>;
/**
* Unsubscribe from Market Depth Realtime Data
* @async
* @function unsubscribe
* @memberof Streams.spot.depth
*/
export declare function depthUnsubscribe(): Promise<any>;
/**
* Unsubscribe from Multi-Market Depth Realtime Data
* @async
* @function unsubscribeMulti
* @memberof Streams.spot.depth
*/
export declare function depthUnsubscribeMulti(): Promise<any>;
/**
* Query the Market Depth' Data on specific market
* @async
* @function query
* @memberof Streams.spot.depth
* @param {String} market Market name
* @param {5|10|20|50|100} limit Number of records obtained
* @param {"0.1"|"0.01"|"0"|"1"|"10"} interval Market depth aggregation level
* @returns {Promise<Object>} Promise object represents the result of the request
*/
export declare function depthQuery(market: string, limit: 5 | 10 | 20 | 50 | 100, interval: "0.1" | "0.01" | "0" | "1" | "10"): Promise<any>;