cloud.metaapi.sdk.clients.meta_api.models

Class MetatraderAccountDto

java.lang.Object

cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountDto

public class MetatraderAccountDto
extends Object

MetaTrader account model

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetatraderAccountDto.ConnectionStatus Terminal and broker connection status enum
static class	MetatraderAccountDto.CopyFactoryRole Account roles for CopyFactory2 application
static class	MetatraderAccountDto.DeploymentState Account deployment state enum
static class	MetatraderAccountDto.Extension Extension model

Field Summary

Fields

Modifier and Type	Field and Description
String	_id Account unique identifier
String	accessToken Authorization token to be used for accessing single account data.
String	application Application name to connect the account to.
String	baseCurrency 3-character ISO currency code of the account base currency.
MetatraderAccountDto.ConnectionStatus	connectionStatus Terminal and broker connection status
int	copyFactoryResourceSlots Number of CopyFactory 2 resource slots to allocate to account.
List<MetatraderAccountDto.CopyFactoryRole>	copyFactoryRoles Account roles for CopyFactory2 application, or null
List<MetatraderAccountDto.Extension>	extensions API extensions
String	login MetaTrader account number
long	magic MetaTrader magic to place trades using
Boolean	manualTrades Flag indicating if trades should be placed as manual trades, or null.
Map<String,Object>	metadata Extra information which can be stored together with your account
String	name MetaTrader account human-readable name in the MetaApi app
String	provisioningProfileId Id of the account's provisioning profile
Double	quoteStreamingIntervalInSeconds Quote streaming interval in seconds, or null.
String	region Region id to deploy account at.
String	reliability Used to increase the reliability of the account.
Integer	resourceSlots Number of resource slots to allocate to account.
boolean	riskManagementApiEnabled Flag indicating that risk management API should be enabled on account.
String	server MetaTrader server which hosts the account
Integer	slippage Default trade slippage in points.
MetatraderAccountDto.DeploymentState	state Account deployment state
String	symbol Any symbol provided by broker (required for G1 only), or null
List<String>	tags MetaTrader account tags, or null.
String	type Account type, can be cloud, cloud-g1, cloud-g2 or self-hosted.
int	version MetaTrader version

Constructor Summary

Constructors

Constructor and Description
MetatraderAccountDto()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_id

public String _id

Account unique identifier

name

public String name

MetaTrader account human-readable name in the MetaApi app

type

public String type

Account type, can be cloud, cloud-g1, cloud-g2 or self-hosted. Cloud and cloud-g2 are aliases.

login

public String login

MetaTrader account number

server

public String server

MetaTrader server which hosts the account

provisioningProfileId

public String provisioningProfileId

Id of the account's provisioning profile

application

public String application

Application name to connect the account to. Currently allowed values are MetaApi and AgiliumTrade

magic

public long magic

MetaTrader magic to place trades using

state

public MetatraderAccountDto.DeploymentState state

Account deployment state

connectionStatus

public MetatraderAccountDto.ConnectionStatus connectionStatus

Terminal and broker connection status

accessToken

public String accessToken

Authorization token to be used for accessing single account data. Intended to be used in browser API.

manualTrades

public Boolean manualTrades

Flag indicating if trades should be placed as manual trades, or null. Default is false. Supported on G2 only

quoteStreamingIntervalInSeconds

public Double quoteStreamingIntervalInSeconds

Quote streaming interval in seconds, or null. 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

version

public int version

MetaTrader version

tags

public List<String> tags

MetaTrader account tags, or null.

extensions

public List<MetatraderAccountDto.Extension> extensions

API extensions

metadata

public Map<String,Object> metadata

Extra information which can be stored together with your account

reliability

public String reliability

Used to increase the reliability of the account. Allowed values are regular and high. Default is regular

baseCurrency

public String baseCurrency

3-character ISO currency code of the account base currency. Default value is USD. The setting is to be used for copy trading accounts which use national currencies only, such as some Brazilian brokers. You should not alter this setting unless you understand what you are doing.

copyFactoryRoles

public List<MetatraderAccountDto.CopyFactoryRole> copyFactoryRoles

Account roles for CopyFactory2 application, or null

resourceSlots

public Integer resourceSlots

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 CopyFactory 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

public int copyFactoryResourceSlots

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.

symbol

public String symbol

Any symbol provided by broker (required for G1 only), or null

region

public String region

Region id to deploy account at. One of returned by the /users/current/regions endpoint

slippage

public Integer slippage

Default trade slippage in points. Should be greater or equal to zero. If null, system internal setting will be used which we believe is reasonable for most cases

riskManagementApiEnabled

public boolean riskManagementApiEnabled

Flag indicating that risk management API should be enabled on account. Default is false

Constructor Detail

MetatraderAccountDto

public MetatraderAccountDto()