Endpoint
/accounts
Description
Create account allows you to add a MetaTrader trading account to the platform.
In order to create an account you require a trading account from a broker.
You will need to find your broker_server_id using the /broker-servers endpoint here.
You can add two different types of trading accounts; Readonly and Full.
| Features |
Readonly |
Full |
| Manage accounts |
Yes |
Yes |
| Analyse accounts |
Yes |
Yes |
| Copy trades |
No |
Yes |
| Monitor equity |
No |
Yes |
Request parameters
| Attribute |
Description |
Data type |
Required |
Default |
| account_name |
Descriptive account name |
string |
Yes |
Not set |
| account_number |
MetaTrader account number |
integer |
Yes |
Not set |
| password |
MetaTrader account password |
string |
Yes |
Not set |
| application |
Account application |
"mt4" or "mt5" |
Yes |
Not set |
| broker_server_id |
Tradesync broker server ID for MetaTrader broker server |
A valid broker_server_id . See broker server page here |
Yes |
Not set |
| type |
Tradesync account type |
readonly or full |
No |
full |
Request example
{
"account_name": "Test account 1",
"account_number": 5449295,
"password":"KSaaog",
"application": "mt4",
"broker_server_id": 119,
"type": "readonly"
}
Response parameters
| 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 |
| restored_at |
Timestamp for restoration of item |
datetime UTC |
| type |
Tradesync account type |
string |
| application |
Account application |
integer |
| account_name |
Tradesync account name |
string |
| account_number |
MetaTrader account number |
integer |
| password |
MetaTrader account password |
string |
| broker_server_id |
Tradesync broker server ID for MetaTrader broker server |
integer |
| status |
Connection status of Tradesync account |
string |
| login_response |
MetaTrader login status |
string |
| modify_disabled |
Tradesync modify disabled status |
string |
Response example
{
"result": "success",
"status": 200,
"data": {
"id": 1241433,
"created_at": "2025-04-23T13:36:07Z",
"updated_at": "2025-04-23T13:36:07Z",
"restored_at": null,
"type": "readonly",
"application": "mt4",
"account_name": "Test account 1",
"account_number": 5449295,
"password": "KSaaog",
"broker_server_id": 119,
"status": "allocating",
"login_response": null,
"modify_disabled": "no"
}
}
Status
| Value |
Description |
| suspended |
Your account has been suspended from trading due to excess trading volume. |
| maintenance |
Maintenance is being performed on your account. |
| restoring |
Your account was deleted and is currently being restored. |
| allocating |
Your account is currently being allocated to a server. |
| installing |
You account is being installed to a server. |
| attempt_connection |
Attempting to connect to your broker server. |
| login_success |
We have successfully logged into your trading account. |
| investor_mode |
You have logged into your account using the investor password. |
| attempt_success |
We have successfully connected to your broker server. |
| attempt_failed |
Our attempt to connect to your broker server failed. |
| no_ping |
We cannot establish a connection to your account. |
| connection_lost |
The connection to your account has been lost for over 10 minutes. |
| connection_slow |
The connection to your account has been lost for 2 minutes. |
| connection_ok |
Your account is connected. |
Login responses
| Value |
Description |
| login_success |
You have successfully logged in with the main password. |
| invalid_account |
Your account details are incorrect. |
| no_connection |
There is no connection to your account. |
| investor_mode |
You have logged onto the account with the investor password, a slave account will not be able to copy. |
| no_info |
Default response when no information is available. |