jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-03 16:02:04 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd08218c35aed534ad59309ff2ca99d08e94de6a
OpenBB/website/content/sdk/reference/crypto/disc/gainers.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622) 
* 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>
2023-10-30 21:01:29 +00:00

2.8 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
gainers The page provides functionalities regarding Largest Gainers in cryptocurrency, powered by CoinGecko's API. It contains Python models and charts to display the coins which gain the most in a given period. Additionally, it provides details on how to sort and display data, and export data to different file formats.
gainers
crypto
coingecko
model
chart
dataframe
price
volume
export

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

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

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