calendar

Get the upcoming, or historical, economic calendar of global events.

Examples

from openbb import obb
# By default, the calendar will be forward-looking.
obb.economy.calendar(provider='fmp')
obb.economy.calendar(provider='fmp', start_date='2020-03-01', end_date='2020-03-31')
# By default, the calendar will be forward-looking.
obb.economy.calendar(provider='nasdaq')

---

Parameters

• standard
• fmp
• nasdaq
• tradingeconomics

Name	Type	Description	Default	Optional
start_date	Union[date, str]	Start date of the data, in YYYY-MM-DD format.	None	True
end_date	Union[date, str]	End date of the data, in YYYY-MM-DD format.	None	True

Name	Type	Description	Default	Optional
start_date	Union[date, str]	Start date of the data, in YYYY-MM-DD format.	None	True
end_date	Union[date, str]	End date of the data, in YYYY-MM-DD format.	None	True

Name	Type	Description	Default	Optional
start_date	Union[date, str]	Start date of the data, in YYYY-MM-DD format.	None	True
end_date	Union[date, str]	End date of the data, in YYYY-MM-DD format.	None	True
country	Union[str, List[str]]	Country of the event Multiple items allowed for provider(s): nasdaq.	None	True

Name	Type	Description	Default	Optional
start_date	Union[date, str]	Start date of the data, in YYYY-MM-DD format.	None	True
end_date	Union[date, str]	End date of the data, in YYYY-MM-DD format.	None	True
country	Union[str, List[str]]	Country of the event. Multiple items allowed for provider(s): tradingeconomics.	None	True
importance	Literal['low', 'medium', 'high']	Importance of the event.	None	True
group	Literal['interest_rate', 'inflation', 'bonds', 'consumer', 'gdp', 'government', 'housing', 'labour', 'markets', 'money', 'prices', 'trade', 'business']	Grouping of events.	None	True
calendar_id	Union[Union[None, int, str], List[Union[None, int, str]]]	Get events by TradingEconomics Calendar ID. Multiple items allowed for provider(s): tradingeconomics.	None	True

---

Returns

OBBject
    results : List[EconomicCalendar]
        Serializable results.

    provider : Optional[Literal['fmp', 'nasdaq', 'tradingeconomics']]
        Provider name.

    warnings : Optional[List[Warning_]]
        List of warnings.

    chart : Optional[Chart]
        Chart object.

    extra : Dict[str, Any]
        Extra info.

---

Data

• standard
• fmp
• nasdaq
• tradingeconomics

Name	Type	Description
date	Union[datetime, str]	The date of the data.
country	str	Country of event.
category	str	Category of event.
event	str	Event name.
importance	str	The importance level for the event.
source	str	Source of the data.
currency	str	Currency of the data.
unit	str	Unit of the data.
consensus	Union[float, str]	Average forecast among a representative group of economists.
previous	Union[float, str]	Value for the previous period after the revision (if revision is applicable).
revised	Union[float, str]	Revised previous value, if applicable.
actual	Union[float, str]	Latest released value.

Name	Type	Description
date	Union[datetime, str]	The date of the data.
country	str	Country of event.
category	str	Category of event.
event	str	Event name.
importance	str	The importance level for the event.
source	str	Source of the data.
currency	str	Currency of the data.
unit	str	Unit of the data.
consensus	Union[float, str]	Average forecast among a representative group of economists.
previous	Union[float, str]	Value for the previous period after the revision (if revision is applicable).
revised	Union[float, str]	Revised previous value, if applicable.
actual	Union[float, str]	Latest released value.
change	float	Value change since previous.
change_percent	float	Percentage change since previous.
last_updated	datetime	Last updated timestamp.
created_at	datetime	Created at timestamp.

Name	Type	Description
date	Union[datetime, str]	The date of the data.
country	str	Country of event.
category	str	Category of event.
event	str	Event name.
importance	str	The importance level for the event.
source	str	Source of the data.
currency	str	Currency of the data.
unit	str	Unit of the data.
consensus	Union[float, str]	Average forecast among a representative group of economists.
previous	Union[float, str]	Value for the previous period after the revision (if revision is applicable).
revised	Union[float, str]	Revised previous value, if applicable.
actual	Union[float, str]	Latest released value.
description	str	Event description.

Name	Type	Description
date	Union[datetime, str]	The date of the data.
country	str	Country of event.
category	str	Category of event.
event	str	Event name.
importance	str	The importance level for the event.
source	str	Source of the data.
currency	str	Currency of the data.
unit	str	Unit of the data.
consensus	Union[float, str]	Average forecast among a representative group of economists.
previous	Union[float, str]	Value for the previous period after the revision (if revision is applicable).
revised	Union[float, str]	Revised previous value, if applicable.
actual	Union[float, str]	Latest released value.
forecast	Union[float, str]	TradingEconomics projections.
reference	str	Abbreviated period for which released data refers to.
reference_date	date	Date for the reference period.
calendar_id	int	TradingEconomics Calendar ID.
date_span	int	Date span of the event.
symbol	str	TradingEconomics Symbol.
ticker	str	TradingEconomics Ticker symbol.
te_url	str	TradingEconomics URL path.
source_url	str	Source URL.
last_updated	datetime	Last update of the data.