Files
OpenBB/website/content/api/crypto/dd/rm/_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

1.0 KiB
Vendored

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

Get underlying data

crypto.dd.rm(symbol: str, ascend: bool = True) -> pandas.core.frame.DataFrame

Returns coin roadmap [Source: https://messari.io/]

Parameters
----------
symbol : str
    Crypto symbol to check roadmap
ascend: bool
    reverse order

Returns
-------
pd.DataFrame
    roadmap

Getting charts

crypto.dd.rm(symbol: str, ascend: bool = True, limit: int = 5, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) -> None

Display coin roadmap [Source: https://messari.io/]

Parameters
----------
symbol : str
    Crypto symbol to check roadmap
ascend: bool
    reverse order
limit : int
    number to show
export : str
    Export dataframe data to csv,json,xlsx file
external_axes : Optional[List[plt.Axes]], optional
    External axes (1 axis is expected in the list), by default None