Skip to content

Update account

About

Updates specified metatrader account

PUT /users/current/accounts/:accountId

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
accountId string Yes MetaTrader account id

Body

Name Type Required Description
password string Yes MetaTrader account password. The password can be either investor password for read-only access or master password to enable trading features. Required for cloud account
name string Yes Human-readable account name
server string Yes MetaTrader server name to connect to
magic number Magic value the trades should be performed using. When manualTrades field is set to true, magic value must be 0
manualTrades boolean Flag indicating if trades placed on this account are manual trades. Default is false. Supported for G2 only.
slippage number Default trade slippage in points. Should be greater or equal to zero. If not specified, system internal setting will be used which we believe is reasonable for most cases
quoteStreamingIntervalInSeconds number Quote streaming interval in seconds. Set to 0 in order to receive quotes on each tick. Default value is 2.5 seconds. Intervals less than 2.5 seconds are supported only for G2.
extensions Array API extensions
tags Array User-defined account tags
metadata object Extra information which can be stored together with your account. Total length of this field after serializing it to JSON is limited to 1024 characters
copyFactoryRoles Array Account roles for CopyFactory2 application. Allowed values are PROVIDER and SUBSCRIBER
resourceSlots number Number of resource slots to allocate to account. Allocating extra resource slots results in better account performance under load which is useful for some applications. E.g. if you have many accounts copying the same strategy via CooyFactory API, then you can increase resourceSlots to get a lower trade copying latency. Please note that allocating extra resource slots is a paid option. Default is 1

Response

  • 204 - MetaTrader account updated
  • 401 - Authorization failed. Response schema: Error
  • 404 - MetaTrader account not found. Response schema: Error

Examples

Example request:

curl -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'auth-token: token' -d '{
    "password": "password",
    "name": "testAccount",
    "server": "ICMarketsSC-Demo"
}' 'https://mt-provisioning-api-v1.agiliumtrade.agiliumtrade.ai/users/current/accounts/1eda642a-a9a3-457c-99af-3bc5e8d5c4c9'