Skip to content

Get accounts by group#

About#

Get accounts by group.

GET /users/current/mt4/provisioning-profiles/:profileId/groups/:groupName/accounts

For more information see swagger documentation

Headers#

Name Type Required Description
auth-token string Yes MetaApi account token. See Authentication & authorization

Path parameters#

Name Type Required Description
profileId string Yes Id of the provisioning profile that will be used as the basis
groupName string Yes Group name

Response#

  • 200 - Successfully retrieved accounts by group. Response schema: MetatraderUser
  • 400 - Request validation failed. Response schema: Error

Examples#

Example request:

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'auth-token: token' -d '{}' 'https://mt-manager-api-v1.new-york.agiliumtrade.ai/users/current/mt4/provisioning-profiles/profileId/groups/Example\\Group/accounts'

Example response:

[
  {
    "login": "876557",
    "address": "953 Some Address street",
    "balance": "100",
    "city": "Macon",
    "country": "USA",
    "email": "user@domain.tld",
    "group": "Example\\Group",
    "leverage": "100",
    "name": "Example User",
    "phone": "+1(546)936-0523",
    "state": "New York",
    "zip": "3456",
    "clientId": "5423512"
  }
]