jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-08 18:32:21 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
8731fbd692f911e10778207df26276fcce715e21
OpenBB/website/content/api/crypto/chart/_index.md
Colin Delahunty 8731fbd692 Auto Generate API Documentation (#2360) 
* Started auto doc generation

* Created a markdown document

* Added test changed to md

* Created working version of new documentation

* Made requested changes

* Generate docs for all

Co-authored-by: minhhoang1023 <40023817+minhhoang1023@users.noreply.github.com>
2022-09-20 19:15:54 +01:00

1.1 KiB
Vendored
Raw Blame History

crypto.chart

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

Get underlying data

###crypto.chart(prices_df: 'pd.DataFrame', symbol: 'str' = '', currency: '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
symbol: str
    Coin (only used for chart title), by default ""
currency: str
    Currency (only used for chart title), by default ""

Getting charts

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

Load data for Technical Analysis

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