Skip to content

Create MetaTrader 5 demo account

About

Creates MetaTrader 5 demo account

POST /users/current/provisioning-profiles/:profileId/mt5-demo-accounts

For more information see swagger documentation

Headers

Name Type Required Description
auth-token string Yes Authorization token. See Authentication and 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
languageId number Language id (default is 1)
leverage number Yes Account leverage
name string Account holder's name
phone string Account holder's phone
serverName string Yes Server name
state string Account holder's state
zip string Zip address

Response

  • 201 - Demo account created successfully. Response schema: MetatraderDemoAccount
  • 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,
  "serverName": "ICMarketsSC-Demo"
}' 'https://mt-provisioning-api-v1.agiliumtrade.agiliumtrade.ai/users/current/provisioning-profiles/profileId/mt5-demo-accounts'

Example response:

{
  "login": "86053193",
  "password": "2y8kpft",
  "investorPassword": "dc56esco",
  "serverName": "ICMarketsSC-Demo"
}