Skip to main content

retail_prices

Get retail prices for common items.

Examples

from openbb import obb
obb.economy.retail_prices(provider='fred')
# The price of eggs in the northeast census region.
obb.economy.retail_prices(item='eggs', region=northeast, provider='fred')
# The percentage change in price, from one-year ago, of various meats, US City Average.
obb.economy.retail_prices(item='meats', transform=pc1, provider='fred')

Parameters

item: str

The item or basket of items to query.

Optional: True


country: str

The country to get data.

Default: united_states

Optional: True


start_date: Union[date, str]

Start date of the data, in YYYY-MM-DD format.

Optional: True


end_date: Union[date, str]

End date of the data, in YYYY-MM-DD format.

Optional: True


Returns

results: list[RetailPrices]

Serializable results.


provider: Optional[Literal['fred']]

Provider name.


warnings: Optional[list[Warning_]]

list of warnings.


chart: Optional[Chart]

Chart object.


extra: dict[str, Any]

Extra info.


Data

date: Union[date, str]

The date of the data.

symbol: str

Symbol representing the entity requested in the data.

country: str

description: str

Description of the item.

value: float

Price, or change in price, per unit.