Skip to content

Create MT5 account#

About#

Creates MT5 account.

POST /users/current/mt5/provisioning-profiles/:profileId/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 for creating this account

Body#

Name Type Required Description
address string Account holder's address
balance number Yes Account balance
city string Account holder's city
country string Account holder's country
email string Yes Account holder's email
group string Yes A group of accounts in accordance with the hierarchy of groups in the trading platform
leverage number Yes Account leverage
firstName string Account holder's first name
lastName string Account holder's last name
middleName string Account holder's middle name
phone string Account holder's phone
state string Account holder's state
zip string Zip address
leadSource string Lead source
leadCampaign string Lead campaign
clientId number Client ID
enabled boolean Is account enabled. Default is true

Response#

  • 201 - Account created successfully. Response schema: MetatraderAccount
  • 400 - Validation failed. Response schema: Error
  • 401 - Authorization failed. Response schema: Error
  • 403 - user is not permitted to create account. Response schema: Error
  • 404 - Provisioning profile with specified id not found. Response schema: Error

Examples#

Example request:

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'auth-token: token' -d '{
  "balance": 1000,
  "email": "example@examle.com",
  "leverage": 10,
  "group": "Exness-Trial4"
}' 'https://mt-manager-api-v1.vint-hill.agiliumtrade.ai/users/current/mt5/provisioning-profiles/profileId/accounts'

Example response:

{
  "login": "86053193", 
  "password": "2y8kpft", 
  "investorPassword": "dc56esco"
}