online.mtapi.mt4

Class QuoteClient

java.lang.Object

online.mtapi.mt4.QuoteClient

public class QuoteClient
extends java.lang.Object

Quote retrieving, account information, order uHpdates.

Field Summary

Fields

Modifier and Type	Field and Description
ConGroup	_Account
int	_AccountMode
ConSymbolGroup[]	_Groups
boolean	_IsDemo
int	_SleepTime
double	Balance
boolean	CalculateTradeProps Flag, allowing to calculate the parameters of trade: AccountProfit, AccountEquity, AccountMargin, AccountFreeMargin.
Order[]	ClosedOrders
java.time.LocalDateTime	ClosedOrdersFrom
java.time.LocalDateTime	ClosedOrdersTo
online.mtapi.mt4.QuoteCmdHandler	CmdHandler
int	ConnectTimeout
double	Credit
int	DisconnectTimeout
double	Equity
double	FreeMargin
online.mtapi.mt4.HighLow	HighLow
int	Leverage
Logger	Log
java.lang.String	LoginIdWebServerUrl
double	Margin
online.mtapi.mt4.MT4Symbol	MT4Symbol
java.lang.String	Name
Event<ConnectEventHandler>	OnConnect Connect event.
Event<DisconnectEventHandler>	OnDisconnect Disconnect event.
Event<OrderUpdateEventHandler>	OnOrderUpdate Order status changed event.
Event<QuoteEventHandler>	OnQuote New quote event.
Event<QuoteHistoryEventHandler>	OnQuoteHistory Quote history event.
java.lang.String	Password
static java.lang.String	PathDecompress
java.lang.String	PathForSavingSrv Path for saving .srv files.
java.lang.String	PathForSavingSym Path for saving .sym files.
double	Profit
ServerInfo	SrvInfo
java.time.LocalDateTime	Time
int	User Account number.

Constructor Summary

Constructors

Constructor and Description
QuoteClient(int user, java.lang.String password, java.lang.String host, int port) Initialize quote client.
QuoteClient(int user, java.lang.String password, java.lang.String host, int port, java.time.LocalDateTime closedOrdersFrom, java.time.LocalDateTime closedOrdersTo) Initialize quote client to give history of closed orders.
QuoteClient(int user, java.lang.String password, java.lang.String host, int port, java.lang.String proxyHost, int proxyPort, java.lang.String proxyUser, java.lang.String proxyPass) Initialize quote client via proxy.
QuoteClient(int user, java.lang.String password, java.lang.String host, int port, java.lang.String proxyHost, int proxyPort, java.lang.String proxyUser, java.lang.String proxyPass, java.time.LocalDateTime closedOrdersFrom, java.time.LocalDateTime closedOrdersTo) Initialize quote client via proxy to give history of closed orders.

Method Summary

Modifier and Type	Method and Description
ConGroup	Account() Various account information.
double	AccountBalance() Account balance.
double	AccountCredit() Account credit.
double	AccountEquity() Account equity.
double	AccountFreeMargin() Account free margin.
int	AccountLeverage() Account leverage.
double	AccountMargin() Account margin.
int	AccountMode() Account mode.
java.lang.String	AccountName() Currency name of the current account.
double	AccountProfit() Account profit.
double	CalculateMargin(SymbolInfoEx info, int leverage, boolean bFlag, double all_volume, double delta_volume, double all_open_price, double all_margin_rate, double buy_volume, double buy_open_price, double buy_margin_rate, double sell_volume, double sell_open_price, double sell_margin_rate)
double	CalculateOrderProfit(Order order, SymbolInfoEx info, double bid, double ask)
void	CalculateTradeProperties()
void	Connect() Connect to server.
void	ConnectAsync() Connect to server without awiting reply from server.
boolean	Connected() Check connection state.
void	Disconnect() Disconnect from server.
Order[]	DownloadOrderHistory(java.time.LocalDateTime from, java.time.LocalDateTime to) Returns closed orders.
void	DownloadQuoteHistory(java.lang.String symbol, Timeframe tf, java.time.LocalDateTime from, short count) Request quote history.
static DemoAccount	GetDemo(java.lang.String serverFilePath, int leverage, double balance, java.lang.String name, java.lang.String accountType, java.lang.String country, java.lang.String city, java.lang.String state, java.lang.String zip, java.lang.String address, java.lang.String phone, java.lang.String email, java.lang.String terminalCompany) Get demo account.
static DemoAccount	GetDemo(java.lang.String host, int port, int leverage, double balance, java.lang.String name, java.lang.String accountType, java.lang.String country, java.lang.String city, java.lang.String state, java.lang.String zip, java.lang.String address, java.lang.String phone, java.lang.String email, java.lang.String terminalCompany) Get demo account.
Order	GetOpenedOrder(int ticket) Get opened order by ticket.
Order[]	GetOpenedOrders() Returns opened orders.
QuoteEventArgs	GetQuote(java.lang.String symbol) Latest quote for the symbol.
boolean	GetRate(java.lang.String currency, online.mtapi.mt4.OutObject<double[]> out)
ServerInfo	GetServerInfo() Get server info.
int	getSleepTime() Sleep time for MainThread of QuoteClient.
ConSymbolGroup	GetSymbolGroup(java.lang.String symbol) Symbol group name and description.
ConGroupSec	GetSymbolGroupParams(java.lang.String symbol) Symbol group parameters.
SymbolInfo	GetSymbolInfo(java.lang.String symbol) Get instrument parameters.
ConGroupSec[]	GroupParameters() Parameters for each group.
ConSymbolGroup[]	Groups() Symbol groups.
boolean	IsDemoAccount() Demo account flag.
boolean	IsSubscribed(java.lang.String symbol) Check subscribe trading instrument.
static Servers	LoadSrv(java.lang.String serverFilePath) Load only main server.
void	onConnect(java.lang.Exception exception)
void	onDisconnect(java.lang.Exception exception)
void	onOrderUpdate(OrderUpdateEventArgs update, double balance, double credit)
void	onQuote(QuoteEventArgs quote)
void	onQuoteHistory(java.lang.String symbol, Timeframe tf, Bar[] bars)
void	readOrders(byte[] buf)
int	ServerBuild() Server build.
java.time.LocalDateTime	ServerTime() Server time, refreshing goes with using incoming quotes.
void	setSleepTime(int value)
void	Subscribe(java.lang.String symbol) Subscribe trading instrument.
void	Subscribe(java.lang.String[] symbols) Subscribes multiple instruments.
java.lang.String[]	Symbols() List of avalible symbols.
void	Unsubscribe(java.lang.String symbol) Unsubscribe trading instrument.
void	UpdateProfit()
void	UpdateSymbolsMargin()

Methods inherited from class java.lang.Object

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

Field Detail

HighLow

public online.mtapi.mt4.HighLow HighLow

OnOrderUpdate

public Event<OrderUpdateEventHandler> OnOrderUpdate

Order status changed event.

OnQuoteHistory

public Event<QuoteHistoryEventHandler> OnQuoteHistory

Quote history event. Use DownloadQuoteHistory to request history.

OnDisconnect

public Event<DisconnectEventHandler> OnDisconnect

Disconnect event.

OnConnect

public Event<ConnectEventHandler> OnConnect

Connect event.

OnQuote

public Event<QuoteEventHandler> OnQuote

New quote event.

ConnectTimeout

public int ConnectTimeout

DisconnectTimeout

public int DisconnectTimeout

Log

public Logger Log

LoginIdWebServerUrl

public java.lang.String LoginIdWebServerUrl

User

public int User

Account number.

Password

public java.lang.String Password

SrvInfo

public ServerInfo SrvInfo

CmdHandler

public online.mtapi.mt4.QuoteCmdHandler CmdHandler

MT4Symbol

public online.mtapi.mt4.MT4Symbol MT4Symbol

_SleepTime

public int _SleepTime

CalculateTradeProps

public boolean CalculateTradeProps

Flag, allowing to calculate the parameters of trade: AccountProfit, AccountEquity, AccountMargin, AccountFreeMargin.

Balance

public double Balance

Credit

public double Credit

Profit

public double Profit

Equity

public double Equity

Margin

public double Margin

FreeMargin

public double FreeMargin

Name

public java.lang.String Name

Leverage

public int Leverage

_Account

public ConGroup _Account

_Groups

public ConSymbolGroup[] _Groups

Time

public java.time.LocalDateTime Time

_IsDemo

public boolean _IsDemo

_AccountMode

public int _AccountMode

PathForSavingSrv

public java.lang.String PathForSavingSrv

Path for saving .srv files. If null - don't save.

PathForSavingSym

public java.lang.String PathForSavingSym

Path for saving .sym files. If null - save in current folder.

PathDecompress

public static java.lang.String PathDecompress

ClosedOrdersFrom

public java.time.LocalDateTime ClosedOrdersFrom

ClosedOrdersTo

public java.time.LocalDateTime ClosedOrdersTo

ClosedOrders

public Order[] ClosedOrders

Constructor Detail

QuoteClient

public QuoteClient(int user,
                   java.lang.String password,
                   java.lang.String host,
                   int port)
            throws java.io.IOException

Initialize quote client.

Parameters:

user - Account number.

password - Password.

host - IP address or domain name.

port - Port. Usually 443.

Throws:

java.io.IOException

QuoteClient

public QuoteClient(int user,
                   java.lang.String password,
                   java.lang.String host,
                   int port,
                   java.lang.String proxyHost,
                   int proxyPort,
                   java.lang.String proxyUser,
                   java.lang.String proxyPass)

Initialize quote client via proxy.

Parameters:

user - Account number.

password - Password.

host - IP address or domain name.

port - Port. Usually 443.

proxyHost - IP address of proxy server.

proxyPort - Port of proxy server.

proxyUser - Account of proxy server.

proxyPass - Password of proxy server.

QuoteClient

public QuoteClient(int user,
                   java.lang.String password,
                   java.lang.String host,
                   int port,
                   java.time.LocalDateTime closedOrdersFrom,
                   java.time.LocalDateTime closedOrdersTo)

Initialize quote client to give history of closed orders.

Parameters:

user - Account number.

password - Password.

host - IP address or domain name.

port - Port. Usually 443.

closedOrdersFrom - Start time.

closedOrdersTo - End time.

QuoteClient

public QuoteClient(int user,
                   java.lang.String password,
                   java.lang.String host,
                   int port,
                   java.lang.String proxyHost,
                   int proxyPort,
                   java.lang.String proxyUser,
                   java.lang.String proxyPass,
                   java.time.LocalDateTime closedOrdersFrom,
                   java.time.LocalDateTime closedOrdersTo)

Initialize quote client via proxy to give history of closed orders.

Parameters:

user - Account number.

password - Password.

host - IP address or domain name.

port - Port. Usually 443.

proxyHost - IP address of proxy server.

proxyPort - Port of proxy server.

proxyUser - Account of proxy server.

proxyPass - Password of proxy server.

closedOrdersFrom - Start time.

closedOrdersTo - End time.

Method Detail

getSleepTime

public int getSleepTime()

Sleep time for MainThread of QuoteClient. Can be from 1 to 20 ms. Default value - 1 ms.

setSleepTime

public void setSleepTime(int value)

AccountBalance

public double AccountBalance()

Account balance.

AccountCredit

public double AccountCredit()

Account credit.

AccountProfit

public double AccountProfit()

Account profit.

AccountEquity

public double AccountEquity()

Account equity.

AccountMargin

public double AccountMargin()

Account margin.

AccountFreeMargin

public double AccountFreeMargin()

Account free margin.

AccountName

public java.lang.String AccountName()

Currency name of the current account.

AccountLeverage

public int AccountLeverage()

Account leverage.

Account

public ConGroup Account()

Various account information.

Groups

public ConSymbolGroup[] Groups()

Symbol groups.

ServerTime

public java.time.LocalDateTime ServerTime()

Server time, refreshing goes with using incoming quotes.

ServerBuild

public int ServerBuild()

Server build.

IsDemoAccount

public boolean IsDemoAccount()

Demo account flag.

AccountMode

public int AccountMode()

Account mode. 0 - master, 1 - investor

LoadSrv

public static Servers LoadSrv(java.lang.String serverFilePath)
                       throws java.io.FileNotFoundException,
                              java.io.IOException

Load only main server.

Parameters:

serverFilePath - Path to srv file. You can find srv files in MT4\config folder.

Returns:

Main server structure.

Throws:

java.io.IOException

java.io.FileNotFoundException

GetServerInfo

public ServerInfo GetServerInfo()

Get server info.

Returns:

Server info structure.

GetDemo

public static DemoAccount GetDemo(java.lang.String serverFilePath,
                                  int leverage,
                                  double balance,
                                  java.lang.String name,
                                  java.lang.String accountType,
                                  java.lang.String country,
                                  java.lang.String city,
                                  java.lang.String state,
                                  java.lang.String zip,
                                  java.lang.String address,
                                  java.lang.String phone,
                                  java.lang.String email,
                                  java.lang.String terminalCompany)
                           throws java.io.IOException

Get demo account.

Parameters:

serverFilePath - Path to srv file. You can find srv files in MT4\config folder.

leverage - Leverage value.

balance - Deposit value.

name - Currency name.

accountType - Account type.

country - Country.

city - City.

state - State.

zip - Zip postal code.

address - Address.

phone - Phone number.

email - Email address.

terminalCompany - Terminal company name.

Returns:

Demo account.

Throws:

java.io.IOException

GetDemo

public static DemoAccount GetDemo(java.lang.String host,
                                  int port,
                                  int leverage,
                                  double balance,
                                  java.lang.String name,
                                  java.lang.String accountType,
                                  java.lang.String country,
                                  java.lang.String city,
                                  java.lang.String state,
                                  java.lang.String zip,
                                  java.lang.String address,
                                  java.lang.String phone,
                                  java.lang.String email,
                                  java.lang.String terminalCompany)
                           throws java.net.UnknownHostException,
                                  java.io.IOException

Get demo account.

Parameters:

host - IP address or domain name.

port - Port. Usually 443.

leverage - Leverage value.

balance - Deposit value.

name - Currency name.

accountType - Account type.

country - Country.

city - City.

state - State.

zip - Zip postal code.

address - Address.

phone - Phone number.

email - Email address.

terminalCompany - Terminal company name.

Returns:

Demo account.

Throws:

java.io.IOException

java.net.UnknownHostException

Symbols

public java.lang.String[] Symbols()

List of avalible symbols.

Throws:

java.lang.Exception - Not connected.

GetSymbolInfo

public SymbolInfo GetSymbolInfo(java.lang.String symbol)

Get instrument parameters.

Parameters:

symbol - Symbol for trading.

Returns:

Symbol information structure.

GetSymbolGroupParams

public ConGroupSec GetSymbolGroupParams(java.lang.String symbol)

Symbol group parameters.

Parameters:

symbol - Symbol for trading.

Returns:

Symbol security group parameters structure.

GetSymbolGroup

public ConSymbolGroup GetSymbolGroup(java.lang.String symbol)

Symbol group name and description.

Parameters:

symbol - Symbol for trading.

Returns:

Symbol groups structure.

GroupParameters

public ConGroupSec[] GroupParameters()

Parameters for each group.

Returns:

IsSubscribed

public boolean IsSubscribed(java.lang.String symbol)

Check subscribe trading instrument.

Parameters:

symbol - Symbol for trading.

Subscribe

public void Subscribe(java.lang.String symbol)

Subscribe trading instrument.

Parameters:

symbol - Symbol for trading.

Throws:

java.lang.Exception - Not connected.

Unsubscribe

public void Unsubscribe(java.lang.String symbol)

Unsubscribe trading instrument.

Parameters:

symbol - Symbol for trading.

Throws:

java.lang.Exception - Not connected.

Subscribe

public void Subscribe(java.lang.String[] symbols)

Subscribes multiple instruments.

Parameters:

symbols - Array of symbols for trading.

Throws:

java.lang.Exception - Not connected.

GetQuote

public QuoteEventArgs GetQuote(java.lang.String symbol)
                        throws InvalidSymbolException

Latest quote for the symbol.

Parameters:

symbol - Symbol for trading.

Returns:

Return null if no quotes for specified symbol avalible, otherwise return quote event arguments.

Throws:

java.lang.Exception - Symbol not subscribed.

InvalidSymbolException

TimeoutException

Connect

public void Connect()
             throws ConnectException,
                    TimeoutException

Connect to server.

Throws:

ConnectException

ServerException - Unable to login for some reason.

TimeoutException - No reply from server.

ConnectAsync

public void ConnectAsync()

Connect to server without awiting reply from server. Use OnConnect event to get result.

GetOpenedOrders

public Order[] GetOpenedOrders()

Returns opened orders.

Returns:

Array of orders.

GetOpenedOrder

public Order GetOpenedOrder(int ticket)

Get opened order by ticket.

Parameters:

ticket - Unique number of the order ticket.

Returns:

Return null if order not found, otherwise return order data.

DownloadQuoteHistory

public void DownloadQuoteHistory(java.lang.String symbol,
                                 Timeframe tf,
                                 java.time.LocalDateTime from,
                                 short count)

Request quote history. Use QuoteHistory event to get bars.

Parameters:

symbol - Symbol for trading.

tf - Timeframe for quote history.

from - Start time of history.

count - Number of requested histories.

Throws:

java.lang.InterruptedException

TimeoutException

DownloadOrderHistory

public Order[] DownloadOrderHistory(java.time.LocalDateTime from,
                                    java.time.LocalDateTime to)
                             throws java.lang.Exception

Returns closed orders.

Parameters:

from - Start time of history.

to - End time of history.

Returns:

Array of orders.

Throws:

java.lang.Exception

onQuoteHistory

public void onQuoteHistory(java.lang.String symbol,
                           Timeframe tf,
                           Bar[] bars)

onDisconnect

public void onDisconnect(java.lang.Exception exception)

onConnect

public void onConnect(java.lang.Exception exception)

readOrders

public void readOrders(byte[] buf)

Disconnect

public void Disconnect()

Disconnect from server.

Connected

public boolean Connected()

Check connection state.

onOrderUpdate

public void onOrderUpdate(OrderUpdateEventArgs update,
                          double balance,
                          double credit)

onQuote

public void onQuote(QuoteEventArgs quote)

UpdateSymbolsMargin

public void UpdateSymbolsMargin()

GetRate

public boolean GetRate(java.lang.String currency,
                       online.mtapi.mt4.OutObject<double[]> out)
                throws TimeoutException,
                       InvalidSymbolException

Throws:

TimeoutException

InvalidSymbolException

CalculateOrderProfit

public double CalculateOrderProfit(Order order,
                                   SymbolInfoEx info,
                                   double bid,
                                   double ask)
                            throws TimeoutException,
                                   InvalidSymbolException

Throws:

TimeoutException

InvalidSymbolException

CalculateMargin

public double CalculateMargin(SymbolInfoEx info,
                              int leverage,
                              boolean bFlag,
                              double all_volume,
                              double delta_volume,
                              double all_open_price,
                              double all_margin_rate,
                              double buy_volume,
                              double buy_open_price,
                              double buy_margin_rate,
                              double sell_volume,
                              double sell_open_price,
                              double sell_margin_rate)

CalculateTradeProperties

public void CalculateTradeProperties()

UpdateProfit

public void UpdateProfit()