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)
123 lines (122 loc) • 13.2 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", {
value: true
});
Object.defineProperty(exports, /**
* metaapi.cloud MetaStats MetaTrader API client
*/ "default", {
enumerable: true,
get: function() {
return MetaStatsClient;
}
});
_export_star(require("./metaStats.client.schemas"), exports);
function _export_star(from, to) {
Object.keys(from).forEach(function(k) {
if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
Object.defineProperty(to, k, {
enumerable: true,
get: function() {
return from[k];
}
});
}
});
return from;
}
let MetaStatsClient = class MetaStatsClient {
_domainClient;
/**
* Constructs MetaStats API client instance
* @param {DomainClient} domainClient domain client
*/ constructor(domainClient){
this._domainClient = domainClient;
}
/**
* 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
*/ async getMetrics(accountId, includeOpenPositions = false) {
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 } = await 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
*/ async getAccountTrades(accountId, startTime, endTime, updateHistory = true, limit = 1000, offset = 0) {
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 } = await 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
*/ async getAccountOpenTrades(accountId) {
const getOpts = (host, id)=>({
url: host + `/users/current/accounts/${id}/open-trades`,
method: "GET",
headers: {
"auth-token": this._domainClient.token
},
json: true
});
const { openTrades } = await 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
*/ async resetMetrics(accountId) {
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);
}
};
//# 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","_domainClient","constructor","domainClient","getMetrics","accountId","includeOpenPositions","getOpts","host","id","url","method","headers","token","params","json","metrics","requestMetastats","getAccountTrades","startTime","endTime","updateHistory","limit","offset","trades","getAccountOpenTrades","openTrades","resetMetrics"],"mappings":"AAAA;;;;+BAOA;;CAEC,GACD;;;eAAqBA;;;qBALP;;;;;;;;;;;;;;AAKC,IAAA,AAAMA,kBAAN,MAAMA;IAEXC,cAA4B;IAEpC;;;GAGC,GACDC,YAAYC,YAA0B,CAAE;QACtC,IAAI,CAACF,aAAa,GAAGE;IACvB;IAEA;;;;;;;GAOC,GACD,MAAMC,WAAWC,SAAiB,EAAEC,uBAAuB,KAAK,EAAoB;QAElF,MAAMC,UAAU,CAACC,MAAMC,KAAQ,CAAA;gBAC7BC,KAAKF,OAAO,CAAC,wBAAwB,EAAEC,GAAG,QAAQ,CAAC;gBACnDE,QAAQ;gBACRC,SAAS;oBACP,cAAc,IAAI,CAACX,aAAa,CAACY,KAAK;gBACxC;gBACAC,QAAQ;oBAACR;gBAAoB;gBAC7BS,MAAM;YACR,CAAA;QAEA,MAAM,EAACC,OAAO,EAAC,GAAG,MAAM,IAAI,CAACf,aAAa,CAACgB,gBAAgB,CAACV,SAASF;QACrE,OAAOW;IACT;IAEA;;;;;;;;;;;;;GAaC,GACD,MAAME,iBACJb,SAAiB,EAAEc,SAAiB,EAAEC,OAAe,EAAEC,gBAAgB,IAAI,EAAEC,QAAQ,IAAI,EAAEC,SAAS,CAAC,EAC9E;QAEvB,MAAMhB,UAAU,CAACC,MAAMC,KAAQ,CAAA;gBAC7BC,KAAKF,OAAO,CAAC,wBAAwB,EAAEC,GAAG,mBAAmB,EAAEU,UAAU,CAAC,EAAEC,QAAQ,CAAC;gBACrFT,QAAQ;gBACRC,SAAS;oBACP,cAAc,IAAI,CAACX,aAAa,CAACY,KAAK;gBACxC;gBACAC,QAAQ;oBAACO;oBAAeC;oBAAOC;gBAAM;gBACrCR,MAAM;YACR,CAAA;QAEA,MAAM,EAACS,MAAM,EAAC,GAAG,MAAM,IAAI,CAACvB,aAAa,CAACgB,gBAAgB,CAACV,SAASF;QACpE,OAAOmB;IACT;IAEA;;;;;;GAMC,GACD,MAAMC,qBAAqBpB,SAAiB,EAA6B;QAEvE,MAAME,UAAU,CAACC,MAAMC,KAAQ,CAAA;gBAC7BC,KAAKF,OAAO,CAAC,wBAAwB,EAAEC,GAAG,YAAY,CAAC;gBACvDE,QAAQ;gBACRC,SAAS;oBACP,cAAc,IAAI,CAACX,aAAa,CAACY,KAAK;gBACxC;gBACAE,MAAM;YACR,CAAA;QAEA,MAAM,EAACW,UAAU,EAAC,GAAG,MAAM,IAAI,CAACzB,aAAa,CAACgB,gBAAgB,CAACV,SAASF;QACxE,OAAOqB;IACT;IAEA;;;;;GAKC,GACD,MAAMC,aAAatB,SAAiB,EAAiB;QAEnD,MAAME,UAAU,CAACC,MAAcC,KAAgB,CAAA;gBAC7CC,KAAKF,OAAO,CAAC,wBAAwB,EAAEC,GAAG,CAAC;gBAC3CE,QAAQ;gBACRC,SAAS;oBACP,cAAc,IAAI,CAACX,aAAa,CAACY,KAAK;gBACxC;gBACAE,MAAM;YACR,CAAA;QAEA,OAAO,IAAI,CAACd,aAAa,CAACgB,gBAAgB,CAACV,SAASF;IACtD;AACF"}