diff options
Diffstat (limited to 'website/content/platform/data_models/ConsumerPriceIndex.md')
| -rw-r--r-- | website/content/platform/data_models/ConsumerPriceIndex.md | 46 |
1 files changed, 34 insertions, 12 deletions
diff --git a/website/content/platform/data_models/ConsumerPriceIndex.md b/website/content/platform/data_models/ConsumerPriceIndex.md index 1f323b15d02..3ec8e5bfe02 100644 --- a/website/content/platform/data_models/ConsumerPriceIndex.md +++ b/website/content/platform/data_models/ConsumerPriceIndex.md @@ -1,6 +1,6 @@ --- -title: Consumer Price Index (CPI) Data -description: OpenBB Platform Data Model +title: "Consumer Price Index" +description: "Consumer Price Index (CPI)" --- <!-- markdownlint-disable MD012 MD031 MD033 --> @@ -27,21 +27,32 @@ ConsumerPriceIndexQueryParams, ) ``` +--- + ## Parameters <Tabs> -<TabItem value="standard" label="Standard"> + +<TabItem value='standard' label='standard'> + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| country | Union[str, List[str]] | The country to get data. Multiple items allowed for provider(s): fred. | | False | +| units | Literal['growth_previous', 'growth_same', 'index_2015'] | The unit of measurement for the data. Options: - `growth_previous`: Percent growth from the previous period. If monthly data, this is month-over-month, etc - `growth_same`: Percent growth from the same period in the previous year. If looking at monthly data, this would be year-over-year, etc. - `index_2015`: Rescaled index value, such that the value in 2015 is 100. | growth_same | True | +| frequency | Literal['monthly', 'quarter', 'annual'] | The frequency of the data. Options: `monthly`, `quarter`, and `annual`. | monthly | True | +| harmonized | bool | Whether you wish to obtain harmonized data. | False | True | +| 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 | +| provider | Literal['fred'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default. | fred | True | +</TabItem> + +<TabItem value='fred' label='fred'> | Name | Type | Description | Default | Optional | | ---- | ---- | ----------- | ------- | -------- | -| countries | List[Literal['australia', 'austria', 'belgium', 'brazil', 'bulgaria', 'canada', 'chile', 'china', 'croatia', 'cyprus', 'czech_republic', 'denmark', 'estonia', 'euro_area', 'finland', 'france', 'germany', 'greece', 'hungary', 'iceland', 'india', 'indonesia', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'malta', 'mexico', 'netherlands', 'new_zealand', 'norway', 'poland', 'portugal', 'romania', 'russian_federation', 'slovak_republic', 'slovakia', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states']] | The country or countries to get data. | | False | -| units | Literal['growth_previous', 'growth_same', 'index_2015'] | The unit of measurement for the data. - Options: - - `growth_previous`: growth from the previous period - - `growth_same`: growth from the same period in the previous year - - `index_2015`: index with base year 2015. | growth_same | True | -| frequency | Literal['monthly', 'quarter', 'annual'] | The frequency of the data. - Options: `monthly`, `quarter`, and `annual`. | monthly | True | +| country | Union[str, List[str]] | The country to get data. Multiple items allowed for provider(s): fred. | | False | +| units | Literal['growth_previous', 'growth_same', 'index_2015'] | The unit of measurement for the data. Options: - `growth_previous`: Percent growth from the previous period. If monthly data, this is month-over-month, etc - `growth_same`: Percent growth from the same period in the previous year. If looking at monthly data, this would be year-over-year, etc. - `index_2015`: Rescaled index value, such that the value in 2015 is 100. | growth_same | True | +| frequency | Literal['monthly', 'quarter', 'annual'] | The frequency of the data. Options: `monthly`, `quarter`, and `annual`. | monthly | True | | harmonized | bool | Whether you wish to obtain harmonized data. | False | True | | 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 | @@ -50,10 +61,20 @@ ConsumerPriceIndexQueryParams, </Tabs> +--- + ## Data <Tabs> -<TabItem value="standard" label="Standard"> + +<TabItem value='standard' label='standard'> + +| Name | Type | Description | +| ---- | ---- | ----------- | +| date | date | The date of the data. | +</TabItem> + +<TabItem value='fred' label='fred'> | Name | Type | Description | | ---- | ---- | ----------- | @@ -61,3 +82,4 @@ ConsumerPriceIndexQueryParams, </TabItem> </Tabs> + |