import { MarketDataSubscription, MarketDataUnsubscription, MetatraderAccountInformation, MetatraderBook, MetatraderTick, MetatraderCandle, MetatraderSymbolPrice, MetatraderSymbolSpecification, MetatraderDeal, MetatraderOrder, MetatraderPosition } from "./metaApiWebsocket.client" /** * Defines interface for a synchronization listener class */ export default class SynchronizationListener { /** * Returns instance number of instance index * @param {string} instanceIndex instance index */ getInstanceNumber(instanceIndex: string): number | undefined; /** * Returns host name of instance index * @param {string} instanceIndex instance index */ getHostName(instanceIndex: string): string | undefined; /** * Invoked when connection to MetaTrader terminal established * @param {string} instanceIndex index of an account instance connected * @param {number} replicas number of account replicas launched * @return {Promise} promise which resolves when the asynchronous event is processed */ onConnected(instanceIndex: string, replicas: number): Promise; /** * Invoked when a server-side application health status is received from MetaApi * @param {string} instanceIndex index of an account instance connected * @param {HealthStatus} status server-side application health status * @return {Promise} promise which resolves when the asynchronous event is processed */ onHealthStatus(instanceIndex: string, status: HealthStatus): Promise; /** * Invoked when connection to MetaTrader terminal terminated * @param {string} instanceIndex index of an account instance connected * @return {Promise} promise which resolves when the asynchronous event is processed */ onDisconnected(instanceIndex: string): Promise; /** * Invoked when broker connection satus have changed * @param {string} instanceIndex index of an account instance connected * @param {boolean} connected is MetaTrader terminal is connected to broker * @return {Promise} promise which resolves when the asynchronous event is processed */ onBrokerConnectionStatusChanged(instanceIndex: string, connected: boolean): Promise; /** * Invoked when MetaTrader terminal state synchronization is started * @param {string} instanceIndex index of an account instance connected * @param {string} specificationsHash specifications hash * @param {string} positionsHash positions hash * @param {string} ordersHash orders hash * @param {string} synchronizationId synchronization id * @return {Promise} promise which resolves when the asynchronous event is processed */ onSynchronizationStarted(instanceIndex: string, specificationsHash: string, positionsHash: string, ordersHash: string, synchronizationId: string): Promise; /** * Invoked when MetaTrader account information is updated * @param {string} instanceIndex index of an account instance connected * @param {MetatraderAccountInformation} accountInformation updated MetaTrader account information * @return {Promise} promise which resolves when the asynchronous event is processed */ onAccountInformationUpdated(instanceIndex: string, accountInformation: MetatraderAccountInformation): Promise; /** * Invoked when the positions are replaced as a result of initial terminal state synchronization. This method * will be invoked only if server thinks the data was updated, otherwise invocation can be skipped * @param {string} instanceIndex index of an account instance connected * @param {Array} positions updated array of positions * @return {Promise} promise which resolves when the asynchronous event is processed */ onPositionsReplaced(instanceIndex: string, positions: Array): Promise; /** * Invoked when position synchronization fnished to indicate progress of an initial terminal state synchronization * @param {string} instanceIndex index of an account instance connected * @param {string} synchronizationId synchronization request id * @return {Promise} promise which resolves when the asynchronous event is processed */ onPositionsSynchronized(instanceIndex: string, synchronizationId: string): Promise; /** * Invoked when MetaTrader positions are updated * @param {string} instanceIndex index of an account instance connected * @param {MetatraderPosition[]} positions updated MetaTrader positions * @param {string[]} removedPositionIds removed position ids * @return {Promise} promise which resolves when the asynchronous event is processed */ onPositionsUpdated(instanceIndex: string, positions: MetatraderPosition[], removedPositionIds: string[]): Promise; /** * Invoked when MetaTrader position is updated * @param {string} instanceIndex index of an account instance connected * @param {MetatraderPosition} position updated MetaTrader position * @return {Promise} promise which resolves when the asynchronous event is processed */ onPositionUpdated(instanceIndex: string, position: MetatraderPosition): Promise; /** * Invoked when MetaTrader position is removed * @param {string} instanceIndex index of an account instance connected * @param {string} positionId removed MetaTrader position id * @return {Promise} promise which resolves when the asynchronous event is processed */ onPositionRemoved(instanceIndex: string, positionId: string): Promise; /** * Invoked when the pending orders are replaced as a result of initial terminal state synchronization. This method * will be invoked only if server thinks the data was updated, otherwise invocation can be skipped * @param {string} instanceIndex index of an account instance connected * @param {Array} orders updated array of pending orders * @return {Promise} promise which resolves when the asynchronous event is processed */ onPendingOrdersReplaced(instanceIndex: string, orders: Array): Promise; /** * Invoked when MetaTrader pending orders are updated or completed * @param {string} instanceIndex index of an account instance connected * @param {MetatraderOrder[]} orders updated MetaTrader pending orders * @param {string[]} completedOrderIds completed MetaTrader pending order ids * @return {Promise} promise which resolves when the asynchronous event is processed */ onPendingOrdersUpdated(instanceIndex: string, orders: MetatraderOrder[], completedOrderIds: string[]): Promise; /** * Invoked when MetaTrader pending order is updated * @param {string} instanceIndex index of an account instance connected * @param {MetatraderOrder} order updated MetaTrader pending order * @return {Promise} promise which resolves when the asynchronous event is processed */ onPendingOrderUpdated(instanceIndex: string, order: MetatraderOrder): Promise; /** * Invoked when MetaTrader pending order is completed (executed or canceled) * @param {string} instanceIndex index of an account instance connected * @param {string} orderId completed MetaTrader pending order id * @return {Promise} promise which resolves when the asynchronous event is processed */ onPendingOrderCompleted(instanceIndex: string, orderId: string): Promise; /** * Invoked when pending order synchronization fnished to indicate progress of an initial terminal state * synchronization * @param {string} instanceIndex index of an account instance connected * @param {string} synchronizationId synchronization request id * @return {Promise} promise which resolves when the asynchronous event is processed */ onPendingOrdersSynchronized(instanceIndex: string, synchronizationId: string): Promise; /** * Invoked when a new MetaTrader history order is added * @param {string} instanceIndex index of an account instance connected * @param {MetatraderOrder} historyOrder new MetaTrader history order * @return {Promise} promise which resolves when the asynchronous event is processed */ onHistoryOrderAdded(instanceIndex: string, historyOrder: MetatraderOrder): Promise; /** * Invoked when a synchronization of history orders on a MetaTrader account have finished to indicate progress of an * initial terminal state synchronization * @param {string} instanceIndex index of an account instance connected * @param {string} synchronizationId synchronization request id * @return {Promise} promise which resolves when the asynchronous event is processed */ onHistoryOrdersSynchronized(instanceIndex: string, synchronizationId: string): Promise; /** * Invoked when a new MetaTrader history deal is added * @param {string} instanceIndex index of an account instance connected * @param {MetatraderDeal} deal new MetaTrader history deal * @return {Promise} promise which resolves when the asynchronous event is processed */ onDealAdded(instanceIndex: string, deal: MetatraderDeal): Promise; /** * Invoked when a synchronization of history deals on a MetaTrader account have finished to indicate progress of an * initial terminal state synchronization * @param {string} instanceIndex index of an account instance connected * @param {string} synchronizationId synchronization request id * @return {Promise} promise which resolves when the asynchronous event is processed */ onDealsSynchronized(instanceIndex: string, synchronizationId: string): Promise; /** * Invoked when a symbol specification was updated * @param {string} instanceIndex index of an account instance connected * @param {MetatraderSymbolSpecification} specification updated MetaTrader symbol specification * @return {Promise} promise which resolves when the asynchronous event is processed */ onSymbolSpecificationUpdated(instanceIndex: string, specification: MetatraderSymbolSpecification): Promise; /** * Invoked when a symbol specification was removed * @param {string} instanceIndex index of an account instance connected * @param {string} symbol removed symbol * @returns {Promise} promise which resolves when the asynchronous event is processed */ onSymbolSpecificationRemoved(instanceIndex: string, symbol: string): Promise; /** * Invoked when a symbol specifications were updated * @param {string} instanceIndex index of account instance connected * @param {Array} specifications updated specifications * @param {Array} removedSymbols removed symbols * @return {Promise} promise which resolves when the asynchronous event is processed */ onSymbolSpecificationsUpdated(instanceIndex: string, specifications: Array, removedSymbols: Array): Promise; /** * Invoked when a symbol price was updated * @param {string} instanceIndex index of an account instance connected * @param {MetatraderSymbolPrice} price updated MetaTrader symbol price * @return {Promise} promise which resolves when the asynchronous event is processed */ onSymbolPriceUpdated(instanceIndex: string, price: MetatraderSymbolPrice): Promise; /** * Invoked when prices for several symbols were updated * @param {string} instanceIndex index of an account instance connected * @param {Array} prices updated MetaTrader symbol prices * @param {number} equity account liquidation value * @param {number} margin margin used * @param {number} freeMargin free margin * @param {number} marginLevel margin level calculated as % of equity/margin * @param {number} accountCurrencyExchangeRate current exchange rate of account currency into USD * @return {Promise} promise which resolves when the asynchronous event is processed */ onSymbolPricesUpdated(instanceIndex: string, prices: Array, equity: number, margin: number, freeMargin: number, marginLevel: number, accountCurrencyExchangeRate: number): Promise; /** * Invoked when symbol candles were updated * @param {string} instanceIndex index of an account instance connected * @param {Array} candles updated MetaTrader symbol candles * @param {number} equity account liquidation value * @param {number} margin margin used * @param {number} freeMargin free margin * @param {number} marginLevel margin level calculated as % of equity/margin * @param {number} accountCurrencyExchangeRate current exchange rate of account currency into USD * @return {Promise} promise which resolves when the asynchronous event is processed */ onCandlesUpdated(instanceIndex: string, candles: Array, equity: number, margin: number, freeMargin: number, marginLevel: number, accountCurrencyExchangeRate: number): Promise; /** * Invoked when symbol ticks were updated * @param {string} instanceIndex index of an account instance connected * @param {Array} ticks updated MetaTrader symbol ticks * @param {number} equity account liquidation value * @param {number} margin margin used * @param {number} freeMargin free margin * @param {number} marginLevel margin level calculated as % of equity/margin * @param {number} accountCurrencyExchangeRate current exchange rate of account currency into USD * @return {Promise} promise which resolves when the asynchronous event is processed */ onTicksUpdated(instanceIndex: string, ticks: Array, equity: number, margin: number, freeMargin: number, marginLevel: number, accountCurrencyExchangeRate: number): Promise; /** * Invoked when order books were updated * @param {string} instanceIndex index of an account instance connected * @param {Array} books updated MetaTrader order books * @param {number} equity account liquidation value * @param {number} margin margin used * @param {number} freeMargin free margin * @param {number} marginLevel margin level calculated as % of equity/margin * @param {number} accountCurrencyExchangeRate current exchange rate of account currency into USD * @return {Promise} promise which resolves when the asynchronous event is processed */ onBooksUpdated(instanceIndex: string, books: Array, equity: number, margin: number, freeMargin: number, marginLevel: number, accountCurrencyExchangeRate: number): Promise; /** * Invoked when subscription downgrade has occurred * @param {string} instanceIndex index of an account instance connected * @param {string} symbol symbol to update subscriptions for * @param {Array} updates array of market data subscription to update * @param {Array} unsubscriptions array of subscriptions to cancel * @return {Promise} promise which resolves when the asynchronous event is processed */ onSubscriptionDowngraded(instanceIndex: string, symbol: string, updates: Array, unsubscriptions: Array): Promise; /** * Invoked when a stream for an instance index is closed * @param {string} instanceIndex index of an account instance connected */ onStreamClosed(instanceIndex: string): Promise; /** * Invoked when account region has been unsubscribed * @param {string} region account region unsubscribed * @return {Promise} promise which resolves when the asynchronous event is processed */ onUnsubscribeRegion(region: string): Promise; } /** * Server-side application health status */ export declare type HealthStatus = { /** * flag indicating that REST API is healthy */ restApiHealthy?: boolean, /** * flag indicating that CopyFactory subscriber is healthy */ copyFactorySubscriberHealthy?: boolean, /** * flag indicating that CopyFactory provider is healthy */ copyFactoryProviderHealthy?: boolean }