@exchange-connect/coinex
Version:
Coinex ( https://www.coinex.com ) SDK
71 lines (70 loc) • 2.86 kB
TypeScript
/**
* Orders' Realtime Data
* @namespace Streams.spot.order
*/
/**
* Subscribe to Orders Realtime Data on Specific Market
* @async
* @function subscribe
* @memberof Streams.spot.order
* @param {Array<String>} markets Markets' Name
* @param {function} onData On Data Incomming Callback
*/
export declare function orderSubscribe(markets: string[], onData: () => any): void;
/**
* Unsubscribe from Orders Realtime Data
* @async
* @function unsubscribe
* @memberof Streams.spot.order
*/
export declare function orderUnsubscribe(): void;
/**
* Query the Orders' Data on specific market
* @async
* @function query
* @memberof Streams.spot.order
* @param {String} market Market Name
* @param {0|1|2} side Transaction Direction (0: all, 1: sell, 2: buy)
* @param {Number} offset That is, from which one to get
* @param {Number} limit The number of records obtained
* @returns {Promise<Object>} Promise object represents the result of the request
*/
export declare function orderQuery(market: string, side: 0 | 1 | 2, offset: number, limit: number): Promise<any>;
/**
* Query the stop Orders' Data on specific market
* @async
* @function queryStop
* @memberof Streams.spot.order
* @param {String} market Market Name
* @param {0|1|2} side Transaction Direction (0: all, 1: sell, 2: buy)
* @param {Number} offset that is, from which one to get
* @param {Number} limit The number of records obtained
* @returns {Promise<Object>} Promise object represents the result of the request
*/
export declare function orderQueryStop(market: string, side: 0 | 1 | 2, offset: number, limit: number): Promise<any>;
/**
* Query the Orders' Data on specific market and account
* @async
* @function queryAccount
* @memberof Streams.spot.order
* @param {Number} account Account ID
* @param {String} market Market Name
* @param {0|1|2} side Transaction Direction (0: all, 1: sell, 2: buy)
* @param {Number} offset that is, from which one to get
* @param {Number} limit The number of records obtained
* @returns {Promise<Object>} Promise object represents the result of the request
*/
export declare function orderQueryAccount(account: number, market: string, side: 0 | 1 | 2, offset: number, limit: number): Promise<any>;
/**
* Query the stop Orders' Data on specific market and account
* @async
* @function queryAccountStop
* @memberof Streams.spot.order
* @param {Number} account Account ID
* @param {String} market Market Name
* @param {0|1|2} side Transaction Direction (0: all, 1: sell, 2: buy)
* @param {Number} offset that is, from which one to get
* @param {Number} limit The number of records obtained
* @returns {Promise<Object>} Promise object represents the result of the request
*/
export declare function orderQueryAccountStop(account: number, market: string, side: 0 | 1 | 2, offset: number, limit: number): Promise<any>;