Fred Retail Prices
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
FredRetailPrices | FredRetailPricesQueryParams | FredRetailPricesData |
Import Statement
from openbb_core.provider.standard_models. import (
FredRetailPricesData,
FredRetailPricesQueryParams,
)
Parameters
- standard
- fred
item: str | None
The item or basket of items to query.
country: str | None
Default: united_states
The country to get data.
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.
item: str | None
Default: fuel
The item or basket of items to query.
country: str | None
Default: united_states
The country to get data.
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.
region: str | None
Default: all_city
The region to get average price levels for.
frequency: str | None
Default: monthly
The frequency of the data.
transform: str | None
Description
Transformation type
None = No transformation
chg = Change
ch1 = Change from Year Ago
pch = Percent Change
pc1 = Percent Change from Year Ago
pca = Compounded Annual Rate of Change
cch = Continuously Compounded Rate of Change
cca = Continuously Compounded Annual Rate of Change
log = Natural Log
use_cache: bool | None
Default: True
When True, the request is served from, and written to, the FRED response cache.
Data
- standard
- fred
date: date | None | str
The date of the data.
symbol: str | None
Symbol representing the entity requested in the data.
country: str | None
description: str | None
Description of the item.
value: float | None
Price, or change in price, per unit.
date: date | None | str
The date of the data.
symbol: str | None
Symbol representing the entity requested in the data.
country: str | None
description: str | None
Description of the item.
value: float | None
Price, or change in price, per unit.