mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-05 00:42:19 +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>
110 lines
2.7 KiB
Markdown
Vendored
110 lines
2.7 KiB
Markdown
Vendored
---
|
|
title: stables
|
|
description: Documentation for the stable coins API provided by OpenBB, including
|
|
how to use the model endpoints for data extraction and the chart endpoints for data
|
|
visualization.
|
|
keywords:
|
|
- OpenBB stable coins API
|
|
- cryptocurrency documentation
|
|
- data extraction
|
|
- data visualization
|
|
- metadata SEO
|
|
- python cryptocurrency API
|
|
- OpenBB documentation
|
|
- CoinGecko API
|
|
- programming examples
|
|
- SDK usage
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="crypto.ov.stables - Reference | OpenBB SDK Docs" />
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
<Tabs>
|
|
<TabItem value="model" label="Model" default>
|
|
|
|
Returns top stable coins [Source: CoinGecko]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/pycoingecko_model.py#L191)]
|
|
|
|
```python
|
|
openbb.crypto.ov.stables(limit: int = 15, sortby: str = "Market_Cap_[$]", ascend: bool = False)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| limit | int | How many rows to show | 15 | True |
|
|
| sortby | str | Key by which to sort data, default is Market_Cap_[$] | Market_Cap_[$] | True |
|
|
| ascend | bool | Flag to sort data ascending | False | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| pd.DataFrame | Dataframe with stable coins data |
|
|
---
|
|
|
|
## Examples
|
|
|
|
```python
|
|
from openbb_terminal.sdk import openbb
|
|
openbb.crypto.ov.stables(sortby="Volume_[$]", ascend=True, limit=10)
|
|
```
|
|
|
|
---
|
|
|
|
</TabItem>
|
|
<TabItem value="view" label="Chart">
|
|
|
|
Shows stablecoins data [Source: CoinGecko]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/pycoingecko_view.py#L331)]
|
|
|
|
```python
|
|
openbb.crypto.ov.stables_chart(limit: int = 15, export: str = "", sortby: str = "Market_Cap_[$]", ascend: bool = False, pie: bool = True)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| limit | int | Number of records to display | 15 | True |
|
|
| sortby | str | Key by which to sort data, default is Market_Cap_[$] | Market_Cap_[$] | True |
|
|
| ascend | bool | Flag to sort data ascending | False | True |
|
|
| pie | bool | Whether to show a pie chart, default is True | True | True |
|
|
| export | str | Export dataframe data to csv,json,xlsx file | | True |
|
|
| pie | bool | Whether to show a pie chart | True | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
This function does not return anything
|
|
|
|
---
|
|
|
|
## Examples
|
|
|
|
```python
|
|
from openbb_terminal.sdk import openbb
|
|
openbb.crypto.ov.stables_chart(sortby="Volume_[$]", ascend=True, limit=10)
|
|
```
|
|
|
|
---
|
|
|
|
</TabItem>
|
|
</Tabs>
|