cloud.metaapi.sdk.meta_api

Class MetaApiConnection

java.lang.Object

cloud.metaapi.sdk.clients.meta_api.SynchronizationListener

cloud.metaapi.sdk.meta_api.MetaApiConnection

All Implemented Interfaces:

ReconnectListener

public class MetaApiConnection
extends SynchronizationListener
implements ReconnectListener

Exposes MetaApi MetaTrader API connection to consumers

Nested Class Summary

Nested classes/interfaces inherited from class cloud.metaapi.sdk.clients.meta_api.SynchronizationListener

SynchronizationListener.HealthStatus

Constructor Summary

Constructors

Constructor and Description
MetaApiConnection(MetaApiWebsocketClient websocketClient, MetatraderAccount account, HistoryStorage historyStorage, ConnectionRegistry connectionRegistry) Constructs MetaApi MetaTrader Api connection
MetaApiConnection(MetaApiWebsocketClient websocketClient, MetatraderAccount account, HistoryStorage historyStorage, ConnectionRegistry connectionRegistry, IsoTime historyStartTime) Constructs MetaApi MetaTrader Api connection

Method Summary

Modifier and Type	Method and Description
void	addSynchronizationListener(SynchronizationListener listener) Adds synchronization listener
CompletableFuture<MetatraderTradeResponse>	cancelOrder(String orderId) Cancels order (see https://metaapi.cloud/docs/client/websocket/api/trade/).
CompletableFuture<Void>	close() Closes the connection.
CompletableFuture<MetatraderTradeResponse>	closeBy(String positionId, String oppositePositionId, MarketTradeOptions options) Fully closes a position (see https://metaapi.cloud/docs/client/websocket/api/trade/).
CompletableFuture<MetatraderTradeResponse>	closePosition(String positionId, MarketTradeOptions options) Fully closes a position (see https://metaapi.cloud/docs/client/websocket/api/trade/).
CompletableFuture<MetatraderTradeResponse>	closePositionPartially(String positionId, double volume, MarketTradeOptions options) Partially closes a position (see https://metaapi.cloud/docs/client/websocket/api/trade/).
CompletableFuture<MetatraderTradeResponse>	closePositionsBySymbol(String symbol, MarketTradeOptions options) Closes position by a symbol (see https://metaapi.cloud/docs/client/websocket/api/trade/)
CompletableFuture<MetatraderTradeResponse>	createLimitBuyOrder(String symbol, double volume, double openPrice, Double stopLoss, Double takeProfit, PendingTradeOptions options) Creates a limit buy order (see https://metaapi.cloud/docs/client/websocket/api/trade/).
CompletableFuture<MetatraderTradeResponse>	createLimitSellOrder(String symbol, double volume, double openPrice, Double stopLoss, Double takeProfit, PendingTradeOptions options) Creates a limit sell order (see https://metaapi.cloud/docs/client/websocket/api/trade/).
CompletableFuture<MetatraderTradeResponse>	createMarketBuyOrder(String symbol, double volume, Double stopLoss, Double takeProfit, MarketTradeOptions options) Creates a market buy order (see https://metaapi.cloud/docs/client/websocket/api/trade/).
CompletableFuture<MetatraderTradeResponse>	createMarketSellOrder(String symbol, double volume, Double stopLoss, Double takeProfit, MarketTradeOptions options) Creates a market sell order (see https://metaapi.cloud/docs/client/websocket/api/trade/).
CompletableFuture<MetatraderTradeResponse>	createStopBuyOrder(String symbol, double volume, double openPrice, Double stopLoss, Double takeProfit, PendingTradeOptions options) Creates a stop buy order (see https://metaapi.cloud/docs/client/websocket/api/trade/).
CompletableFuture<MetatraderTradeResponse>	createStopLimitBuyOrder(String symbol, double volume, double openPrice, double stopLimitPrice, Double stopLoss, Double takeProfit, PendingTradeOptions options) Creates a stop limit buy order (see https://metaapi.cloud/docs/client/websocket/api/trade/).
CompletableFuture<MetatraderTradeResponse>	createStopLimitSellOrder(String symbol, double volume, double openPrice, double stopLimitPrice, Double stopLoss, Double takeProfit, PendingTradeOptions options) Creates a stop limit sell order (see https://metaapi.cloud/docs/client/websocket/api/trade/).
CompletableFuture<MetatraderTradeResponse>	createStopSellOrder(String symbol, double volume, double openPrice, Double stopLoss, Double takeProfit, PendingTradeOptions options) Creates a stop sell order (see https://metaapi.cloud/docs/client/websocket/api/trade/).
MetatraderAccount	getAccount() Returns MetaApi account
CompletableFuture<MetatraderAccountInformation>	getAccountInformation() Returns account information (see https://metaapi.cloud/docs/client/websocket/api/readTradingTerminalState/readAccountInformation/).
CompletableFuture<MetatraderDeals>	getDealsByPosition(String positionId) Returns history deals for a specific position id (see https://metaapi.cloud/docs/client/websocket/api/retrieveHistoricalData/readDealsByPosition/).
CompletableFuture<MetatraderDeals>	getDealsByTicket(String ticket) Returns history deals with a specific ticket number (see https://metaapi.cloud/docs/client/websocket/api/retrieveHistoricalData/readDealsByTicket/).
CompletableFuture<MetatraderDeals>	getDealsByTimeRange(IsoTime startTime, IsoTime endTime, int offset, int limit) Returns history deals with for a specific time range (see https://metaapi.cloud/docs/client/websocket/api/retrieveHistoricalData/readDealsByTimeRange/).
ConnectionHealthMonitor	getHealthMonitor() Returns connection health monitor instance
CompletableFuture<MetatraderHistoryOrders>	getHistoryOrdersByPosition(String positionId) Returns the history of completed orders for a specific position id (see https://metaapi.cloud/docs/client/websocket/api/retrieveHistoricalData/readHistoryOrdersByPosition/)
CompletableFuture<MetatraderHistoryOrders>	getHistoryOrdersByTicket(String ticket) Returns the history of completed orders for a specific ticket number (see https://metaapi.cloud/docs/client/websocket/api/retrieveHistoricalData/readHistoryOrdersByTicket/).
CompletableFuture<MetatraderHistoryOrders>	getHistoryOrdersByTimeRange(IsoTime startTime, IsoTime endTime, int offset, int limit) Returns the history of completed orders for a specific time range (see https://metaapi.cloud/docs/client/websocket/api/retrieveHistoricalData/readHistoryOrdersByTimeRange/)
HistoryStorage	getHistoryStorage() Returns local history storage
CompletableFuture<MetatraderOrder>	getOrder(String orderId) Returns specific open order (see https://metaapi.cloud/docs/client/websocket/api/readTradingTerminalState/readOrder/).
CompletableFuture<List<MetatraderOrder>>	getOrders() Returns open orders (see https://metaapi.cloud/docs/client/websocket/api/readTradingTerminalState/readOrders/).
CompletableFuture<MetatraderPosition>	getPosition(String positionId) Returns specific position (see https://metaapi.cloud/docs/client/websocket/api/readTradingTerminalState/readPosition/).
CompletableFuture<List<MetatraderPosition>>	getPositions() Returns positions (see https://metaapi.cloud/docs/client/websocket/api/readTradingTerminalState/readPositions/).
List<String>	getSubscribedSymbols() Returns list of the symbols connection is subscribed to
CompletableFuture<MetatraderSymbolPrice>	getSymbolPrice(String symbol) Retrieves specification for a symbol (see https://metaapi.cloud/docs/client/websocket/api/retrieveMarketData/getSymbolPrice/).
CompletableFuture<MetatraderSymbolSpecification>	getSymbolSpecification(String symbol) Retrieves specification for a symbol (see https://metaapi.cloud/docs/client/websocket/api/retrieveMarketData/getSymbolSpecification/).
TerminalState	getTerminalState() Returns local copy of terminal state
CompletableFuture<Void>	initialize() Initializes meta api connection
boolean	isSynchronized() Returns synchronization status
CompletableFuture<Boolean>	isSynchronized(Integer instanceIndex, String synchronizationId) Returns flag indicating status of state synchronization with MetaTrader terminal
CompletableFuture<MetatraderTradeResponse>	modifyOrder(String orderId, double openPrice, double stopLoss, double takeProfit) Modifies a pending order (see https://metaapi.cloud/docs/client/websocket/api/trade/).
CompletableFuture<MetatraderTradeResponse>	modifyPosition(String positionId, Double stopLoss, Double takeProfit) Modifies a position (see https://metaapi.cloud/docs/client/websocket/api/trade/).
CompletableFuture<Void>	onConnected(int instanceIndex, int replicas) Invoked when connection to MetaTrader terminal established
CompletableFuture<Void>	onDealSynchronizationFinished(int instanceIndex, String synchronizationId) Invoked when a synchronization of history deals on a MetaTrader account have finished
CompletableFuture<Void>	onDisconnected(int instanceIndex) Invoked when connection to MetaTrader terminal terminated
CompletableFuture<Void>	onOrderSynchronizationFinished(int instanceIndex, String synchronizationId) Invoked when a synchronization of history orders on a MetaTrader account have finished
CompletableFuture<Void>	onReconnected() Invoked when connection to MetaTrader terminal re-established
CompletableFuture<Void>	reconnect() Reconnects to the Metatrader terminal (see https://metaapi.cloud/docs/client/websocket/api/reconnect/).
CompletableFuture<Void>	removeApplication() Clears the order and transaction history of a specified application and removes application (see https://metaapi.cloud/docs/client/websocket/api/removeApplication/).
CompletableFuture<Void>	removeHistory() Clears the order and transaction history of a specified application so that it can be synchronized from scratch (see https://metaapi.cloud/docs/client/websocket/api/removeHistory/).
CompletableFuture<Void>	removeHistory(String application) Clears the order and transaction history of a specified application so that it can be synchronized from scratch (see https://metaapi.cloud/docs/client/websocket/api/removeHistory/).
void	removeSynchronizationListener(SynchronizationListener listener) Removes synchronization listener for specific account
CompletableFuture<Void>	saveUptime(Map<String,Double> uptime) Sends client uptime stats to the server.
CompletableFuture<Void>	subscribe() Initiates subscription to MetaTrader terminal
CompletableFuture<Void>	subscribeToMarketData(String symbol, int instanceIndex) Subscribes on market data of specified symbol (see https://metaapi.cloud/docs/client/websocket/marketDataStreaming/subscribeToMarketData/).
CompletableFuture<Void>	synchronize(int instanceIndex) Requests the terminal to start synchronization process (see https://metaapi.cloud/docs/client/websocket/synchronizing/synchronize/)
CompletableFuture<Void>	unsubscribeFromMarketData(String symbol, int instanceIndex) Unsubscribes from market data of specified symbol (see https://metaapi.cloud/docs/client/websocket/marketDataStreaming/unsubscribeFromMarketData/).
CompletableFuture<Void>	waitSynchronized() Waits until synchronization to MetaTrader terminal is completed.
CompletableFuture<Void>	waitSynchronized(SynchronizationOptions options) Waits until synchronization to MetaTrader terminal is completed.

Methods inherited from class cloud.metaapi.sdk.clients.meta_api.SynchronizationListener

onAccountInformationUpdated, onBrokerConnectionStatusChanged, onDealAdded, onHealthStatus, onHistoryOrderAdded, onOrderCompleted, onOrdersReplaced, onOrderUpdated, onPositionRemoved, onPositionsReplaced, onPositionUpdated, onSymbolPricesUpdated, onSymbolPriceUpdated, onSymbolSpecificationUpdated, onSynchronizationStarted

Methods inherited from class java.lang.Object

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

Constructor Detail

MetaApiConnection

public MetaApiConnection(MetaApiWebsocketClient websocketClient,
                         MetatraderAccount account,
                         HistoryStorage historyStorage,
                         ConnectionRegistry connectionRegistry)

Constructs MetaApi MetaTrader Api connection

Parameters:

websocketClient - MetaApi websocket client

account - MetaTrader account to connect to

historyStorage - terminal history storage or null. By default an instance of MemoryHistoryStorage will be used.

connectionRegistry - metatrader account connection registry

MetaApiConnection

public MetaApiConnection(MetaApiWebsocketClient websocketClient,
                         MetatraderAccount account,
                         HistoryStorage historyStorage,
                         ConnectionRegistry connectionRegistry,
                         IsoTime historyStartTime)

Constructs MetaApi MetaTrader Api connection

Parameters:

websocketClient - MetaApi websocket client

account - MetaTrader account to connect to

historyStorage - terminal history storage or null. By default an instance of MemoryHistoryStorage will be used.

connectionRegistry - metatrader account connection registry

historyStartTime - history start sync time, or null

Method Detail

getAccountInformation

public CompletableFuture<MetatraderAccountInformation> getAccountInformation()

Returns account information (see https://metaapi.cloud/docs/client/websocket/api/readTradingTerminalState/readAccountInformation/).

Returns:

completable future resolving with account information

getPositions

public CompletableFuture<List<MetatraderPosition>> getPositions()

Returns positions (see https://metaapi.cloud/docs/client/websocket/api/readTradingTerminalState/readPositions/).

Returns:

completable future resolving with array of open positions

getPosition

public CompletableFuture<MetatraderPosition> getPosition(String positionId)

Returns specific position (see https://metaapi.cloud/docs/client/websocket/api/readTradingTerminalState/readPosition/).

Parameters:

positionId - position id

Returns:

completable future resolving with MetaTrader position found

getOrders

public CompletableFuture<List<MetatraderOrder>> getOrders()

Returns open orders (see https://metaapi.cloud/docs/client/websocket/api/readTradingTerminalState/readOrders/).

Returns:

completable future resolving with open MetaTrader orders

getOrder

public CompletableFuture<MetatraderOrder> getOrder(String orderId)

Returns specific open order (see https://metaapi.cloud/docs/client/websocket/api/readTradingTerminalState/readOrder/).

Parameters:

orderId - order id (ticket number)

Returns:

completable future resolving with metatrader order found

getHistoryOrdersByTicket

public CompletableFuture<MetatraderHistoryOrders> getHistoryOrdersByTicket(String ticket)

Returns the history of completed orders for a specific ticket number (see https://metaapi.cloud/docs/client/websocket/api/retrieveHistoricalData/readHistoryOrdersByTicket/).

Parameters:

ticket - ticket number (order id)

Returns:

completable future resolving with request results containing history orders found

getHistoryOrdersByPosition

public CompletableFuture<MetatraderHistoryOrders> getHistoryOrdersByPosition(String positionId)

Returns the history of completed orders for a specific position id (see https://metaapi.cloud/docs/client/websocket/api/retrieveHistoricalData/readHistoryOrdersByPosition/)

Parameters:

positionId - position id

Returns:

completable future resolving with request results containing history orders found

getHistoryOrdersByTimeRange

public CompletableFuture<MetatraderHistoryOrders> getHistoryOrdersByTimeRange(IsoTime startTime,
                                                                              IsoTime endTime,
                                                                              int offset,
                                                                              int limit)

Returns the history of completed orders for a specific time range (see https://metaapi.cloud/docs/client/websocket/api/retrieveHistoricalData/readHistoryOrdersByTimeRange/)

Parameters:

startTime - start of time range, inclusive

endTime - end of time range, exclusive

offset - pagination offset

limit - pagination limit

Returns:

completable future resolving with request results containing history orders found

getDealsByTicket

public CompletableFuture<MetatraderDeals> getDealsByTicket(String ticket)

Returns history deals with a specific ticket number (see https://metaapi.cloud/docs/client/websocket/api/retrieveHistoricalData/readDealsByTicket/).

Parameters:

ticket - ticket number (deal id for MT5 or order id for MT4)

Returns:

completable future resolving with request results containing deals found

getDealsByPosition

public CompletableFuture<MetatraderDeals> getDealsByPosition(String positionId)

Returns history deals for a specific position id (see https://metaapi.cloud/docs/client/websocket/api/retrieveHistoricalData/readDealsByPosition/).

Parameters:

positionId - position id

Returns:

completable future resolving with request results containing deals found

getDealsByTimeRange

public CompletableFuture<MetatraderDeals> getDealsByTimeRange(IsoTime startTime,
                                                              IsoTime endTime,
                                                              int offset,
                                                              int limit)

Returns history deals with for a specific time range (see https://metaapi.cloud/docs/client/websocket/api/retrieveHistoricalData/readDealsByTimeRange/).

Parameters:

startTime - start of time range, inclusive

endTime - end of time range, exclusive

offset - pagination offset

limit - pagination limit

Returns:

completable future resolving with request results containing deals found

removeHistory

public CompletableFuture<Void> removeHistory()

Clears the order and transaction history of a specified application so that it can be synchronized from scratch (see https://metaapi.cloud/docs/client/websocket/api/removeHistory/).

Returns:

completable future resolving when the history is cleared

removeHistory

public CompletableFuture<Void> removeHistory(String application)

Clears the order and transaction history of a specified application so that it can be synchronized from scratch (see https://metaapi.cloud/docs/client/websocket/api/removeHistory/).

Parameters:

application - application to remove history for, or null

Returns:

completable future resolving when the history is cleared

removeApplication

public CompletableFuture<Void> removeApplication()

Clears the order and transaction history of a specified application and removes application (see https://metaapi.cloud/docs/client/websocket/api/removeApplication/).

Returns:

completable future resolving when the history is cleared and application is removed

createMarketBuyOrder

public CompletableFuture<MetatraderTradeResponse> createMarketBuyOrder(String symbol,
                                                                       double volume,
                                                                       Double stopLoss,
                                                                       Double takeProfit,
                                                                       MarketTradeOptions options)

Creates a market buy order (see https://metaapi.cloud/docs/client/websocket/api/trade/).

Parameters:

symbol - symbol to trade

volume - order volume

stopLoss - optional stop loss price or null

takeProfit - optional take profit price or null

options - optional trade options or null

Returns:

completable future resolving with trade result or completing exceptionally with TradeException, check error properties for error code details

createMarketSellOrder

public CompletableFuture<MetatraderTradeResponse> createMarketSellOrder(String symbol,
                                                                        double volume,
                                                                        Double stopLoss,
                                                                        Double takeProfit,
                                                                        MarketTradeOptions options)

Creates a market sell order (see https://metaapi.cloud/docs/client/websocket/api/trade/).

Parameters:

symbol - symbol to trade

volume - order volume

stopLoss - optional stop loss price or null

takeProfit - optional take profit price or null

options - optional trade options or null

Returns:

completable future resolving with trade result or completing exceptionally with TradeException, check error properties for error code details

createLimitBuyOrder

public CompletableFuture<MetatraderTradeResponse> createLimitBuyOrder(String symbol,
                                                                      double volume,
                                                                      double openPrice,
                                                                      Double stopLoss,
                                                                      Double takeProfit,
                                                                      PendingTradeOptions options)

Creates a limit buy order (see https://metaapi.cloud/docs/client/websocket/api/trade/).

Parameters:

symbol - symbol to trade

volume - order volume

openPrice - order limit price

stopLoss - optional stop loss price or null

takeProfit - optional take profit price or null

options - optional trade options or null

Returns:

completable future resolving with trade result or completing exceptionally with TradeException, check error properties for error code details

createLimitSellOrder

public CompletableFuture<MetatraderTradeResponse> createLimitSellOrder(String symbol,
                                                                       double volume,
                                                                       double openPrice,
                                                                       Double stopLoss,
                                                                       Double takeProfit,
                                                                       PendingTradeOptions options)

Creates a limit sell order (see https://metaapi.cloud/docs/client/websocket/api/trade/).

Parameters:

symbol - symbol to trade

volume - order volume

openPrice - order limit price

stopLoss - optional stop loss price or null

takeProfit - optional take profit price or null

options - optional trade options or null

Returns:

completable future resolving with trade result or completing exceptionally with TradeException, check error properties for error code details

createStopBuyOrder

public CompletableFuture<MetatraderTradeResponse> createStopBuyOrder(String symbol,
                                                                     double volume,
                                                                     double openPrice,
                                                                     Double stopLoss,
                                                                     Double takeProfit,
                                                                     PendingTradeOptions options)

Creates a stop buy order (see https://metaapi.cloud/docs/client/websocket/api/trade/).

Parameters:

symbol - symbol to trade

volume - order volume

openPrice - order stop price

stopLoss - optional stop loss price or null

takeProfit - optional take profit price or null

options - optional trade options or null

Returns:

completable future resolving with trade result or completing exceptionally with TradeException, check error properties for error code details

createStopSellOrder

public CompletableFuture<MetatraderTradeResponse> createStopSellOrder(String symbol,
                                                                      double volume,
                                                                      double openPrice,
                                                                      Double stopLoss,
                                                                      Double takeProfit,
                                                                      PendingTradeOptions options)

Creates a stop sell order (see https://metaapi.cloud/docs/client/websocket/api/trade/).

Parameters:

symbol - symbol to trade

volume - order volume

openPrice - order stop price

stopLoss - optional stop loss price or null

takeProfit - optional take profit price or null

options - optional trade options or null

Returns:

completable future resolving with trade result or completing exceptionally with TradeException, check error properties for error code details

createStopLimitBuyOrder

public CompletableFuture<MetatraderTradeResponse> createStopLimitBuyOrder(String symbol,
                                                                          double volume,
                                                                          double openPrice,
                                                                          double stopLimitPrice,
                                                                          Double stopLoss,
                                                                          Double takeProfit,
                                                                          PendingTradeOptions options)

Creates a stop limit buy order (see https://metaapi.cloud/docs/client/websocket/api/trade/).

Parameters:

symbol - symbol to trade

volume - order volume

openPrice - order stop price

stopLimitPrice - the limit order price for the stop limit order

stopLoss - stop loss price, or null

takeProfit - take profit price, or null

options - trade options, or null

Returns:

completable future resolving with trade result or completing exceptionally with TradeException, check error properties for error code details

createStopLimitSellOrder

public CompletableFuture<MetatraderTradeResponse> createStopLimitSellOrder(String symbol,
                                                                           double volume,
                                                                           double openPrice,
                                                                           double stopLimitPrice,
                                                                           Double stopLoss,
                                                                           Double takeProfit,
                                                                           PendingTradeOptions options)

Creates a stop limit sell order (see https://metaapi.cloud/docs/client/websocket/api/trade/).

Parameters:

symbol - symbol to trade

volume - order volume

openPrice - order stop price

stopLimitPrice - the limit order price for the stop limit order

stopLoss - stop loss price, or null

takeProfit - take profit price, or null

options - trade options, or null

Returns:

completable future resolving with trade result or completing exceptionally with TradeException, check error properties for error code details

modifyPosition

public CompletableFuture<MetatraderTradeResponse> modifyPosition(String positionId,
                                                                 Double stopLoss,
                                                                 Double takeProfit)

Modifies a position (see https://metaapi.cloud/docs/client/websocket/api/trade/).

Parameters:

positionId - position id to modify

stopLoss - optional stop loss price or null

takeProfit - optional take profit price or null

Returns:

completable future resolving with trade result or completing exceptionally with TradeException, check error properties for error code details

closePositionPartially

public CompletableFuture<MetatraderTradeResponse> closePositionPartially(String positionId,
                                                                         double volume,
                                                                         MarketTradeOptions options)

Partially closes a position (see https://metaapi.cloud/docs/client/websocket/api/trade/).

Parameters:

positionId - position id to modify

volume - volume to close

options - optional trade options or null

Returns:

completable future resolving with trade result or completing exceptionally with TradeException, check error properties for error code details

closePosition

public CompletableFuture<MetatraderTradeResponse> closePosition(String positionId,
                                                                MarketTradeOptions options)

Fully closes a position (see https://metaapi.cloud/docs/client/websocket/api/trade/).

Parameters:

positionId - position id to modify

options - optional trade options or null

Returns:

completable future resolving with trade result or completing exceptionally with TradeException, check error properties for error code details

closeBy

public CompletableFuture<MetatraderTradeResponse> closeBy(String positionId,
                                                          String oppositePositionId,
                                                          MarketTradeOptions options)

Fully closes a position (see https://metaapi.cloud/docs/client/websocket/api/trade/).

Parameters:

positionId - position id to close by opposite position

oppositePositionId - opposite position id to close

options - optional trade options, or null

Returns:

completable future resolving with trade result or completing exceptionally with TradeException, check error properties for error code details

closePositionsBySymbol

public CompletableFuture<MetatraderTradeResponse> closePositionsBySymbol(String symbol,
                                                                         MarketTradeOptions options)

Closes position by a symbol (see https://metaapi.cloud/docs/client/websocket/api/trade/)

Parameters:

symbol - symbol to trade

options - optional trade options or null

Returns:

completable future resolving with trade result or completing exceptionally with TradeException, check error properties for error code details

modifyOrder

public CompletableFuture<MetatraderTradeResponse> modifyOrder(String orderId,
                                                              double openPrice,
                                                              double stopLoss,
                                                              double takeProfit)

Modifies a pending order (see https://metaapi.cloud/docs/client/websocket/api/trade/).

Parameters:

orderId - order id (ticket number)

openPrice - order stop price

stopLoss - optional stop loss price or null

takeProfit - optional take profit price or null

Returns:

completable future resolving with trade result or completing exceptionally with TradeException, check error properties for error code details

cancelOrder

public CompletableFuture<MetatraderTradeResponse> cancelOrder(String orderId)

Cancels order (see https://metaapi.cloud/docs/client/websocket/api/trade/).

Parameters:

orderId - order id (ticket number)

Returns:

completable future resolving with trade result or completing exceptionally with TradeException, check error properties for error code details

reconnect

public CompletableFuture<Void> reconnect()

Reconnects to the Metatrader terminal (see https://metaapi.cloud/docs/client/websocket/api/reconnect/).

Returns:

completable future which resolves when reconnection started

synchronize

public CompletableFuture<Void> synchronize(int instanceIndex)

Requests the terminal to start synchronization process (see https://metaapi.cloud/docs/client/websocket/synchronizing/synchronize/)

Parameters:

instanceIndex - instance index

Returns:

completable future which resolves when synchronization started

initialize

public CompletableFuture<Void> initialize()

Initializes meta api connection

Returns:

completable future which resolves when meta api connection is initialized

subscribe

public CompletableFuture<Void> subscribe()

Initiates subscription to MetaTrader terminal

Returns:

completable future which resolves when subscription is initiated

subscribeToMarketData

public CompletableFuture<Void> subscribeToMarketData(String symbol,
                                                     int instanceIndex)

Subscribes on market data of specified symbol (see https://metaapi.cloud/docs/client/websocket/marketDataStreaming/subscribeToMarketData/).

Parameters:

symbol - symbol (e.g. currency pair or an index)

instanceIndex - instance index

Returns:

completable future which resolves when subscription request was processed

unsubscribeFromMarketData

public CompletableFuture<Void> unsubscribeFromMarketData(String symbol,
                                                         int instanceIndex)

Unsubscribes from market data of specified symbol (see https://metaapi.cloud/docs/client/websocket/marketDataStreaming/unsubscribeFromMarketData/).

Parameters:

symbol - symbol (e.g. currency pair or an index)

instanceIndex - instance index

Returns:

completable future which resolves when unsubscription request was processed

getSubscribedSymbols

public List<String> getSubscribedSymbols()

Returns list of the symbols connection is subscribed to

Returns:

list of the symbols connection is subscribed to

getSymbolSpecification

public CompletableFuture<MetatraderSymbolSpecification> getSymbolSpecification(String symbol)

Retrieves specification for a symbol (see https://metaapi.cloud/docs/client/websocket/api/retrieveMarketData/getSymbolSpecification/).

Parameters:

symbol - symbol to retrieve specification for

Returns:

completable future which resolves with specification retrieved

getSymbolPrice

public CompletableFuture<MetatraderSymbolPrice> getSymbolPrice(String symbol)

Retrieves specification for a symbol (see https://metaapi.cloud/docs/client/websocket/api/retrieveMarketData/getSymbolPrice/).

Parameters:

symbol - symbol to retrieve price for

Returns:

completable future which resolves with price retrieved

saveUptime

public CompletableFuture<Void> saveUptime(Map<String,Double> uptime)

Sends client uptime stats to the server.

Parameters:

uptime - uptime statistics to send to the server

Returns:

completable future which resolves when uptime statistics is submitted

getTerminalState

public TerminalState getTerminalState()

Returns local copy of terminal state

Returns:

local copy of terminal state

getHistoryStorage

public HistoryStorage getHistoryStorage()

Returns local history storage

Returns:

local history storage

addSynchronizationListener

public void addSynchronizationListener(SynchronizationListener listener)

Adds synchronization listener

Parameters:

listener - synchronization listener to add

removeSynchronizationListener

public void removeSynchronizationListener(SynchronizationListener listener)

Removes synchronization listener for specific account

Parameters:

listener - synchronization listener to remove

onConnected

public CompletableFuture<Void> onConnected(int instanceIndex,
                                           int replicas)

Description copied from class: SynchronizationListener

Invoked when connection to MetaTrader terminal established

Overrides:

onConnected in class SynchronizationListener

Parameters:

instanceIndex - index of an account instance connected

replicas - number of account replicas launched

Returns:

completable future which resolves when the asynchronous event is processed

onDisconnected

public CompletableFuture<Void> onDisconnected(int instanceIndex)

Description copied from class: SynchronizationListener

Invoked when connection to MetaTrader terminal terminated

Overrides:

onDisconnected in class SynchronizationListener

Parameters:

instanceIndex - index of an account instance connected

Returns:

completable future which resolves when the asynchronous event is processed

onDealSynchronizationFinished

public CompletableFuture<Void> onDealSynchronizationFinished(int instanceIndex,
                                                             String synchronizationId)

Description copied from class: SynchronizationListener

Invoked when a synchronization of history deals on a MetaTrader account have finished

Overrides:

onDealSynchronizationFinished in class SynchronizationListener

Parameters:

instanceIndex - index of an account instance connected

synchronizationId - synchronization request id

Returns:

completable future which resolves when the asynchronous event is processed

onOrderSynchronizationFinished

public CompletableFuture<Void> onOrderSynchronizationFinished(int instanceIndex,
                                                              String synchronizationId)

Description copied from class: SynchronizationListener

Invoked when a synchronization of history orders on a MetaTrader account have finished

Overrides:

onOrderSynchronizationFinished in class SynchronizationListener

Parameters:

instanceIndex - index of an account instance connected

synchronizationId - synchronization request id

Returns:

completable future which resolves when the asynchronous event is processed

onReconnected

public CompletableFuture<Void> onReconnected()

Description copied from interface: ReconnectListener

Invoked when connection to MetaTrader terminal re-established

Specified by:

onReconnected in interface ReconnectListener

Returns:

completable future which resolves when the asynchronous event is processed

isSynchronized

public CompletableFuture<Boolean> isSynchronized(Integer instanceIndex,
                                                 String synchronizationId)

Returns flag indicating status of state synchronization with MetaTrader terminal

Parameters:

instanceIndex - index of an account instance connected

synchronizationId - optional synchronization request id, last synchronization request id will be used by default

Returns:

completable future resolving with a flag indicating status of state synchronization with MetaTrader terminal

waitSynchronized

public CompletableFuture<Void> waitSynchronized()

Waits until synchronization to MetaTrader terminal is completed. Completes exceptionally with TimeoutError if application failed to synchronize with the teminal withing timeout allowed.

Returns:

completable future which resolves when synchronization to MetaTrader terminal is completed

waitSynchronized

public CompletableFuture<Void> waitSynchronized(SynchronizationOptions options)

Waits until synchronization to MetaTrader terminal is completed. Completes exceptionally with TimeoutError if application failed to synchronize with the teminal withing timeout allowed.

Parameters:

options - synchronization options, or null

Returns:

completable future which resolves when synchronization to MetaTrader terminal is completed

close

public CompletableFuture<Void> close()

Closes the connection. The instance of the class should no longer be used after this method is invoked.

Returns:

completable future resolving when connection is closed

isSynchronized

public boolean isSynchronized()

Returns synchronization status

Returns:

synchronization status

getAccount

public MetatraderAccount getAccount()

Returns MetaApi account

Returns:

MetaApi account

getHealthMonitor

public ConnectionHealthMonitor getHealthMonitor()

Returns connection health monitor instance

Returns:

connection health monitor instance