jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 13:01:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f68929fa1efaa5e9abb7911029e287c975b37fd3
OpenBB/website/content/sdk/reference/crypto/ov/info.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.0 KiB
Vendored
Raw Blame History

title, description
title description
info OpenBB SDK Function

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

info

Returns basic coin information for all coins from CoinPaprika API [Source: CoinPaprika]

Source Code: [link]

openbb.crypto.ov.info(symbols: str = "USD", sortby: str = "rank", ascend: bool = True)

Parameters

Name Type Description Default Optional
symbols str Comma separated quotes to return e.g quotes=USD,BTC USD True
sortby str Key by which to sort data rank True
ascend bool Flag to sort data descending True True

Returns

Type Description
pd.DataFrame rank, name, symbol, price, volume_24h, circulating_supply, total_supply,
max_supply, market_cap, beta_value, ath_price,

Displays basic coin information for all coins from CoinPaprika API. [Source: CoinPaprika]

Source Code: [link]

openbb.crypto.ov.info_chart(symbol: str, sortby: str = "rank", ascend: bool = True, limit: int = 15, export: str = "")

Parameters

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

Returns

This function does not return anything