Subscriber#
About#
CopyFactory subscriber the user has configured
Fields#
| Name | Type | Required | Description |
|---|---|---|---|
| _id | string | Yes | account id |
| name | string | Yes | account human-readable name |
| reservedMarginFraction | number | fraction of reserved margin to reduce a risk of margin call. Default is to reserve no margin. We recommend using maxLeverage setting instead. Specified as a fraction of balance thus the value is usually greater than 1 | |
| phoneNumbers | Array<string> | id of the MetaApi account to copy trades to | |
| minTradeAmount | number | value of minimal trade size allowed, expressed in amount of account currency. Can be useful if your broker charges a fixed fee per transaction so that you can skip small trades with high broker commission rates. Default is 0 | |
| closeOnly | string | 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). immediately means to close all positions immediately . One of by-position, by-symbol, immediately |
|
| riskLimits | Array<StrategyR...> | account 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 | |
| maxLeverage | number | setting indicating maxumum leverage allowed when opening a new positions. Any trade which results in a higher leverage will be discarded | |
| 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 | |
| signalDelay | SignalDelay | Extra trade copying delay introduced by trade copier before applying the trade signal. You can configure either a fixed or a random delay | |
| subscriptions | Array<StrategyS...> | strategy subscription |
Example#
{
"_id": "105646d8-8c97-4d4d-9b74-413bd66cd4ed",
"name": "Demo subscriber",
"stopOutRisk": {
"absoluteValue": 0.05,
"relativeValue": 0.01,
"startTime": "2020-08-24T00:00:00.000Z"
},
"riskLimits": [
{
"type": "day",
"applyTo": "balance-difference",
"maxAbsoluteRisk": 0.05,
"maxRelativeRisk": 0.01,
"closePositions": true,
"startTime": "2020-08-24T00:00:00.000Z"
}
],
"maxLeverage": 50,
"subscriptions": [
{
"strategyId": "SMKn",
"multiplier": 1,
"skipPendingOrders": true,
"closeOnly": "by-strategy",
"maxTradeRisk": 0.01,
"reverse": true,
"reduceCorrelations": "by-strategy",
"stopOutRisk": {
"absoluteValue": 0.05,
"relativeValue": 0.01,
"startTime": "2020-08-24T00:00:00.000Z"
},
"symbolFilter": {
"included": [
"EURUSD"
]
},
"newsFilter": {
"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": 100,
"units": "pips"
},
"maxLeverage": 0,
"symbolMapping": [
{
"to": "AUDUSD",
"from": "AUDUSD.m"
}
],
"tradeSizeScaling": {
"mode": "none"
},
}
]
}