Message: CalendarEventListRequest

File: WebAPI/economic_calendar_2.proto

Description

Request for calendar events.

Prerequisites: All calendar events will be filtered by customer enablements. E.g., ‘DJ News Service’ enablement will allow calendar events from Dow Jones calendar event provider.

Note: The server maintains a limited number of full calendar days (in UTC) of past events. The default is 65 days, the actual limit is returned in the oldest available timestamp of the report. Requested event time range is truncated to the oldest available timestamp.

Tips: For subscriptions, new or updated events are delivered if they are within the available range, regardless of the from_ and to_utc_timestamp in the request. To subscribe on new / updated events only (without receiving events for specified time range), you can omit both ‘from_utc_timestamp’ and ‘to_utc_timestamp’ in the request.

Limits:

1.  The request rate is 60 per 60 seconds by default.

2.  The number of simultaneous requests in processing is 50 by default.

3.  The number of simultaneous update subscriptions is 1 per connection by default.

Responses: CalendarEventListReport.

Used in

InformationRequest

Fields

from_utc_timestamp

Type: google.protobuf.Timestamp

Description: Time to start from.

Note: If not specified, then current time is used.

to_utc_timestamp

Type: google.protobuf.Timestamp

Description: Time to end with.

Note: If not specified, then current time is used.

skip_events_without_provider_event_category_id

Type: bool

Description: Note: If True, skip calendar events without field ‘provider_event_category_id’.

skip_events_without_details

Type: bool

Description: Note: If True, skip calendar events without details.