metaapi.cloud-sdk
Version:
SDK for MetaApi, a professional cloud forex API which includes MetaTrader REST API and MetaTrader websocket API. Supports both MetaTrader 5 (MT5) and MetaTrader 4 (MT4). CopyFactory copy trading API included. (https://metaapi.cloud)
48 lines (41 loc) • 1.3 kB
TypeScript
/**
* HTTP client library based on axios
*/
export default class HttpClient {
/**
* Constructs HttpClient class instance
* @param {Number} [timeout] request timeout in seconds
* @param {Number} [extendedTimeout] request timeout in seconds
* @param {RetryOptions} [retryOpts] retry options
*/
constructor(timeout?: number, extendedTimeout?: number, retryOpts?: RetryOptions);
/**
* Performs a request. Response errors are returned as ApiError or subclasses.
* @param {Object} options request options
* @returns {Object|String|any} request result
*/
request(options: Object): Promise<Object> | Promise<string> | Promise<any>;
/**
* Performs a request. Response errors are returned as ApiError or subclasses.
* @param {Object} options request options
* @returns {Object|String|any} request result
*/
requestWithFailover(options: Object): Promise<Object> | Promise<string> | Promise<any>;
}
/**
* retry options
*/
export declare type RetryOptions = {
/**
* the number of attempts to retry failed request, default 5
*/
retries?: number,
/**
* minimum delay in seconds before retrying, default 1
*/
minDelayInSeconds?: number,
/**
* maximum delay in seconds before retrying, default 30
*/
maxDelayInSeconds?: number
}