cloud.metaapi.sdk.clients.copy_factory.models

Class CopyFactoryStrategySubscription

java.lang.Object

cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategySubscription

public class CopyFactoryStrategySubscription
extends Object

CopyFactory strategy subscriptions

Field Summary

Fields

Modifier and Type	Field and Description
String	closeOnly Optional setting wich instructs the application not to open new positions, or null.
Boolean	copyStopLoss Flag indicating whether stop loss should be copied.
Boolean	copyTakeProfit Flag indicating whether take profit should be copied.
Double	maxLeverage Optional setting indicating maximum leverage allowed when opening a new positions, or null.
CopyFactoryStrategyMaxStopLoss	maxStopLoss Optional stop loss value restriction, or null
Double	maxTradeRisk Optional max risk per trade, expressed as a fraction of 1, or null.
Double	maxTradeVolume Maximum trade volume to copy, or null.
Double	minTradeVolume Minimum trade volume to copy, or null.
Double	multiplier Optional subscription multiplier or null, default is 1x
CopyFactoryStrategyNewsFilter	newsFilter Optional news risk filter configuration, or null
String	reduceCorrelations Optional setting indicating whether to enable automatic trade correlation reduction, or null.
Boolean	reverse Flag indicating that the strategy should be copied in a reverse direction, or null
List<CopyFactoryStrategyRiskLimit>	riskLimits Optional strategy risk limits, or null.
Boolean	skipPendingOrders Optional flag indicating that pending orders should not be copied, or null.
CopyFactoryStrategyStopOutRisk	stopOutRisk Optional stop out setting, or null.
String	strategyId Id of the strategy to subscribe to
CopyFactoryStrategySymbolFilter	symbolFilter Optional symbol filter, or null.
List<CopyFactoryStrategySymbolMapping>	symbolMapping Defines how symbol name should be changed when trading (e.g.
CopyFactoryStrategyTradeSizeScaling	tradeSizeScaling Trade size scaling settings, or null.

Constructor Summary

Constructors

Constructor and Description
CopyFactoryStrategySubscription()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

strategyId

public String strategyId

Id of the strategy to subscribe to

multiplier

public Double multiplier

Optional subscription multiplier or null, default is 1x

skipPendingOrders

public Boolean skipPendingOrders

Optional flag indicating that pending orders should not be copied, or null. Default is to copy pending orders

closeOnly

public String closeOnly

Optional setting wich instructs the application not to open new positions, or null. 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). One of by-position, by-symbol or leave empty to disable this setting.

maxTradeRisk

public Double maxTradeRisk

Optional max risk per trade, expressed as a fraction of 1, or null. 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

public Boolean reverse

Flag indicating that the strategy should be copied in a reverse direction, or null

reduceCorrelations

public String reduceCorrelations

Optional setting indicating whether to enable automatic trade correlation reduction, or null. 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

public CopyFactoryStrategyStopOutRisk stopOutRisk

Optional stop out setting, or null. All trading will be terminated and positions closed once equity drawdown reaches this value

symbolFilter

public CopyFactoryStrategySymbolFilter symbolFilter

Optional symbol filter, or null. Can be used to copy only specific symbols or exclude some symbols from copying

newsFilter

public CopyFactoryStrategyNewsFilter newsFilter

Optional news risk filter configuration, or null

riskLimits

public List<CopyFactoryStrategyRiskLimit> riskLimits

Optional strategy risk limits, or null. 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

public CopyFactoryStrategyMaxStopLoss maxStopLoss

Optional stop loss value restriction, or null

maxLeverage

public Double maxLeverage

Optional setting indicating maximum leverage allowed when opening a new positions, or null. Any trade which results in a higher leverage will be discarded

symbolMapping

public List<CopyFactoryStrategySymbolMapping> symbolMapping

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 (null) and the trades are copied using signal source symbol name

tradeSizeScaling

public CopyFactoryStrategyTradeSizeScaling tradeSizeScaling

Trade size scaling settings, or null. By default the trade size on strategy subscriber side will be scaled according to balance to preserve risk.

copyStopLoss

public Boolean copyStopLoss

Flag indicating whether stop loss should be copied. Default (null) is to copy stop loss

copyTakeProfit

public Boolean copyTakeProfit

Flag indicating whether take profit should be copied. Default (null) is to copy take profit

minTradeVolume

public Double minTradeVolume

Minimum trade volume to copy, or null. Trade signals with a smaller volume will not be copied

maxTradeVolume

public Double maxTradeVolume

Maximum trade volume to copy, or null. Trade signals with a larger volume will be copied with maximum volume instead

Constructor Detail

CopyFactoryStrategySubscription

public CopyFactoryStrategySubscription()