Files
OpenBB/website/content/sdk/reference/crypto/disc/gainers.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

2.3 KiB
Vendored

title, description
title description
gainers OpenBB SDK Function

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

gainers

Shows Largest Gainers - coins which gain the most in given period. [Source: CoinGecko]

Source Code: [link]

openbb.crypto.disc.gainers(interval: str = "1h", limit: int = 50, sortby: str = "market_cap_rank")

Parameters

Name Type Description Default Optional
interval str Time interval by which data is displayed. One from [1h, 24h, 7d, 14d, 30d, 60d, 1y] 1h True
limit int Number of records to display 50 True
sortby str Key to sort data. The table can be sorted by every of its columns. Refer to
API documentation (see /coins/markets in https://www.coingecko.com/en/api/documentation)
market_cap_rank True

Returns

Type Description
pd.DataFrame Top Gainers - coins which gain most in price in given period of time.
Columns: Symbol, Name, Volume, Price, %Change_{interval}, Url

Prints table showing Largest Gainers - coins which gain the most in given period. [Source: CoinGecko]

Source Code: [link]

openbb.crypto.disc.gainers_chart(interval: str = "1h", limit: int = 20, sortby: str = "market_cap_rank", export: str = "")

Parameters

Name Type Description Default Optional
interval str Time period by which data is displayed. One from [1h, 24h, 7d, 14d, 30d, 60d, 1y] 1h True
limit int Number of records to display 20 True
sortby str Key to sort data. The table can be sorted by every of its columns. Refer to
API documentation (see /coins/markets in https://www.coingecko.com/en/api/documentation)
market_cap_rank True
export str Export dataframe data to csv,json,xlsx file True

Returns

This function does not return anything