MetatraderAccountReplica
About
Metatrader account replica model
Fields
Name | Type | Required | Description |
---|---|---|---|
_id | string | Yes | account replica id |
magic | number | magic value the trades should be performed using | |
connectionStatus | string | Yes | connection status of the MetaTrader terminal to the application, enum: CONNECTED , DISCONNECTED , DISCONNECTED_FROM_BROKER |
state | string | Yes | current account state, enum: CREATED , DEPLOYING , DEPLOYED , UNDEPLOYING , UNDEPLOYED , DELETING |
region | string | Yes | Region id to deploy account at. One of returned by the /users/current/regions endpoint |
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<Extension> | 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 | |
reliability | string | Used to increase the reliability of the account. Allowed values are regular and high. Default is regular. 'high' is a recommended value for production environment | |
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 |
Example
{
"_id": "1eda642a-a9a3-457c-99af-3bc5e8d5c4c9",
"name": "mt5a",
"magic": 123456,
"connectionStatus": "DISCONNECTED",
"state": "DEPLOYED",
"manualTrades": true,
"quoteStreamingIntervalInSeconds": 2.5
}