food_at_home_monthly_area_prices

Get ERS Food-at-Home Monthly Area Prices - monthly unit values, purchases, store counts, and price indexes for a food item and measure, spread across the national, Census-region, and metropolitan areas.

Examples

from openbb import obb
obb.usda.food_at_home_monthly_area_prices(provider='usda')
# Get the GEKS price index for whole milk across the 15 areas.
obb.usda.food_at_home_monthly_area_prices(item='40000', measure='price_index_geks', provider='usda')
# Get the supplemental Fisher Ideal price index for fresh whole fruit since 2017.
obb.usda.food_at_home_monthly_area_prices(table='supplemental_price_indexes', group='Fruit', item='30000', measure='price_index_fisher_ideal', start_year=2017, provider='usda')

Parameters

• standard
• usda

table: str | None
Default: monthly_area_prices

Description

Table to retrieve. The main table carries the nine F-MAP price, purchase, and store measures for 2012-2018; the supplemental table carries six alternative price-index formulas for 2016-2018. Valid tables are:
monthly_area_prices, supplemental_price_indexes

group: str | None
Default: Dairy

Description

Tier-1 food group that narrows the food-item options. Ignored once an item is chosen. Valid groups are:
Grains, Vegetables, Fruit, Dairy, Meat and Protein Foods, Prepared meals, sides, and salads, Other foods

item: str | None
Default: 40000
ERS Food Purchase Group (EFPG) code of the food item whose monthly area prices are spread across the area columns, e.g. '40000' for whole milk.

measure: str | None
Default: unit_value_mean_wtd

Description

Measure spread into the 15 area columns. Only measures the selected table publishes are valid; an unavailable measure falls back to the table's default. Valid measures are:
unit_value_mean_wtd, unit_value_mean_unwtd, unit_value_se_wtd, price_index_geks, purchase_dollars_wtd, purchase_dollars_unwtd, purchase_grams_wtd, purchase_grams_unwtd, number_stores, price_index_laspeyres, price_index_paasche, price_index_tornqvist, price_index_fisher_ideal, price_index_ccd

start_year: int | None
Start year for filtering the data. If None, returns from the first year of the table.

end_year: int | None
End year for filtering the data. If None, returns up to the last year of the table.

---

Returns

results: FoodAtHomeMonthlyAreaPrices

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

date: date | str
First day of the observation month.

national: float | None
Selected measure for the United States.

northeast: float | None
Selected measure for Census Region 1: Northeast.

midwest: float | None
Selected measure for Census Region 2: Midwest.

south: float | None
Selected measure for Census Region 3: South.

west: float | None
Selected measure for Census Region 4: West.

atlanta: float | None
Selected measure for the Atlanta, GA metro area.

boston: float | None
Selected measure for the Boston, MA-NH metro area.

chicago: float | None
Selected measure for the Chicago, IL-IN-WI metro area.

dallas: float | None
Selected measure for the Dallas-Fort Worth, TX metro area.

detroit: float | None
Selected measure for the Detroit, MI metro area.

houston: float | None
Selected measure for the Houston, TX metro area.

los_angeles: float | None
Selected measure for the Los Angeles, CA metro area.

miami: float | None
Selected measure for the Miami, FL metro area.

new_york: float | None
Selected measure for the New York, NY-NJ-PA metro area.

philadelphia: float | None
Selected measure for the Philadelphia, PA-NJ-DE-MD metro area.