Skip navigation links
A B C D E F G H I J L M N O P Q R S T U V W _ 

A

accessToken - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountDto
Authorization token to be used for accessing single account data.
accountCurrencyExchangeRate - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal
Current exchange rate of account currency into USD, or null
accountCurrencyExchangeRate - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
Current exchange rate of account currency into USD, or null
accountCurrencyExchangeRate - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition
Current exchange rate of account currency into USD, or null
accountCurrencyExchangeRate - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderSymbolPrice
Current exchange rate of account currency into USD, or null
accountId - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryTransaction
CopyFactory account id
AccountsFilter - Class in cloud.metaapi.sdk.clients.meta_api.models
 
AccountsFilter() - Constructor for class cloud.metaapi.sdk.clients.meta_api.models.AccountsFilter
 
AccountType - Enum in cloud.metaapi.sdk.clients.meta_api.models
Account type
actionType - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderTrade
Action type
addReconnectListener(ReconnectListener) - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Adds reconnect listener
addSynchronizationListener(String, SynchronizationListener) - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Adds synchronization listener for specific account
addSynchronizationListener(SynchronizationListener) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Adds synchronization listener
amount - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryTransaction
Trade amount, or null
ApiException - Exception in cloud.metaapi.sdk.clients.error_handler
Base class for API errors.
ApiException(String, int) - Constructor for exception cloud.metaapi.sdk.clients.error_handler.ApiException
ApiError constructor
ApiException(String, int, Throwable) - Constructor for exception cloud.metaapi.sdk.clients.error_handler.ApiException
ApiError constructor
application - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountDto
Application name to connect the account to.
application - Variable in class cloud.metaapi.sdk.clients.meta_api.models.NewMetatraderAccountDto
Application name to connect the account to.
applyTo - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyRiskLimit
Account metric to apply limit to.
ask - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderSymbolPrice
Ask price

B

balance - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountInformation
Account balance
bid - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderSymbolPrice
Bid price
billingPeriod - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyComissionScheme
Billing period.
breakingNewsFilter - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyNewsFilter
Optional breaking news filter, or null
broker - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountInformation
Broker name
brokerTime - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal
Time the deal was conducted at, in broker timezone, YYYY-MM-DD HH:mm:ss.SSS format
brokerTime - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
Time order was created at, in broker timezone, YYYY-MM-DD HH:mm:ss.SSS format
brokerTime - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition
Time position was opened at, in broker timezone, YYYY-MM-DD HH:mm:ss.SSS format
brokerTime - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderSymbolPrice
Quote time, in broker timezone, YYYY-MM-DD HH:mm:ss.SSS format

C

calendarNewsFilter - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyNewsFilter
Optional calendar news filter, or null
cancelOrder(String) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Cancels order (see https://metaapi.cloud/docs/client/websocket/api/trade/).
clientId - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal
Client-assigned id or null.
clientId - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
Client-assigned id or null.
clientId - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition
Client-assigned id or null.
clientId - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderTrade
Client-assigned id or null.
clientId - Variable in class cloud.metaapi.sdk.clients.meta_api.models.TradeOptions
Optional client-assigned id or null.
close() - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Closes connection to MetaApi server
close() - Method in class cloud.metaapi.sdk.meta_api.MetaApi
Closes all clients and connections
close() - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Closes the connection.
closeOnly - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryAccountUpdate
Optional setting which instructs the application not to open new positions. by-symbol means that it is still allowed to open new positions with a symbol equal to the symbol of an existing strategy position (can be used to gracefuly exit strategies trading in netting mode or placing a series of related trades per symbol).
closeOnly - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategySubscription
Optional setting wich instructs the application not to open new positions, or null. by-symbol means that it is still allowed to open new positions with a symbol equal to the symbol of an existing strategy position (can be used to gracefuly exit strategies trading in netting mode or placing a series of related trades per symbol).
closePosition(String, MarketTradeOptions) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Fully closes a position (see https://metaapi.cloud/docs/client/websocket/api/trade/).
closePositionPartially(String, double, MarketTradeOptions) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Partially closes a position (see https://metaapi.cloud/docs/client/websocket/api/trade/).
closePositions - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyRiskLimit
Whether to force close positions when the risk is reached.
closePositionsBySymbol(String, MarketTradeOptions) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Closes position by a symbol (see https://metaapi.cloud/docs/client/websocket/api/trade/)
closePositionTimeGapInMinutes - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyBreakingNewsFilter
Optional time interval specifying when to force close an already open position before calendar news, or null.
closePositionTimeGapInMinutes - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyCalendarNewsFilter
Optional time interval specifying when to force close an already open position before calendar news, or null.
cloud.metaapi.sdk.clients - package cloud.metaapi.sdk.clients
 
cloud.metaapi.sdk.clients.copy_factory - package cloud.metaapi.sdk.clients.copy_factory
 
cloud.metaapi.sdk.clients.copy_factory.models - package cloud.metaapi.sdk.clients.copy_factory.models
 
cloud.metaapi.sdk.clients.error_handler - package cloud.metaapi.sdk.clients.error_handler
 
cloud.metaapi.sdk.clients.meta_api - package cloud.metaapi.sdk.clients.meta_api
 
cloud.metaapi.sdk.clients.meta_api.models - package cloud.metaapi.sdk.clients.meta_api.models
 
cloud.metaapi.sdk.clients.models - package cloud.metaapi.sdk.clients.models
 
cloud.metaapi.sdk.copy_factory - package cloud.metaapi.sdk.copy_factory
 
cloud.metaapi.sdk.meta_api - package cloud.metaapi.sdk.meta_api
 
cloud.metaapi.sdk.util - package cloud.metaapi.sdk.util
 
comment - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal
Deal comment or null.
comment - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
Order comment or null.
comment - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition
Position comment or null.
comment - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderTrade
Order comment or null.
comment - Variable in class cloud.metaapi.sdk.clients.meta_api.models.TradeOptions
Optional order comment or null.
commission - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryTransaction
Trade commission or null
commission - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal
Deal commission or null
commission - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition
Position commission
commissionRate - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyComissionScheme
Commission rate.
commissionScheme - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyUpdate
Commission scheme allowed by this strategy, or null
ConfigurationClient - Class in cloud.metaapi.sdk.clients.copy_factory
metaapi.cloud CopyFactory configuration API (trade copying configuration API) client (see https://trading-api-v1.project-stock.agiliumlabs.cloud/swagger/#/)
ConfigurationClient(HttpClient, String) - Constructor for class cloud.metaapi.sdk.clients.copy_factory.ConfigurationClient
Constructs CopyFactory configuration API client instance.
ConfigurationClient(HttpClient, String, String) - Constructor for class cloud.metaapi.sdk.clients.copy_factory.ConfigurationClient
Constructs CopyFactory configuration API client instance
ConflictException - Exception in cloud.metaapi.sdk.clients.error_handler
Represents conflict error.
ConflictException(String) - Constructor for exception cloud.metaapi.sdk.clients.error_handler.ConflictException
Constructs conflict error.
connect() - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Connects to MetaApi server via socket.io protocol
connect(MetatraderAccount, HistoryStorage) - Method in class cloud.metaapi.sdk.meta_api.ConnectionRegistry
Creates and returns a new account connection if doesnt exist, otherwise returns old
connect() - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccount
Connects to MetaApi with default history storage.
connect(HistoryStorage) - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccount
Connects to MetaApi.
connectionId - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryAccountUpdate
Id of the MetaApi MetaTrader account this copy trading account is connected to
connectionId - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyUpdate
Id of the MetaApi account providing the strategy
ConnectionRegistry - Class in cloud.metaapi.sdk.meta_api
Manages account connections
ConnectionRegistry(MetaApiWebsocketClient) - Constructor for class cloud.metaapi.sdk.meta_api.ConnectionRegistry
Constructs a MetaTrader connection registry instance
connectionStatus - Variable in class cloud.metaapi.sdk.clients.meta_api.models.AccountsFilter
Connection status or null
connectionStatus - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountDto
Terminal and broker connection status
CopyFactory - Class in cloud.metaapi.sdk.copy_factory
MetaApi CopyFactory copy trading API SDK
CopyFactory(String) - Constructor for class cloud.metaapi.sdk.copy_factory.CopyFactory
Constructs CopyFactory class instance.
CopyFactory(String, String, int, int) - Constructor for class cloud.metaapi.sdk.copy_factory.CopyFactory
Constructs CopyFactory class instance
CopyFactoryAccount - Class in cloud.metaapi.sdk.clients.copy_factory.models
CopyFactory account model
CopyFactoryAccount() - Constructor for class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryAccount
 
CopyFactoryAccountUpdate - Class in cloud.metaapi.sdk.clients.copy_factory.models
CopyFactory account update
CopyFactoryAccountUpdate() - Constructor for class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryAccountUpdate
 
CopyFactoryStrategy - Class in cloud.metaapi.sdk.clients.copy_factory.models
CopyFactory provider strategy
CopyFactoryStrategy() - Constructor for class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategy
 
CopyFactoryStrategyBreakingNewsFilter - Class in cloud.metaapi.sdk.clients.copy_factory.models
CopyFactory breaking news risk filter
CopyFactoryStrategyBreakingNewsFilter() - Constructor for class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyBreakingNewsFilter
 
CopyFactoryStrategyCalendarNewsFilter - Class in cloud.metaapi.sdk.clients.copy_factory.models
CopyFactory calendar new filter
CopyFactoryStrategyCalendarNewsFilter() - Constructor for class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyCalendarNewsFilter
 
CopyFactoryStrategyComissionScheme - Class in cloud.metaapi.sdk.clients.copy_factory.models
CopyFactory strategy commission scheme
CopyFactoryStrategyComissionScheme() - Constructor for class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyComissionScheme
 
CopyFactoryStrategyIdAndName - Class in cloud.metaapi.sdk.clients.copy_factory.models
CopyFactory strategy id and name
CopyFactoryStrategyIdAndName() - Constructor for class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyIdAndName
 
CopyFactoryStrategyMagicFilter - Class in cloud.metaapi.sdk.clients.copy_factory.models
CopyFactory strategy magic filter
CopyFactoryStrategyMagicFilter() - Constructor for class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyMagicFilter
 
CopyFactoryStrategyMaxStopLoss - Class in cloud.metaapi.sdk.clients.copy_factory.models
CopyFactory strategy max stop loss settings
CopyFactoryStrategyMaxStopLoss() - Constructor for class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyMaxStopLoss
 
CopyFactoryStrategyNewsFilter - Class in cloud.metaapi.sdk.clients.copy_factory.models
CopyFactory news risk filter
CopyFactoryStrategyNewsFilter() - Constructor for class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyNewsFilter
 
CopyFactoryStrategyRiskLimit - Class in cloud.metaapi.sdk.clients.copy_factory.models
CopyFactory risk limit filter
CopyFactoryStrategyRiskLimit() - Constructor for class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyRiskLimit
 
CopyFactoryStrategyStopout - Class in cloud.metaapi.sdk.clients.copy_factory.models
CopyFactory strategy stopout
CopyFactoryStrategyStopout() - Constructor for class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyStopout
 
CopyFactoryStrategyStopOutRisk - Class in cloud.metaapi.sdk.clients.copy_factory.models
CopyFactory strategy stopout settings
CopyFactoryStrategyStopOutRisk() - Constructor for class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyStopOutRisk
 
CopyFactoryStrategySubscription - Class in cloud.metaapi.sdk.clients.copy_factory.models
CopyFactory strategy subscriptions
CopyFactoryStrategySubscription() - Constructor for class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategySubscription
 
CopyFactoryStrategySymbolFilter - Class in cloud.metaapi.sdk.clients.copy_factory.models
CopyFactory symbol filter
CopyFactoryStrategySymbolFilter() - Constructor for class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategySymbolFilter
 
CopyFactoryStrategyTimeSettings - Class in cloud.metaapi.sdk.clients.copy_factory.models
CopyFactory strategy time settings
CopyFactoryStrategyTimeSettings() - Constructor for class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyTimeSettings
 
CopyFactoryStrategyUpdate - Class in cloud.metaapi.sdk.clients.copy_factory.models
CopyFactory strategy update
CopyFactoryStrategyUpdate() - Constructor for class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyUpdate
 
CopyFactorySubscriberOrProvider - Class in cloud.metaapi.sdk.clients.copy_factory.models
CopyFactory provider or subscriber
CopyFactorySubscriberOrProvider() - Constructor for class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactorySubscriberOrProvider
 
CopyFactoryTransaction - Class in cloud.metaapi.sdk.clients.copy_factory.models
CopyFactory transaction
CopyFactoryTransaction() - Constructor for class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryTransaction
 
create(MetaApiWebsocketClient, MetatraderAccount, HistoryStorage, ConnectionRegistry) - Method in interface cloud.metaapi.sdk.util.ServiceProvider.MetaApiConnectionProvider
Creates MetaApiConnection mock
createAccount(NewMetatraderAccountDto) - Method in class cloud.metaapi.sdk.clients.meta_api.MetatraderAccountClient
Starts cloud API server for a MetaTrader account using specified provisioning profile (see https://metaapi.cloud/docs/provisioning/api/account/createAccount/).
createAccount(NewMetatraderAccountDto) - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccountApi
Creates a MetaTrader account
createHistoryFileManager(String, HistoryStorage) - Static method in class cloud.metaapi.sdk.util.ServiceProvider
Constructs history file manager with its corresponding constructor or returns a mock if it is set.
createLimitBuyOrder(String, double, double, Double, Double, PendingTradeOptions) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Creates a limit buy order (see https://metaapi.cloud/docs/client/websocket/api/trade/).
createLimitSellOrder(String, double, double, Double, Double, PendingTradeOptions) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Creates a limit sell order (see https://metaapi.cloud/docs/client/websocket/api/trade/).
createMarketBuyOrder(String, double, Double, Double, MarketTradeOptions) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Creates a market buy order (see https://metaapi.cloud/docs/client/websocket/api/trade/).
createMarketSellOrder(String, double, Double, Double, MarketTradeOptions) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Creates a market sell order (see https://metaapi.cloud/docs/client/websocket/api/trade/).
createMetaApiConnection(MetaApiWebsocketClient, MetatraderAccount, HistoryStorage, ConnectionRegistry) - Static method in class cloud.metaapi.sdk.util.ServiceProvider
Constructs metaapi connection with its corresponding constructor or returns a mock if it is set.
createProvisioningProfile(NewProvisioningProfileDto) - Method in class cloud.metaapi.sdk.clients.meta_api.ProvisioningProfileClient
Creates a new provisioning profile (see https://metaapi.cloud/docs/provisioning/api/provisioningProfile/createNewProvisioningProfile/).
createProvisioningProfile(NewProvisioningProfileDto) - Method in class cloud.metaapi.sdk.meta_api.ProvisioningProfileApi
Creates a provisioning profile
createStopBuyOrder(String, double, double, Double, Double, PendingTradeOptions) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Creates a stop buy order (see https://metaapi.cloud/docs/client/websocket/api/trade/).
createStopSellOrder(String, double, double, Double, Double, PendingTradeOptions) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Creates a stop sell order (see https://metaapi.cloud/docs/client/websocket/api/trade/).
currency - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountInformation
Account base currency ISO code
currentPrice - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
Current price
currentPrice - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition
Current price
currentTickValue - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition
Current tick value
currentVolume - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
Order remaining quantity, i.e. requested quantity - filled quantity

D

deals - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeals
List of history deals returned
deals - Variable in class cloud.metaapi.sdk.meta_api.HistoryFileManager.History
List of history deals
deleteAccount(String) - Method in class cloud.metaapi.sdk.clients.meta_api.MetatraderAccountClient
Stops and deletes an API server for a specified MetaTrader account.
deleteProvisioningProfile(String) - Method in class cloud.metaapi.sdk.clients.meta_api.ProvisioningProfileClient
Deletes a provisioning profile (see https://metaapi.cloud/docs/provisioning/api/provisioningProfile/deleteProvisioningProfile/).
deleteStorageFromDisk() - Method in class cloud.metaapi.sdk.meta_api.HistoryFileManager
Deletes storage files from disk
demo - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryTransaction
Demo account flag
deploy() - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccount
Schedules account for deployment.
deployAccount(String) - Method in class cloud.metaapi.sdk.clients.meta_api.MetatraderAccountClient
Starts API server for MetaTrader account.
description - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyUpdate
Longer strategy human-readable description
details - Variable in exception cloud.metaapi.sdk.clients.error_handler.ValidationException
Validation error details
details - Variable in class cloud.metaapi.sdk.clients.models.Error
Additional information about error or null.
doneBrokerTime - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
Time order was executed or canceled at, in broker timezone, YYYY-MM-DD HH:mm:ss.SSS format, or null.
doneTime - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
Time order was executed or canceled at or null.

E

entryType - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal
Deal entry type or null
equity - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountInformation
Account liquidation value
Error - Class in cloud.metaapi.sdk.clients.models
Contains an error message
Error() - Constructor for class cloud.metaapi.sdk.clients.models.Error
 
error - Variable in class cloud.metaapi.sdk.clients.models.Error
Error name
excluded - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyMagicFilter
List of magics (expert ids) or magic ranges excluded from copying, or null.
excluded - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategySymbolFilter
List of symbols excluded from copying, or null.
executionMode - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderSymbolSpecification
Deal execution mode
expiration - Variable in class cloud.metaapi.sdk.clients.meta_api.models.PendingTradeOptions
Optional pending order expiration settings or null.
ExpirationOptions - Class in cloud.metaapi.sdk.clients.meta_api.models
Pending order expiration settings
ExpirationOptions() - Constructor for class cloud.metaapi.sdk.clients.meta_api.models.ExpirationOptions
 
ExpirationOptions.ExpirationType - Enum in cloud.metaapi.sdk.clients.meta_api.models
Type pending order expiration type.
expirationTime - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
Optional order expiration time or null
expirationType - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
Order expiration type

F

FileStreamField(File) - Constructor for class cloud.metaapi.sdk.clients.HttpRequestOptions.FileStreamField
Constructs the file field wrapper from File object
FileStreamField(InputStream, String) - Constructor for class cloud.metaapi.sdk.clients.HttpRequestOptions.FileStreamField
Constructs the file field wrapper from InputStream and the file name
fillingMode - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
Order filling mode
fillingModes - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MarketTradeOptions
Optional allowed filling modes in the order of priority or null.
fillingModes - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderSymbolSpecification
List of allowed order filling modes
fillingModes - Variable in class cloud.metaapi.sdk.clients.meta_api.models.TradeOptions
Optional allowed filling modes in the order of priority or null.
ForbiddenException - Exception in cloud.metaapi.sdk.clients.error_handler
Throwing this error results in 403 (Forbidden) HTTP response code.
ForbiddenException(String) - Constructor for exception cloud.metaapi.sdk.clients.error_handler.ForbiddenException
Constructs forbidden error.
freeMargin - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountInformation
Free margin

G

generateAccountId() - Method in class cloud.metaapi.sdk.clients.copy_factory.ConfigurationClient
Generates random account id
generateStrategyId() - Method in class cloud.metaapi.sdk.clients.copy_factory.ConfigurationClient
Retrieves new unused strategy id.
getAccessToken() - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccount
Returns authorization access token to be used for accessing single account data.
getAccount(String) - Method in class cloud.metaapi.sdk.clients.meta_api.MetatraderAccountClient
Retrieves a MetaTrader account by id (see https://metaapi.cloud/docs/provisioning/api/account/readAccount/).
getAccount(String) - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccountApi
Retrieves a MetaTrader account by id
getAccountByToken() - Method in class cloud.metaapi.sdk.clients.meta_api.MetatraderAccountClient
Retrieves a MetaTrader account by token (see https://metaapi.cloud/docs/provisioning/api/account/readAccount/).
getAccountByToken() - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccountApi
Retrieves a MetaTrader account by token
getAccountInformation(String) - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Returns account information for a specified MetaTrader account (see https://metaapi.cloud/docs/client/websocket/api/readTradingTerminalState/readAccountInformation/).
getAccountInformation() - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Returns account information (see https://metaapi.cloud/docs/client/websocket/api/readTradingTerminalState/readAccountInformation/).
getAccountInformation() - Method in class cloud.metaapi.sdk.meta_api.TerminalState
Returns a local copy of account information
getAccounts() - Method in class cloud.metaapi.sdk.clients.copy_factory.ConfigurationClient
Retrieves CopyFactory copy trading accounts.
getAccounts(AccountsFilter) - Method in class cloud.metaapi.sdk.clients.meta_api.MetatraderAccountClient
Retrieves MetaTrader accounts owned by user (see https://metaapi.cloud/docs/provisioning/api/account/readAccounts/).
getAccounts() - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccountApi
Retrieves MetaTrader accounts without filtering
getAccounts(AccountsFilter) - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccountApi
Retrieves MetaTrader accounts
getApplication() - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccount
Returns application name to connect the account to.
getArguments() - Method in exception cloud.metaapi.sdk.clients.error_handler.ApiException
Returns message arguments for i18n
getBodyFields() - Method in class cloud.metaapi.sdk.clients.HttpRequestOptions
Returns fields of the request form data body
getBodyJson() - Method in class cloud.metaapi.sdk.clients.HttpRequestOptions
Returns the json body of a request
getCode() - Method in exception cloud.metaapi.sdk.clients.error_handler.ApiException
Returns error code used for i18n
getConfigurationApi() - Method in class cloud.metaapi.sdk.copy_factory.CopyFactory
Returns CopyFactory configuration API
getConnectionStatus() - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccount
Returns terminal and broker connection status
getDate() - Method in class cloud.metaapi.sdk.clients.models.IsoTime
Returns wrapper time as Date object
getDeals() - Method in class cloud.metaapi.sdk.meta_api.HistoryStorage
Returns all deals stored in history storage
getDeals() - Method in class cloud.metaapi.sdk.meta_api.MemoryHistoryStorage
 
getDealsByPosition(String, String) - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Returns history deals for a specific position id (see https://metaapi.cloud/docs/client/websocket/api/retrieveHistoricalData/readDealsByPosition/).
getDealsByPosition(String) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Returns history deals for a specific position id (see https://metaapi.cloud/docs/client/websocket/api/retrieveHistoricalData/readDealsByPosition/).
getDealsByTicket(String, String) - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Returns history deals with a specific ticket number (see https://metaapi.cloud/docs/client/websocket/api/retrieveHistoricalData/readDealsByTicket/).
getDealsByTicket(String) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Returns history deals with a specific ticket number (see https://metaapi.cloud/docs/client/websocket/api/retrieveHistoricalData/readDealsByTicket/).
getDealsByTimeRange(String, IsoTime, IsoTime, int, int) - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Returns history deals with for a specific time range (see https://metaapi.cloud/docs/client/websocket/api/retrieveHistoricalData/readDealsByTimeRange/).
getDealsByTimeRange(IsoTime, IsoTime, int, int) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Returns history deals with for a specific time range (see https://metaapi.cloud/docs/client/websocket/api/retrieveHistoricalData/readDealsByTimeRange/).
getFileName() - Method in class cloud.metaapi.sdk.clients.HttpRequestOptions.FileStreamField
Returns the file name under which the file will be sent in request
getHeaders() - Method in class cloud.metaapi.sdk.clients.HttpRequestOptions
Returns headers of request.
getHistoryApi() - Method in class cloud.metaapi.sdk.copy_factory.CopyFactory
Returns CopyFactory history API
getHistoryFromDisk() - Method in class cloud.metaapi.sdk.meta_api.HistoryFileManager
Retrieves history from saved file
getHistoryOrders() - Method in class cloud.metaapi.sdk.meta_api.HistoryStorage
Returns all history orders stored in history storage
getHistoryOrders() - Method in class cloud.metaapi.sdk.meta_api.MemoryHistoryStorage
 
getHistoryOrdersByPosition(String, String) - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Returns the history of completed orders for a specific position id (see https://metaapi.cloud/docs/client/websocket/api/retrieveHistoricalData/readHistoryOrdersByPosition/)
getHistoryOrdersByPosition(String) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Returns the history of completed orders for a specific position id (see https://metaapi.cloud/docs/client/websocket/api/retrieveHistoricalData/readHistoryOrdersByPosition/)
getHistoryOrdersByTicket(String, String) - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Returns the history of completed orders for a specific ticket number (see https://metaapi.cloud/docs/client/websocket/api/retrieveHistoricalData/readHistoryOrdersByTicket/).
getHistoryOrdersByTicket(String) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Returns the history of completed orders for a specific ticket number (see https://metaapi.cloud/docs/client/websocket/api/retrieveHistoricalData/readHistoryOrdersByTicket/).
getHistoryOrdersByTimeRange(String, IsoTime, IsoTime, int, int) - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Returns the history of completed orders for a specific time range (see https://metaapi.cloud/docs/client/websocket/api/retrieveHistoricalData/readHistoryOrdersByTimeRange/).
getHistoryOrdersByTimeRange(IsoTime, IsoTime, int, int) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Returns the history of completed orders for a specific time range (see https://metaapi.cloud/docs/client/websocket/api/retrieveHistoricalData/readHistoryOrdersByTimeRange/)
getHistoryStorage() - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Returns local history storage
getId() - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccount
Returns account id
getId() - Method in class cloud.metaapi.sdk.meta_api.ProvisioningProfile
Returns profile id
getInstance() - Static method in class cloud.metaapi.sdk.util.JsonMapper
Returns a singleton instance of a configured JSON object mapper
getIsoString() - Method in class cloud.metaapi.sdk.clients.models.IsoTime
Returns wrapper time in ISO format
getItemSize(Object) - Method in class cloud.metaapi.sdk.meta_api.HistoryFileManager
Helper function to calculate object size in bytes in utf-8 encoding
getLastDealTime() - Method in class cloud.metaapi.sdk.meta_api.HistoryStorage
Returns the time of the last history deal record stored in the history storage
getLastDealTime() - Method in class cloud.metaapi.sdk.meta_api.MemoryHistoryStorage
 
getLastHistoryOrderTime() - Method in class cloud.metaapi.sdk.meta_api.HistoryStorage
Returns the time of the last history order record stored in the history storage
getLastHistoryOrderTime() - Method in class cloud.metaapi.sdk.meta_api.MemoryHistoryStorage
 
getLogin() - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccount
Returns account login
getMagic() - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccount
Returns MetaTrader magic to place trades using
getMessage() - Method in exception cloud.metaapi.sdk.clients.MethodAccessException
 
getMetatraderAccountApi() - Method in class cloud.metaapi.sdk.meta_api.MetaApi
Returns MetaTrader account API
getMethod() - Method in class cloud.metaapi.sdk.clients.HttpRequestOptions
Returns HTTP method used for request
getName() - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccount
Returns account name
getName() - Method in class cloud.metaapi.sdk.meta_api.ProvisioningProfile
Returns profile name
getNumber() - Method in enum cloud.metaapi.sdk.clients.meta_api.models.Version
Returns version number
getOrder(String, String) - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Returns specific open order for a MetaTrader account (see https://metaapi.cloud/docs/client/websocket/api/readTradingTerminalState/readOrder/).
getOrder(String) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Returns specific open order (see https://metaapi.cloud/docs/client/websocket/api/readTradingTerminalState/readOrder/).
getOrders(String) - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Returns open orders for a specified MetaTrader account (see https://metaapi.cloud/docs/client/websocket/api/readTradingTerminalState/readOrders/).
getOrders() - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Returns open orders (see https://metaapi.cloud/docs/client/websocket/api/readTradingTerminalState/readOrders/).
getOrders() - Method in class cloud.metaapi.sdk.meta_api.TerminalState
Returns a local copy of MetaTrader orders opened
getPosition(String, String) - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Returns specific position for a MetaTrader account (see https://metaapi.cloud/docs/client/websocket/api/readTradingTerminalState/readPosition/).
getPosition(String) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Returns specific position (see https://metaapi.cloud/docs/client/websocket/api/readTradingTerminalState/readPosition/).
getPositions(String) - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Returns positions for a specified MetaTrader account (see https://metaapi.cloud/docs/client/websocket/api/readTradingTerminalState/readPositions/).
getPositions() - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Returns positions (see https://metaapi.cloud/docs/client/websocket/api/readTradingTerminalState/readPositions/).
getPositions() - Method in class cloud.metaapi.sdk.meta_api.TerminalState
Returns a local copy of MetaTrader positions opened
getPrice(String) - Method in class cloud.metaapi.sdk.meta_api.TerminalState
Returns MetaTrader symbol price by symbol
getProvidedStrategies() - Method in class cloud.metaapi.sdk.clients.copy_factory.HistoryClient
Returns list of strategies the current user provides to other users https://trading-api-v1.agiliumtrade.agiliumtrade.ai/swagger/#!
getProvidedStrategiesTransactions(IsoTime, IsoTime) - Method in class cloud.metaapi.sdk.clients.copy_factory.HistoryClient
Returns list of transactions on the strategies the current user provides to other users.
getProvidedStrategiesTransactions(IsoTime, IsoTime, List<String>, List<String>) - Method in class cloud.metaapi.sdk.clients.copy_factory.HistoryClient
Returns list of transactions on the strategies the current user provides to other users.
getProvidedStrategiesTransactions(IsoTime, IsoTime, List<String>, List<String>, Integer, Integer) - Method in class cloud.metaapi.sdk.clients.copy_factory.HistoryClient
Returns list of transactions on the strategies the current user provides to other users https://trading-api-v1.agiliumtrade.agiliumtrade.ai/swagger/#!
getProviders() - Method in class cloud.metaapi.sdk.clients.copy_factory.HistoryClient
Returns list of providers providing strategies to the current user https://trading-api-v1.agiliumtrade.agiliumtrade.ai/swagger/#!
getProvisioningProfile(String) - Method in class cloud.metaapi.sdk.clients.meta_api.ProvisioningProfileClient
Retrieves a provisioning profile by id (see https://metaapi.cloud/docs/provisioning/api/provisioningProfile/readProvisioningProfile/).
getProvisioningProfile(String) - Method in class cloud.metaapi.sdk.meta_api.ProvisioningProfileApi
Retrieves a provisioning profile by id
getProvisioningProfileApi() - Method in class cloud.metaapi.sdk.meta_api.MetaApi
Returns provisioning profile API
getProvisioningProfileId() - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccount
Returns id of the account's provisioning profile
getProvisioningProfiles(Integer, String) - Method in class cloud.metaapi.sdk.clients.meta_api.ProvisioningProfileClient
Retrieves provisioning profiles owned by user (see https://metaapi.cloud/docs/provisioning/api/provisioningProfile/readProvisioningProfiles/).
getProvisioningProfiles() - Method in class cloud.metaapi.sdk.meta_api.ProvisioningProfileApi
Retrieves provisioning profiles without filtering by version or status.
getProvisioningProfiles(Integer, String) - Method in class cloud.metaapi.sdk.meta_api.ProvisioningProfileApi
Retrieves provisioning profiles
getQueryParameters() - Method in class cloud.metaapi.sdk.clients.HttpRequestOptions
Returns query parameters of request.
getServer() - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccount
Returns MetaTrader server which hosts the account
getSpecification(String) - Method in class cloud.metaapi.sdk.meta_api.TerminalState
Returns MetaTrader symbol specification by symbol
getSpecifications() - Method in class cloud.metaapi.sdk.meta_api.TerminalState
Returns a local copy of symbol specifications available in MetaTrader trading terminal
getState() - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccount
Returns account deployment state
getStatus() - Method in class cloud.metaapi.sdk.meta_api.ProvisioningProfile
Returns profile status.
getStopouts(String) - Method in class cloud.metaapi.sdk.clients.copy_factory.TradingClient
Returns subscriber account stopouts.
getStrategies() - Method in class cloud.metaapi.sdk.clients.copy_factory.ConfigurationClient
Retrieves CopyFactory copy trading strategies.
getStrategiesSubscribed() - Method in class cloud.metaapi.sdk.clients.copy_factory.HistoryClient
Returns list of strategies the current user is subscribed to https://trading-api-v1.agiliumtrade.agiliumtrade.ai/swagger/#!
getStrategiesSubscribedTransactions(IsoTime, IsoTime) - Method in class cloud.metaapi.sdk.clients.copy_factory.HistoryClient
Returns list of trades on the strategies the current user subscribed to https://trading-api-v1.agiliumtrade.agiliumtrade.ai/swagger/#!
getStrategiesSubscribedTransactions(IsoTime, IsoTime, List<String>, List<String>) - Method in class cloud.metaapi.sdk.clients.copy_factory.HistoryClient
Returns list of trades on the strategies the current user subscribed to https://trading-api-v1.agiliumtrade.agiliumtrade.ai/swagger/#!
getStrategiesSubscribedTransactions(IsoTime, IsoTime, List<String>, List<String>, Integer, Integer) - Method in class cloud.metaapi.sdk.clients.copy_factory.HistoryClient
Returns list of trades on the strategies the current user subscribed to https://trading-api-v1.agiliumtrade.agiliumtrade.ai/swagger/#!
getStream() - Method in class cloud.metaapi.sdk.clients.HttpRequestOptions.FileStreamField
Returns InputStream with contents of the file
getSubscribers() - Method in class cloud.metaapi.sdk.clients.copy_factory.HistoryClient
Returns list of subscribers subscribed to the strategies of the current user https://trading-api-v1.agiliumtrade.agiliumtrade.ai/swagger/#!
getSymbolPrice(String, String) - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Retrieves price for a symbol (see https://metaapi.cloud/docs/client/websocket/api/retrieveMarketData/getSymbolPrice/).
getSymbolPrice(String) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Retrieves specification for a symbol (see https://metaapi.cloud/docs/client/websocket/api/retrieveMarketData/getSymbolPrice/).
getSymbolSpecification(String, String) - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Retrieves specification for a symbol (see https://metaapi.cloud/docs/client/websocket/api/retrieveMarketData/getSymbolSpecification/).
getSymbolSpecification(String) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Retrieves specification for a symbol (see https://metaapi.cloud/docs/client/websocket/api/retrieveMarketData/getSymbolSpecification/).
getTerminalState() - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Returns local copy of terminal state
getTimeConverter() - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccount
Returns algorithm used to parse your broker timezone.
getTokenType() - Method in class cloud.metaapi.sdk.clients.MetaApiClient
Returns type of current token
getTradingApi() - Method in class cloud.metaapi.sdk.copy_factory.CopyFactory
Returns CopyFactory trading API
getType() - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccount
Returns account type.
getUrl() - Method in class cloud.metaapi.sdk.clients.HttpRequestOptions
Returns URL used for request
getValue() - Method in enum cloud.metaapi.sdk.clients.meta_api.models.AccountType
Returns the value of type
getVersion() - Method in class cloud.metaapi.sdk.meta_api.ProvisioningProfile
Returns profile version.

H

handleNoAccessError(String) - Method in class cloud.metaapi.sdk.clients.MetaApiClient
Handles no accessing to the method
History() - Constructor for class cloud.metaapi.sdk.meta_api.HistoryFileManager.History
 
HistoryClient - Class in cloud.metaapi.sdk.clients.copy_factory
metaapi.cloud CopyFactory history API (trade copying history API) client (see https://trading-api-v1.project-stock.agiliumlabs.cloud/swagger/#/)
HistoryClient(HttpClient, String) - Constructor for class cloud.metaapi.sdk.clients.copy_factory.HistoryClient
Constructs CopyFactory history API client instance.
HistoryClient(HttpClient, String, String) - Constructor for class cloud.metaapi.sdk.clients.copy_factory.HistoryClient
Constructs CopyFactory history API client instance
HistoryFileManager - Class in cloud.metaapi.sdk.meta_api
History storage file manager which saves and loads history on disk
HistoryFileManager(String, HistoryStorage) - Constructor for class cloud.metaapi.sdk.meta_api.HistoryFileManager
Constructs the history file manager instance
HistoryFileManager.History - Class in cloud.metaapi.sdk.meta_api
Class to store history deals and orders
historyOrders - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderHistoryOrders
List of history orders returned
historyOrders - Variable in class cloud.metaapi.sdk.meta_api.HistoryFileManager.History
List of history orders
HistoryStorage - Class in cloud.metaapi.sdk.meta_api
Abstract class which defines MetaTrader history storage interface.
HistoryStorage() - Constructor for class cloud.metaapi.sdk.meta_api.HistoryStorage
 
host - Variable in class cloud.metaapi.sdk.clients.MetaApiClient
 
HttpClient - Class in cloud.metaapi.sdk.clients
HTTP client library based on request-promise
HttpClient() - Constructor for class cloud.metaapi.sdk.clients.HttpClient
Constructs HttpClient class instance.
HttpClient(int, int) - Constructor for class cloud.metaapi.sdk.clients.HttpClient
Constructs HttpClient class instance
httpClient - Variable in class cloud.metaapi.sdk.clients.MetaApiClient
 
HttpRequestOptions - Class in cloud.metaapi.sdk.clients
Options for HttpClient requests
HttpRequestOptions(String, HttpRequestOptions.Method) - Constructor for class cloud.metaapi.sdk.clients.HttpRequestOptions
Constructs HttpRequestOptions instance
HttpRequestOptions.FileStreamField - Class in cloud.metaapi.sdk.clients
File field wrapper for use in form data body.
HttpRequestOptions.Method - Enum in cloud.metaapi.sdk.clients
Represents HTTP request methods supported by HttpClient

I

id - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyIdAndName
Unique strategy id
id - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactorySubscriberOrProvider
Profile id
id - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryTransaction
Transaction id
id - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.StrategyId
Strategy id
id - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountIdDto
MetaTrader account unique identifier
id - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal
Deal id (ticket number)
id - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
Order id (ticket number)
id - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition
Position id (ticket number)
id - Variable in class cloud.metaapi.sdk.clients.meta_api.models.ProvisioningProfileIdDto
Provisioning profile unique identifier
id - Variable in class cloud.metaapi.sdk.clients.models.Error
Error id
improvement - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryTransaction
High-water mark strategy balance improvement
included - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyMagicFilter
List of magics (expert ids) or magic ranges copied, or null.
included - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategySymbolFilter
List of symbols copied, or null.
initialize() - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Initializes meta api connection
InternalException - Exception in cloud.metaapi.sdk.clients.error_handler
Represents unexpected error.
InternalException(String) - Constructor for exception cloud.metaapi.sdk.clients.error_handler.InternalException
Constructs unexpected error.
isConnected() - Method in class cloud.metaapi.sdk.meta_api.TerminalState
Returns true if MetaApi have connected to MetaTrader terminal
isConnectedToBroker() - Method in class cloud.metaapi.sdk.meta_api.TerminalState
Returns true if MetaApi have connected to MetaTrader terminal and MetaTrader terminal is connected to broker
isDealSynchronizationFinished() - Method in class cloud.metaapi.sdk.meta_api.HistoryStorage
Returns flag indicating whether deal history synchronization have finished
isManualTrades() - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccount
Returns flag indicating if trades should be placed as manual trades on this account
isNotAccountToken() - Method in class cloud.metaapi.sdk.clients.MetaApiClient
Checks that current token is not account token
isNotJwtToken() - Method in class cloud.metaapi.sdk.clients.MetaApiClient
Checks that current token is not api token
isOrderSynchronizationFinished() - Method in class cloud.metaapi.sdk.meta_api.HistoryStorage
Returns flag indicating whether order history synchronization have finished
IsoTime - Class in cloud.metaapi.sdk.clients.models
Wrapper for setting and getting model time fields as Date objects and in ISO format strings.
IsoTime(String) - Constructor for class cloud.metaapi.sdk.clients.models.IsoTime
Constructs wrapper from ISO time string
IsoTime(Date) - Constructor for class cloud.metaapi.sdk.clients.models.IsoTime
Constructs wrapper from Date object
isSynchronized(String) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Returns flag indicating status of state synchronization with MetaTrader terminal

J

JsonMapper - Class in cloud.metaapi.sdk.util
Class for getting a singleton instance of a configured JSON object mapper

L

leverage - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountInformation
Account leverage coefficient
lifetimeInHours - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyTimeSettings
Optional position lifetime, or null.
limit - Variable in class cloud.metaapi.sdk.clients.meta_api.models.AccountsFilter
Search limit (must be greater or equal to 1 and less or equal to 1000) or null (defaults to 1000)
loadData() - Method in class cloud.metaapi.sdk.meta_api.HistoryStorage
Loads history data from the file manager
loadData() - Method in class cloud.metaapi.sdk.meta_api.MemoryHistoryStorage
 
loadDataFromDisk() - Method in class cloud.metaapi.sdk.meta_api.MemoryHistoryStorage
Loads history data from the file manager.
login - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountDto
MetaTrader account number
login - Variable in class cloud.metaapi.sdk.clients.meta_api.models.NewMetatraderAccountDto
MetaTrader account number
lossTickValue - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderSymbolPrice
Tick value for a losing position
lotPrice - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryTransaction
Trade lot price, or null

M

magic - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountDto
MetaTrader magic to place trades using
magic - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal
Deal magic number or null, identifies the EA which initiated the deal
magic - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
Order magic number, identifies the EA which created the order
magic - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition
Position magic number, identifies the EA which opened the position
magic - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderTrade
Magic number (expert adviser id) or null
magic - Variable in class cloud.metaapi.sdk.clients.meta_api.models.NewMetatraderAccountDto
MetaTrader magic to place trades using
magic - Variable in class cloud.metaapi.sdk.clients.meta_api.models.TradeOptions
Magic (expert id) number or null.
magicFilter - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyUpdate
Optional magic (expert id) filter, or null
makeCheckedRequest(HttpRequestOptions) - Method in class cloud.metaapi.sdk.clients.HttpClient
Performs a request.
manualTrades - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountDto
Flag indicating if trades should be placed as manual trades, or null.
manualTrades - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountUpdateDto
Flag indicating if trades should be placed as manual trades, or null.
manualTrades - Variable in class cloud.metaapi.sdk.clients.meta_api.models.NewMetatraderAccountDto
Flag indicating if trades should be placed as manual trades, or null.
margin - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountInformation
Used margin
marginLevel - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountInformation
Margin level calculated as % of equity/margin or null
MarketTradeOptions - Class in cloud.metaapi.sdk.clients.meta_api.models
Market trade options
MarketTradeOptions() - Constructor for class cloud.metaapi.sdk.clients.meta_api.models.MarketTradeOptions
 
maxLeverage - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryAccountUpdate
Optional setting indicating maxumum leverage allowed when opening a new positions, or null.
maxLeverage - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategySubscription
Optional setting indicating maximum leverage allowed when opening a new positions, or null.
maxLeverage - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyUpdate
Optional max leverage risk restriction.
maxRisk - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyRiskLimit
Max drawdown allowed, expressed as a fraction of 1
maxStopLoss - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategySubscription
Optional stop loss value restriction, or null
maxStopLoss - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyUpdate
Optional stop loss value restriction, or null
maxTradeRisk - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategySubscription
Optional max risk per trade, expressed as a fraction of 1, or null.
maxTradeRisk - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyUpdate
Optional max risk per trade, expressed as a fraction of 1, or null.
maxVolume - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderSymbolSpecification
Maximum order volume for the symbol
MemoryHistoryStorage - Class in cloud.metaapi.sdk.meta_api
History storage which stores MetaTrader history in RAM
MemoryHistoryStorage(String) - Constructor for class cloud.metaapi.sdk.meta_api.MemoryHistoryStorage
Constructs the in-memory history store instance
message - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderTradeResponse
Human-readable error or result message
message - Variable in class cloud.metaapi.sdk.clients.models.Error
Error description
message - Variable in class cloud.metaapi.sdk.clients.models.ValidationDetails
Message of the error
MetaApi - Class in cloud.metaapi.sdk.meta_api
MetaApi MetaTrader API SDK
MetaApi(String) - Constructor for class cloud.metaapi.sdk.meta_api.MetaApi
Constructs MetaApi class instance.
MetaApi(String, String) - Constructor for class cloud.metaapi.sdk.meta_api.MetaApi
Constructs MetaApi class instance.
MetaApi(String, String, Integer, Integer) - Constructor for class cloud.metaapi.sdk.meta_api.MetaApi
Constructs MetaApi class instance
MetaApiClient - Class in cloud.metaapi.sdk.clients
metaapi.cloud MetaTrader API client
MetaApiClient(HttpClient, String) - Constructor for class cloud.metaapi.sdk.clients.MetaApiClient
Constructs MetaTrader API client instance.
MetaApiClient(HttpClient, String, String) - Constructor for class cloud.metaapi.sdk.clients.MetaApiClient
Constructs MetaTrader API client instance
MetaApiConnection - Class in cloud.metaapi.sdk.meta_api
Exposes MetaApi MetaTrader API connection to consumers
MetaApiConnection(MetaApiWebsocketClient, MetatraderAccount, HistoryStorage, ConnectionRegistry) - Constructor for class cloud.metaapi.sdk.meta_api.MetaApiConnection
Constructs MetaApi MetaTrader Api connection
MetaApiWebsocketClient - Class in cloud.metaapi.sdk.clients.meta_api
MetaApi websocket API client (see https://metaapi.cloud/docs/client/websocket/overview/)
MetaApiWebsocketClient(String) - Constructor for class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Constructs MetaApi websocket API client instance.
MetaApiWebsocketClient(String, String, long, long) - Constructor for class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Constructs MetaApi websocket API client instance
MetatraderAccount - Class in cloud.metaapi.sdk.meta_api
Implements a MetaTrader account entity
MetatraderAccount(MetatraderAccountDto, MetatraderAccountClient, MetaApiWebsocketClient, ConnectionRegistry) - Constructor for class cloud.metaapi.sdk.meta_api.MetatraderAccount
Constructs a MetaTrader account entity
MetatraderAccountApi - Class in cloud.metaapi.sdk.meta_api
Exposes MetaTrader account API logic to the consumers
MetatraderAccountApi(MetatraderAccountClient, MetaApiWebsocketClient, ConnectionRegistry) - Constructor for class cloud.metaapi.sdk.meta_api.MetatraderAccountApi
Constructs a MetaTrader account API instance
MetatraderAccountClient - Class in cloud.metaapi.sdk.clients.meta_api
metaapi.cloud MetaTrader account API client (see https://metaapi.cloud/docs/provisioning/)
MetatraderAccountClient(HttpClient, String) - Constructor for class cloud.metaapi.sdk.clients.meta_api.MetatraderAccountClient
Constructs MetaTrader account API client instance with default domain agiliumtrade.agiliumtrade.ai
MetatraderAccountClient(HttpClient, String, String) - Constructor for class cloud.metaapi.sdk.clients.meta_api.MetatraderAccountClient
 
MetatraderAccountDto - Class in cloud.metaapi.sdk.clients.meta_api.models
MetaTrader account model
MetatraderAccountDto() - Constructor for class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountDto
 
MetatraderAccountDto.ConnectionStatus - Enum in cloud.metaapi.sdk.clients.meta_api.models
Terminal and broker connection status enum
MetatraderAccountDto.DeploymentState - Enum in cloud.metaapi.sdk.clients.meta_api.models
Account deployment state enum
MetatraderAccountIdDto - Class in cloud.metaapi.sdk.clients.meta_api.models
MetaTrader account id model
MetatraderAccountIdDto() - Constructor for class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountIdDto
 
MetatraderAccountInformation - Class in cloud.metaapi.sdk.clients.meta_api.models
MetaTrader account information (see https://metaapi.cloud/docs/client/models/metatraderAccountInformation/)
MetatraderAccountInformation() - Constructor for class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountInformation
 
MetatraderAccountUpdateDto - Class in cloud.metaapi.sdk.clients.meta_api.models
Updated MetaTrader account data
MetatraderAccountUpdateDto() - Constructor for class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountUpdateDto
 
MetatraderDeal - Class in cloud.metaapi.sdk.clients.meta_api.models
MetaTrader deal
MetatraderDeal() - Constructor for class cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal
 
MetatraderDeal.DealEntryType - Enum in cloud.metaapi.sdk.clients.meta_api.models
Deal entry type.
MetatraderDeal.DealReason - Enum in cloud.metaapi.sdk.clients.meta_api.models
Deal execution reason.
MetatraderDeal.DealType - Enum in cloud.metaapi.sdk.clients.meta_api.models
Deal type.
MetatraderDeals - Class in cloud.metaapi.sdk.clients.meta_api.models
MetaTrader history deals search query response
MetatraderDeals() - Constructor for class cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeals
 
MetatraderHistoryOrders - Class in cloud.metaapi.sdk.clients.meta_api.models
MetaTrader history orders search query response
MetatraderHistoryOrders() - Constructor for class cloud.metaapi.sdk.clients.meta_api.models.MetatraderHistoryOrders
 
MetatraderOrder - Class in cloud.metaapi.sdk.clients.meta_api.models
MetaTrader order
MetatraderOrder() - Constructor for class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
 
MetatraderOrder.FillingMode - Enum in cloud.metaapi.sdk.clients.meta_api.models
Order filling mode.
MetatraderOrder.OrderReason - Enum in cloud.metaapi.sdk.clients.meta_api.models
Order opening reason.
MetatraderOrder.OrderState - Enum in cloud.metaapi.sdk.clients.meta_api.models
Order state.
MetatraderOrder.OrderType - Enum in cloud.metaapi.sdk.clients.meta_api.models
Order type.
MetatraderPosition - Class in cloud.metaapi.sdk.clients.meta_api.models
MetaTrader position
MetatraderPosition() - Constructor for class cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition
 
MetatraderPosition.PositionReason - Enum in cloud.metaapi.sdk.clients.meta_api.models
Position opening reason.
MetatraderPosition.PositionType - Enum in cloud.metaapi.sdk.clients.meta_api.models
Position type
MetatraderSymbolPrice - Class in cloud.metaapi.sdk.clients.meta_api.models
MetaTrader symbol price.
MetatraderSymbolPrice() - Constructor for class cloud.metaapi.sdk.clients.meta_api.models.MetatraderSymbolPrice
 
MetatraderSymbolSpecification - Class in cloud.metaapi.sdk.clients.meta_api.models
MetaTrader symbol specification.
MetatraderSymbolSpecification() - Constructor for class cloud.metaapi.sdk.clients.meta_api.models.MetatraderSymbolSpecification
 
MetatraderSymbolSpecification.ExecutionMode - Enum in cloud.metaapi.sdk.clients.meta_api.models
Deal execution mode.
MetatraderSymbolSpecification.FillingMode - Enum in cloud.metaapi.sdk.clients.meta_api.models
Order filling modes.
MetatraderTrade - Class in cloud.metaapi.sdk.clients.meta_api.models
MetaTrader trade (see https://metaapi.cloud/docs/client/models/metatraderTrade/)
MetatraderTrade() - Constructor for class cloud.metaapi.sdk.clients.meta_api.models.MetatraderTrade
 
MetatraderTrade.ActionType - Enum in cloud.metaapi.sdk.clients.meta_api.models
Action type enum
MetatraderTradeResponse - Class in cloud.metaapi.sdk.clients.meta_api.models
Сontains trade command result.
MetatraderTradeResponse() - Constructor for class cloud.metaapi.sdk.clients.meta_api.models.MetatraderTradeResponse
 
MethodAccessException - Exception in cloud.metaapi.sdk.clients
Error which indicates that user doesn't have access to a method
MethodAccessException(String) - Constructor for exception cloud.metaapi.sdk.clients.MethodAccessException
Constructs the exception.
MethodAccessException(String, String) - Constructor for exception cloud.metaapi.sdk.clients.MethodAccessException
Constructs the exception
minTradeAmount - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryAccountUpdate
Optional value of minimal trade size allowed, expressed in amount of account currency, or null.
minVolume - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderSymbolSpecification
Minimum order volume for the symbol
modifyOrder(String, double, double, double) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Modifies a pending order (see https://metaapi.cloud/docs/client/websocket/api/trade/).
modifyPosition(String, Double, Double) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Modifies a position (see https://metaapi.cloud/docs/client/websocket/api/trade/).
multiplier - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategySubscription
Optional subscription multiplier or null, default is 1x

N

name - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryAccountUpdate
Account human-readable name
name - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyIdAndName
Human-readable strategy name
name - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyUpdate
Strategy human-readable name
name - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactorySubscriberOrProvider
User name
name - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountDto
MetaTrader account human-readable name in the MetaApi app
name - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountUpdateDto
MetaTrader account human-readable name in the MetaApi app
name - Variable in class cloud.metaapi.sdk.clients.meta_api.models.NewMetatraderAccountDto
MetaTrader account human-readable name in the MetaApi app
name - Variable in class cloud.metaapi.sdk.clients.meta_api.models.NewProvisioningProfileDto
Provisioning profile name
name - Variable in class cloud.metaapi.sdk.clients.meta_api.models.ProvisioningProfileDto
Provisioning profile name
name - Variable in class cloud.metaapi.sdk.clients.meta_api.models.ProvisioningProfileUpdateDto
Provisioning profile name
NewMetatraderAccountDto - Class in cloud.metaapi.sdk.clients.meta_api.models
New MetaTrader account model
NewMetatraderAccountDto() - Constructor for class cloud.metaapi.sdk.clients.meta_api.models.NewMetatraderAccountDto
 
NewProvisioningProfileDto - Class in cloud.metaapi.sdk.clients.meta_api.models
New provisioning profile model
NewProvisioningProfileDto() - Constructor for class cloud.metaapi.sdk.clients.meta_api.models.NewProvisioningProfileDto
 
newsFilter - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategySubscription
Optional news risk filter configuration, or null
newsFilter - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyUpdate
News risk filter configuration, or null
NotConnectedException - Exception in cloud.metaapi.sdk.clients.meta_api
Error which indicates that MetaTrader terminal did not start yet.
NotConnectedException(String) - Constructor for exception cloud.metaapi.sdk.clients.meta_api.NotConnectedException
Constructs the error
NotFoundException - Exception in cloud.metaapi.sdk.clients.error_handler
Throwing this error results in 404 (Not Found) HTTP response code.
NotFoundException(String) - Constructor for exception cloud.metaapi.sdk.clients.error_handler.NotFoundException
Represents NotFoundError.
NotSynchronizedException - Exception in cloud.metaapi.sdk.clients.meta_api
Error which indicates that MetaApi MetaTrader account was not synchronized yet.
NotSynchronizedException(String) - Constructor for exception cloud.metaapi.sdk.clients.meta_api.NotSynchronizedException
Constructs the error
numericCode - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderTradeResponse
Numeric response code, see https://www.mql5.com/en/docs/constants/errorswarnings/enum_trade_return_codes and https://book.mql4.com/appendix/errors.
numericCode - Variable in exception cloud.metaapi.sdk.clients.meta_api.TradeException
Numeric error code
numericCode - Variable in class cloud.metaapi.sdk.clients.models.Error
Numeric error code or null

O

offset - Variable in class cloud.metaapi.sdk.clients.meta_api.models.AccountsFilter
Search offset (must be greater or equal to 0) or null (defaults to 0)
ofNumber(int) - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.Version
Returns enum version from its number
ofValue(String) - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.AccountType
Returns enum account type from its value
onAccountInformationUpdated(MetatraderAccountInformation) - Method in class cloud.metaapi.sdk.clients.meta_api.SynchronizationListener
Invoked when MetaTrader account information is updated
onAccountInformationUpdated(MetatraderAccountInformation) - Method in class cloud.metaapi.sdk.meta_api.TerminalState
 
onBrokerConnectionStatusChanged(boolean) - Method in class cloud.metaapi.sdk.clients.meta_api.SynchronizationListener
Invoked when broker connection satus have changed
onBrokerConnectionStatusChanged(boolean) - Method in class cloud.metaapi.sdk.meta_api.TerminalState
 
onConnected() - Method in class cloud.metaapi.sdk.clients.meta_api.SynchronizationListener
Invoked when connection to MetaTrader terminal established
onConnected() - Method in class cloud.metaapi.sdk.meta_api.HistoryStorage
 
onConnected() - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
 
onConnected() - Method in class cloud.metaapi.sdk.meta_api.TerminalState
 
onDealAdded(MetatraderDeal) - Method in class cloud.metaapi.sdk.clients.meta_api.SynchronizationListener
Invoked when a new MetaTrader history deal is added
onDealAdded(MetatraderDeal) - Method in class cloud.metaapi.sdk.meta_api.HistoryStorage
 
onDealAdded(MetatraderDeal) - Method in class cloud.metaapi.sdk.meta_api.MemoryHistoryStorage
 
onDealSynchronizationFinished(String) - Method in class cloud.metaapi.sdk.clients.meta_api.SynchronizationListener
Invoked when a synchronization of history deals on a MetaTrader account have finished
onDealSynchronizationFinished(String) - Method in class cloud.metaapi.sdk.meta_api.HistoryStorage
 
onDealSynchronizationFinished(String) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
 
onDisconnected() - Method in class cloud.metaapi.sdk.clients.meta_api.SynchronizationListener
Invoked when connection to MetaTrader terminal terminated
onDisconnected() - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
 
onDisconnected() - Method in class cloud.metaapi.sdk.meta_api.TerminalState
 
onHistoryOrderAdded(MetatraderOrder) - Method in class cloud.metaapi.sdk.clients.meta_api.SynchronizationListener
Invoked when a new MetaTrader history order is added
onHistoryOrderAdded(MetatraderOrder) - Method in class cloud.metaapi.sdk.meta_api.HistoryStorage
 
onHistoryOrderAdded(MetatraderOrder) - Method in class cloud.metaapi.sdk.meta_api.MemoryHistoryStorage
 
onOrderCompleted(String) - Method in class cloud.metaapi.sdk.clients.meta_api.SynchronizationListener
Invoked when MetaTrader order is completed (executed or canceled)
onOrderCompleted(String) - Method in class cloud.metaapi.sdk.meta_api.TerminalState
 
onOrderSynchronizationFinished(String) - Method in class cloud.metaapi.sdk.clients.meta_api.SynchronizationListener
Invoked when a synchronization of history orders on a MetaTrader account have finished
onOrderSynchronizationFinished(String) - Method in class cloud.metaapi.sdk.meta_api.HistoryStorage
 
onOrderSynchronizationFinished(String) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
 
onOrderUpdated(MetatraderOrder) - Method in class cloud.metaapi.sdk.clients.meta_api.SynchronizationListener
Invoked when MetaTrader order is updated
onOrderUpdated(MetatraderOrder) - Method in class cloud.metaapi.sdk.meta_api.TerminalState
 
onPositionRemoved(String) - Method in class cloud.metaapi.sdk.clients.meta_api.SynchronizationListener
Invoked when MetaTrader position is removed
onPositionRemoved(String) - Method in class cloud.metaapi.sdk.meta_api.TerminalState
 
onPositionUpdated(MetatraderPosition) - Method in class cloud.metaapi.sdk.clients.meta_api.SynchronizationListener
Invoked when MetaTrader position is updated
onPositionUpdated(MetatraderPosition) - Method in class cloud.metaapi.sdk.meta_api.TerminalState
 
onReconnected() - Method in interface cloud.metaapi.sdk.clients.meta_api.ReconnectListener
Invoked when connection to MetaTrader terminal re-established
onReconnected() - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
 
onSymbolPriceUpdated(MetatraderSymbolPrice) - Method in class cloud.metaapi.sdk.clients.meta_api.SynchronizationListener
Invoked when a symbol price was updated
onSymbolPriceUpdated(MetatraderSymbolPrice) - Method in class cloud.metaapi.sdk.meta_api.TerminalState
 
onSymbolSpecificationUpdated(MetatraderSymbolSpecification) - Method in class cloud.metaapi.sdk.clients.meta_api.SynchronizationListener
Invoked when a symbol specification was updated
onSymbolSpecificationUpdated(MetatraderSymbolSpecification) - Method in class cloud.metaapi.sdk.meta_api.TerminalState
 
openingIntervalInMinutes - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyTimeSettings
Optional time interval to copy new positions, or null.
openPositionFollowingTimeGapInMinutes - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyBreakingNewsFilter
Optional time interval specifying when it is allowed to open position after calendar news, or null.
openPositionFollowingTimeGapInMinutes - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyCalendarNewsFilter
Optional time interval specifying when it is allowed to open position after calendar news, or null.
openPositionPrecedingTimeGapInMinutes - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyCalendarNewsFilter
Optional time interval specifying when it is still allowed to open position before calendar news, or null.
openPrice - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
Order open price (market price for market orders, limit price for limit orders or stop price for stop orders) or null
openPrice - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition
Position open price
openPrice - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderTrade
Order limit or stop price or null
orderId - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal
Id of order the deal relates to or null
orderId - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderTrade
Order id or null, must be specified for order modification commands
orderId - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderTradeResponse
Id of the order created or modified by the trade, or null
originalComment - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal
Deal original comment or null (present if possible to restore original comment from history)
originalComment - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
Order original comment or null (present if possible to restore original comment from history)

P

parameter - Variable in class cloud.metaapi.sdk.clients.models.ValidationDetails
Name of the parameter to which an error relates
password - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountUpdateDto
MetaTrader account password.
password - Variable in class cloud.metaapi.sdk.clients.meta_api.models.NewMetatraderAccountDto
MetaTrader account password.
PendingTradeOptions - Class in cloud.metaapi.sdk.clients.meta_api.models
Pending order trade options
PendingTradeOptions() - Constructor for class cloud.metaapi.sdk.clients.meta_api.models.PendingTradeOptions
 
phoneNumbers - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryAccountUpdate
Optional phone numbers to send sms notifications to, or null.
platform - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountInformation
Platform id, either mt4 or mt5
platform - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal
Platform id (mt4 or mt5)
platform - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
Platform id (mt4 or mt5)
platformCommission - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryTransaction
Platform commission
platformCommissionRate - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategy
Commission rate the platform charges for strategy copying, applied to commissions charged by provider.
platformCommissionRate - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyUpdate
Commission rate the platform charges for strategy copying, applied to commissions charged by provider.
positionId - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal
Id of position the deal relates to or null
positionId - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
Order position id or null.
positionId - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderTrade
Position id or null, must be specified for position modification commands
positionId - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderTradeResponse
Id of the position created or modified by the trade, or null
positionLifecycle - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyUpdate
Position detection mode.
price - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal
The price the deal was conducted at or null
priorities - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyBreakingNewsFilter
List of breaking news priorities to stop trading on, or null.
priorities - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyCalendarNewsFilter
List of calendar news priorities to stop trading on, or null, leave empty to disable calendar news filter.
profit - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryTransaction
Trade profit
profit - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal
Deal profit
profit - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition
Position cumulative profit
profitTickValue - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderSymbolPrice
Tick value for a profitable position
provider - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryTransaction
Strategy provider
providerCommission - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryTransaction
Provider commission
ProvisioningProfile - Class in cloud.metaapi.sdk.meta_api
Implements a provisioning profile entity
ProvisioningProfile(ProvisioningProfileDto, ProvisioningProfileClient) - Constructor for class cloud.metaapi.sdk.meta_api.ProvisioningProfile
Constructs a provisioning profile entity
ProvisioningProfileApi - Class in cloud.metaapi.sdk.meta_api
Exposes provisioning profile API logic to the consumers
ProvisioningProfileApi(ProvisioningProfileClient) - Constructor for class cloud.metaapi.sdk.meta_api.ProvisioningProfileApi
Constructs a provisioning profile API instance
ProvisioningProfileClient - Class in cloud.metaapi.sdk.clients.meta_api
metaapi.cloud provisioning profile API client (see https://metaapi.cloud/docs/provisioning/)
ProvisioningProfileClient(HttpClient, String) - Constructor for class cloud.metaapi.sdk.clients.meta_api.ProvisioningProfileClient
Constructs provisioning API client instance with default domain agiliumtrade.agiliumtrade.ai
ProvisioningProfileClient(HttpClient, String, String) - Constructor for class cloud.metaapi.sdk.clients.meta_api.ProvisioningProfileClient
 
ProvisioningProfileDto - Class in cloud.metaapi.sdk.clients.meta_api.models
Provisioning profile model
ProvisioningProfileDto() - Constructor for class cloud.metaapi.sdk.clients.meta_api.models.ProvisioningProfileDto
 
provisioningProfileId - Variable in class cloud.metaapi.sdk.clients.meta_api.models.AccountsFilter
Provisioning profile id or null
provisioningProfileId - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountDto
Id of the account's provisioning profile
provisioningProfileId - Variable in class cloud.metaapi.sdk.clients.meta_api.models.NewMetatraderAccountDto
Id of the account's provisioning profile
ProvisioningProfileIdDto - Class in cloud.metaapi.sdk.clients.meta_api.models
Provisioning profile id model
ProvisioningProfileIdDto() - Constructor for class cloud.metaapi.sdk.clients.meta_api.models.ProvisioningProfileIdDto
 
ProvisioningProfileUpdateDto - Class in cloud.metaapi.sdk.clients.meta_api.models
Updated provisioning profile data
ProvisioningProfileUpdateDto() - Constructor for class cloud.metaapi.sdk.clients.meta_api.models.ProvisioningProfileUpdateDto
 

Q

quantity - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryTransaction
Trade volume, or null
query - Variable in class cloud.metaapi.sdk.clients.meta_api.models.AccountsFilter
If it is not null, searches over _id, name, server and login to match query
quoteStreamingIntervalInSeconds - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountDto
Quote streaming interval in seconds, or null.
quoteStreamingIntervalInSeconds - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountUpdateDto
Quote streaming interval in seconds, or null.
quoteStreamingIntervalInSeconds - Variable in class cloud.metaapi.sdk.clients.meta_api.models.NewMetatraderAccountDto
Quote streaming interval in seconds, or null.

R

realizedProfit - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition
Profit of the already closed part, including commissions and swap
reason - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyStopout
Stopout reason.
reason - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal
Optional deal execution reason or null
reason - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
Order opening reason
reason - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition
Position opening reason
reasonDescription - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyStopout
Human-readable description of the stopout reason
reconnect(String) - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Reconnects to the Metatrader terminal (see https://metaapi.cloud/docs/client/websocket/api/reconnect/).
reconnect() - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Reconnects to the Metatrader terminal (see https://metaapi.cloud/docs/client/websocket/api/reconnect/).
ReconnectListener - Interface in cloud.metaapi.sdk.clients.meta_api
Defines interface for a websocket reconnect listener class
redeploy() - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccount
Schedules account for redeployment.
redeployAccount(String) - Method in class cloud.metaapi.sdk.clients.meta_api.MetatraderAccountClient
Redeploys MetaTrader account.
reduceCorrelations - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategySubscription
Optional setting indicating whether to enable automatic trade correlation reduction, or null.
reduceCorrelations - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyUpdate
Optional setting indicating whether to enable automatic trade correlation reduction, or null.
reload() - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccount
Reloads MetaTrader account from API
reload() - Method in class cloud.metaapi.sdk.meta_api.ProvisioningProfile
Reloads provisioning profile from API
remove(String) - Method in class cloud.metaapi.sdk.meta_api.ConnectionRegistry
Removes an account from registry
remove() - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccount
Removes MetaTrader account.
remove() - Method in class cloud.metaapi.sdk.meta_api.ProvisioningProfile
Removes provisioning profile.
removeAccount(String) - Method in class cloud.metaapi.sdk.clients.copy_factory.ConfigurationClient
Deletes a CopyFactory trade copying account.
removeAllListeners() - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Removes all listeners.
removeHistory(String) - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Clears the order and transaction history of a specified account so that it can be synchronized from scratch (see https://metaapi.cloud/docs/client/websocket/api/removeHistory/).
removeHistory() - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Clears the order and transaction history of a specified account so that it can be synchronized from scratch (see https://metaapi.cloud/docs/client/websocket/api/removeHistory/).
removeReconnectListener(ReconnectListener) - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Removes reconnect listener
removeStrategy(String) - Method in class cloud.metaapi.sdk.clients.copy_factory.ConfigurationClient
Deletes a CopyFactory strategy.
removeSynchronizationListener(String, SynchronizationListener) - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Removes synchronization listener for specific account
removeSynchronizationListener(SynchronizationListener) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Removes synchronization listener for specific account
request(HttpRequestOptions) - Method in class cloud.metaapi.sdk.clients.HttpClient
Performs a request.
requestId - Variable in class cloud.metaapi.sdk.clients.models.WebsocketError
Request id the response relates to
requestJson(HttpRequestOptions, Class<T>) - Method in class cloud.metaapi.sdk.clients.HttpClient
Does the same as HttpClient.request(HttpRequestOptions) but automatically converts response into json.
reservedMarginFraction - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryAccountUpdate
Optional fraction of reserved margin to reduce a risk of margin call, or null.
reset() - Method in class cloud.metaapi.sdk.meta_api.HistoryStorage
Resets the storage
reset() - Method in class cloud.metaapi.sdk.meta_api.MemoryHistoryStorage
 
resetStopout(String, String) - Method in class cloud.metaapi.sdk.clients.copy_factory.TradingClient
Resets account stopout.
resynchronize(String, List<String>) - Method in class cloud.metaapi.sdk.clients.copy_factory.TradingClient
Resynchronizes the account.
riskLimits - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategySubscription
Optional strategy risk limits, or null.
riskLimits - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyUpdate
Optional strategy risk limits, or null.

S

server - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountDto
MetaTrader server which hosts the account
server - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountInformation
Broker server name
server - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountUpdateDto
MetaTrader server which hosts the account
server - Variable in class cloud.metaapi.sdk.clients.meta_api.models.NewMetatraderAccountDto
MetaTrader server which hosts the account
ServiceProvider - Class in cloud.metaapi.sdk.util
Inner service provider that implements dependency injection (DI) of some SDK classes which are needed to be tested properly.
ServiceProvider() - Constructor for class cloud.metaapi.sdk.util.ServiceProvider
 
ServiceProvider.MetaApiConnectionProvider - Interface in cloud.metaapi.sdk.util
Interface for creating MetaApiConnection.
setArguments(List<Object>) - Method in exception cloud.metaapi.sdk.clients.error_handler.ApiException
Set message arguments for i18n
setBody(Object) - Method in class cloud.metaapi.sdk.clients.HttpRequestOptions
Sets the json body of a request.
setBody(Map<String, Object>) - Method in class cloud.metaapi.sdk.clients.HttpRequestOptions
Sets the form data body of a request.
setCode(String) - Method in exception cloud.metaapi.sdk.clients.error_handler.ApiException
Sets error code, used for i18n
setFile(File) - Method in class cloud.metaapi.sdk.clients.HttpRequestOptions.FileStreamField
Sets file from File object
setFile(InputStream, String) - Method in class cloud.metaapi.sdk.clients.HttpRequestOptions.FileStreamField
Sets file from InputStream object
setHistoryFileManagerMock(HistoryFileManager) - Static method in class cloud.metaapi.sdk.util.ServiceProvider
Sets history file manager mock that will be created by this provider.
setMetApiConnectionMock(MetaApiConnection) - Static method in class cloud.metaapi.sdk.util.ServiceProvider
Sets metaapi connection mock that will be created by this provider.
setMetApiConnectionMock(ServiceProvider.MetaApiConnectionProvider) - Static method in class cloud.metaapi.sdk.util.ServiceProvider
Sets metaapi connection provider that will be used for creating the mock.
setMethod(HttpRequestOptions.Method) - Method in class cloud.metaapi.sdk.clients.HttpRequestOptions
Sets HTTP method used for request
setStartNewDealIndex(int) - Method in class cloud.metaapi.sdk.meta_api.HistoryFileManager
Sets the index of the earliest changed deal record
setStartNewOrderIndex(int) - Method in class cloud.metaapi.sdk.meta_api.HistoryFileManager
Sets the index of the earliest changed historyOrder record
setTime(String) - Method in class cloud.metaapi.sdk.clients.models.IsoTime
Sets wrapper time from ISO format time
setTime(Date) - Method in class cloud.metaapi.sdk.clients.models.IsoTime
Sets wrapper time from Date object
setUrl(String) - Method in class cloud.metaapi.sdk.clients.HttpRequestOptions
Sets URL used for request
setUrl(String) - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Patch server URL for use in unit tests
skipPendingOrders - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategySubscription
Optional flag indicating that pending orders should not be copied, or null.
skipPendingOrders - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyUpdate
Optional flag indicating that pending orders should not be copied, or null.
slippage - Variable in class cloud.metaapi.sdk.clients.meta_api.models.TradeOptions
Optional slippage in points or null.
startTime - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyRiskLimit
Optional time to start risk tracking from, or {code null}.
startTime - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyStopOutRisk
The time to start risk calculation from, or null.
startUpdateJob() - Method in class cloud.metaapi.sdk.meta_api.HistoryFileManager
Starts a job to periodically save history on disk
state - Variable in class cloud.metaapi.sdk.clients.meta_api.models.AccountsFilter
Account state or null
state - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountDto
Account deployment state
state - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
Order state
status - Variable in exception cloud.metaapi.sdk.clients.error_handler.ApiException
HTTP status code
status - Variable in class cloud.metaapi.sdk.clients.meta_api.models.ProvisioningProfileDto
Provisioning profile status (allowed values are new and active)
statusTimerTimeoutInMilliseconds - Variable in class cloud.metaapi.sdk.meta_api.TerminalState
Defines timeout of waiting for a broker connection status changed signal.
stopLoss - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
Order stop loss price or null
stopLoss - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition
Position stop loss price or null
stopLoss - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderTrade
Stop loss price or null
stopOutRisk - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategySubscription
Optional stop out setting, or null.
stopOutRisk - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyUpdate
Optional stop out setting, or null.
stoppedAt - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyStopout
Time the strategy was stopped at
stoppedTill - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyStopout
Time the strategy is stopped till
stopUpdateJob() - Method in class cloud.metaapi.sdk.meta_api.HistoryFileManager
Stops a job to periodically save history on disk
strategies - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactorySubscriberOrProvider
List of strategy IDs provided by provider or subscribed to by subscriber
strategy - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyStopout
Strategy which was stopped out
strategy - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryTransaction
Strategy
strategyId - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategySubscription
Id of the strategy to subscribe to
StrategyId - Class in cloud.metaapi.sdk.clients.copy_factory.models
Strategy id
StrategyId() - Constructor for class cloud.metaapi.sdk.clients.copy_factory.models.StrategyId
 
stringCode - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderTradeResponse
String response code, see https://www.mql5.com/en/docs/constants/errorswarnings/enum_trade_return_codes and https://book.mql4.com/appendix/errors.
stringCode - Variable in exception cloud.metaapi.sdk.clients.meta_api.TradeException
String error code
stringCode - Variable in class cloud.metaapi.sdk.clients.models.Error
String error code or null
subscribe(String) - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Subscribes to the Metatrader terminal events (see https://metaapi.cloud/docs/client/websocket/api/subscribe/).
subscribe() - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Initiates subscription to MetaTrader terminal
subscriber - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryTransaction
Strategy subscriber
subscribeToMarketData(String, String) - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Subscribes on market data of specified symbol (see https://metaapi.cloud/docs/client/websocket/marketDataStreaming/subscribeToMarketData/).
subscribeToMarketData(String) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Subscribes on market data of specified symbol (see https://metaapi.cloud/docs/client/websocket/marketDataStreaming/subscribeToMarketData/).
subscriptions - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryAccountUpdate
Strategy subscriptions
swap - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryTransaction
Trade swap
swap - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal
Deal swap or null
swap - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition
Position cumulative swap
symbol - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryTransaction
Optional symbol traded, or null
symbol - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal
Symbol deal relates to or null
symbol - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
Order symbol
symbol - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition
Position symbol
symbol - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderSymbolPrice
Symbol (e.g. a currency pair or an index)
symbol - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderSymbolSpecification
Symbol (e.g. a currency pair or an index)
symbol - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderTrade
Symbol to trade or null
symbolFilter - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategySubscription
Optional symbol filter, or null.
symbolFilter - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyUpdate
Symbol filters which can be used to copy only specific symbols or exclude some symbols from copying, or null
SynchronizationListener - Class in cloud.metaapi.sdk.clients.meta_api
Defines abstract class for a synchronization listener class
SynchronizationListener() - Constructor for class cloud.metaapi.sdk.clients.meta_api.SynchronizationListener
 
synchronize(String, String, IsoTime, IsoTime) - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Requests the terminal to start synchronization process (see https://metaapi.cloud/docs/client/websocket/synchronizing/synchronize/).
synchronize() - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Requests the terminal to start synchronization process (see https://metaapi.cloud/docs/client/websocket/synchronizing/synchronize/)
synchronizing - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeals
Flag indicating that deal initial synchronization is still in progress and thus search results may be incomplete
synchronizing - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderHistoryOrders
Flag indicating that history order initial synchronization is still in progress and thus search results may be incomplete

T

takeProfit - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
Order take profit price or null
takeProfit - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition
Position take profit price or null
takeProfit - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderTrade
Take profit price or null
TerminalState - Class in cloud.metaapi.sdk.meta_api
Responsible for storing a local copy of remote terminal state
TerminalState() - Constructor for class cloud.metaapi.sdk.meta_api.TerminalState
 
tickPrice - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryTransaction
Trade tick price, or null
tickSize - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderSymbolSpecification
Tick size
time - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryTransaction
Transaction time
time - Variable in class cloud.metaapi.sdk.clients.meta_api.models.ExpirationOptions
Optional pending order expiration time or null.
time - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal
Time the deal was conducted at
time - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
Time order was created at
time - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition
Time position was opened at
time - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderSymbolPrice
Quote time, in ISO format
timeConverter - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountDto
Algorithm used to parse your broker timezone.
timeConverter - Variable in class cloud.metaapi.sdk.clients.meta_api.models.NewMetatraderAccountDto
Algorithm used to parse your broker timezone.
TimeoutException - Exception in cloud.metaapi.sdk.clients
Error which indicates a timeout
TimeoutException(String) - Constructor for exception cloud.metaapi.sdk.clients.TimeoutException
Constructs the timeout error
timeSettings - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyUpdate
Settings to manage copying timeframe and position lifetime, or null.
token - Variable in class cloud.metaapi.sdk.clients.MetaApiClient
 
toString() - Method in enum cloud.metaapi.sdk.clients.meta_api.models.AccountType
Returns the value of type
toString() - Method in enum cloud.metaapi.sdk.clients.meta_api.models.Version
Returns version number as string
toString() - Method in class cloud.metaapi.sdk.clients.models.IsoTime
Represents the wrapper as ISO format time string
trade(String, MetatraderTrade) - Method in class cloud.metaapi.sdk.clients.meta_api.MetaApiWebsocketClient
Execute a trade on a connected MetaTrader account (see https://metaapi.cloud/docs/client/websocket/api/trade/).
TradeException - Exception in cloud.metaapi.sdk.clients.meta_api
Error which indicates that a trade have failed
TradeException(String, int, String) - Constructor for exception cloud.metaapi.sdk.clients.meta_api.TradeException
Constructs the timeout error
TradeOptions - Class in cloud.metaapi.sdk.clients.meta_api.models
Common trade options
TradeOptions() - Constructor for class cloud.metaapi.sdk.clients.meta_api.models.TradeOptions
 
TradingClient - Class in cloud.metaapi.sdk.clients.copy_factory
metaapi.cloud CopyFactory trading API (trade copying trading API) client (see https://trading-api-v1.project-stock.agiliumlabs.cloud/swagger/#/)
TradingClient(HttpClient, String) - Constructor for class cloud.metaapi.sdk.clients.copy_factory.TradingClient
Constructs CopyFactory trading API client instance.
TradingClient(HttpClient, String, String) - Constructor for class cloud.metaapi.sdk.clients.copy_factory.TradingClient
Constructs CopyFactory trading API client instance
type - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyComissionScheme
Commission type.
type - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyRiskLimit
Restriction type.
type - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryTransaction
Transaction type
type - Variable in class cloud.metaapi.sdk.clients.meta_api.models.AccountsFilter
Account type or null
type - Variable in class cloud.metaapi.sdk.clients.meta_api.models.ExpirationOptions
Type pending order expiration type
type - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountDto
Account type, can be cloud, cloud-g1, cloud-g2 or self-hosted.
type - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal
Deal type
type - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
Order type
type - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition
Position type
type - Variable in class cloud.metaapi.sdk.clients.meta_api.models.NewMetatraderAccountDto
Account type, can be cloud, cloud-g1, cloud-g2 or self-hosted. cloud-g2 and cloud are aliases.

U

UnauthorizedException - Exception in cloud.metaapi.sdk.clients.error_handler
Throwing this error results in 401 (Unauthorized) HTTP response code.
UnauthorizedException(String) - Constructor for exception cloud.metaapi.sdk.clients.error_handler.UnauthorizedException
Constructs unauthorized error.
undeploy() - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccount
Schedules account for undeployment.
undeployAccount(String) - Method in class cloud.metaapi.sdk.clients.meta_api.MetatraderAccountClient
Stops API server for a MetaTrader account.
units - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyMaxStopLoss
SL units.
unrealizedProfit - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition
Profit of the part of the position which is not yet closed, including swap
update(MetatraderAccountUpdateDto) - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccount
Updates MetaTrader account data
update(ProvisioningProfileUpdateDto) - Method in class cloud.metaapi.sdk.meta_api.ProvisioningProfile
Updates provisioning profile
updateAccount(String, CopyFactoryAccountUpdate) - Method in class cloud.metaapi.sdk.clients.copy_factory.ConfigurationClient
Updates a CopyFactory trade copying account.
updateAccount(String, MetatraderAccountUpdateDto) - Method in class cloud.metaapi.sdk.clients.meta_api.MetatraderAccountClient
Updates existing metatrader account data (see https://metaapi.cloud/docs/provisioning/api/account/updateAccount/).
updateDiskStorage() - Method in class cloud.metaapi.sdk.meta_api.HistoryFileManager
Saves unsaved history items to disk storage
updateDiskStorage() - Method in class cloud.metaapi.sdk.meta_api.MemoryHistoryStorage
Saves unsaved history items to disk storage.
updateJobIntervalInMilliseconds - Variable in class cloud.metaapi.sdk.meta_api.HistoryFileManager
Defines interval between update jobs.
updatePending - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal
Flag indicating that deal client id and original comment was not identified yet and will be updated in a future synchronization packet, or null
updatePending - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
Optional flag indicating that order client id and original comment was not identified yet and will be updated in a future synchronization packet, or null
updateProvisioningProfile(String, ProvisioningProfileUpdateDto) - Method in class cloud.metaapi.sdk.clients.meta_api.ProvisioningProfileClient
Updates existing provisioning profile data (see https://metaapi.cloud/docs/provisioning/api/provisioningProfile/updateProvisioningProfile/).
updateStorage() - Method in class cloud.metaapi.sdk.meta_api.HistoryStorage
Saves unsaved history items to storage
updateStorage() - Method in class cloud.metaapi.sdk.meta_api.MemoryHistoryStorage
 
updateStrategy(String, CopyFactoryStrategyUpdate) - Method in class cloud.metaapi.sdk.clients.copy_factory.ConfigurationClient
Updates a CopyFactory strategy.
updateTime - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition
Last position modification time
uploadFile(String, String) - Method in class cloud.metaapi.sdk.meta_api.ProvisioningProfile
Uploads a file to provisioning profile.
uploadFile(String, InputStream) - Method in class cloud.metaapi.sdk.meta_api.ProvisioningProfile
Uploads a file to provisioning profile.
uploadProvisioningProfileFile(String, String, String) - Method in class cloud.metaapi.sdk.clients.meta_api.ProvisioningProfileClient
Uploads a file to a provisioning profile (see https://metaapi.cloud/docs/provisioning/api/provisioningProfile/uploadFilesToProvisioningProfile/).
uploadProvisioningProfileFile(String, String, InputStream) - Method in class cloud.metaapi.sdk.clients.meta_api.ProvisioningProfileClient
Uploads a file to a provisioning profile (see https://metaapi.cloud/docs/provisioning/api/provisioningProfile/uploadFilesToProvisioningProfile/).

V

ValidationDetails - Class in cloud.metaapi.sdk.clients.models
Object to supply additional information for validation exceptions
ValidationDetails() - Constructor for class cloud.metaapi.sdk.clients.models.ValidationDetails
 
ValidationException - Exception in cloud.metaapi.sdk.clients.error_handler
Represents validation error.
ValidationException(String, List<ValidationDetails>) - Constructor for exception cloud.metaapi.sdk.clients.error_handler.ValidationException
Constructs validation error.
value - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyMaxStopLoss
Maximum SL value
value - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategyStopOutRisk
Value of the stop out risk, expressed as a fraction of 1
value - Variable in class cloud.metaapi.sdk.clients.models.ValidationDetails
Value of the parameter
valueOf(String) - Static method in enum cloud.metaapi.sdk.clients.HttpRequestOptions.Method
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.AccountType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.ExpirationOptions.ExpirationType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountDto.ConnectionStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountDto.DeploymentState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal.DealEntryType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal.DealReason
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal.DealType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder.FillingMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder.OrderReason
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder.OrderState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder.OrderType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition.PositionReason
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition.PositionType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderSymbolSpecification.ExecutionMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderSymbolSpecification.FillingMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderTrade.ActionType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.Version
Returns the enum constant of this type with the specified name.
values() - Static method in enum cloud.metaapi.sdk.clients.HttpRequestOptions.Method
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.AccountType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.ExpirationOptions.ExpirationType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountDto.ConnectionStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountDto.DeploymentState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal.DealEntryType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal.DealReason
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal.DealType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder.FillingMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder.OrderReason
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder.OrderState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder.OrderType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition.PositionReason
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition.PositionType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderSymbolSpecification.ExecutionMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderSymbolSpecification.FillingMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.MetatraderTrade.ActionType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum cloud.metaapi.sdk.clients.meta_api.models.Version
Returns an array containing the constants of this enum type, in the order they are declared.
version - Variable in class cloud.metaapi.sdk.clients.meta_api.models.AccountsFilter
MT version or null
version - Variable in class cloud.metaapi.sdk.clients.meta_api.models.NewProvisioningProfileDto
MetaTrader version (allowed values are 4 and 5)
version - Variable in class cloud.metaapi.sdk.clients.meta_api.models.ProvisioningProfileDto
MetaTrader version (allowed values are 4 and 5)
Version - Enum in cloud.metaapi.sdk.clients.meta_api.models
MT version
volume - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderDeal
Deal volume or null
volume - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder
Order requested quantity
volume - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderPosition
Position volume
volume - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderTrade
Order volume or null
volumeStep - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderSymbolSpecification
Order volume step for the symbol

W

waitConnected() - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccount
Waits until API server has connected to the terminal and terminal has connected to the broker.
waitConnected(Integer, Integer) - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccount
Waits until API server has connected to the terminal and terminal has connected to the broker.
waitDeployed(Integer, Integer) - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccount
Waits until API server has finished deployment and account reached the DEPLOYED state.
waitRemoved(Integer, Integer) - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccount
Waits until account has been deleted.
waitSynchronized() - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Waits until synchronization to MetaTrader terminal is completed.
waitSynchronized(String) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Waits until synchronization to MetaTrader terminal is completed.
waitSynchronized(String, Integer, Integer) - Method in class cloud.metaapi.sdk.meta_api.MetaApiConnection
Waits until synchronization to MetaTrader terminal is completed.
waitUndeployed(Integer, Integer) - Method in class cloud.metaapi.sdk.meta_api.MetatraderAccount
Waits until API server has finished undeployment and account reached the UNDEPLOYED state.
WebsocketError - Class in cloud.metaapi.sdk.clients.models
Contains an error message from websocket.
WebsocketError() - Constructor for class cloud.metaapi.sdk.clients.models.WebsocketError
 

_

_id - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryAccount
Account unique identifier
_id - Variable in class cloud.metaapi.sdk.clients.copy_factory.models.CopyFactoryStrategy
Unique strategy id
_id - Variable in class cloud.metaapi.sdk.clients.meta_api.models.MetatraderAccountDto
Account unique identifier
_id - Variable in class cloud.metaapi.sdk.clients.meta_api.models.ProvisioningProfileDto
Provisioning profile unique identifier
A B C D E F G H I J L M N O P Q R S T U V W _ 
Skip navigation links

Copyright © 2020. All rights reserved.