Files
OpenBB/website/content/api/etf/summary/_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

505 B
Vendored

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

Get underlying data

etf.summary(name: str) -> str

Return summary description of ETF. [Source: Yahoo Finance]

Parameters
----------
name: str
    ETF name

Returns
----------
str
    Summary description of the ETF

Getting charts

etf.summary(name: str, chart=True)

Display ETF description summary. [Source: Yahoo Finance]

Parameters
----------
name: str
    ETF name