mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 16:02:04 +00:00
4ad995fdd0
* 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>
96 lines
2.7 KiB
Markdown
Vendored
96 lines
2.7 KiB
Markdown
Vendored
---
|
|
title: info
|
|
description: This page provides detailed documentation on retrieving and visualizing
|
|
cryptocurrency data from the CoinPaprika API using methods from the OpenBB crypto
|
|
module. The page includes parameters and return values, data sorting, and export
|
|
options. Source codes are also linked for better understanding.
|
|
keywords:
|
|
- CoinPaprika API
|
|
- crypto coin data
|
|
- cryptocurrency information
|
|
- openbb.crypto.ov.info
|
|
- data modeling
|
|
- data sorting
|
|
- ascending and descending sorting
|
|
- data visualization
|
|
- data export formats
|
|
- python coding
|
|
- coin market cap
|
|
- coin volume
|
|
- price chart
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="crypto.ov.info - Reference | OpenBB SDK Docs" />
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
<Tabs>
|
|
<TabItem value="model" label="Model" default>
|
|
|
|
Returns basic coin information for all coins from CoinPaprika API [Source: CoinPaprika]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/coinpaprika_model.py#L183)]
|
|
|
|
```python
|
|
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,<br/>max_supply, market_cap, beta_value, ath_price, |
|
|
---
|
|
|
|
</TabItem>
|
|
<TabItem value="view" label="Chart">
|
|
|
|
Displays basic coin information for all coins from CoinPaprika API. [Source: CoinPaprika]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/coinpaprika_view.py#L159)]
|
|
|
|
```python
|
|
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
|
|
|
|
---
|
|
|
|
</TabItem>
|
|
</Tabs>
|