Get cTrader Accounts
GET
/public/v1/ctrader/accounts
Query Parameters
Key | Type | Required | Rule | Description |
---|---|---|---|---|
connection_id | string | Mandatory | minimum 0 | cTrader 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[].bonus | number | account current bonus |
records[].ib_bonus | number | bonus from IB |
records[].manager_bonus | number | bonus from broker |
records[].available_bonus | number | available bonus |
records[].available_withdrawal | number | account available balance |
records[].leverage | number | leverage |
records[].equity | number | equity |
records[].created_at | string | registration date |
records[].name | string | name of account owner |
records[].email | string | |
records[].access_rights | number | cTrader account access rights |
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 | trade_connection_not_found | Cannot find connection from given connection_id |