mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-04 00:12:29 +00:00
4ad995fdd0
* add first iteration of content for Terminal Pro * Update index.md * Update dashboards.md * Update folders.md * Update grouping.md * Update report.md * Update templates.md * Update quick-start.md * Update index.md * Update index.md * Update home.md * Update news.md * Update index.md * Update index.md * Update index.md * Update data-provider.md * Update chat-with-widget.md * Update data-manipulation.md * Update forecasting.md * fix: images self closing tags * fix: only pro visitors can see pro * inter font * improve SEO content and restructuring * add new package for toggle on tutorials * move folder around * improve main page of each prod * small updates and improvements * fix logo above * small improvement in headtitle for portfolio funcs * fix typos from OpenAI's GPT-4 * fix _category_ json * remove generic SEO words * add script that generates SEO for documentation * add missing file * remove sdk warning message * fix links for andrew --------- Co-authored-by: jose-donato <zmcdonato@gmail.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
88 lines
2.4 KiB
Markdown
Vendored
88 lines
2.4 KiB
Markdown
Vendored
---
|
|
title: hm
|
|
description: The page provides detailed documentation for OpenBB crypto functions
|
|
that interact with CoinGecko to retrieve and visualise cryptocurrency data. It includes
|
|
code examples, a list of parameters and their descriptions for each function, and
|
|
source code links.
|
|
keywords:
|
|
- cryptocurrency
|
|
- CoinGecko
|
|
- heatmap
|
|
- docusaurus
|
|
- dataframe
|
|
- metadata
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="crypto.ov.hm - Reference | OpenBB SDK Docs" />
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
<Tabs>
|
|
<TabItem value="model" label="Model" default>
|
|
|
|
Get N coins from CoinGecko [Source: CoinGecko]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/discovery/pycoingecko_model.py#L128)]
|
|
|
|
```python
|
|
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 |
|
|
---
|
|
|
|
</TabItem>
|
|
<TabItem value="view" label="Chart">
|
|
|
|
Shows cryptocurrencies heatmap [Source: CoinGecko]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/pycoingecko_view.py#L36)]
|
|
|
|
```python
|
|
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
|
|
|
|
---
|
|
|
|
</TabItem>
|
|
</Tabs>
|