Connect a MetaTrader account
What you need from the trader, how to register, check and activate an MT4 or MT5 account, and how to follow it in your panel.
What you need
- Platform — MT4 or MT5.
- Broker — a broker listed under API → Brokers (see Brokers and broker requests).
- Server — the exact server name the trader's terminal shows, for example
Exness-MT5Trial12. - Login — the account number.
- Password — the master (trading) password to trade, or the investor (read-only) password to only read.
Passwords are stored encrypted and are only used to log your accounts in.
Register, check, activate
Accounts are managed through the API with a key that has the Manage permission:
POST /v1/accountsregisters the account. It starts in STANDBY and uses no active slot.POST /v1/accounts/{id}/checklogs in once and confirms the password works — do this before you hand the account to a user.POST /v1/accounts/{id}/activatestarts the permanent connection (ACTIVE).POST /v1/accounts/{id}/deactivatereturns it to STANDBY and frees the active slot;DELETE /v1/accounts/{id}removes it.
The Accounts & brokers page of the docs has every field and example.
Registering the same server and login again doesn't create a duplicate: it updates the stored passwords.
Follow your accounts in the panel
API → MT accounts lists every account with its State (Active, Standby), Connection (for example Connecting, Connected, Disconnected, Login rejected) and Authorization of the master and investor passwords. Click Refresh to update. The page is read-only — changes are made through the API.
Good practice
- Test on demo accounts first.
- Keep only accounts that need live data or fast trading ACTIVE; the rest can stay in STANDBY.
- Subscribe to
ACCOUNT_STATE_CHANGEDandAUTH_REJECTEDevents so you know when a trader changes their password. - Give every account an
externalRef(your own user or challenge ID) so you can find it later.
For developers
The API side of this topic, with every field and code examples: