jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-07 18:01:10 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
4e6a2fb5648d7e8ee4fdb31d1ce6ffddbaf701bf
OpenBB/website/content/api/crypto/dd/tk/_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
Raw Blame History

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

Get underlying data

crypto.dd.tk(symbol: str, coingecko_id: str) -> Tuple[pandas.core.frame.DataFrame, pandas.core.frame.DataFrame]

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

Parameters
----------
symbol : str
    Crypto symbol to check tokenomics
coingecko_id : str
    ID from coingecko
Returns
-------
pd.DataFrame
    Metric Value tokenomics
pd.DataFrame
    Circulating supply overtime

Getting charts

crypto.dd.tk(symbol: str, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) -> None

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

Parameters
----------
symbol : str
    Crypto symbol to check tokenomics
export : str
    Export dataframe data to csv,json,xlsx file
external_axes : Optional[List[plt.Axes]], optional
    External axes (2 axes are expected in the list), by default None