livingston_survey
Get the Philadelphia Fed Livingston Survey forecasts.
Examples
from openbb import obb
obb.federal_reserve.philadelphia.livingston_survey(provider='federal_reserve')
# Get the median CPI forecast.
obb.federal_reserve.philadelphia.livingston_survey(variable='CPI', statistic='median', provider='federal_reserve')
Parameters
- standard
- federal_reserve
variable: str | None
Default: RGDPX
The forecast variable sheet code, e.g. 'RGDPX' for real GDP.
statistic: str | None
Default: mean
The cross-forecaster summary statistic.
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: FederalReservePhiladelphiaLivingston
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
- standard
- federal_reserve
date: date | str
The survey date, June or December.
base_prior: float | None
The prior-period base value ('BP').
base_current: float | None
The current-period base value ('ZM').
six_month: float | None
The six-month-ahead forecast ('6M').
twelve_month: float | None
The twelve-month-ahead forecast ('12M').
base_year: float | None
The base-year annual value ('BY').
current_year: float | None
The current-year annual value ('ZY').
one_year: float | None
The one-year-ahead annual forecast ('1Y').
two_year: float | None
The two-year-ahead annual forecast ('2Y').
ten_year: float | None
The ten-year-ahead annual forecast ('10Y').