University Of Michigan
Implementation details
Class names
Model name | Parameters class | Data class |
---|---|---|
UniversityOfMichigan | UniversityOfMichiganQueryParams | UniversityOfMichiganData |
Import Statement
from openbb_core.provider.standard_models. import (
UniversityOfMichiganData,
UniversityOfMichiganQueryParams,
)
Parameters
- standard
- fred
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
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
frequency
: Literal['annual', 'quarter']
Frequency aggregation to convert monthly data to lower frequency. None is monthly.
• Optional: True
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
• Optional: True
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
• Optional: True
Data
- standard
- fred
date
: Union[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
: Union[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.