Message: CalendarEvent

File: WebAPI/economic_calendar_2.proto

Description

Description of calendar event.

Used in

CalendarEventListReport

Fields

provider_id

Type: sint32

Description: Provider ID.

Note: Metadata can be obtained via CalendarEventProviderListRequest.

Source: CalendarEventProvider.id.

provider_event_id

Type: string

Description: Unique identifier of the calendar event.

Required: yes.

event_utc_timestamp

Type: google.protobuf.Timestamp

Description: Time of this event (can be in the future).

event_has_time

Type: bool

Description: Note: True means that event_utc_timestamp is an exact time of the event, False means that only a date of the event is provided.

period

Type: string

Description: Period (in a free format) for which the event was published.

Example: ‘Feb’, ‘Mar 9’, ‘Mar-May’, ‘Q1’, ‘to Nov 30’, ‘Week Ending’, ‘12/26’, ‘12/7/2025’.

description

Type: string

Description: Description.

venue

Type: string

Description: The Venue where the event will occur.

event_url

Type: string

Description: A URL link to more information about the event.

organization_name

Type: string

Description: The name of the company/organization the event refers to.

organization_isin

Type: string

Description: The ticker symbol for the company if it’s a company related event.

organization_url

Type: string

Description: A URL with information about the company/organization.

details

Type: CalendarEventDetail

Description: Collection of event details.

is_key_event

Type: bool

Description: Note: True if it’s key event.

Required: yes.

country_id

Type: sint32

Description: Country ID.

Note: Metadata can be obtained via metadata_2.CountryListRequest.

Source: metadata_2.CountryMetadata.country_id.

actual_expected

Type: bool

Description: True means that an actual update is expected when the event occurs.

provider_event_category_id

Type: string

Description: Provider event category ID.

Note: The tuple of {country_id, provider_id, provider_event_category_id} can be used for filtering of similar events.