MetatraderAccount (cloud.metaapi.sdk:metaapi-java-sdk 13.2.2 API)

java.lang.Object
- cloud.metaapi.sdk.meta_api.MetatraderAccount

public class MetatraderAccount
extends Object

Implements a MetaTrader account entity

Constructor Summary

Constructors
Constructor and Description
`MetatraderAccount(MetatraderAccountDto data, MetatraderAccountClient metatraderAccountClient, MetaApiWebsocketClient metaApiWebsocketClient, ConnectionRegistry connectionRegistry, ExpertAdvisorClient expertAdvisorClient, HistoricalMarketDataClient historicalMarketDataClient)` Constructs a MetaTrader account entity

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CompletableFuture<MetaApiConnection>`	`connect()` Connects to MetaApi with default history storage.
`CompletableFuture<MetaApiConnection>`	`connect(HistoryStorage historyStorage)` Connects to MetaApi.
`CompletableFuture<MetaApiConnection>`	`connect(HistoryStorage historyStorage, IsoTime historyStartTime)` Connects to MetaApi.
`CompletableFuture<ExpertAdvisor>`	`createExpertAdvisor(String expertId, ExpertAdvisorClient.NewExpertAdvisorDto expert)` Creates an expert advisor
`CompletableFuture<Void>`	`deploy()` Schedules account for deployment.
`String`	`getAccessToken()` Returns authorization access token to be used for accessing single account data.
`String`	`getApplication()` Returns application name to connect the account to.
`String`	`getBaseCurrency()` Returns 3-character ISO currency code of the account base currency.
`MetatraderAccountDto.ConnectionStatus`	`getConnectionStatus()` Returns terminal and broker connection status
`List<MetatraderAccountDto.CopyFactoryRole>`	`getCopyFactoryRoles()` Returns account roles for CopyFactory2 application
`CompletableFuture<ExpertAdvisor>`	`getExpertAdvisor(String expertId)` Retrieves a expert advisor of current account by id
`CompletableFuture<List<ExpertAdvisor>>`	`getExpertAdvisors()` Retrieves expert advisor of current account
`List<MetatraderAccountDto.Extension>`	`getExtensions()` Returns API extensions
`CompletableFuture<List<MetatraderCandle>>`	`getHistoricalCandles(String symbol, String timeframe)` Returns historical candles for a specific symbol and timeframe from the MetaTrader account.
`CompletableFuture<List<MetatraderCandle>>`	`getHistoricalCandles(String symbol, String timeframe, IsoTime startTime)` Returns historical candles for a specific symbol and timeframe from the MetaTrader account.
`CompletableFuture<List<MetatraderCandle>>`	`getHistoricalCandles(String symbol, String timeframe, IsoTime startTime, Integer limit)` Returns historical candles for a specific symbol and timeframe from the MetaTrader account.
`CompletableFuture<List<MetatraderTick>>`	`getHistoricalTicks(String symbol)` Returns historical ticks for a specific symbol from the MetaTrader account.
`CompletableFuture<List<MetatraderTick>>`	`getHistoricalTicks(String symbol, IsoTime startTime)` Returns historical ticks for a specific symbol from the MetaTrader account.
`CompletableFuture<List<MetatraderTick>>`	`getHistoricalTicks(String symbol, IsoTime startTime, Integer offset, Integer limit)` Returns historical ticks for a specific symbol from the MetaTrader account.
`String`	`getId()` Returns account id
`String`	`getLogin()` Returns account login
`int`	`getMagic()` Returns MetaTrader magic to place trades using
`Map<String,Object>`	`getMetadata()` Returns extra information which can be stored together with your account
`String`	`getName()` Returns account name
`String`	`getProvisioningProfileId()` Returns id of the account's provisioning profile
`String`	`getReliability()` Returns reliability value.
`int`	`getResourceSlots()` Returns number of resource slots to allocate to account.
`String`	`getServer()` Returns MetaTrader server which hosts the account
`MetatraderAccountDto.DeploymentState`	`getState()` Returns account deployment state
`List<String>`	`getTags()` Returns user-defined account tags
`String`	`getType()` Returns account type.
`int`	`getVersion()` Returns version value.
`CompletableFuture<Void>`	`increaseReliability()` Increases MetaTrader account reliability.
`boolean`	`isManualTrades()` Returns flag indicating if trades should be placed as manual trades on this account
`CompletableFuture<Void>`	`redeploy()` Schedules account for redeployment.
`CompletableFuture<Void>`	`reload()` Reloads MetaTrader account from API
`CompletableFuture<Void>`	`remove()` Removes MetaTrader account.
`CompletableFuture<Void>`	`undeploy()` Schedules account for undeployment.
`CompletableFuture<Void>`	`update(MetatraderAccountUpdateDto account)` Updates MetaTrader account data
`CompletableFuture<Void>`	`waitConnected()` Waits until API server has connected to the terminal and terminal has connected to the broker.
`CompletableFuture<Void>`	`waitConnected(Integer timeoutInSeconds, Integer intervalInMilliseconds)` Waits until API server has connected to the terminal and terminal has connected to the broker.
`CompletableFuture<Void>`	`waitDeployed(Integer timeoutInSeconds, Integer intervalInMilliseconds)` Waits until API server has finished deployment and account reached the DEPLOYED state.
`CompletableFuture<Void>`	`waitRemoved(Integer timeoutInSeconds, Integer intervalInMilliseconds)` Waits until account has been deleted.
`CompletableFuture<Void>`	`waitUndeployed(Integer timeoutInSeconds, Integer intervalInMilliseconds)` Waits until API server has finished undeployment and account reached the UNDEPLOYED state.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MetatraderAccount
```
public MetatraderAccount(MetatraderAccountDto data,
                         MetatraderAccountClient metatraderAccountClient,
                         MetaApiWebsocketClient metaApiWebsocketClient,
                         ConnectionRegistry connectionRegistry,
                         ExpertAdvisorClient expertAdvisorClient,
                         HistoricalMarketDataClient historicalMarketDataClient)
```
    Constructs a MetaTrader account entity
    
    Parameters:
    
    data - MetaTrader account data
    
    metatraderAccountClient - MetaTrader account REST API client
    
    metaApiWebsocketClient - MetaApi websocket client
    
    connectionRegistry - metatrader account connection registry
    
    expertAdvisorClient - expert advisor REST API client
    
    historicalMarketDataClient - historical market data REST API client
- Method Detail
  - getId
```
public String getId()
```
    Returns account id
    
    Returns:
    
    account id
  - getName
```
public String getName()
```
    Returns account name
    
    Returns:
    
    account name
  - getType
```
public String getType()
```
    Returns account type. Possible values are cloud, cloud-g1, cloud-g2 and self-hosted.
    
    Returns:
    
    account type
  - getLogin
```
public String getLogin()
```
    Returns account login
    
    Returns:
    
    account login
  - getServer
```
public String getServer()
```
    Returns MetaTrader server which hosts the account
    
    Returns:
    
    MetaTrader server which hosts the account
  - getProvisioningProfileId
```
public String getProvisioningProfileId()
```
    Returns id of the account's provisioning profile
    
    Returns:
    
    id of the account's provisioning profile
  - getApplication
```
public String getApplication()
```
    Returns application name to connect the account to. Currently allowed values are MetaApi and AgiliumTrade
    
    Returns:
    
    application name to connect the account to
  - getMagic
```
public int getMagic()
```
    Returns MetaTrader magic to place trades using
    
    Returns:
    
    MetaTrader magic to place trades using
  - getState
```
public MetatraderAccountDto.DeploymentState getState()
```
    Returns account deployment state
    
    Returns:
    
    account deployment state
  - getConnectionStatus
```
public MetatraderAccountDto.ConnectionStatus getConnectionStatus()
```
    Returns terminal and broker connection status
    
    Returns:
    
    terminal and broker connection status
  - getAccessToken
```
public String getAccessToken()
```
    Returns authorization access token to be used for accessing single account data. Intended to be used in browser API.
    
    Returns:
    
    authorization token
  - isManualTrades
```
public boolean isManualTrades()
```
    Returns flag indicating if trades should be placed as manual trades on this account
    
    Returns:
    
    flag indicating if trades should be placed as manual trades on this account
  - getExtensions
```
public List<MetatraderAccountDto.Extension> getExtensions()
```
    Returns API extensions
    
    Returns:
    
    API extensions
  - getMetadata
```
public Map<String,Object> getMetadata()
```
    Returns extra information which can be stored together with your account
    
    Returns:
    
    extra information which can be stored together with your account
  - getTags
```
public List<String> getTags()
```
    Returns user-defined account tags
    
    Returns:
    
    user-defined account tags
  - getCopyFactoryRoles
```
public List<MetatraderAccountDto.CopyFactoryRole> getCopyFactoryRoles()
```
    Returns account roles for CopyFactory2 application
    
    Returns:
    
    account roles for CopyFactory2 application
  - getResourceSlots
```
public int getResourceSlots()
```
    Returns 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
    
    Returns:
    
    number of resource slots to allocate to account
  - getBaseCurrency
```
public String getBaseCurrency()
```
    Returns 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.
    
    Returns:
    
    3-character ISO currency code of the account base currency
  - getReliability
```
public String getReliability()
```
    Returns reliability value. Possible values are regular and high
    
    Returns:
    
    account reliability value
  - getVersion
```
public int getVersion()
```
    Returns version value. Possible values are 4 and 5
    
    Returns:
    
    account version value
  - reload
```
public CompletableFuture<Void> reload()
```
    Reloads MetaTrader account from API
    
    Returns:
    
    completable future resolving when MetaTrader account is updated
  - remove
```
public CompletableFuture<Void> remove()
```
    Removes MetaTrader account. Cloud account transitions to DELETING state. It takes some time for an account to be eventually deleted. Self-hosted account is deleted immediately.
    
    Returns:
    
    completable future resolving when account is scheduled for deletion
  - deploy
```
public CompletableFuture<Void> deploy()
```
    Schedules account for deployment. It takes some time for API server to be started and account to reach the DEPLOYED state
    
    Returns:
    
    completable future resolving when account is scheduled for deployment
  - undeploy
```
public CompletableFuture<Void> undeploy()
```
    Schedules account for undeployment. It takes some time for API server to be stopped and account to reach the UNDEPLOYED state
    
    Returns:
    
    completable future resolving when account is scheduled for undeployment
  - redeploy
```
public CompletableFuture<Void> redeploy()
```
    Schedules account for redeployment. It takes some time for API server to be restarted and account to reach the DEPLOYED state
    
    Returns:
    
    completable future resolving when account is scheduled for redeployment
  - increaseReliability
```
public CompletableFuture<Void> increaseReliability()
```
    Increases MetaTrader account reliability. The account will be temporary stopped to perform this action
    
    Returns:
    
    completable future resolving when account reliability is increased
  - waitDeployed
```
public CompletableFuture<Void> waitDeployed(Integer timeoutInSeconds,
                                            Integer intervalInMilliseconds)
```
    Waits until API server has finished deployment and account reached the DEPLOYED state. Completes exceptionally with TimeoutException if account have not reached the DEPLOYED state withing timeout allowed.
    
    Parameters:
    
    timeoutInSeconds - optional wait timeout in seconds, default is 5m
    
    intervalInMilliseconds - optional interval between account reloads while waiting for a change, default is 1s
    
    Returns:
    
    completable future which resolves when account is deployed
  - waitUndeployed
```
public CompletableFuture<Void> waitUndeployed(Integer timeoutInSeconds,
                                              Integer intervalInMilliseconds)
```
    Waits until API server has finished undeployment and account reached the UNDEPLOYED state. Completes exceptionally with TimeoutException if account have not reached the UNDEPLOYED state withing timeout allowed.
    
    Parameters:
    
    timeoutInSeconds - optional wait timeout in seconds, default is 5m
    
    intervalInMilliseconds - optional interval between account reloads while waiting for a change, default is 1s
    
    Returns:
    
    completable future which resolves when account is undeployed
  - waitRemoved
```
public CompletableFuture<Void> waitRemoved(Integer timeoutInSeconds,
                                           Integer intervalInMilliseconds)
```
    Waits until account has been deleted. Completes exceptionally with TimeoutException if account was not deleted withing timeout allowed.
    
    Parameters:
    
    timeoutInSeconds - optional wait timeout in seconds, default is 5m
    
    intervalInMilliseconds - optional interval between account reloads while waiting for a change, default is 1s
    
    Returns:
    
    completable future which resolves when account is deleted
  - waitConnected
```
public CompletableFuture<Void> waitConnected()
```
    Waits until API server has connected to the terminal and terminal has connected to the broker. Completes exceptionally with TimeoutException if account have not connected to the broker withing timeout allowed. Wait timeout in seconds is 5m and interval between account reloads while waiting for a change is 1s.
    
    Returns:
    
    completable future which resolves when API server is connected to the broker
  - waitConnected
```
public CompletableFuture<Void> waitConnected(Integer timeoutInSeconds,
                                             Integer intervalInMilliseconds)
```
    Waits until API server has connected to the terminal and terminal has connected to the broker. Completes exceptionally with TimeoutException if account have not connected to the broker withing timeout allowed.
    
    Parameters:
    
    timeoutInSeconds - optional wait timeout in seconds, default is 5m
    
    intervalInMilliseconds - optional interval between account reloads while waiting for a change, default is 1s
    
    Returns:
    
    completable future which resolves when API server is connected to the broker
  - connect
```
public CompletableFuture<MetaApiConnection> connect()
```
    Connects to MetaApi with default history storage. There is only one connection per account. Subsequent calls to this method will return the same connection.
    
    Returns:
    
    MetaApi connection
  - connect
```
public CompletableFuture<MetaApiConnection> connect(HistoryStorage historyStorage)
```
    Connects to MetaApi. There is only one connection per account. Subsequent calls to this method will return the same connection.
    
    Parameters:
    
    historyStorage - optional history storage, or null
    
    Returns:
    
    MetaApi connection
  - connect
```
public CompletableFuture<MetaApiConnection> connect(HistoryStorage historyStorage,
                                                    IsoTime historyStartTime)
```
    Connects to MetaApi. There is only one connection per account. Subsequent calls to this method will return the same connection.
    
    Parameters:
    
    historyStorage - optional history storage, or null
    
    historyStartTime - history start time, or null. Used for tests
    
    Returns:
    
    MetaApi connection
  - update
```
public CompletableFuture<Void> update(MetatraderAccountUpdateDto account)
```
    Updates MetaTrader account data
    
    Parameters:
    
    account - MetaTrader account update
    
    Returns:
    
    completable future resolving when account is updated
  - getExpertAdvisors
```
public CompletableFuture<List<ExpertAdvisor>> getExpertAdvisors()
```
    Retrieves expert advisor of current account
    
    Returns:
    
    completable future resolving with an array of expert advisor entities
  - getExpertAdvisor
```
public CompletableFuture<ExpertAdvisor> getExpertAdvisor(String expertId)
```
    Retrieves a expert advisor of current account by id
    
    Parameters:
    
    expertId - expert advisor id
    
    Returns:
    
    completable future resolving with expert advisor entity
  - createExpertAdvisor
```
public CompletableFuture<ExpertAdvisor> createExpertAdvisor(String expertId,
                                                            ExpertAdvisorClient.NewExpertAdvisorDto expert)
```
    Creates an expert advisor
    
    Parameters:
    
    expertId - expert advisor id
    
    expert - expert advisor data
    
    Returns:
    
    completable future resolving with expert advisor entity
  - getHistoricalCandles
```
public CompletableFuture<List<MetatraderCandle>> getHistoricalCandles(String symbol,
                                                                      String timeframe)
```
    Returns historical candles for a specific symbol and timeframe from the MetaTrader account. See https://metaapi.cloud/docs/client/restApi/api/retrieveMarketData/readHistoricalCandles/
    
    Parameters:
    
    symbol - symbol to retrieve candles for (e.g. a currency pair or an index)
    
    timeframe - defines the timeframe according to which the candles must be generated. Allowed values for MT5 are 1m, 2m, 3m, 4m, 5m, 6m, 10m, 12m, 15m, 20m, 30m, 1h, 2h, 3h, 4h, 6h, 8h, 12h, 1d, 1w, 1mn. Allowed values for MT4 are 1m, 5m, 15m 30m, 1h, 4h, 1d, 1w, 1mn
    
    Returns:
    
    completable future promise resolving with historical candles downloaded
  - getHistoricalCandles
```
public CompletableFuture<List<MetatraderCandle>> getHistoricalCandles(String symbol,
                                                                      String timeframe,
                                                                      IsoTime startTime)
```
    Returns historical candles for a specific symbol and timeframe from the MetaTrader account. See https://metaapi.cloud/docs/client/restApi/api/retrieveMarketData/readHistoricalCandles/
    
    Parameters:
    
    symbol - symbol to retrieve candles for (e.g. a currency pair or an index)
    
    timeframe - defines the timeframe according to which the candles must be generated. Allowed values for MT5 are 1m, 2m, 3m, 4m, 5m, 6m, 10m, 12m, 15m, 20m, 30m, 1h, 2h, 3h, 4h, 6h, 8h, 12h, 1d, 1w, 1mn. Allowed values for MT4 are 1m, 5m, 15m 30m, 1h, 4h, 1d, 1w, 1mn
    
    startTime - time to start loading candles from. Note that candles are loaded in backwards direction, so this should be the latest time. Leave null to request latest candles.
    
    Returns:
    
    completable future promise resolving with historical candles downloaded
  - getHistoricalCandles
```
public CompletableFuture<List<MetatraderCandle>> getHistoricalCandles(String symbol,
                                                                      String timeframe,
                                                                      IsoTime startTime,
                                                                      Integer limit)
```
    Returns historical candles for a specific symbol and timeframe from the MetaTrader account. See https://metaapi.cloud/docs/client/restApi/api/retrieveMarketData/readHistoricalCandles/
    
    Parameters:
    
    symbol - symbol to retrieve candles for (e.g. a currency pair or an index)
    
    timeframe - defines the timeframe according to which the candles must be generated. Allowed values for MT5 are 1m, 2m, 3m, 4m, 5m, 6m, 10m, 12m, 15m, 20m, 30m, 1h, 2h, 3h, 4h, 6h, 8h, 12h, 1d, 1w, 1mn. Allowed values for MT4 are 1m, 5m, 15m 30m, 1h, 4h, 1d, 1w, 1mn
    
    startTime - time to start loading candles from. Note that candles are loaded in backwards direction, so this should be the latest time. Leave null to request latest candles.
    
    limit - maximum number of candles to retrieve, or null. Must be less or equal to 1000
    
    Returns:
    
    completable future resolving with historical candles downloaded
  - getHistoricalTicks
```
public CompletableFuture<List<MetatraderTick>> getHistoricalTicks(String symbol)
```
    Returns historical ticks for a specific symbol from the MetaTrader account. See https://metaapi.cloud/docs/client/restApi/api/retrieveMarketData/readHistoricalTicks/
    
    Parameters:
    
    symbol - symbol to retrieve ticks for (e.g. a currency pair or an index)
    
    Returns:
    
    completable future resolving with historical ticks downloaded
  - getHistoricalTicks
```
public CompletableFuture<List<MetatraderTick>> getHistoricalTicks(String symbol,
                                                                  IsoTime startTime)
```
    Returns historical ticks for a specific symbol from the MetaTrader account. See https://metaapi.cloud/docs/client/restApi/api/retrieveMarketData/readHistoricalTicks/
    
    Parameters:
    
    symbol - symbol to retrieve ticks for (e.g. a currency pair or an index)
    
    startTime - time to start loading ticks from. Note that ticks are loaded in forward direction, so this should be the earliest time. Leave null to request latest candles.
    
    Returns:
    
    completable future resolving with historical ticks downloaded
  - getHistoricalTicks
```
public CompletableFuture<List<MetatraderTick>> getHistoricalTicks(String symbol,
                                                                  IsoTime startTime,
                                                                  Integer offset,
                                                                  Integer limit)
```
    Returns historical ticks for a specific symbol from the MetaTrader account. See https://metaapi.cloud/docs/client/restApi/api/retrieveMarketData/readHistoricalTicks/
    
    Parameters:
    
    symbol - symbol to retrieve ticks for (e.g. a currency pair or an index)
    
    startTime - time to start loading ticks from. Note that ticks are loaded in forward direction, so this should be the earliest time. Leave null to request latest candles.
    
    offset - number of ticks to skip, or null (you can use it to avoid requesting ticks from previous request twice)
    
    limit - maximum number of ticks to retrieve, or null. Must be less or equal to 1000
    
    Returns:
    
    completable future resolving with historical ticks downloaded

Class MetatraderAccount

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MetatraderAccount

Method Detail

getId

getName

getType

getLogin

getServer

getProvisioningProfileId

getApplication

getMagic

getState

getConnectionStatus

getAccessToken

isManualTrades

getExtensions

getMetadata

getTags

getCopyFactoryRoles

getResourceSlots

getBaseCurrency

getReliability

getVersion

reload

remove

deploy

undeploy

redeploy

increaseReliability

waitDeployed

waitUndeployed

waitRemoved

waitConnected

waitConnected

connect

connect

connect

update

getExpertAdvisors

getExpertAdvisor

createExpertAdvisor

getHistoricalCandles

getHistoricalCandles

getHistoricalCandles

getHistoricalTicks

getHistoricalTicks

getHistoricalTicks