metaapi.cloud-copyfactory-sdk/dist/clients/copyfactory/strategySignal.client.js

Javascript SDK for SDK for CopyFactory trade copying API. Can copy trades both between MetaTrader 5 (MT5) and MetaTrader 4 (MT4). (https://metaapi.cloud)

"use strict";
Object.defineProperty(exports, "__esModule", {
    value: true
});
Object.defineProperty(exports, /**
 * CopyFactory client for strategy signal requests
 */ "default", {
    enumerable: true,
    get: function() {
        return StrategySignalClient;
    }
});
const _randomstring = /*#__PURE__*/ _interop_require_default(require("randomstring"));
function _interop_require_default(obj) {
    return obj && obj.__esModule ? obj : {
        default: obj
    };
}
let StrategySignalClient = class StrategySignalClient {
    /**
   * Constructs CopyFactory strategy signal client instance
   * @param {string} accountId strategy provider id
   * @param {string} strategyId strategy id
   * @param {Object} host host data
   * @param {DomainClient} domainClient domain client
   */ constructor(accountId, strategyId, host, domainClient){
        this._accountId = accountId;
        this._strategyId = strategyId;
        this._domainClient = domainClient;
        this._host = host;
    }
    /**
   * Generates random signal id
   * @return {String} signal id
   */ generateSignalId() {
        return _randomstring.default.generate(8);
    }
    /**
   * CopyFactory external signal update payload
   * @typedef {Object} CopyFactoryExternalSignalUpdate
   * @property {String} symbol trade symbol
   * @property {String} type trade type (one of POSITION_TYPE_BUY, POSITION_TYPE_SELL, ORDER_TYPE_BUY_LIMIT, ORDER_TYPE_SELL_LIMIT, 
   * ORDER_TYPE_BUY_STOP, ORDER_TYPE_SELL_STOP)
   * @property {Date} time time the signal was emitted at
   * @property {Date} [updateTime] last time of the signal update
   * @property {Number} volume volume traded
   * @property {Number} [magic] expert advisor id
   * @property {Number} [stopLoss] stop loss price
   * @property {Number} [takeProfit] take profit price
   * @property {Number} [openPrice] pending order open price
   */ /**
   * CopyFactory external signal
   * @typedef {CopyFactoryExternalSignalUpdate} CopyFactoryExternalSignal
   * @property {String} id external signal id
   */ /**
   * CopyFactory external signal remove payload
   * @typedef {Object} CopyFactoryExternalSignalRemove
   * @property {Date} time the time signal was removed (closed) at
   */ /**
   * Returns active external signals of a strategy. Requires access to
   * copyfactory-api:rest:public:external-signals:getSignals method which is included into reader role.
   * Requires access to strategy, account resources.
   * @param {String} strategyId strategy id
   * @returns {Promise<Array<CopyFactoryExternalSignal>>}
   */ getExternalSignals() {
        const opts = {
            url: `/users/current/strategies/${this._strategyId}/external-signals`,
            method: "GET",
            headers: {
                "auth-token": this._domainClient.token
            },
            json: true
        };
        return this._domainClient.requestSignal(opts, this._host, this._accountId);
    }
    /**
   * Updates external signal for a strategy or creates it if it does not exist. See
   * https://metaapi.cloud/docs/copyfactory/restApi/api/trading/updateExternalSignal/
   * @param {String} signalId external signal id (should be 8 alphanumerical symbols)
   * @param {CopyFactoryExternalSignalUpdate} signal signal update payload
   * @return {Promise} promise which resolves when the external signal is updated
   */ updateExternalSignal(signalId, signal) {
        const opts = {
            url: `/users/current/strategies/${this._strategyId}/external-signals/${signalId}`,
            method: "PUT",
            headers: {
                "auth-token": this._domainClient.token
            },
            data: signal,
            json: true
        };
        return this._domainClient.requestSignal(opts, this._host, this._accountId);
    }
    /**
   * CopyFactory external signal remove payload
   * @typedef {Object} CopyFactoryExternalSignalRemove
   * @property {Date} time the time signal was removed (closed) at
   */ /**
   * Removes (closes) external signal for a strategy. See
   * https://metaapi.cloud/docs/copyfactory/restApi/api/trading/removeExternalSignal/
   * @param {String} signalId external signal id
   * @param {CopyFactoryExternalSignalRemove} signal signal removal payload
   * @return {Promise} promise which resolves when the external signal is removed
   */ removeExternalSignal(signalId, signal) {
        const opts = {
            url: `/users/current/strategies/${this._strategyId}/external-signals/${signalId}/remove`,
            method: "POST",
            headers: {
                "auth-token": this._domainClient.token
            },
            data: signal,
            json: true
        };
        return this._domainClient.requestSignal(opts, this._host, this._accountId);
    }
};

//# sourceMappingURL=data:application/json;base64,{"version":3,"sources":["<anon>"],"sourcesContent":["import randomstring from 'randomstring';\n\n/**\n * CopyFactory client for strategy signal requests\n */\nexport default class StrategySignalClient {\n\n  /**\n   * Constructs CopyFactory strategy signal client instance\n   * @param {string} accountId strategy provider id\n   * @param {string} strategyId strategy id\n   * @param {Object} host host data\n   * @param {DomainClient} domainClient domain client\n   */\n  constructor(accountId, strategyId, host, domainClient) {\n    this._accountId = accountId;\n    this._strategyId = strategyId;\n    this._domainClient = domainClient;\n    this._host = host;\n  }\n\n  /**\n   * Generates random signal id\n   * @return {String} signal id\n   */\n  generateSignalId() {\n    return randomstring.generate(8);\n  }\n\n  /**\n   * CopyFactory external signal update payload\n   * @typedef {Object} CopyFactoryExternalSignalUpdate\n   * @property {String} symbol trade symbol\n   * @property {String} type trade type (one of POSITION_TYPE_BUY, POSITION_TYPE_SELL, ORDER_TYPE_BUY_LIMIT, ORDER_TYPE_SELL_LIMIT, \n   * ORDER_TYPE_BUY_STOP, ORDER_TYPE_SELL_STOP)\n   * @property {Date} time time the signal was emitted at\n   * @property {Date} [updateTime] last time of the signal update\n   * @property {Number} volume volume traded\n   * @property {Number} [magic] expert advisor id\n   * @property {Number} [stopLoss] stop loss price\n   * @property {Number} [takeProfit] take profit price\n   * @property {Number} [openPrice] pending order open price\n   */\n\n  /**\n   * CopyFactory external signal\n   * @typedef {CopyFactoryExternalSignalUpdate} CopyFactoryExternalSignal\n   * @property {String} id external signal id\n   */\n\n  /**\n   * CopyFactory external signal remove payload\n   * @typedef {Object} CopyFactoryExternalSignalRemove\n   * @property {Date} time the time signal was removed (closed) at\n   */\n\n  /**\n   * Returns active external signals of a strategy. Requires access to\n   * copyfactory-api:rest:public:external-signals:getSignals method which is included into reader role.\n   * Requires access to strategy, account resources.\n   * @param {String} strategyId strategy id\n   * @returns {Promise<Array<CopyFactoryExternalSignal>>}\n   */\n  getExternalSignals() {\n    const opts = {\n      url: `/users/current/strategies/${this._strategyId}/external-signals`,\n      method: 'GET',\n      headers: {\n        'auth-token': this._domainClient.token\n      },\n      json: true\n    };\n\n    return this._domainClient.requestSignal(opts, this._host, this._accountId);\n  }\n\n  /**\n   * Updates external signal for a strategy or creates it if it does not exist. See\n   * https://metaapi.cloud/docs/copyfactory/restApi/api/trading/updateExternalSignal/\n   * @param {String} signalId external signal id (should be 8 alphanumerical symbols)\n   * @param {CopyFactoryExternalSignalUpdate} signal signal update payload\n   * @return {Promise} promise which resolves when the external signal is updated\n   */\n  updateExternalSignal(signalId, signal) {\n    const opts = {\n      url: `/users/current/strategies/${this._strategyId}/external-signals/${signalId}`,\n      method: 'PUT',\n      headers: {\n        'auth-token': this._domainClient.token\n      },\n      data: signal,\n      json: true\n    };\n    return this._domainClient.requestSignal(opts, this._host, this._accountId);\n  }\n\n  /**\n   * CopyFactory external signal remove payload\n   * @typedef {Object} CopyFactoryExternalSignalRemove\n   * @property {Date} time the time signal was removed (closed) at\n   */\n\n  /**\n   * Removes (closes) external signal for a strategy. See\n   * https://metaapi.cloud/docs/copyfactory/restApi/api/trading/removeExternalSignal/\n   * @param {String} signalId external signal id\n   * @param {CopyFactoryExternalSignalRemove} signal signal removal payload\n   * @return {Promise} promise which resolves when the external signal is removed\n   */\n  removeExternalSignal(signalId, signal) {\n    const opts = {\n      url: `/users/current/strategies/${this._strategyId}/external-signals/${signalId}/remove`,\n      method: 'POST',\n      headers: {\n        'auth-token': this._domainClient.token\n      },\n      data: signal,\n      json: true\n    };\n    return this._domainClient.requestSignal(opts, this._host, this._accountId);\n  }\n\n}"],"names":["StrategySignalClient","constructor","accountId","strategyId","host","domainClient","_accountId","_strategyId","_domainClient","_host","generateSignalId","randomstring","generate","getExternalSignals","opts","url","method","headers","token","json","requestSignal","updateExternalSignal","signalId","signal","data","removeExternalSignal"],"mappings":";;;;+BAEA;;CAEC,GACD;;;eAAqBA;;;qEALI;;;;;;AAKV,IAAA,AAAMA,uBAAN,MAAMA;IAEnB;;;;;;GAMC,GACDC,YAAYC,SAAS,EAAEC,UAAU,EAAEC,IAAI,EAAEC,YAAY,CAAE;QACrD,IAAI,CAACC,UAAU,GAAGJ;QAClB,IAAI,CAACK,WAAW,GAAGJ;QACnB,IAAI,CAACK,aAAa,GAAGH;QACrB,IAAI,CAACI,KAAK,GAAGL;IACf;IAEA;;;GAGC,GACDM,mBAAmB;QACjB,OAAOC,qBAAY,CAACC,QAAQ,CAAC;IAC/B;IAEA;;;;;;;;;;;;;GAaC,GAED;;;;GAIC,GAED;;;;GAIC,GAED;;;;;;GAMC,GACDC,qBAAqB;QACnB,MAAMC,OAAO;YACXC,KAAK,CAAC,0BAA0B,EAAE,IAAI,CAACR,WAAW,CAAC,iBAAiB,CAAC;YACrES,QAAQ;YACRC,SAAS;gBACP,cAAc,IAAI,CAACT,aAAa,CAACU,KAAK;YACxC;YACAC,MAAM,IAAI;QACZ;QAEA,OAAO,IAAI,CAACX,aAAa,CAACY,aAAa,CAACN,MAAM,IAAI,CAACL,KAAK,EAAE,IAAI,CAACH,UAAU;IAC3E;IAEA;;;;;;GAMC,GACDe,qBAAqBC,QAAQ,EAAEC,MAAM,EAAE;QACrC,MAAMT,OAAO;YACXC,KAAK,CAAC,0BAA0B,EAAE,IAAI,CAACR,WAAW,CAAC,kBAAkB,EAAEe,SAAS,CAAC;YACjFN,QAAQ;YACRC,SAAS;gBACP,cAAc,IAAI,CAACT,aAAa,CAACU,KAAK;YACxC;YACAM,MAAMD;YACNJ,MAAM,IAAI;QACZ;QACA,OAAO,IAAI,CAACX,aAAa,CAACY,aAAa,CAACN,MAAM,IAAI,CAACL,KAAK,EAAE,IAAI,CAACH,UAAU;IAC3E;IAEA;;;;GAIC,GAED;;;;;;GAMC,GACDmB,qBAAqBH,QAAQ,EAAEC,MAAM,EAAE;QACrC,MAAMT,OAAO;YACXC,KAAK,CAAC,0BAA0B,EAAE,IAAI,CAACR,WAAW,CAAC,kBAAkB,EAAEe,SAAS,OAAO,CAAC;YACxFN,QAAQ;YACRC,SAAS;gBACP,cAAc,IAAI,CAACT,aAAa,CAACU,KAAK;YACxC;YACAM,MAAMD;YACNJ,MAAM,IAAI;QACZ;QACA,OAAO,IAAI,CAACX,aAAa,CAACY,aAAa,CAACN,MAAM,IAAI,CAACL,KAAK,EAAE,IAAI,CAACH,UAAU;IAC3E;AAEF"}