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/coins.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.4 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
coins This page documents the functions for retrieving and displaying cryptocurrency coin data using the OpenBB Terminal. The main categories explained are 'model' and 'view', each with descriptions of available parameters and returns.
docusaurus
metadata
cryptocurrency
CoinGecko
coins data
dataframe
model
view
sort data
export data
coins chart

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

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

Get N coins from CoinGecko [Source: CoinGecko]

Source Code: [link]

openbb.crypto.disc.coins(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

Prints table showing top coins [Source: CoinGecko]

Source Code: [link]

openbb.crypto.disc.coins_chart(category: str, limit: int = 250, sortby: str = "Symbol", export: str = "", ascend: bool = False)

Parameters

Name Type Description Default Optional
category str If no category is passed it will search for all coins. (E.g., smart-contract-platform) None False
limit int Number of records to display 250 True
sortby str Key to sort data Symbol True
export str Export dataframe data to csv,json,xlsx file True
ascend bool Sort data in ascending order False True

Returns

This function does not return anything