Get MT4 Accounts
GET /public/v1/mt4/accounts
Query Parameters
| Key | Type | Required | Rule | Description |
|---|---|---|---|---|
| connection_id | string | Mandatory | minimum 0 | MT4 Server ID given by this API |
| skip | number | Optional | minimum 0 default 0 | the number of the records that is skipping from the full list |
| limit | number | Optional | minimum 0 maximum 500 default 10 | the number of records each page will show |
| user_id | string | Optional | length 8 | filter accounts by user id |
Expected HTTP status code
- 200
Response
| Name | Type | Description |
|---|---|---|
| count | number | total number of the list |
| records | array | list of accounts in array |
| records[].login | number | account login |
| records[].group | string | account trade group on server |
| records[].currency | string | account currency |
| records[].balance | number | account current balance |
| records[].credit | number | account credit |
| records[].available_withdrawal | number | account available balance, calculated using margin_free - credit |
| records[].balance_previous_month | number | balance as of the end of previous month |
| records[].balance_previous_day | number | balance at the end of previous day |
| records[].leverage | number | leverage |
| records[].equity | number | equity |
| records[].margin_free | number | size of free margin |
| records[].margin | number | size of reserved margin |
| records[].margin_level | number | margin level |
| records[].created_at | string | registration date |
| records[].last_active | string | time of account's last access to trade server |
| records[].name | string | name of account owner |
| records[].email | string | |
| records[].comment | string | comment of account |
| records[].agent_account | number | agent account number |
| records[].lead_source | string | utm_campaign= value set for desktop or mobile terminal download link used by client |
| records[].enable | number | flag of account activity (1 - active, 0 - not active) |
| records[].enable_readonly | number | flag of setting read-only mode without trading (1 - read-only mode on, 0 - read-only mode off) |
| records[].enable_change_password | number | flag of account's permission to change password (1 - password change allowed, 0 - password change prohibited) |
| records[].enable_otp | number | flag of permission to use one-time passwords (1 - OTP passwords use is allowed, 0 - OTP passwords use is prohibited) |
| records[].send_reports | number | flag of generating daily reports (1 - reports are allowed, 0 - reports are prohibited) |
| records[].profit | number | current (floating) profit for opened positions |
| records[].crm_user | object | account's CRM user information |
| records[].crm_user.id | string | CRM user ID |
| records[].crm_user.email | string | CRM user's email |
| records[].crm_user.name | string | CRM user's name |
| records[].crm_user.phone.number | string | CRM user's phone number |
| records[].crm_user.phone.country_code | string | CRM user's phone country code |
| records[].crm_user.owner_id | string | CRM user's owner's ID |
| records[].crm_user.owner_name | string | CRM user's owner's name |
| records[].crm_user.referrer_id | string | CRM user's referrer's ID |
| records[].crm_user.referrer_name | string | CRM user's referrer's name |
| records[].crm_user.rank_id | string | CRM user's rank ID |
| records[].crm_user.tier | string | CRM user's tier |
Error
| Code | Type | Description |
|---|---|---|
400 | mt4_connection_not_found | Cannot find connection from given connection_id |