Food Price Outlook
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
FoodPriceOutlook | FoodPriceOutlookQueryParams | FoodPriceOutlookData |
Import Statement
from openbb_core.provider.standard_models. import (
FoodPriceOutlookData,
FoodPriceOutlookQueryParams,
)
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.
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.