jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-27 12:40:35 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
8731fbd692f911e10778207df26276fcce715e21
OpenBB/website/content/api/crypto/dd/basic/_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

777 B
Vendored
Raw Blame History

crypto.dd.basic

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

Get underlying data

###crypto.dd.basic(symbol: str = 'btc-bitcoin') -> pandas.core.frame.DataFrame

Basic coin information [Source: CoinPaprika]

Parameters
----------
symbol: str
    Coin id

Returns
-------
pd.DataFrame
    Metric, Value

Getting charts

###crypto.dd.basic(symbol: str = 'BTC', export: str = '', chart=True) -> None

Get basic information for coin. Like: name, symbol, rank, type, description, platform, proof_type, contract, tags, parent. [Source: CoinPaprika]

Parameters
----------
symbol: str
    Cryptocurrency symbol (e.g. BTC)
export: str
    Export dataframe data to csv,json,xlsx