jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-02 23:41:27 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd08218c35aed534ad59309ff2ca99d08e94de6a
OpenBB/website/content/sdk/reference/economy/cpi.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622) 
* add first iteration of content for Terminal Pro

* Update index.md

* Update dashboards.md

* Update folders.md

* Update grouping.md

* Update report.md

* Update templates.md

* Update quick-start.md

* Update index.md

* Update index.md

* Update home.md

* Update news.md

* Update index.md

* Update index.md

* Update index.md

* Update data-provider.md

* Update chat-with-widget.md

* Update data-manipulation.md

* Update forecasting.md

* fix: images self closing tags

* fix: only pro visitors can see pro

* inter font

* improve SEO content and restructuring

* add new package for toggle on tutorials

* move folder around

* improve main page of each prod

* small updates and improvements

* fix logo above

* small improvement in headtitle for portfolio funcs

* fix typos from OpenAI's GPT-4

* fix _category_ json

* remove generic SEO words

* add script that generates SEO for documentation

* add missing file

* remove sdk warning message

* fix links for andrew

---------

Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2023-10-30 21:01:29 +00:00

2.3 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
cpi This page provides documentation on the cpi command within the OpenBBTerminal. It explains how to use the command to fetch Consumer Price Index data from Alpha Vantage and to display the US Consumer Price Index as a chart. It lists all parameters and returns for this command.
cpi
consumer price index
Alpha Vantage
dataframe
matplotlib
economy
chart
parameters
returns

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Get Consumer Price Index from Alpha Vantage

Source Code: [link]

openbb.economy.cpi(interval: str = "m", start_year: int = 2010)

Parameters

Name Type Description Default Optional
interval str Interval for data. Either "m" or "s" for monthly or semiannual m True
start_year int Start year for plot, by default 2010 2010 True

Returns

Type Description
pd.DataFrame Dataframe of CPI

Display US consumer price index (CPI) from AlphaVantage

Source Code: [link]

openbb.economy.cpi_chart(interval: str = "m", start_year: int = 2010, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)

Parameters

Name Type Description Default Optional
interval str Interval for GDP. Either "m" or "s" m True
start_year int Start year for plot, by default 2010 2010 True
raw bool Flag to show raw data, by default False False True
export str Format to export data, by default "" True
external_axes Optional[List[plt.Axes]] External axes (1 axis is expected in the list), by default None None True

Returns

This function does not return anything