Skip to content

Updated strategy#

About#

Updated strategy

Fields#

Name Type Required Description
name string Yes strategy human-readable name
description string Yes longer strategy human-readable description
accountId string Yes id of the MetaApi account providing the strategy
skipPendingOrders boolean flag indicating that pending orders should not be copied. Default is to copy pending orders
commissionScheme CommissionScheme commission scheme allowed by this strategy. By default monthly billing period with no commission is being used
maxTradeRisk number max risk per trade, expressed as a fraction of 1. If trade has a SL, the trade size will be adjusted to match the risk limit. If not, the trade SL will be applied according to the risk limit
reverse boolean flag indicating that the strategy should be copied in a reverse direction
reduceCorrelations string setting indicating whether to enable automatic trade correlation reduction. Possible settings are not specified (disable correlation risk restrictions), by-strategy (limit correlations on strategy level) or by-symbol (limit correlations on symbol level)
symbolFilter StrategySymbolF... symbol filter which can be used to copy only specific symbols or exclude some symbols from copying
newsFilter StrategyNewsFilter news risk filter configuration. Experimental feature
riskLimits Array<StrategyR...> strategy risk limits. You can configure trading to be stopped once total drawdown generated during specific period is exceeded. Can be specified either for balance or equity drawdown
maxStopLoss StrategyMaxSto... stop loss value restriction
maxLeverage number setting indicating maximum leverage allowed when opening a new positions. Any trade which results in a higher leverage will be discarded
symbolMapping Array<SymbolM...> defines how symbol name should be changed when trading (e.g. when broker uses symbol names with unusual suffixes). By default this setting is disabled and the trades are copied using signal source symbol name
tradeSizeScaling StrategyTrade... Trade size scaling settings. By default the trade size on strategy subscriber side will be scaled according to balance to preserve risk.
copyStopLoss boolean flag indicating whether stop loss should be copied. Default is to copy stop loss.
copyTakeProfit boolean flag indicating whether take profit should be copied. Default is to copy take profit.
allowedSides Array<string> Trade sides which will be copied. Buy trades only, sell trades only or all trades. Default is to copy all trades
minTradeVolume number Minimum trade volume to copy. Trade signals with a smaller volume will not be copied
maxTradeVolume number Maximum trade volume to copy. Trade signals with a larger volume will be copied with maximum volume instead
magicFilter StrategyMagicF... magic (expert id) filter
equityCurveFilter StrategyEquity... filter which permits the trades only if account equity is greater than balance moving average
drawdownFilter StrategyDrawdo... master account strategy drawdown filter
symbolsTraded Array<string> symbols traded by this strategy. Specifying the symbols will improve trade latency on first trades made by strategy. If you do not specify this setting the application will monitor the strategy trades and detect the symbols automatically over time
telegram StrategyTelegr... telegram integration settings
timeSettings StrategyTimeSe... settings to manage copying timeframe and position lifetime. Default is to copy position within 1 minute from being opened at source and let the position to live for up to 90 days

Example#

{
  "name": "Test strategy",
  "description": "Some useful description about your strategy",
  "skipPendingOrders": true,
  "accountId": "105646d8-8c97-4d4d-9b74-413bd66cd4ed",
  "commissionScheme": {
    "type": "flat-fee",
    "billingPeriod": "week",
    "commissionRate": 1
  },
  "maxTradeRisk": 0.4,
  "reverse": true,
  "reduceCorrelations": "by-strategy",
  "stopOutRisk": {
    "absoluteValue": 0.05,
    "relativeValue": 0.01,
    "startTime": "2020-08-24T00:00:00.000Z"
  },
  "symbolFilter": {
    "included": [
      "EURUSD"
    ]
  },
  "newsFilter": {
    "breakingNewsFilter": {
      "priorities": [
        "high"
      ],
      "closePositionTimeGapInMinutes": 10,
      "openPositionFollowingTimeGapInMinutes": 20
    },
    "calendarNewsFilter": {
      "priorities": [
        "election"
      ],
      "closePositionTimeGapInMinutes": 10,
      "openPositionPrecedingTimeGapInMinutes": 20,
      "openPositionFollowingTimeGapInMinutes": 20
    }
  },
  "riskLimits": [
    {
      "type": "day",
      "applyTo": "balance-difference",
      "maxAbsoluteRisk": 0.05,
      "maxRelativeRisk": 0.01,
      "closePositions": true,
      "startTime": "2020-08-24T00:00:00.000Z"
    }
  ],
  "maxStopLoss": {
    "value": 120,
    "units": "pips"
  },
  "maxLeverage": 50,
  "symbolMapping": [
    {
      "to": "EURUSD",
      "from": "EURUSD.m"
    }
  ],
  "tradeSizeScaling": {
    "mode": "none"
  },
  "magicFilter": {
    "included": [
      "1000-2000"
    ],
    "excluded": [
      "1250-1500"
    ]
  },
  "drawdownFilter": {
    "maxDrawdown": 0.4,
    "action": "include"
  },
  "timeSettings": {
    "lifetimeInHours": 10,
    "openingIntervalInMinutes": 6
  }
}

Usages#