metaapi.cloud-sdk/examples/node/copyfactory/externalSignal.js

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)

let MetaApi = require('metaapi.cloud-sdk').default;
let CopyFactory = require('metaapi.cloud-sdk').CopyFactory;

// your MetaApi API token
let token = process.env.TOKEN || '<put in your token here>';
// your provider MetaApi account id
// provider account must have PROVIDER value in copyFactoryRoles
let providerAccountId = process.env.PROVIDER_ACCOUNT_ID || '<put in your providerAccountId here>';
// your subscriber MetaApi account id
// subscriber account must have SUBSCRIBER value in copyFactoryRoles
let subscriberAccountId = process.env.SUBSCRIBER_ACCOUNT_ID || '<put in your subscriberAccountId here>';

const api = new MetaApi(token);
const copyFactory = new CopyFactory(token);

async function externalSignal() {
  try {
    let providerMetaapiAccount = await api.metatraderAccountApi.getAccount(providerAccountId);
    if(!providerMetaapiAccount.copyFactoryRoles || !providerMetaapiAccount.copyFactoryRoles.includes('PROVIDER')) {
      throw new Error('Please specify PROVIDER copyFactoryRoles value in your MetaApi account in ' +
        'order to use it in CopyFactory API');
    }

    let subscriberMetaapiAccount = await api.metatraderAccountApi.getAccount(subscriberAccountId);
    if(!subscriberMetaapiAccount.copyFactoryRoles || !subscriberMetaapiAccount.copyFactoryRoles.includes('SUBSCRIBER')) {
      throw new Error('Please specify SUBSCRIBER copyFactoryRoles value in your MetaApi account in ' +
        'order to use it in CopyFactory API');
    }

    let configurationApi = copyFactory.configurationApi;
    const strategies = await configurationApi.getStrategiesWithInfiniteScrollPagination();
    const strategy = strategies.find(s => s.accountId === providerMetaapiAccount.id);
    let strategyId;
    if(strategy) {
      strategyId = strategy._id;
    } else {
      strategyId = await configurationApi.generateStrategyId();
      strategyId = strategyId.id;
    }

    // create a strategy being copied
    await configurationApi.updateStrategy(strategyId, {
      name: 'Test strategy',
      description: 'Some useful description about your strategy',
      accountId: providerMetaapiAccount.id
    });

    // create subscriber
    await configurationApi.updateSubscriber(subscriberMetaapiAccount.id, {
      name: 'Test subscriber',
      subscriptions: [
        {
          strategyId: strategyId,
          multiplier: 1
        }
      ]
    });

    // send external signal
    const tradingApi = copyFactory.tradingApi;
    const subscriberSignalClient = await tradingApi.getSubscriberSignalClient(subscriberAccountId);
    const strategySignalClient = await tradingApi.getStrategySignalClient(strategyId);
    const signalId = strategySignalClient.generateSignalId();
    await strategySignalClient.updateExternalSignal(signalId, {
      symbol: 'EURUSD',
      type: 'POSITION_TYPE_BUY',
      time: new Date(),
      volume: 0.01
    });

    await new Promise(res => setTimeout(res, 10000));

    // output strategy external signals
    console.log(await strategySignalClient.getExternalSignals());

    // output trading signals
    console.log(await subscriberSignalClient.getTradingSignals());

    // remove external signal
    await strategySignalClient.removeExternalSignal(signalId, {
      time: new Date()
    });
  } catch (err) {
    console.error(err);
  }
  process.exit();
}

externalSignal();