Skip to content

Strategy subscription#

About#

Strategy subscription

Fields#

Name Type Required Description
strategyId string Yes id of the strategy to subscribe to
multiplier number optional subscription multiplier, default is 1x
skipPendingOrders boolean optional flag indicating that pending orders should not be copied. Default is to copy pending orders
closeOnly string optional setting wich instructs the application not to open new positions. by-symbol means that it is still allowed to open new positions with a symbol equal to the symbol of an existing strategy position (can be used to gracefuly exit strategies trading in netting mode or placing a series of related trades per symbol) = [by-strategy, by-symbol]
maxTradeRisk number optional 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 optional 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)
stopOutRisk StrategyStopOut optional stop out setting. All trading will be terminated and positions closed once equity drawdown reaches this value
symbolFilter StrategySymbolF... optional symbol filter which can be used to copy only specific symbols or exclude some symbols from copying
newsFilter StrategyNewsFilter optional news risk filter configuration
riskLimits Array<StrategyR...> optional 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... optional stop loss value restriction
maxLeverage number optional setting indicating maxumum 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.
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

Example#

{
  "strategyId": "SMKn",
  "multiplier": 1,
  "skipPendingOrders": true,
  "closeOnly": "by-strategy",
  "maxTradeRisk": 0.01,
  "reverse": true,
  "reduceCorrelations": "by-strategy",
  "stopOutRisk": {
    "value": 0.01,
    "startTime": "2020-08-24T00:00:00.000Z"
  },
  "symbolFilter": {
    "included": [
      "EURUSD"
    ]
  },
  "newsFilter": {
    "calendarNewsFilter": {
      "priorities": [
        "election"
      ],
      "closePositionTimeGapInMinutes": 10,
      "openPositionPrecedingTimeGapInMinutes": 20,
      "openPositionFollowingTimeGapInMinutes": 20
    }
  },
  "riskLimits": [
    {
      "type": "daily",
      "applyTo": "balance",
      "maxRisk": 0.01,
      "closePositions": true,
      "startTime": "2020-08-24T00:00:00.000Z"
    }
  ],
  "maxStopLoss": {
    "value": 100,
    "units": "pips"
  },
  "maxLeverage": 0,
  "symbolMapping": [
    {
      "to": "EURUSD",
      "from": "EURUSD.m"
    }
  ],
  "tradeSizeScalingMode": "none"
}

Usages#