/copiers
Create copier allows you to make a trade copier between two MetaTrader trading accounts on the platform.
To create a trade copier you must have at least 2 trading accounts added to the platform.
The accounts you create a copier with must be of the full type.
| Attribute | Description | Data type | Required | Default |
|---|---|---|---|---|
| lead_id | Lead Tradesync account ID | integer | Yes | Not set |
| follower_id | Follower Tradesync account ID | integer | Yes | Not set |
| risk_type | Risk calculation used for calculating outputted follower trade lot size | See risk types below. | Yes | Not set |
| risk_value | Risk multiplier used for calculating outputted follower trade lot size | double | Yes | Not set |
| copy_existing | Copy existing lead account trades | yes or no | No | No |
| mode | State of the copier on creation | on, off or monitor | No | off |
| reverse | Reverse direction of trades | yes or no | No | No |
| force_min | Round up the lot size if less than the minimum | yes or no | No | No |
| max_lot | Round down the lot size if it is greater than the max lot | double | No | 50 |
| slippage | An acceptable difference between the lead open price | double | No | 100 |
| copy_pending | Copy pending orders to you follower account | yes or no | No | No |
| copy_sl | Copy stop loss values directly to your follower account | yes, no or fixed | No | No |
| fixed_sl | A fixed stop loss if using copy_sl fixed | double | No | Null |
| copy_tp | Copy take profit values directly to your follower account | yes, no or fixed | No | No |
| fixed_tp | A fixed take profit if using copy_tp fixed | double | No | Null |
| comment | Append a string to the MetaTrader trade comment | string | No | Null |
{
"lead_id": 1241453,
"follower_id": 1241451,
"risk_type": "risk_multiplier_by_balance",
"risk_value": 1
}
Defaults
| Attribute | Description | Data type | Value |
|---|---|---|---|
| result | Status response | string | Success, fail or error |
| status | HTTP status code | integer | 200, 400 to 429, 500 & 503 |
| data | Array of resource data | JSON array | |
| meta | Array of metadata | JSON array | |
| message | Error message | string |
Endpoint specific
| Attribute | Description | Data type |
|---|---|---|
| id | Unique identifier for item | string |
| created_at | Timestamp for creation of item | datetime UTC |
| updated_at | Timestamp for update of item | datetime UTC |
| lead_id | Lead Tradesync account ID | datetime UTC |
| follower_id | Follower Tradesync account ID | string |
| risk_type | Risk calculation used for calculating outputted follower trade lot size | integer |
| risk_value | Risk multiplier used for calculating outputted follower trade lot size | string |
| mode | State of the copier | on, off or monitor |
| reverse | Reverse direction of trades | yes or no |
| force_min | Round up the lot size if less than the minimum | yes or no |
| max_lot | Round down the lot size if it is greater than the max lot | double |
| slippage | An acceptable difference between the lead open price | double |
| copy_pending | Copy pending orders to you follower account | yes or no |
| copy_sl | Copy stop loss values directly to your follower account | yes, no or fixed |
| fixed_sl | A fixed stop loss if using copy_sl fixed | double |
| copy_tp | Copy take profit values directly to your follower account | yes, no or fixed |
| fixed_tp | A fixed take profit if using copy_tp fixed | double |
| comment | Append a string to the MetaTrader trade comment | string |
{
"result": "success",
"status": 200,
"data": {
"id": 1309158,
"created_at": "2025-04-23T14:33:50Z",
"updated_at": "2025-04-23T14:33:50Z",
"lead_id": 1241453,
"follower_id": 1241451,
"risk_type": "risk_multiplier_by_balance",
"risk_value": 1,
"mode": "off",
"reverse": "no",
"force_min": "no",
"max_lot": 50,
"slippage": 100,
"copy_pending": "no",
"copy_sl": "no",
"fixed_sl": null,
"copy_tp": "no",
"fixed_tp": null,
"comment": null
}
}
| Value | Description |
|---|---|
| risk_multiplier_by_balance | The copier will consider the balance of accounts to calculate a proportional lot size |
| risk_multiplier_by_equity | The copier will consider the equity values of accounts to calculate a proportional lot size |
| lot_multiplier | The lot size is calculated by taking the Copy From lot size and multiplying by the Multiplier value |
| fixed_lot | All trades will be copied to the Send To account at the defined Fixed Lot value |
| percentage_risk_per_trade_by_balance | The copier will consider the balance of the accounts to calculate the percentage risk per trade (must enable copy stop loss on copier) |
| percentage_risk_per_trade_by_equity | The copier will consider the equity values of the accounts to calculate the percentage risk per trade (must enable copy stop loss on copier) |
| risk_amount_per_trade | A fixed monetary amount for the risk per trade, there must be a stop loss on the master account with this risk type |