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
Name | Type | Description | Default | Optional |
---|---|---|---|---|
start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True |
end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True |
end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True |
frequency | Literal['annual', 'quarter'] | Frequency aggregation to convert monthly data to lower frequency. None is monthly. | None | True |
aggregation_method | Literal['avg', 'sum', 'eop'] | A key that indicates the aggregation method used for frequency aggregation. ; avg = Average; ; sum = Sum; ; eop = End of Period | None | True |
transform | Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log'] | 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 | None | True |
Returns
OBBject
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
Name | Type | Description |
---|---|---|
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. |
Name | Type | Description |
---|---|---|
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. |