Table of Contents

MT5 MT5API

MT5 class mtapi.mt5.MT5API → ViiSync ViiSyncAccountApi.

123 of 124 applicable members are fully covered, 1 partially.

MT5 member kind ViiSync equivalent status what differs
MT5API() ctor ViiSyncAccountApi (constructor) full pfx-certificate and proxy overloads are N/A (TLS via wss://; proxy -> see ProxyHost)
MT5API(ulong user, string password, string host, int port, byte[] pfxFile, string pfxFilePassword) ctor ViiSyncAccountApi (constructor) full pfx-certificate and proxy overloads are N/A (TLS via wss://; proxy -> see ProxyHost)
MT5API(ulong user, string password, string server, byte[] pfxFile, string pfxFilePassword) ctor ViiSyncAccountApi (constructor) full pfx-certificate and proxy overloads are N/A (TLS via wss://; proxy -> see ProxyHost)
MT5API(ulong user, string password, string host, int port) ctor ViiSyncAccountApi (constructor) full pfx-certificate and proxy overloads are N/A (TLS via wss://; proxy -> see ProxyHost)
MT5API(ulong user, string password, string host, int port, string proxyHost, int proxyPort, string proxyUser, string proxyPassword, ProxyTypes type) ctor ViiSyncAccountApi (constructor) full pfx-certificate and proxy overloads are N/A (TLS via wss://; proxy -> see ProxyHost)
ExecutionTimeout field ViiSyncAccountApi.ExecutionTimeout full
PlacedType field ViiSyncAccountApi.PlacedType full sent as ViiOrderInfo.Reason / ViiPositionCloseRequest.Reason: Mobile, Web, Expert (magic ≠ 0 stays Expert)
LoginIdPath field not applicable mtapi.io/MT5 platform plumbing (login-id service, certificates, servers.dat, cluster, internal request ids, MT5 build numbers) - no ViiSync counterpart needed
LoginIdWebServerTimeout field not applicable mtapi.io/MT5 platform plumbing (login-id service, certificates, servers.dat, cluster, internal request ids, MT5 build numbers) - no ViiSync counterpart needed
ApiKey field not applicable mtapi.io/MT5 platform plumbing (login-id service, certificates, servers.dat, cluster, internal request ids, MT5 build numbers) - no ViiSync counterpart needed
ExLoginManagers field not applicable mtapi.io/MT5 platform plumbing (login-id service, certificates, servers.dat, cluster, internal request ids, MT5 build numbers) - no ViiSync counterpart needed
ExLoginProxies field not applicable mtapi.io/MT5 platform plumbing (login-id service, certificates, servers.dat, cluster, internal request ids, MT5 build numbers) - no ViiSync counterpart needed
DisallowLocalConnections field not applicable mtapi.io/MT5 platform plumbing (login-id service, certificates, servers.dat, cluster, internal request ids, MT5 build numbers) - no ViiSync counterpart needed
UseConnectTask field not applicable mtapi.io/MT5 platform plumbing (login-id service, certificates, servers.dat, cluster, internal request ids, MT5 build numbers) - no ViiSync counterpart needed
ProxyEnable field ViiSyncAccountApi.Proxy full (different shape) one System.Net.IWebProxy property instead of six fields
ProxyHost field ViiSyncAccountApi.Proxy full (different shape) one System.Net.IWebProxy property instead of six fields
ProxyPort field ViiSyncAccountApi.Proxy full (different shape) one System.Net.IWebProxy property instead of six fields
ProxyUser field ViiSyncAccountApi.Proxy full (different shape) one System.Net.IWebProxy property instead of six fields
ProxyPassword field ViiSyncAccountApi.Proxy full (different shape) one System.Net.IWebProxy property instead of six fields
ProxyType field ViiSyncAccountApi.Proxy full (different shape) one System.Net.IWebProxy property instead of six fields
GetQuoteTimeoutMs field ViiSyncAccountApi.GetQuoteTimeoutMs full
ProcessEventTimeoutMs field ViiSyncAccountApi.ProcessEventTimeoutMs full event-handler watchdog: a handler slower than the limit is reported on OnLog and counted (SlowEventHandlers); events run on the receive loop
DownloadOrderHistoryTimeout field ViiSyncAccountApi.DownloadOrderHistoryTimeout full
Symbols field ViiSyncAccountApi.Symbols full
NoServerMessagesTimeout field ViiSyncAccountApi.NoServerMessagesTimeout full
LastServerMessageTime field ViiSyncAccountApi.LastServerMessageTime full
Server field ViiSyncAccountApi.Endpoint full
ConnectTimeout field ViiSyncAccountApi.ConnectTimeout full
ConnectTimeoutForOneClusterMember field not applicable MT5 cluster failover; ViiSync is one endpoint
Account property ViiSyncAccountApi.Account full
OtpPassword property not applicable mtapi.io/MT5 platform plumbing (login-id service, certificates, servers.dat, cluster, internal request ids, MT5 build numbers) - no ViiSync counterpart needed
ConnectTime property ViiSyncAccountApi.ConnectTime full
DisconnectOnSymbolUpdate property not applicable mtapi.io/MT5 platform plumbing (login-id service, certificates, servers.dat, cluster, internal request ids, MT5 build numbers) - no ViiSync counterpart needed
ProcessServerMessagesInThread property not applicable mtapi.io/MT5 platform plumbing (login-id service, certificates, servers.dat, cluster, internal request ids, MT5 build numbers) - no ViiSync counterpart needed
Id property ViiSyncAccountApi.Id full caller-owned tag
Host property ViiSyncAccountApi.Host full
Port property ViiSyncAccountApi.Port full
PfxFile property not applicable mtapi.io/MT5 platform plumbing (login-id service, certificates, servers.dat, cluster, internal request ids, MT5 build numbers) - no ViiSync counterpart needed
PfxFilePassword property not applicable mtapi.io/MT5 platform plumbing (login-id service, certificates, servers.dat, cluster, internal request ids, MT5 build numbers) - no ViiSync counterpart needed
CommonKey property not applicable mtapi.io/MT5 platform plumbing (login-id service, certificates, servers.dat, cluster, internal request ids, MT5 build numbers) - no ViiSync counterpart needed
LastQuoteTime property ViiSyncAccountApi.LastQuoteTime full
ServerTime property ViiSyncAccountApi.ServerTime full
HardwareId property not applicable mtapi.io/MT5 platform plumbing (login-id service, certificates, servers.dat, cluster, internal request ids, MT5 build numbers) - no ViiSync counterpart needed
ServerTimeZoneInMinutes property ViiSyncAccountApi.ServerTimeZoneInMinutes full
ClusterSummary property not applicable mtapi.io/MT5 platform plumbing (login-id service, certificates, servers.dat, cluster, internal request ids, MT5 build numbers) - no ViiSync counterpart needed
ClusterMembers property not applicable mtapi.io/MT5 platform plumbing (login-id service, certificates, servers.dat, cluster, internal request ids, MT5 build numbers) - no ViiSync counterpart needed
AccountCurrency property ViiSyncAccountApi.AccountCurrency full
ServerBuild property ViiSyncAccountApi.ServerVersion full
AccountCompanyName property ViiSyncAccountApi.AccountCompanyName full the account holder company; the broker brand is a deployment setting
AccountMethod property ViiSyncAccountApi.AccountMethod full
AccountProfit property ViiSyncAccountApi.AccountProfit full
AccountMargin property ViiSyncAccountApi.AccountMargin full
MarginLevel property ViiSyncAccountApi.MarginLevel full
AccountFreeMargin property ViiSyncAccountApi.AccountFreeMargin full
AccountEquity property ViiSyncAccountApi.AccountEquity full
Connected property ViiSyncAccountApi.Connected full
User property ViiSyncAccountApi.User full
Password property ViiSyncAccountApi.Password full
Build property not applicable terminal build number sent to MT5
EnableAllOrderUpdates property not applicable mtapi.io/MT5 platform plumbing (login-id service, certificates, servers.dat, cluster, internal request ids, MT5 build numbers) - no ViiSync counterpart needed
IsInvestor property ViiSyncAccountApi.IsInvestor full investor (read-only) login: the engine accepts the investor password, flags the session (login-response flags byte, JWT inv claim, connections view) and refuses every non-read opcode with TRADE_DISABLED
IsTradeDisableOnServer property ViiSyncAccountApi.IsTradeDisableOnServer partial always false: the engine has no per-account trade-disable flag (RBAC allows every role to trade)
IsNotConfirmedAccount property ViiSyncAccountApi.IsNotConfirmedAccount full
IsTradeAllowed property ViiSyncAccountApi.IsTradeAllowed full
Mails property ViiSyncAccountApi.Mails full
OnQuote event ViiSyncAccountApi.OnQuote full
OnOrderHistory event ViiSyncAccountApi.OnOrderHistory full
OnOrderUpdate event ViiSyncAccountApi.OnOrderUpdate full
OnSymbolUpdate event ViiSyncAccountApi.OnSymbolUpdate full
OnConnectProgress event ViiSyncAccountApi.OnConnectProgress full
OnSymbolsUpdate event ViiSyncAccountApi.OnSymbolsUpdate full
OnOrderProgress event ViiSyncAccountApi.OnOrderProgress full
OnQuoteHistory event ViiSyncAccountApi.OnQuoteHistory full
OnTickHistory event ViiSyncAccountApi.OnTickHistory full
OnMail event ViiSyncAccountApi.OnMail full
OnOrderBook event ViiSyncAccountApi.OnOrderBook full
UpdateProfits(Quote quote = null) method ViiSyncAccountApi.UpdateProfits full AccountApi re-marks locally on each quote
UpdateAccountProfit() method ViiSyncAccountApi.UpdateAccountProfit full
UpdateAccountProfit(List<Order> orders) method ViiSyncAccountApi.UpdateAccountProfit full
RequiredMargin(string symbol, double lots, DealType type = DealBuy, double price = 0) method ViiSyncAccountApi.RequiredMargin full
CalculateOrderProfit(string symbol, double openPrice, double closePrice, double lots, bool buy) method ViiSyncAccountApi.CalculateOrderProfit full
RequestDemoAccount(AccountRequest req, string host, int port) method full (different shape) account opening is a CRM/onboarding flow in ViiSync, not an account-API call
GetRequestId() method not applicable mtapi.io/MT5 platform plumbing (login-id service, certificates, servers.dat, cluster, internal request ids, MT5 build numbers) - no ViiSync counterpart needed
OrderSendAsync(int requestId, string symbol, double lots, double price, OrderType type, double sl = 0, double tp = 0, ulong deviation = 0, string comment = null, long expertID = 0, FillPolicy fillPolicy = Any, TradeType tradeType = Transfer, double stoplimit = 0, Expiration expiration = null, long closeByTicket = 0, PlacedType placedType = Manually) method ViiSyncAccountApi.OrderSendAsync full (different shape) MT5 void(requestId, …) variant → Task-returning OrderXxxAsync; progress on OnOrderProgress
OrderSend(string symbol, double lots, double price, OrderType type, double sl = 0, double tp = 0, ulong deviation = 0, string comment = null, long expertID = 0, FillPolicy fillPolicy = Any, TradeType tradeType = Transfer, double stoplimit = 0, Expiration expiration = null, long closeByTicket = 0, PlacedType placedType = Manually) method ViiSyncAccountApi.OrderSend full
OrderSendAsyncTask(string symbol, double lots, double price, OrderType type, double sl = 0, double tp = 0, ulong deviation = 0, string comment = null, long expertID = 0, FillPolicy fillPolicy = Any, TradeType tradeType = Transfer, double stoplimit = 0, Expiration expiration = null, long closeByTicket = 0, PlacedType placedType = Manually) method ViiSyncAccountApi.OrderSendAsync full
OrderCloseAsync(int requestId, long ticket, string symbol, double price, double lots, OrderType type, ulong deviation = 0, FillPolicy fillPolicy = Any, long expertId = 0, string comment = null, long closeByTicket = 0, PlacedType placedType = Manually) method ViiSyncAccountApi.OrderCloseAsync full (different shape) MT5 void(requestId, …) variant → Task-returning OrderXxxAsync; progress on OnOrderProgress
OrderClose(long ticket, string symbol, double price, double lots, OrderType type, ulong deviation = 0, FillPolicy fillPolicy = Any, long expertId = 0, string comment = null, long closeByTicket = 0, PlacedType placedType = Manually) method ViiSyncAccountApi.OrderClose full
OrderCloseAsyncTask(long ticket, string symbol, double price, double lots, OrderType type, ulong deviation = 0, FillPolicy fillPolicy = Any, long expertId = 0, string comment = null, long closeByTicket = 0, PlacedType placedType = Manually) method ViiSyncAccountApi.OrderCloseAsync full
OrderModify(long ticket, string symbol, double lots, double price, OrderType type, double sl, double tp, long expertID = 0, double stoplimit = 0, Expiration expiration = null, string comment = null) method ViiSyncAccountApi.OrderModify full
OrderModifyAsyncTask(long ticket, string symbol, double lots, double price, OrderType type, double sl, double tp, long expertID = 0, double stoplimit = 0, Expiration expiration = null, string comment = null) method ViiSyncAccountApi.OrderModifyAsync full
OrderModifyAsync(int requestId, long ticket, string symbol, double lots, double price, OrderType type, double sl, double tp, long expertID = 0, double stoplimit = 0, Expiration expiration = null, string comment = null) method ViiSyncAccountApi.OrderModifyAsync full (different shape) MT5 void(requestId, …) variant → Task-returning OrderXxxAsync; progress on OnOrderProgress
IsSubscribed(string symbol) method ViiSyncAccountApi.IsSubscribed full
LoadServersDat(string path) method not applicable mtapi.io/MT5 platform plumbing (login-id service, certificates, servers.dat, cluster, internal request ids, MT5 build numbers) - no ViiSync counterpart needed
LoadServersDat(byte[] bytes) method not applicable mtapi.io/MT5 platform plumbing (login-id service, certificates, servers.dat, cluster, internal request ids, MT5 build numbers) - no ViiSync counterpart needed
SaveServersDat(Server[] servers) method not applicable mtapi.io/MT5 platform plumbing (login-id service, certificates, servers.dat, cluster, internal request ids, MT5 build numbers) - no ViiSync counterpart needed
GetContractSize(string symbol) method ViiSyncAccountApi.GetContractSize full
RequestPendingOrderHistory(DateTime from, DateTime to) method ViiSyncAccountApi.RequestPendingOrderHistory full
RequestOrderHistory(DateTime from, DateTime to) method ViiSyncAccountApi.RequestOrderHistory full
RequestOrderHistory(int year, int month, List<DealInternal> partialResponse = null) method ViiSyncAccountApi.RequestOrderHistory full
RequestDealHistory(int year, int month, List<DealInternal> partialResponse) method ViiSyncAccountApi.RequestDealHistory full
RequestPendingHistory(int year, int month, List<OrderInternal> exist) method ViiSyncAccountApi.RequestPendingOrderHistory full
RequestPendingOrderHistory(int year, int month, List<DealInternal> exist = null) method ViiSyncAccountApi.RequestPendingOrderHistory full
DownloadOrderHistoryAsync(DateTime from, DateTime to, OrderSort sort = OpenTime, bool ascending = True, DealInternal[] existDeals = null, CancellationToken cancellation = null) method ViiSyncAccountApi.DownloadOrderHistoryAsync full
DownloadOrderHistory(DateTime from, DateTime to, OrderSort sort = OpenTime, bool ascending = True) method ViiSyncAccountApi.DownloadOrderHistory full
DownloadPendingOrderHistoryAsync(DateTime from, DateTime to, bool ascending = True) method ViiSyncAccountApi.DownloadPendingOrderHistoryAsync full
DownloadPendingOrderHistory(DateTime from, DateTime to, bool ascending = True) method ViiSyncAccountApi.DownloadPendingOrderHistory full
Connect() method ViiSyncAccountApi.Connect full
ConnectAsync(CancellationToken cancellation) method ViiSyncAccountApi.ConnectAsync full
ConnectAsync(int timeoutMs) method ViiSyncAccountApi.ConnectAsync full
ConnectAsync() method ViiSyncAccountApi.ConnectAsync full
GetTickSize(string symbol) method ViiSyncAccountApi.GetTickSize full
GetTickValue(string symbol, int msGetQuoteTimeout = 10000) method ViiSyncAccountApi.GetTickValue full
GetBidTickValue(Quote quote) method ViiSyncAccountApi.GetBidTickValue full
GetAskTickValue(Quote quote) method ViiSyncAccountApi.GetAskTickValue full
Disconnect() method ViiSyncAccountApi.Disconnect full
RequestQuoteHistoryMonth(string symbol, int year, int month, int day) method ViiSyncAccountApi.RequestQuoteHistoryMonth full
RequestQuoteHistoryToday(string symbol) method ViiSyncAccountApi.RequestQuoteHistoryToday full
Subscribe(string symbol) method ViiSyncAccountApi.Subscribe full
SubscribeOrderBook(string symbol) method ViiSyncAccountApi.SubscribeOrderBook full
UnsubscribeOrderBook(string symbol) method ViiSyncAccountApi.UnsubscribeOrderBook full
Subscribe(string[] symbols) method ViiSyncAccountApi.Subscribe full
SubscribeForce(string[] symbols) method ViiSyncAccountApi.SubscribeForce full
Unsubscribe(string symbol) method ViiSyncAccountApi.Unsubscribe full
Unsubscribe(string[] symbols) method ViiSyncAccountApi.Unsubscribe full
Subscriptions() method ViiSyncAccountApi.Subscriptions full
GetQuoteTask(string symbol, int msTimeout = 5000, int msNotOlder = 0) method ViiSyncAccountApi.GetQuoteAsync full
GetQuote(string symbol, int msTimeout = 0, int msNotOlder = 0) method ViiSyncAccountApi.GetQuote full
GetQuoteFromAnyServer(string symbol) method not applicable mtapi.io/MT5 platform plumbing (login-id service, certificates, servers.dat, cluster, internal request ids, MT5 build numbers) - no ViiSync counterpart needed
GetMarketWatch(string symbol) method ViiSyncAccountApi.GetMarketWatch full
ConvertToTimeframe(List<Bar> bars, int minutes) method ViiSyncAccountApi.ConvertToTimeframe full
RequestQuoteHistoryTodayInternal(string symbol) method not applicable mtapi.io/MT5 platform plumbing (login-id service, certificates, servers.dat, cluster, internal request ids, MT5 build numbers) - no ViiSync counterpart needed
DownloadQuoteHistoryMonthAsync(string symbol, int year, int month, int day, int timeFrame, int timeoutMs = 15000) method ViiSyncAccountApi.DownloadQuoteHistoryMonthAsync full
DownloadQuoteHistoryMonth(string symbol, int year, int month, int day, int timeFrame, int timeoutMs = 15000) method ViiSyncAccountApi.DownloadQuoteHistoryMonth full
DownloadQuoteHistoryTodayAsync(string symbol, int timeFrame, int timeoutMs = 15000) method ViiSyncAccountApi.DownloadQuoteHistoryTodayAsync full
DownloadQuoteHistoryToday(string symbol, int timeFrame, int timeoutMs = 15000) method ViiSyncAccountApi.DownloadQuoteHistoryToday full
GetOpenedOrders(OrderSort sort = OpenTime, bool ascending = True) method ViiSyncAccountApi.GetOpenedOrders full
GetOpenedOrder(long ticket) method ViiSyncAccountApi.GetOpenedOrder full
ChangePassword(string password, bool isInvestor = False) method ViiSyncAccountApi.ChangePassword full
IsQuoteSession(string symbol) method ViiSyncAccountApi.IsQuoteSession full
IsTradeSession(string symbol) method ViiSyncAccountApi.IsTradeSession full
PingHost(string host, int port = 443) method ViiSyncAccountApi.PingHost full
ClusterDetails() method not applicable mtapi.io/MT5 platform plumbing (login-id service, certificates, servers.dat, cluster, internal request ids, MT5 build numbers) - no ViiSync counterpart needed
DownloadQuoteHistory(string symbol, DateTime from, DateTime to, int timeFrame) method ViiSyncAccountApi.DownloadQuoteHistory full
DownloadQuoteHistoryAsync(string symbol, DateTime from, DateTime to, int timeFrame) method ViiSyncAccountApi.DownloadQuoteHistoryAsync full
MailBodyRequest(long id) method ViiSyncAccountApi.MailBodyRequest full
CalculateEquityHistory(DateTime from, MT5API api, EquityTimeframe timeframe, bool excludeSameBars = True) method ViiSyncAccountApi.CalculateEquityHistory full balance/realized/unrealized sampled from deals + M1 closes at the timeframe; cross-currency P/L converted at the historical M1 rate of the conversion pair
ClosedOrders() method ViiSyncAccountApi.ClosedOrders full
TickHistoryRequest(string symbol, int startYear, int startMonth, int startDay) method ViiSyncAccountApi.TickHistoryRequest full
TickHistoryStop(string symbol) method ViiSyncAccountApi.TickHistoryStop full