university_of_michigan
Get University of Michigan Consumer Sentiment and Inflation Expectations Surveys.
Examples
from openbb import obb
obb.economy.survey.university_of_michigan(provider='fred')
Parameters
- standard
- fred
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
frequency: Literal['quarter', 'annual']
Frequency aggregation to convert monthly data to lower frequency. None is monthly.
aggregation_method: Literal['avg', 'sum', 'eop']
Description
A key that indicates the aggregation method used for frequency aggregation.
avg = Average
sum = Sum
eop = End of Period
transform: Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']
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
Returns
results: list[UniversityOfMichigan]
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
- standard
- fred
date: date | str
The date of the data.
consumer_sentiment: float
Index of the results of the University of Michigan's monthly Survey of Consumers, which is used to estimate future spending and saving. (1966:Q1=100).
inflation_expectation: float
Median expected price change next 12 months, Surveys of Consumers.
date: date | str
The date of the data.
consumer_sentiment: float
Index of the results of the University of Michigan's monthly Survey of Consumers, which is used to estimate future spending and saving. (1966:Q1=100).
inflation_expectation: float
Median expected price change next 12 months, Surveys of Consumers.