CopyFactory trade copying API for javascript (a member ofmetaapi.cloud project)

Why do we offer CopyFactory trade copying API

Frequently asked questions (FAQ)

CopyFactory copytradging API features

REST API documentation

FAQ

Code examples

Installation

npm install --save metaapi.cloud-sdk

Installing SDK in browser SPA applications

npm install --save metaapi.cloud-sdk

Installing SDK in browser HTML applications

<scriptsrc="unpkg.com/metaapi.cloud-sdk/index.js"></script><script>consttoken='...';constapi=newCopyFactory(token);</script>

Retrieving API token

Configuring trade copying

importMetaApi,{CopyFactory}from'metaapi.cloud-sdk';consttoken='...';constmetaapi=newMetaApi(token);constcopyFactory=newCopyFactory(token);// retrieve MetaApi MetaTrader accounts with CopyFactory as application field value// master account must have PROVIDER value in copyFactoryRolesconstmasterMetaapiAccount=awaitapi.metatraderAccountApi.getAccount('masterMetaapiAccountId');if(!masterMetaapiAccount.copyFactoryRoles||!masterMetaapiAccount.copyFactoryRoles.includes('PROVIDER')){thrownewError('Please specify PROVIDER copyFactoryRoles value in your MetaApi account in '+'order to use it in CopyFactory API');}// slave account must have SUBSCRIBER value in copyFactoryRolesconstslaveMetaapiAccount=awaitapi.metatraderAccountApi.getAccount('slaveMetaapiAccountId');if(!slaveMetaapiAccount.copyFactoryRoles||!slaveMetaapiAccount.copyFactoryRoles.includes('SUBSCRIBER')){thrownewError('Please specify SUBSCRIBER copyFactoryRoles value in your MetaApi account in '+'order to use it in CopyFactory API');}letconfigurationApi=copyFactory.configurationApi;// create a strategy being copiedletstrategyId=awaitconfigurationApi.generateStrategyId();awaitconfigurationApi.updateStrategy(strategyId.id,{name:'Test strategy',description:'Some useful description about your strategy',accountId:masterMetaapiAccount.id,maxTradeRisk:0.1,timeSettings:{lifetimeInHours:192,openingIntervalInMinutes:5}});// subscribe slave CopyFactory accounts to the strategyawaitconfigurationApi.updateSubscriber(slaveMetaapiAccount.id,{name:'Demo account',subscriptions:[{strategyId:strategyId.id,multiplier:1}]});// retrieve list of strategiesconsole.log(awaitconfigurationApi.getStrategies())// retrieve list of provider portfoliosconsole.log(awaitconfigurationApi.getPortfolioStrategies())// retrieve list of subscribersconsole.log(awaitconfigurationApi.getSubscribers())

Retrieving trade copying history

Retrieving trading history on provider side

lethistoryApi=copyFactory.historyApi;// retrieve trading history, please note that this method support pagination and limits number of recordsconsole.log(awaithistoryApi.getProvidedTransactions(newDate('2020-08-01'),newDate('2020-09-01')));

Retrieving trading history on subscriber side

lethistoryApi=copyFactory.historyApi;// retrieve trading history, please note that this method support pagination and limits number of recordsconsole.log(awaithistoryApi.getSubscriptionTransactions(newDate('2020-08-01'),newDate('2020-09-01')));

Resynchronizing slave accounts to masters

letaccountId='...';// CopyFactory account id// resynchronize all strategiesawaitcopyFactory.tradingApi.resynchronize(accountId);// resynchronize specific strategyawaitcopyFactory.tradingApi.resynchronize(accountId,['ABCD']);

Sending external trading signals to a strategy

constaccountId='...';consttradingApi=copyFactory.tradingApi;constsignalId='...';// get signal clientconstsignalClient=awaittradingApi.getSignalClient(accountId);// add trading signalawaitsignalClient.updateExternalSignal(strategyId,signalId,{symbol:'EURUSD',type:'POSITION_TYPE_BUY',time:newDate(),volume:0.01});// get external signalsconsole.log(awaitsignalClient.getStrategyExternalSignals(strategyId));// remove signalawaitsignalClient.removeExternalSignal(strategyId,signalId,{time:newDate()});

Retrieving trading signals

constaccountId='...';constsignalClient=awaittradingApi.getSignalClient(accountId);// retrieve trading signalsconsole.log(awaitsignalClient.getTradingSignals());

Managing stopouts

lettradingApi=copyFactory.tradingApi;letaccountId='...';// CopyFactory account idletstrategyId='...';// CopyFactory strategy id// retrieve list of strategy stopoutsconsole.log(awaittradingApi.getStopouts(accountId));// reset a stopout so that subscription can continueawaittradingApi.resetSubscriptionStopouts(accountId,strategyId,'daily-equity');

Managing stopout listeners

import{StopoutListener}from'metaapi.cloud-sdk';lettradingApi=copyFactory.tradingApi;// create a custom class based on the StopoutListenerclassListenerextendsStopoutListener{// specify the function called on event arrivalasynconStopout(strategyStopoutEvent){console.log('Strategy stopout event',strategyStopoutEvent);}// specify the function called on error eventasynconError(error){console.log('Error event',error);}}// add listenerconstlistener=newListener();constlistenerId=tradingApi.addStopoutListener(listener);// remove listenertradingApi.removeStopoutListener(listenerId);

Retrieving slave trading logs

lettradingApi=copyFactory.tradingApi;letaccountId='...';// CopyFactory account id// retrieve slave trading logconsole.log(awaittradingApi.getUserLog(accountId));// retrieve paginated slave trading log by time rangeconsole.log(awaittradingApi.getUserLog(accountId,newDate(Date.now()-24*60*60*1000),undefined,20,10));

Log streaming

Strategy logs

import{UserLogListener}from'metaapi.cloud-sdk';lettradingApi=copyFactory.tradingApi;// create a custom class based on the UserLogListenerclassListenerextendsUserLogListener{// specify the function called on event arrivalasynconUserLog(logEvent){console.log('Strategy user log event',logEvent);}// specify the function called on error eventasynconError(error){console.log('Error event',error);}}// add listenerconstlistener=newListener();constlistenerId=tradingApi.addStrategyLogListener(listener,'ABCD');// remove listenertradingApi.removeStrategyLogListener(listenerId);

Subscriber logs

import{UserLogListener}from'metaapi.cloud-sdk';lettradingApi=copyFactory.tradingApi;// create a custom class based on the UserLogListenerclassListenerextendsUserLogListener{// specify the function called on event arrivalasynconUserLog(logEvent){console.log('Subscriber user log event',logEvent);}// specify the function called on error eventasynconError(error){console.log('Error event',error);}}// add listenerconstlistener=newListener();constlistenerId=tradingApi.addSubscriberLogListener(listener,'accountId');// remove listenertradingApi.removeSubscriberLogListener(listenerId);

Transaction streaming

Strategy transactions

import{TransactionListener}from'metaapi.cloud-sdk';lethistoryApi=copyFactory.historyApi;// create a custom class based on the TransactionListenerclassListenerextendsTransactionListener{// specify the function called on event arrivalasynconTransaction(transactionEvent){console.log('Strategy transaction event',transactionEvent);}// specify the function called on error eventasynconError(error){console.log('Error event',error);}}// add listenerconstlistener=newListener();constlistenerId=historyApi.addStrategyTransactionListener(listener,'ABCD');// remove listenerhistoryApi.removeStrategyTransactionListener(listenerId);

Subscriber transactions

import{TransactionListener}from'metaapi.cloud-sdk';lethistoryApi=copyFactory.historyApi;// create a custom class based on the TransactionListenerclassListenerextendsTransactionListener{// specify the function called on event arrivalasynconTransaction(transactionEvent){console.log('Subscriber transaction event',transactionEvent);}// specify the function called on error eventasynconError(error){console.log('Error event',error);}}// add listenerconstlistener=newListener();constlistenerId=historyApi.addSubscriberTransactionListener(listener,'accountId');// remove listenerhistoryApi.removeSubscriberTransactionListener(listenerId);

Related projects: