Skip to content

Update account replica

About

Updates specified metatrader account replica

PUT /users/current/accounts/:accountId/replicas/:replicaId

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 primary account id
replicaId string Yes MetaTrader account replica id

Body

Name Type Required Description
magic number Magic value the trades should be performed using. When manualTrades field is set to true, magic value must be 0
magic 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
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
copyFactoryResourceSlots number Number of CopyFactory 2 resource slots to allocate to account. Allocating extra resource slots results in lower trade copying latency. Please note that allocating extra resource slots is a paid option. Please also note that CopyFactory 2 uses redundant infrastructure so that each CopyFactory resource slot is billed as 2 standard resource slots. You will be billed for CopyFactory 2 resource slots only if you have added your account to CopyFactory 2 by specifying copyFactoryRoles field. Default is 1

Response

  • 204 - MetaTrader account replica updated
  • 401 - Authorization failed. Response schema: Error
  • 404 - MetaTrader account replica 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 '{
    "magic": 1,
    "resourceSlots": 5
}' 'https://mt-provisioning-api-v1.agiliumtrade.agiliumtrade.ai/users/current/accounts/1eda642a-a9a3-457c-99af-3bc5e8d5c4c9/replicas/861ceafd-a58e-2fb9-a9bb-c9dd449f3bb4'