jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-02 07:23:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
041ff008de6fe892e8d9ac1e251eaa892cbdf97b
OpenBB/website/versioned_docs/version-v3/sdk/reference/crypto/dd/pr.md
Theodore Aptekarev f72bc8ccec Add Versioned Documentation (#5470) 
* Adding versioning to docs

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-09-29 11:49:05 +02:00

2.4 KiB
Vendored
Raw Blame History

title, description
title description
pr OpenBB SDK Function

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

pr

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