latestOpenAPI 3.0.12026-08-16171142480.4 KB

ff1699330afa

Account API

Get account copiers

get/rest/api/v1/accounts/{accountId}/copiers

Path parameters

accountIdstring uuid required

Response

OK

activeboolean

Controls whether the copier is active or disabled. When false (inactive), the copier is fully disabled/detached and will not copy any new trades and existing open positions are no longer managed. When true, the copier operates normally.

copyMagicNumberboolean

When enabled, the magic number from the master account's order will be copied to the corresponding trade on the slave account. If the master's magic number is 0 (or absent), no magic number is stamped on the copy — the field is omitted in the outgoing order rather than sent as 0. If customMagicNumber is also set to a non-zero value, customMagicNumber takes precedence and overrides this behavior.

copyOpenPositionsboolean

When enabled, the copier will also replicate any open positions on the master account to the slave account at the time of activation.

copyOriginalCommentboolean

Enabling this option is not recommended. Comments on the slave account are used for internal tracking purposes, and if missing, open positions may under certain circumstances be incorrectly detected as unmanaged. When enabled, the original order comment from the master account will be copied to the corresponding order on the slave account. If disabled, the default tracking comment will be used instead.

copyStopLossboolean

If the copier belongs to a strategy, this setting will be ignored.

copyTakeProfitboolean

If the copier belongs to a strategy, this setting will be ignored.

createdstring date-time

ISO 8601. Timestamp when this copier was created.

customCommentstring

Custom comment to be used for trades. If specified, this comment will be used instead of the default tracking comment.

customMagicNumberinteger

Custom magic number to be stamped on every copied trade on the slave account, overriding the master's magic number regardless of the copyMagicNumber setting. Only applies to copied trades — trades opened directly on the slave (manual or by other systems) are not affected. The value 0 is treated as 'not set' (no override is applied, and no magic number is sent on the copy); use null/omit the field for the same effect. To apply a magic number, send any positive integer.

fixMasterBalanceAndEquityinteger

Set the master balance and equity to the specified value. A value of 0 means deactivated. If set to 1000, the lot size calculation for the slave account will use 1000 as the master balance/equity. If the copier belongs to a strategy, this setting will be ignored.

fixSlaveBalanceAndEquityinteger

Set the slave balance and equity to the specified value. A value of 0 means deactivated. If set to 1000, the lot size calculation for the slave account will use 1000 as the slave balance/equity. If the copier belongs to a strategy, this setting will be ignored.

fixedLotSizenumber

Set the lot size to a specific value, only applicable when the scaleType is set to '3' (Fixed lot size). If the copier belongs to a strategy, this setting will be ignored.

forceMinTradeboolean

If set to true, when the calculated lot size is for example 0.005, it will be adjusted to the minimum size of the symbol. If set to false, the trade will not be executed. If the copier belongs to a strategy, this setting will be ignored.

forcePositionLotSizeboolean

Place more trades if max lot size for a specific symbol is reached. Not available for Binance, Bybit, Bitget, BloFin, OKX, TradeStation, Tradovate and Alpaca.

fromAccountAliasstring
fromAccountIdstring uuid

You have to set it during resource creation, after that, it is only read-only

fromStrategyIdstring uuid

You have to set it during resource creation, after that, it is only read-only

fromStrategyNamestring
hideCommentboolean

When enabled, the comment will be hidden, leaving the comment field empty. Furthermore, any positions opened manually or by other systems with an empty comment field will be closed to prevent them from remaining open in case of an error. It is recommended to enable this option only if absolutely necessary.

idstring uuid
ignoreContractSizeboolean

For the lot size calculation, the contract size (lot size) of the symbol will be ignored.

ignoreCurrencyboolean

When enabled, the lot size calculation will ignore currency differences between the master and slave accounts—no conversion will be applied. If false, and the currencies of the master and slave accounts differ, the lot size calculation will include a conversion to account for the currency difference.

martingaleStrategyboolean

Adjust the lot size based on the Martingale multiplier. If there is a significant difference in balance/equity between the master and slave accounts, the lot size on the slave account may be rounded down. For example, if trades of 0.02 and 0.04 lots are placed on the master account (balance 4000 USD), a standard copier would open 0.01 and 0.01 lots on the slave account (balance 1000 USD - which is incorrect). However, if this option is activated, it will open 0.01 and 0.02 lots. Default is false. If the copier belongs to a strategy, this setting will be ignored.

maxLotSizenumber

Sets the maximum lot size for each position. If a position exceeds this size, it will be adjusted to this maximum limit. A value of 0 means deactivated.

maxOpenPositionsinteger

Limits the maximum number of open positions the copier can maintain at any given time. If the limit is reached, new positions will be skipped until existing positions are closed. A value of 0 means the feature is deactivated.

maxSlippageinteger

Set the slippage (deviation) in points. A value of 0 means deactivated. For scalping strategies with a close take profit, it's recommended to set the value low, for example, 1-3 points (10 points = 1 pip). A common value is 20. A value of 0 means deactivated (Trade is always executed at actual price - recommended if you use martingale/hedging/grid). If the copier belongs to a strategy, this setting will be ignored.

maximumLotnumber

When enabled, the total lot size of all open positions (related to this copier) will not exceed this value, new positions will be skipped until existing positions are closed. A value of 0 means deactivated.

minVolumeSafetySkipThresholdMultipliernumber

Defines the maximum allowed amplification when forceMinTrade would increase the calculated slave lot to the broker minimum. This check only applies when the slave broker's minimum lot size for the symbol is greater than the master broker's minimum lot size. If the amplification (slave min lot / calculated lot) is equal to or greater than this value, the trade is skipped. A value of 0 means deactivated. Example: master min lot 0.01, slave min lot 1.00, calculated lot 0.10 → amplification = 1.00 / 0.10 = 10.0x → skipped if threshold <= 10.0. If both brokers have the same min lot size, this check is not applied.

monitorOnlyboolean

Indicates whether this copier is in monitor-only mode. When true, the copier monitors the source account and manages existing open positions (can close, modify them) but will not copy any new trades. When false, the copier operates in normal copying mode.

multipliernumber

Set the multiplier. Default is 1.000

openRetryboolean

If enabled, the retry mechanism activates when a broker rejects the request or fails to respond. If set to false, the request is sent only once. For Martingale strategies, it is recommended to activate this option, especially when copying between different brokers with varying market opening/closing times. For strategies with small pip profits and larger lot sizes, it is better to deactivate the retry mechanism. For HFT (High-Frequency Trading), it is also better to deactivate it.

openRetryTimeoutInMinutesinteger

Specifies the total duration (in minutes) during which the retry mechanism will attempt to resend a rejected or failed request. If set to 0, the system will retry indefinitely. Once this duration elapses, no further retry attempts will be made. This setting is applicable only if 'openRetry' is set to true.

reverseboolean

If enabled, the order direction is reversed. Useful for trading strategies that require inverse operations.

skipPendingOrdersboolean

This setting allows traders to choose whether or not to replicate pending orders (orders that have not yet been executed). Skipping pending orders is highly recommended. By default, this option is blocked. If you are an expert trader, please contact us to unlock this option. If the copier belongs to a strategy, this setting will be ignored. For DXtrade is not supported. For TradeLocker, MatchTrader, Binance, Bybit, Bitget, BloFin, OKX, TradeStation, Tradovate and Alpaca, quotes are not in real-time, so small slippage settings are not recommended.

toAccountIdstring uuid

You have to set it during resource creation, after that, it is only read-only

toStrategyIdstring uuid

You have to set it during resource creation, after that, it is only read-only

Example response

[
  {
    "customComment": "My Custom Comment",
    "customMagicNumber": 123456,
    "fixedLotSize": 0.01,
    "forceMinTrade": true,
    "ignoreContractSize": true,
    "minVolumeSafetySkipThresholdMultiplier": 3,
    "multiplier": 1,
    "openRetryTimeoutInMinutes": 10,
    "skipPendingOrders": true
  }
]