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
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
country: str | list[str]
Country of the event Multiple items allowed for provider(s): nasdaq.
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
country: str | list[str]
Country of the event. Multiple items allowed for provider(s): tradingeconomics.
Choices
- afghanistan
- albania
- algeria
- andorra
- angola
- antigua_and_barbuda
- argentina
- armenia
- aruba
- australia
- austria
- azerbaijan
- bahamas
- bahrain
- bangladesh
- barbados
- belarus
- belgium
- belize
- benin
- bermuda
- bhutan
- bolivia
- bosnia_and_herzegovina
- botswana
- brazil
- brunei
- bulgaria
- burkina_faso
- burundi
- cambodia
- cameroon
- canada
- cape_verde
- cayman_islands
- central_african_republic
- chad
- chile
- china
- colombia
- comoros
- congo
- costa_rica
- croatia
- cuba
- cyprus
- czech_republic
- denmark
- djibouti
- dominica
- dominican_republic
- east_timor
- ecuador
- egypt
- el_salvador
- equatorial_guinea
- eritrea
- estonia
- ethiopia
- euro_area
- faroe_islands
- fiji
- finland
- france
- gabon
- gambia
- georgia
- germany
- ghana
- greece
- grenada
- guatemala
- guinea
- guinea_bissau
- guyana
- haiti
- honduras
- hong_kong
- hungary
- iceland
- india
- indonesia
- iran
- iraq
- ireland
- isle_of_man
- israel
- italy
- ivory_coast
- jamaica
- japan
- jordan
- kazakhstan
- kenya
- kiribati
- kosovo
- kuwait
- kyrgyzstan
- laos
- latvia
- lebanon
- lesotho
- liberia
- libya
- liechtenstein
- lithuania
- luxembourg
- macao
- madagascar
- malawi
- malaysia
- maldives
- mali
- malta
- mauritania
- mauritius
- mexico
- moldova
- monaco
- mongolia
- montenegro
- morocco
- mozambique
- myanmar
- namibia
- nepal
- netherlands
- new_caledonia
- new_zealand
- nicaragua
- niger
- nigeria
- north_korea
- north_macedonia
- norway
- oman
- pakistan
- palestine
- panama
- papua_new_guinea
- paraguay
- peru
- philippines
- poland
- portugal
- puerto_rico
- qatar
- republic_of_the_congo
- romania
- russia
- rwanda
- samoa
- sao_tome_and_principe
- saudi_arabia
- senegal
- serbia
- seychelles
- sierra_leone
- singapore
- slovakia
- slovenia
- solomon_islands
- somalia
- south_africa
- south_korea
- south_sudan
- spain
- sri_lanka
- sudan
- suriname
- swaziland
- sweden
- switzerland
- syria
- taiwan
- tajikistan
- tanzania
- thailand
- togo
- tonga
- trinidad_and_tobago
- tunisia
- turkey
- turkmenistan
- uganda
- ukraine
- united_arab_emirates
- united_kingdom
- united_states
- uruguay
- uzbekistan
- vanuatu
- venezuela
- vietnam
- yemen
- zambia
- zimbabwe
importance: Literal['low', 'medium', 'high']
Importance of the event.
group: Literal['interest_rate', 'inflation', 'bonds', 'consumer', 'gdp', 'government', 'housing', 'labour', 'markets', 'money', 'prices', 'trade', 'business']
Grouping of events.
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.
Returns
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
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.
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.
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.
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[str, float]
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.