Skip to main content
Version: v5

calendar

Economic release calendar.

Examples​

from openbb import obb
obb.fred.economy.calendar(provider='fred')

Parameters​

start_date: date | None | str
Start date of the data, in YYYY-MM-DD format.

end_date: date | None | str
End date of the data, in YYYY-MM-DD format.


Returns​

results: FredEconomicCalendar

Serializable results.

provider: str | None

Provider name.

warnings: Optional[list[Warning_]]

List of warnings.

chart: Optional[Chart]

Chart object.

extra: dict[str, Any]

Extra info.


Data​

date: datetime | None | str
The date of the data.

country: str | None
Country of event.

category: str | None
Category of event.

event: str | None
Event name.

importance: str | None
The importance level for the event.

source: str | None
Source of the data.

currency: str | None
Currency of the data.

unit: str | None
Unit of the data.

consensus: float | str | None
Average forecast among a representative group of economists.

previous: float | str | None
Value for the previous period after the revision (if revision is applicable).

revised: float | str | None
Revised previous value, if applicable.

actual: float | str | None
Latest released value.