metaapi.cloud-metastats-sdk
Version:
Javascript SDK for MetaStats forex trading statistics API. Can calculate metrics for MetaTrader accounts added to MetaApi. Supports both MetaTrader 5 (MT5) and MetaTrader 4 (MT4). (https://metaapi.cloud)
156 lines (155 loc) • 14.4 kB
JavaScript
;
function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
try {
var info = gen[key](arg);
var value = info.value;
} catch (error) {
reject(error);
return;
}
if (info.done) {
resolve(value);
} else {
Promise.resolve(value).then(_next, _throw);
}
}
function _async_to_generator(fn) {
return function() {
var self = this, args = arguments;
return new Promise(function(resolve, reject) {
var gen = fn.apply(self, args);
function _next(value) {
asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
}
function _throw(err) {
asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
}
_next(undefined);
});
};
}
function _define_property(obj, key, value) {
if (key in obj) {
Object.defineProperty(obj, key, {
value: value,
enumerable: true,
configurable: true,
writable: true
});
} else {
obj[key] = value;
}
return obj;
}
export * from './metaStats.client.schemas';
let MetaStatsClient = class MetaStatsClient {
/**
* Returns metrics of MetaApi account. This API call is billable
* https://metaapi.cloud/docs/metastats/restApi/api/calculateMetrics/
* @param {String} accountId MetaApi account id
* @param {Boolean} [includeOpenPositions] indicates whether open positions will be included
* in the metrics, default false
* @return {Metrics} account metrics
*/ getMetrics(accountId, includeOpenPositions = false) {
var _this = this;
return _async_to_generator(function*() {
const getOpts = (host, id)=>({
url: host + `/users/current/accounts/${id}/metrics`,
method: 'GET',
headers: {
'auth-token': _this._domainClient.token
},
params: {
includeOpenPositions
},
json: true
});
const { metrics } = yield _this._domainClient.requestMetastats(getOpts, accountId);
return metrics;
})();
}
/**
* Returns historical trades of MetaApi account
* https://metaapi.cloud/docs/metastats/restApi/api/getHistoricalTrades/
* @param {String} accountId MetaApi account id
* @param {String} startTime start of time range, inclusive
* @param {String} endTime end of time range, exclusive
* @param {Boolean} [updateHistory] update historical trades before returning results.
* If set to true, the API call will be counted towards billable MetaStats API calls.
* If set to false, the API call is not billable. Default is true
* @param {Number} [limit] pagination limit
* @param {Number} [offset] pagination offset
* @param {Number} [marketValue ] trade market value
* @return {Array<Trade>} account historical trades
*/ getAccountTrades(accountId, startTime, endTime, updateHistory = true, limit = 1000, offset = 0) {
var _this = this;
return _async_to_generator(function*() {
const getOpts = (host, id)=>({
url: host + `/users/current/accounts/${id}/historical-trades/${startTime}/${endTime}`,
method: 'GET',
headers: {
'auth-token': _this._domainClient.token
},
params: {
updateHistory,
limit,
offset
},
json: true
});
const { trades } = yield _this._domainClient.requestMetastats(getOpts, accountId);
return trades;
})();
}
/**
* Returns open trades of MetaApi account. This API call is not billable
* https://metaapi.cloud/docs/metastats/restApi/api/getOpenTrades/
* @param {String} accountId MetaApi account id
* @param {Number} [marketValue] trade market value
* @return {Array<OpenTrade>} account historical trades
*/ getAccountOpenTrades(accountId) {
var _this = this;
return _async_to_generator(function*() {
const getOpts = (host, id)=>({
url: host + `/users/current/accounts/${id}/open-trades`,
method: 'GET',
headers: {
'auth-token': _this._domainClient.token
},
json: true
});
const { openTrades } = yield _this._domainClient.requestMetastats(getOpts, accountId);
return openTrades;
})();
}
/**
* Resets metrics and trade history for a trading account from MetaStats. The data will be downloaded from trading
* account again when you calculate the MetaStats metrics next time. This API call is not billable
* @param accountId MetaApi account id
* @return promise resolving when removed
*/ resetMetrics(accountId) {
var _this = this;
return _async_to_generator(function*() {
const getOpts = (host, id)=>({
url: host + `/users/current/accounts/${id}`,
method: 'DELETE',
headers: {
'auth-token': _this._domainClient.token
},
json: true
});
return _this._domainClient.requestMetastats(getOpts, accountId);
})();
}
/**
* Constructs MetaStats API client instance
* @param {DomainClient} domainClient domain client
*/ constructor(domainClient){
_define_property(this, "_domainClient", void 0);
this._domainClient = domainClient;
}
};
/**
* metaapi.cloud MetaStats MetaTrader API client
*/ export { MetaStatsClient as default };
//# sourceMappingURL=data:application/json;base64,{"version":3,"sources":["<anon>"],"sourcesContent":["'use strict';\n\nimport DomainClient from './domain.client';\nimport {Metrics, OpenTrade, Trade} from './metaStats.client.schemas';\n\nexport * from './metaStats.client.schemas';\n\n/**\n * metaapi.cloud MetaStats MetaTrader API client\n */\nexport default class MetaStatsClient {\n  \n  private _domainClient: DomainClient;\n\n  /**\n   * Constructs MetaStats API client instance\n   * @param {DomainClient} domainClient domain client\n   */\n  constructor(domainClient: DomainClient) {\n    this._domainClient = domainClient;\n  }\n\n  /**\n   * Returns metrics of MetaApi account. This API call is billable\n   * https://metaapi.cloud/docs/metastats/restApi/api/calculateMetrics/\n   * @param {String} accountId MetaApi account id\n   * @param {Boolean} [includeOpenPositions] indicates whether open positions will be included\n   * in the metrics, default false\n   * @return {Metrics} account metrics\n   */\n  async getMetrics(accountId: string, includeOpenPositions = false): Promise<Metrics> {\n\n    const getOpts = (host, id) => ({\n      url: host + `/users/current/accounts/${id}/metrics`,\n      method: 'GET',\n      headers: {\n        'auth-token': this._domainClient.token\n      },\n      params: {includeOpenPositions},\n      json: true,\n    });\n  \n    const {metrics} = await this._domainClient.requestMetastats(getOpts, accountId);\n    return metrics;\n  }\n\n  /**\n   * Returns historical trades of MetaApi account\n   * https://metaapi.cloud/docs/metastats/restApi/api/getHistoricalTrades/\n   * @param {String} accountId MetaApi account id\n   * @param {String} startTime start of time range, inclusive\n   * @param {String} endTime end of time range, exclusive\n   * @param {Boolean} [updateHistory] update historical trades before returning results. \n   * If set to true, the API call will be counted towards billable MetaStats API calls. \n   * If set to false, the API call is not billable. Default is true\n   * @param {Number} [limit] pagination limit\n   * @param {Number} [offset] pagination offset\n   * @param {Number} [marketValue ] trade market value\n   * @return {Array<Trade>} account historical trades\n   */\n  async getAccountTrades(\n    accountId: string, startTime: string, endTime: string, updateHistory = true, limit = 1000, offset = 0\n  ): Promise<Array<Trade>> {\n\n    const getOpts = (host, id) => ({\n      url: host + `/users/current/accounts/${id}/historical-trades/${startTime}/${endTime}`,\n      method: 'GET',\n      headers: {\n        'auth-token': this._domainClient.token\n      },\n      params: {updateHistory, limit, offset},\n      json: true,\n    });\n\n    const {trades} = await this._domainClient.requestMetastats(getOpts, accountId);\n    return trades;\n  }\n\n  /**\n   * Returns open trades of MetaApi account. This API call is not billable\n   * https://metaapi.cloud/docs/metastats/restApi/api/getOpenTrades/\n   * @param {String} accountId MetaApi account id\n   * @param {Number} [marketValue] trade market value\n   * @return {Array<OpenTrade>} account historical trades\n   */\n  async getAccountOpenTrades(accountId: string): Promise<Array<OpenTrade>> {\n\n    const getOpts = (host, id) => ({\n      url: host + `/users/current/accounts/${id}/open-trades`,\n      method: 'GET',\n      headers: {\n        'auth-token': this._domainClient.token\n      },\n      json: true,\n    });\n\n    const {openTrades} = await this._domainClient.requestMetastats(getOpts, accountId);\n    return openTrades;\n  }\n\n  /**\n   * Resets metrics and trade history for a trading account from MetaStats. The data will be downloaded from trading\n   * account again when you calculate the MetaStats metrics next time. This API call is not billable\n   * @param accountId MetaApi account id\n   * @return promise resolving when removed\n   */\n  async resetMetrics(accountId: string): Promise<void> {\n\n    const getOpts = (host: string, id: string) => ({\n      url: host + `/users/current/accounts/${id}`,\n      method: 'DELETE',\n      headers: {\n        'auth-token': this._domainClient.token\n      },\n      json: true\n    });\n\n    return this._domainClient.requestMetastats(getOpts, accountId);\n  }\n}\n"],"names":["MetaStatsClient","getMetrics","accountId","includeOpenPositions","getOpts","host","id","url","method","headers","_domainClient","token","params","json","metrics","requestMetastats","getAccountTrades","startTime","endTime","updateHistory","limit","offset","trades","getAccountOpenTrades","openTrades","resetMetrics","constructor","domainClient"],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAKA,cAAc,6BAA6B;AAK5B,IAAA,AAAMA,kBAAN,MAAMA;IAYnB;;;;;;;GAOC,GACD,AAAMC,WAAWC,SAAiB,EAAEC,uBAAuB,KAAK;;eAAhE,oBAAA;YAEE,MAAMC,UAAU,CAACC,MAAMC,KAAQ,CAAA;oBAC7BC,KAAKF,OAAO,CAAC,wBAAwB,EAAEC,GAAG,QAAQ,CAAC;oBACnDE,QAAQ;oBACRC,SAAS;wBACP,cAAc,MAAKC,aAAa,CAACC,KAAK;oBACxC;oBACAC,QAAQ;wBAACT;oBAAoB;oBAC7BU,MAAM;gBACR,CAAA;YAEA,MAAM,EAACC,OAAO,EAAC,GAAG,MAAM,MAAKJ,aAAa,CAACK,gBAAgB,CAACX,SAASF;YACrE,OAAOY;QACT;;IAEA;;;;;;;;;;;;;GAaC,GACD,AAAME,iBACJd,SAAiB,EAAEe,SAAiB,EAAEC,OAAe,EAAEC,gBAAgB,IAAI,EAAEC,QAAQ,IAAI,EAAEC,SAAS,CAAC;;eADvG,oBAAA;YAIE,MAAMjB,UAAU,CAACC,MAAMC,KAAQ,CAAA;oBAC7BC,KAAKF,OAAO,CAAC,wBAAwB,EAAEC,GAAG,mBAAmB,EAAEW,UAAU,CAAC,EAAEC,QAAQ,CAAC;oBACrFV,QAAQ;oBACRC,SAAS;wBACP,cAAc,MAAKC,aAAa,CAACC,KAAK;oBACxC;oBACAC,QAAQ;wBAACO;wBAAeC;wBAAOC;oBAAM;oBACrCR,MAAM;gBACR,CAAA;YAEA,MAAM,EAACS,MAAM,EAAC,GAAG,MAAM,MAAKZ,aAAa,CAACK,gBAAgB,CAACX,SAASF;YACpE,OAAOoB;QACT;;IAEA;;;;;;GAMC,GACD,AAAMC,qBAAqBrB,SAAiB;;eAA5C,oBAAA;YAEE,MAAME,UAAU,CAACC,MAAMC,KAAQ,CAAA;oBAC7BC,KAAKF,OAAO,CAAC,wBAAwB,EAAEC,GAAG,YAAY,CAAC;oBACvDE,QAAQ;oBACRC,SAAS;wBACP,cAAc,MAAKC,aAAa,CAACC,KAAK;oBACxC;oBACAE,MAAM;gBACR,CAAA;YAEA,MAAM,EAACW,UAAU,EAAC,GAAG,MAAM,MAAKd,aAAa,CAACK,gBAAgB,CAACX,SAASF;YACxE,OAAOsB;QACT;;IAEA;;;;;GAKC,GACD,AAAMC,aAAavB,SAAiB;;eAApC,oBAAA;YAEE,MAAME,UAAU,CAACC,MAAcC,KAAgB,CAAA;oBAC7CC,KAAKF,OAAO,CAAC,wBAAwB,EAAEC,GAAG,CAAC;oBAC3CE,QAAQ;oBACRC,SAAS;wBACP,cAAc,MAAKC,aAAa,CAACC,KAAK;oBACxC;oBACAE,MAAM;gBACR,CAAA;YAEA,OAAO,MAAKH,aAAa,CAACK,gBAAgB,CAACX,SAASF;QACtD;;IAxGA;;;GAGC,GACDwB,YAAYC,YAA0B,CAAE;QANxC,uBAAQjB,iBAAR,KAAA;QAOE,IAAI,CAACA,aAAa,GAAGiB;IACvB;AAmGF;AAhHA;;CAEC,GACD,SAAqB3B,6BA6GpB"}