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/ov/indexes.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.1 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
indexes The documentation page covers the retrieval and visualization of crypto indexes using the CoinGecko API in the OpenBB platform. It details parameters, source code, and return values for related methods.
CoinGecko API
crypto indexes
pycoingecko_model
pycoingecko_view
data sort
crypto data visualization
data export

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

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

Get list of crypto indexes from CoinGecko API [Source: CoinGecko]

Source Code: [link]

openbb.crypto.ov.indexes(sortby: str = "Name", ascend: bool = True)

Parameters

Name Type Description Default Optional
sortby str Key by which to sort data Name True
ascend bool Flag to sort data ascending True True

Returns

Type Description
pd.DataFrame Name, Id, Market, Last, MultiAsset

Shows list of crypto indexes. [Source: CoinGecko]

Source Code: [link]

openbb.crypto.ov.indexes_chart(sortby: str = "Name", ascend: bool = True, limit: int = 15, export: str = "")

Parameters

Name Type Description Default Optional
limit int Number of records to display 15 True
sortby str Key by which to sort data Name True
ascend bool Flag to sort data descending True True
export str Export dataframe data to csv,json,xlsx file True

Returns

This function does not return anything