jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-04 08:22:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
4e6a2fb5648d7e8ee4fdb31d1ce6ffddbaf701bf
OpenBB/website/content/api/crypto/ov/cpexchanges/_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.2 KiB
Vendored
Raw Blame History

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

Get underlying data

crypto.ov.cpexchanges(symbols: str = 'USD', sortby: str = 'rank', ascend: bool = True) -> pandas.core.frame.DataFrame

List exchanges from CoinPaprika API [Source: CoinPaprika]

Parameters
----------
symbols: str
    Comma separated quotes to return e.g quotes=USD,BTC
sortby: str
    Key by which to sort data
ascend: bool
    Flag to sort data ascend

Returns
-------
pandas.DataFrame
    rank, name, currencies, markets, fiats, confidence_score, reported_volume_24h,
    reported_volume_7d ,reported_volume_30d, sessions_per_month,

Getting charts

crypto.ov.cpexchanges(symbol: str, sortby: str = 'rank', ascend: bool = True, limit: int = 15, export: str = '', chart=True) -> None

List exchanges from CoinPaprika API. [Source: CoinPaprika]

Parameters
----------
currency: str
    Quoted currency
limit: int
    Number of records to display
sortby: str
    Key by which to sort data
ascend: bool
    Flag to sort data ascending
links: bool
    Flag to display urls
export : str
    Export dataframe data to csv,json,xlsx file