jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-30 22:11:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
faa1e896fa66eda12edea8cd4e9df75ebbffd937
OpenBB/website/content/sdk/reference/crypto/dd/pr.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.9 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
pr The documentation explains how to leverage APIs for calculating and comparing potential returns of cryptocurrencies. It details requirements and parameters for two functions - fetching data for potential returns calculation and function to record these returns.
cryptocurrency
potential returns
coin comparison
fetch data
APIs usage
python functions
coin calculation
pr model
pr chart
CoinGecko source

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

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

Fetch data to calculate potential returns of a certain coin. [Source: CoinGecko]

Source Code: [link]

openbb.crypto.dd.pr(main_coin: str, to_symbol: Optional[str] = None, limit: Optional[int] = None, price: Optional[int] = None)

Parameters

Name Type Description Default Optional
main_coin str Coin loaded to check potential returns for (e.g., algorand) None False
to_symbol str None Coin to compare main_coin with (e.g., bitcoin) None
limit int None Number of coins with highest market cap to compare main_coin with (e.g., 5) None
price None Target price of main_coin to check potential returns (e.g., 5) None True

Returns

Type Description
pd.DataFrame Potential returns data
Columns: Coin, Current Price, Target Coin, Potential Price, Potential Market Cap ($), Change (%)

Prints table showing potential returns of a certain coin. [Source: CoinGecko]

Source Code: [link]

openbb.crypto.dd.pr_chart(to_symbol: str, from_symbol: Optional[str] = None, limit: Optional[int] = None, price: Optional[int] = None, export: str = "")

Parameters

Name Type Description Default Optional
to_symbol str Coin loaded to check potential returns for (e.g., algorand) None False
from_symbol str None Coin to compare main_coin with (e.g., bitcoin) None
limit int None Number of coins with highest market cap to compare main_coin with (e.g., 5) None
price None Target price of main_coin to check potential returns (e.g., 5) None True
export str Export dataframe data to csv,json,xlsx file True

Returns

This function does not return anything