jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-09 10:51:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
4e6a2fb5648d7e8ee4fdb31d1ce6ffddbaf701bf
OpenBB/website/content/api/etf/ld/_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

885 B
Vendored
Raw Blame History

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

Get underlying data

etf.ld(description: str) -> Dict

Return a selection of ETFs based on description filtered by total assets. [Source: Finance Database]

Parameters
----------
description: str
    Search by description to find ETFs matching the criteria.

Returns
----------
data : Dict
    Dictionary with ETFs that match a certain description

Getting charts

etf.ld(description: str, limit: int = 10, export: str = '', chart=True)

Display a selection of ETFs based on description filtered by total assets. [Source: Finance Database]

Parameters
----------
description: str
    Search by description to find ETFs matching the criteria.
limit: int
    Limit of ETFs to display
export: str
    Type of format to export data