food_price_outlook

Get ERS Food Price Outlook - consumer and producer food price index forecasts, prediction intervals, and the annual percent-change record, each pivoted to a wide layout.

Examples

from openbb import obb
obb.usda.food_price_outlook(provider='usda')
# Get the annual consumer food price index changes since 2000.
obb.usda.food_price_outlook(table='cpi_annual', start_year=2000, provider='usda')
# Get the consumer forecast prediction intervals for beef and eggs.
obb.usda.food_price_outlook(table='cpi_forecast', item='beef,eggs', provider='usda')
# Get the historical consumer forecast vintages for all food.
obb.usda.food_price_outlook(table='cpi_forecast_history', item='all food', provider='usda')

Parameters

• standard
• usda

table: str | None
Default: cpi_forecast

Description

Food Price Outlook table to retrieve. The forecast tables spread each price-index measure into a column, the annual tables spread each food category into a column with years as rows, and the forecast-history tables spread the prediction-interval bounds into columns. Valid tables are:
cpi_forecast, ppi_forecast, cpi_annual, ppi_annual, cpi_forecast_history, ppi_forecast_history

item: str | None
Filter by a single exact price-index item as published, e.g. 'Beef and veal', scoped to the selected table. Filters rows for the forecast and forecast-history tables and value columns for the annual tables. If None, all items are included.

start_year: int | None
Start year for filtering the data, applied to the annual calendar year and the forecast-history year being forecast. Forecast measures with no year, such as month-over-month changes, are always kept. If None, returns from the beginning of the series.

end_year: int | None
End year for filtering the data, applied to the annual calendar year and the forecast-history year being forecast. Forecast measures with no year, such as month-over-month changes, are always kept. If None, returns up to the most recent year.

---

Returns

results: FoodPriceOutlook

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
• usda

item: str | None
Row label: the price-index item on the forecast and forecast-history tables, e.g. 'All food' or 'Wholesale beef', or the calendar year on the annual tables, where each food category is a value column instead.

top_level: str | None
Top level of the consumer price index hierarchy, as published. Only for the consumer forecast table.

aggregate: str | None
Aggregate level of the consumer price index hierarchy, as published. Only for the consumer forecast table.

mid_level: str | None
Mid level of the consumer price index hierarchy, as published. Only for the consumer forecast table.

low_level: str | None
Low level of the consumer price index hierarchy, as published. Only for the consumer forecast table.

disaggregate: str | None
Disaggregate level of the consumer price index hierarchy, as published. Only for the consumer forecast table.

year: int | None
Year of the row: the calendar year on the annual tables and the year being forecast on the forecast-history tables. Absent on the forecast tables, whose measures span several reference years.

forecast_date: date | None
Vintage of the forecast, as the first day of the month the forecast was made. Only for the forecast-history tables.

unit: str | None
Unit of the value columns, as published, when a single unit applies to the whole row. Absent on the forecast tables, whose measures carry differing units per column.