OpenBB/_index.md at aafb5a52ff1b71fa82f8a175b76b0bba1bf66c21

mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-29 13:32:08 +00:00

Files

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

1.1 KiB

Vendored

Raw Blame History

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

Get underlying data

crypto.chart(prices_df: 'pd.DataFrame', to_symbol: 'str' = '', from_symbol: 'str' = '', source: 'str' = '', exchange: 'str' = '', interval: 'str' = '', external_axes: 'list[plt.Axes] | None' = None) -> 'None'

Load data for Technical Analysis

Parameters
----------
prices_df: pd.DataFrame
    Cryptocurrency
to_symbol: str
    Coin (only used for chart title), by default ""
from_symbol: str
    Currency (only used for chart title), by default ""

Getting charts

crypto.chart(prices_df: 'pd.DataFrame', to_symbol: 'str' = '', from_symbol: 'str' = '', source: 'str' = '', exchange: 'str' = '', interval: 'str' = '', external_axes: 'list[plt.Axes] | None' = None, chart=True) -> 'None'