jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-13 21:02:13 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
4e6a2fb5648d7e8ee4fdb31d1ce6ffddbaf701bf
OpenBB/website/content/api/etf/overview/_index.md
Colin Delahunty 0b33cb45f8 Adds auto yaml generation (#2587) 
* Began working on docs creator

* Added fixes

* More

* More

* Adding autogen_try.py for OpenBB API doc generation

* OpenBB API docs gen try

* Fixed

* Added fixes

* Added fixes

* subs -> sub

* Updated docs

* Updated docs

Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
2022-09-23 16:43:34 +01:00

621 B
Vendored
Raw Blame History

To obtain charts, make sure to add chart=True as the last parameter

Get underlying data

etf.overview(symbol: str) -> pandas.core.frame.DataFrame

Get overview data for selected etf

Parameters
----------
etf_symbol : str
    Etf symbol to get overview for

Returns
----------
df : pd.DataFrame
    Dataframe of stock overview data

Getting charts

etf.overview(symbol: str, export: str = '', chart=True)

Print etf overview information

Parameters
----------
symbol:str
    ETF symbols to display overview for
export:str
    Format to export data