Connect and disconnect

All members below belong to MT5API (namespace mtapi.mt5).

Constructors

MT5API(ulong user, string password, string host, int port)

Creates a client for one MT5 account. Nothing is sent yet. Call Connect next.

• user: the MT5 login number.
• password: the account password (trading or investor).
• host, port: address of the broker's MT5 access server.
• Throws: nothing at creation.

var api = new MT5API(12345678, "password", "broker.example.com", 443);

MT5API(ulong user, string password, string server, byte[] pfxFile = null, string pfxFilePassword = null)

Creates a client from the broker server name (for example "Broker-Server"). The library looks the name up and fills in the access addresses.

• server: the broker server name as shown in MT5.
• pfxFile, pfxFilePassword: client certificate bytes and password, only if your broker requires one.
• Throws: ArgumentNullException if server is null. ServerNotFoundException if the name cannot be resolved.

var api = new MT5API(12345678, "password", "Broker-Server");

MT5API(ulong user, string password, string host, int port, byte[] pfxFile = null, string pfxFilePassword = null)

Same as the host and port form, with an optional client certificate.

MT5API(ulong user, string password, string host, int port, string proxyHost, int proxyPort, string proxyUser, string proxyPassword, ProxyTypes type)

Creates a client that connects through a proxy. Sets ProxyEnable to true.

• type: ProxyTypes.Https, Socks4 or Socks5 (None also exists).

MT5API()

Creates an empty client. Set User, Password, Host and Port yourself before Connect.

Connecting

void Connect()

Logs in and loads the account, symbols and open positions. Blocks until done or until ConnectTimeout passes.

• Throws: ServerException (wrong login or password: Code is Msg.INVALID_ACCOUNT or similar), ConnectException (for example KazaTrade: no ApiKey set when api.ApiKey is not set, or local addresses blocked), OperationCanceledException or TimeoutException on timeout, ProxyException for proxy problems.

try { api.Connect(); }
catch (ServerException ex) { Console.WriteLine($"Login refused: {ex.Code}"); }

Task ConnectAsync()

Task ConnectAsync(int timeoutMs)

Task ConnectAsync(CancellationToken cancellation)

Async forms of Connect. The first uses ConnectTimeout. Same errors as Connect.

void Disconnect()

Stops the connection and clears the loaded symbols. Call it when you are done. After Disconnect, use a new MT5API object or call Connect again.

bool Connected { get; }

True while the login is active and the socket is open.

event OnConnectProgress

See events.md.

Settings

Set these before Connect. They are public fields or properties.

api.ConnectTimeout = 45000;

Server and cluster information

ServerRec ClusterSummary { get; }

Name and company of the broker server, plus its time zone (TimeZone in minutes, DST in hours). Null before the server is known.

Dictionary<AccessInfo, AddressRec[]> ClusterMembers { get; }

The access servers of the broker cluster. Null before the server is known.

ClusterDetails ClusterDetails()

Returns the cluster as General (a ServerRec) and Servers (name to addresses). Returns null when unknown.

DateTime ServerTime { get; }

The current time on the broker server, worked out from the server's time zone.

int ServerTimeZoneInMinutes { get; }

Server offset from UTC in minutes, including daylight saving.

short ServerBuild { get; }

MT5 server build number.

• Throws: ConnectException if not connected.

DateTime ConnectTime { get; }

When the current login finished.

DateTime LastServerMessageTime

When the last message came from the server.

long BytesReceived { get; }

Bytes received from the broker on this login. Zero when not connected.

static int PingHost(string host, int port = 443)

Opens a TCP connection to host:port and returns a rough number. Use it only to compare addresses with each other; it is not an exact round trip time in milliseconds.

• Throws: SocketException if the host cannot be reached.

Broker server list files

static Server[] LoadServersDat(string path)

static Server[] LoadServersDat(byte[] bytes)

Reads an MT5 servers.dat file and returns its servers.

static byte[] SaveServersDat(Server[] servers)

Writes servers back to servers.dat format.