Neurotic and Probably Misinformed

    metaapi.cloud-copyfactory-sdk
    TypeScript icon, indicating that this package has built-in type declarations

    4.0.2 • Public • Published

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

    CopyFactory is a powerful copy trading API which makes developing forex trade copying applications as easy as writing few lines of code.

    CopyFactory API is a member of MetaApi project (https://metaapi.cloud), a powerful cloud forex trading API which supports both MetaTrader 4 and MetaTrader 5 platforms.

    MetaApi is a paid service, however API access to one MetaTrader account is free of charge.

    The MetaApi pricing was developed with the intent to make your charges less or equal to what you would have to pay for hosting your own infrastructure. This is possible because over time we managed to heavily optimize our MetaTrader infrastructure. And with MetaApi you can save significantly on application development and maintenance costs and time thanks to high-quality API, open-source SDKs and convenience of a cloud service.

    Why do we offer CopyFactory trade copying API

    We found that developing reliable and flexible trade copier is a task which requires lots of effort, because developers have to solve a series of complex technical tasks to create a product.

    We decided to share our product as it allows developers to start with a powerful solution in almost no time, saving on development and infrastructure maintenance costs.

    Frequently asked questions (FAQ)

    FAQ is located here: http://metaapi.cloud/docs/copyfactory/faq

    CopyFactory copytradging API features

    Features supported:

    • low latency trade copying API
    • reliable trade copying API
    • suitable for large-scale deployments
    • suitable for large number of subscribers
    • connect arbitrary number of strategy providers and subscribers
    • subscribe accounts to multiple strategies at once
    • select arbitrary copy ratio for each subscription
    • configure symbol mapping between strategy providers and subscribers
    • apply advanced risk filters on strategy provider side
    • override risk filters on subscriber side
    • provide multiple strategies from a single account based on magic or symbol filters
    • supports manual trading on subscriber accounts while copying trades
    • synchronize subscriber account with strategy providers
    • monitor trading history
    • calculate trade copying commissions for account managers
    • support portfolio strategies as trading signal source, i.e. the strategies which include signals of several other strategies (also known as combos on some platforms)

    Please note that trade copying to MT5 netting accounts is not supported in the current API version

    Please check Features section of the https://metaapi.cloud/docs/copyfactory/ documentation for detailed description of all settings you can make

    REST API documentation

    CopyFactory SDK is built on top of CopyFactory REST API.

    CopyFactory REST API docs are available at https://metaapi.cloud/docs/copyfactory/

    FAQ

    Please check this page for FAQ: https://metaapi.cloud/docs/copyfactory/faq/.

    Code examples

    We published some code examples in our github repository, namely:

    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

    <script src="unpkg.com/metaapi.cloud-sdk/index.js"></script>
    <script>
        const token = '...';
        const api = new CopyFactory(token);
    </script>

    Retrieving API token

    Please visit https://app.metaapi.cloud/token web UI to obtain your API token.

    Configuring trade copying

    In order to configure trade copying you need to:

    • add MetaApi MetaTrader accounts with CopyFactory as application field value (see above)
    • create CopyFactory master and slave accounts and connect them to MetaApi accounts via connectionId field
    • create a strategy being copied
    • subscribe slave CopyFactory accounts to the strategy
    import MetaApi, {CopyFactory} from 'metaapi.cloud-sdk';
    
    const token = '...';
    const metaapi = new MetaApi(token);
    const copyFactory = new CopyFactory(token);
    
    // retrieve MetaApi MetaTrader accounts with CopyFactory as application field value
    // master account must have PROVIDER value in copyFactoryRoles
    const masterMetaapiAccount = await api.metatraderAccountApi.getAccount('masterMetaapiAccountId');
    if(!masterMetaapiAccount.copyFactoryRoles || !masterMetaapiAccount.copyFactoryRoles.includes('PROVIDER')) {
      throw new Error('Please specify PROVIDER copyFactoryRoles value in your MetaApi account in ' +
        'order to use it in CopyFactory API');
    }
    // slave account must have SUBSCRIBER value in copyFactoryRoles
    const slaveMetaapiAccount = await api.metatraderAccountApi.getAccount('slaveMetaapiAccountId');
    if(!slaveMetaapiAccount.copyFactoryRoles || !slaveMetaapiAccount.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;
    
    // create a strategy being copied
    let strategyId = await configurationApi.generateStrategyId();
    await configurationApi.updateStrategy(strategyId.id, {
      name: 'Test strategy',
      description: 'Some useful description about your strategy',
      accountId: masterMetaapiAccount.id,
      maxTradeRisk: 0.1,
      stopOutRisk: {
        value: 0.4,
        startTime: new Date('2020-08-24T00:00:00.000Z')
      },
      timeSettings: {
        lifetimeInHours: 192,
        openingIntervalInMinutes: 5
      }
    });
    
    // subscribe slave CopyFactory accounts to the strategy
    await configurationApi.updateSubscriber(slaveMetaapiAccount.id, {
      name: 'Demo account',
      subscriptions: [
        {
          strategyId: strategyId.id,
          multiplier: 1
        }
      ]
    });
    
    // retrieve list of strategies
    console.log(await configurationApi.getStrategies())
    
    // retrieve list of provider portfolios
    console.log(await configurationApi.getPortfolioStrategies())
    
    // retrieve list of subscribers
    console.log(await configurationApi.getSubscribers())

    See esdoc in-code documentation for full definition of possible configuration options.

    Retrieving trade copying history

    CopyFactory allows you to monitor transactions conducted on trading accounts in real time.

    Retrieving trading history on provider side

    let historyApi = copyFactory.historyApi;
    
    // retrieve trading history, please note that this method support pagination and limits number of records
    console.log(await historyApi.getProvidedTransactions(new Date('2020-08-01'), new Date('2020-09-01')));

    Retrieving trading history on subscriber side

    let historyApi = copyFactory.historyApi;
    
    // retrieve trading history, please note that this method support pagination and limits number of records
    console.log(await historyApi.getSubscriptionTransactions(new Date('2020-08-01'), new Date('2020-09-01')));

    Resynchronizing slave accounts to masters

    There is a configurable time limit during which the trades can be opened. Sometimes trades can not open in time due to broker errors or trading session time discrepancy. You can resynchronize a slave account to place such late trades. Please note that positions which were closed manually on a slave account will also be reopened during resynchronization.

    let accountId = '...'; // CopyFactory account id
    
    // resynchronize all strategies
    await copyFactory.tradingApi.resynchronize(accountId);
    
    // resynchronize specific strategy
    await copyFactory.tradingApi.resynchronize(accountId, ['ABCD']);

    Sending external trading signals to a strategy

    You can submit external trading signals to your trading strategy.

    const tradingApi = copyFactory.tradingApi;
    const signalId = tradingApi;
    
    // add trading signal
    await tradingApi.updateExternalSignal(strategyId, signalId, {
      symbol: 'EURUSD',
      type: 'POSITION_TYPE_BUY',
      time: new Date(),
      volume: 0.01
    });
    
    // remove signal
    await tradingApi.removeExternalSignal(strategyId, signalId, {
      time: new Date()
    });

    Retrieving trading signals

    const subscriberId = '...' // CopyFactory subscriber id
    
    // retrieve trading signals
    console.log(await tradingApi.getTradingSignals(subscriberId));

    Managing stopouts

    A subscription to a strategy can be stopped if the strategy have exceeded allowed risk limit.

    let tradingApi = copyFactory.tradingApi;
    let accountId = '...'; // CopyFactory account id
    let strategyId = '...'; // CopyFactory strategy id
    
    // retrieve list of strategy stopouts
    console.log(await tradingApi.getStopouts(accountId));
    
    // reset a stopout so that subscription can continue
    await tradingApi.resetStopout(accountId, strategyId, 'daily-equity');

    Retrieving slave trading logs

    let tradingApi = copyFactory.tradingApi;
    let accountId = '...'; // CopyFactory account id
    
    // retrieve slave trading log
    console.log(await tradingApi.getUserLog(accountId));
    
    // retrieve paginated slave trading log by time range
    console.log(await tradingApi.getUserLog(accountId, new Date(Date.now() - 24 * 60 * 60 * 1000), undefined, 20, 10));

    Related projects:

    Take a look at our website for the full list of APIs and features supported https://metaapi.cloud/#features

    Some of the APIs you might decide to use together with MetaStats API are:

    1. MetaApi cloud forex API https://metaapi.cloud/docs/client/
    2. MetaTrader account management API https://metaapi.cloud/docs/provisioning/
    3. MetaStats forex trading metrics API https://metaapi.cloud/docs/metastats/

    Install

    npm i metaapi.cloud-copyfactory-sdk

    DownloadsWeekly Downloads

    151

    Version

    4.0.2

    License

    SEE LICENSE IN LICENSE

    Unpacked Size

    2.28 MB

    Total Files

    94

    Last publish

    Collaborators

    • agiliumtrade