Skip to content

Create MetaTrader 5 demo account

About

Creates MetaTrader 5 demo account

Note: Not all brokers allow creating demo accounts this way. You can create a demo account for the broker which allows creating demo accounts via MT terminal. When creating a demo account please supply correct email and account type values. You can find available account type values in MT terminal. Please make sure the rate at which you create demo accounts is reasonably low, since your broker can rate limit the requests which will cause the API to return error. Your broker can also limit the number of demo accounts per email.

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. Please use a value of default in order to create an account based on provided MT server name only

Body

Name Type Required Description
accountType string Yes Account type. Available account type values can be found in mobile MT application or in MT terminal downloaded from our broker
balance number Yes Account balance
email string Yes Account holder's email
leverage number Yes Account leverage
name string Yes Account holder's name
phone string Yes Account holder's phone, in international format
serverName string Yes Server name

Response

  • 201 - Demo account created successfully. Response schema: MetatraderAccountCredentials
  • 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",
  "name": "Test User",
  "accountType": "type",
  "phone": "+12345678901"
}' '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"
}