Implemented access to economic calendar data from MQL5 programs.
New functions
CalendarCountryById — gets country description by identifier.
bool CalendarCountryById(
const long country_id,
MqlCalendarCountry& country
);
CalendarEventById — gets event description by identifier.
bool CalendarEventById(
const long event_id,
MqlCalendarEvent& event
);
CalendarValueById — gets event value description by identifier.
bool CalendarValueById(
const long value_id,
MqlCalendarValue& value
);
CalendarEventByCountry — gets the array of available events for the country.
bool CalendarEventByCountry(
string country_code,
MqlCalendarEvent& events[]
);
CalendarEventByCurrency — gets the array of available events for the affected currency.
bool CalendarEventByCurrency(
string currency,
MqlCalendarEvent& events[]
);
CalendarValueHistoryByEvent — gets the array of values for the specified time period, by event identifier.
bool CalendarValueHistoryByEvent(
ulong event_id,
MqlCalendarValue& values[],
datetime datetime_from,
datetime datetime_to=0
);
CalendarValueHistory — gets the array of values for the specified time period for all events, filtered by country and/or currency.
bool CalendarValueHistory(
MqlCalendarValue& values[],
datetime datetime_from,
datetime datetime_to=0,
string country_code=NULL,
string currency=NULL
);
CalendarValueLastByEvent — gets an array of last event values by identifier. This function enables the request of the values which have appeared since the previous request. The in/out parameter "change_id" is additionally used for this operation.
Every time the calendar database changes, the "change_id" property (the last change identifier) is updated. During data request, you specify "change_id" and the terminal returns events which appeared after that time, as well as the current "change_id" value, which can be used for the next request. During the first function call, specify the zero "change_id": the function will not return any events, but will return the current "change_id" for further requests.
bool CalendarValueHistory(
ulong event_id,
ulong& change_id,
MqlCalendarValue& values[]
);
CalendarValueLast — gets the array of last values for all events, filtered by country and/or currency. This function enables the request of the values which have appeared since the previous request. Similarly to CalendarValueLastByEvent, the "change_id" property is used for the request.
bool CalendarValueHistory(
ulong event_id,
ulong& change_id,
MqlCalendarValue& values[],
string country_code=NULL,
string currency=NULL
);
New structures
MqlCalendarCountry — country description.
struct MqlCalendarCountry
{
ulong id;
string name;
string code;
string currency;
string currency_symbol;
string url_name;
};MqlCalendarEvent — event description.
struct MqlCalendarEvent
{
ulong id;
ENUM_CALENDAR_EVENT_TYPE type;
ENUM_CALENDAR_EVENT_SECTOR sector;
ENUM_CALENDAR_EVENT_FREQUENCY frequency;
ENUM_CALENDAR_EVENT_TIMEMODE time_mode;
ulong country_id;
ENUM_CALENDAR_EVENT_UNIT unit;
ENUM_CALENDAR_EVENT_IMPORTANCE importance;
ENUM_CALENDAR_EVENT_MULTIPLIER multiplier;
uint digits;
string source_url;
string event_code;
string name;
};MqlCalendarValue — event value description.
struct MqlCalendarValue
{
ulong id;
ulong event_id;
datetime time;
datetime period;
int revision;
long actual_value;
long prev_value;
long revised_prev_value;
long forecast_value;
ENUM_CALENDAR_EVENT_IMPACRT impact_type;
};
New enumerations
enum ENUM_CALENDAR_EVENT_FREQUENCY
{
CALENDAR_FREQUENCY_NONE =0,
CALENDAR_FREQUENCY_WEEK =1,
CALENDAR_FREQUENCY_MONTH =2,
CALENDAR_FREQUENCY_QUARTER =3,
CALENDAR_FREQUENCY_YEAR =4,
CALENDAR_FREQUENCY_DAY =5,
};
enum ENUM_CALENDAR_EVENT_TYPE
{
CALENDAR_TYPE_EVENT =0,
CALENDAR_TYPE_INDICATOR =1,
CALENDAR_TYPE_HOLIDAY =2,
};
enum ENUM_CALENDAR_EVENT_SECTOR
{
CALENDAR_SECTOR_NONE =0,
CALENDAR_SECTOR_MARKET =1,
CALENDAR_SECTOR_GDP =2,
CALENDAR_SECTOR_JOBS =3,
CALENDAR_SECTOR_PRICES =4,
CALENDAR_SECTOR_MONEY =5,
CALENDAR_SECTOR_TRADE =6,
CALENDAR_SECTOR_GOVERNMENT =7,
CALENDAR_SECTOR_BUSINESS =8,
CALENDAR_SECTOR_CONSUMER =9,
CALENDAR_SECTOR_HOUSING =10,
CALENDAR_SECTOR_TAXES =11,
CALENDAR_SECTOR_HOLIDAYS =12,
};
enum ENUM_CALENDAR_EVENT_IMPORTANCE
{
CALENDAR_IMPORTANCE_NONE =0,
CALENDAR_IMPORTANCE_LOW =1,
CALENDAR_IMPORTANCE_MODERATE =2,
CALENDAR_IMPORTANCE_HIGH =3,
};
enum ENUM_CALENDAR_EVENT_UNIT
{
CALENDAR_UNIT_NONE =0,
CALENDAR_UNIT_PERCENT =1,
CALENDAR_UNIT_CURRENCY =2,
CALENDAR_UNIT_HOUR =3,
CALENDAR_UNIT_JOB =4,
CALENDAR_UNIT_RIG =5,
CALENDAR_UNIT_USD =6,
CALENDAR_UNIT_PEOPLE =7,
CALENDAR_UNIT_MORTGAGE =8,
CALENDAR_UNIT_VOTE =9,
CALENDAR_UNIT_BARREL =10,
CALENDAR_UNIT_CUBICFEET =11,
CALENDAR_UNIT_POSITION =12,
CALENDAR_UNIT_BUILDING =13
};
enum ENUM_CALENDAR_EVENT_MULTIPLIER
{
CALENDAR_MULTIPLIER_NONE =0,
CALENDAR_MULTIPLIER_THOUSANDS =1,
CALENDAR_MULTIPLIER_MILLIONS =2,
CALENDAR_MULTIPLIER_BILLIONS =3,
CALENDAR_MULTIPLIER_TRILLIONS =4,
};
enum ENUM_CALENDAR_EVENT_IMPACRT
{
CALENDAR_IMPACT_NA =0,
CALENDAR_IMPACT_POSITIVE =1,
CALENDAR_IMPACT_NEGATIVE =2,
};
enum ENUM_CALENDAR_EVENT_TIMEMODE
{
CALENDAR_TIMEMODE_DATETIME =0,
CALENDAR_TIMEMODE_DATE =1,
CALENDAR_TIMEMODE_NOTIME =2,
CALENDAR_TIMEMODE_TENTATIVE =3,
};
New error codes
ERR_CALENDAR_MORE_DATA =5400,
ERR_CALENDAR_TIMEOUT =5401,
ERR_CALENDAR_NO_DATA =5402,
