Files
OpenBB/website/content/sdk/reference/crypto/ov/hm.md
jose-donato 2e7eb4c9b6 New documentation website (#3526)
* fix(docs): added margin between sections

* feat: removed unused files; updated ga

* fix: juan stuff doesnt work

* fix: random fix

* moon at noon

* fix: update docusaurus config

* Update controller_doc_classes.py

* fix: temp fix

* fix: temp fix

* Update controller_doc_classes.py

* fix: remove old content

* fix: taggfix

* init

* fix: styling and moved file

* Update generate_terminal_markdown.py

* fix: removed unused images

* fix: port new files

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 16:47:03 +00:00

1.9 KiB
Vendored

title, description
title description
hm OpenBB SDK Function

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

hm

Get N coins from CoinGecko [Source: CoinGecko]

Source Code: [link]

openbb.crypto.ov.hm(limit: int = 250, category: str = "", sortby: str = "Symbol", ascend: bool = False)

Parameters

Name Type Description Default Optional
limit int Number of top coins to grab from CoinGecko 250 True
category str Category of the coins we want to retrieve True
sortby str Key to sort data Symbol True
ascend bool Sort data in ascending order False True

Returns

Type Description
pd.DataFrame N coins

Shows cryptocurrencies heatmap [Source: CoinGecko]

Source Code: [link]

openbb.crypto.ov.hm_chart(category: str = "", limit: int = 15, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)

Parameters

Name Type Description Default Optional
caterogy str Category (e.g., stablecoins). Empty for no category (default: ) None True
limit int Number of top cryptocurrencies to display 15 True
export str Export dataframe data to csv,json,xlsx True
external_axes Optional[List[plt.Axes]] External axes (1 axis is expected in the list), by default None None True

Returns

This function does not return anything