jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-29 13:32:08 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f68929fa1efaa5e9abb7911029e287c975b37fd3
OpenBB/website/content/sdk/reference/crypto/ov/stables.md
teh_coderer 79046608b6 Docs Fix (#3543) 
* Update generate_terminal_markdown.py

* updates

* update workflows

* Automated Change

* tests

* tests

* Automated Change

* Update test_generate_docs.py

* Automated Change

* updates

* Automated Change

* Update gen-docs.yml

* Update test.yml

* Automated Change

* Update test.yml

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* test

* Automated Change

* testtt23

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* Automated Change

* added empting reference folders before autogen docs

* updates

* Automated Change

* update tests gitactions

* Automated Change

* up

* Automated Change

* Automated Change

* update pytest

* Automated Change

* tests

* Automated Change

* examples update

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* Update test.yml

* Update generate_sdk_markdown.py

* strip

* Automated Change

* Workflow : check test update

* Automated Change

* Automated Change

* Automated Change

* Update test.yml

* Automated Change

* Update test.yml

* Automated Change

* Automated Change

* up

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* update workflows

* fix guides

* testing

* Update gh-pages.yml

* Update gh-pages.yml

Co-authored-by: tehcoderer <tehcoderer@users.noreply.github.com>
Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
Co-authored-by: Chavithra <Chavithra@users.noreply.github.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
2022-11-25 17:19:08 -05:00

2.2 KiB
Vendored
Raw Blame History

title, description
title description
stables OpenBB SDK Function

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

stables

Returns top stable coins [Source: CoinGecko]

Source Code: [link]

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

from openbb_terminal.sdk import openbb
openbb.crypto.ov.stables(sortby="Volume_[$]", ascend=True, limit=10)

Shows stablecoins data [Source: CoinGecko]

Source Code: [link]

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

from openbb_terminal.sdk import openbb
openbb.crypto.ov.stables_chart(sortby="Volume_[$]", ascend=True, limit=10)