jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-13 21:02:13 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
8731fbd692f911e10778207df26276fcce715e21
OpenBB/website/content/api/crypto/tools/apy/_index.md
Colin Delahunty 8731fbd692 Auto Generate API Documentation (#2360) 
* Started auto doc generation

* Created a markdown document

* Added test changed to md

* Created working version of new documentation

* Made requested changes

* Generate docs for all

Co-authored-by: minhhoang1023 <40023817+minhhoang1023@users.noreply.github.com>
2022-09-20 19:15:54 +01:00

998 B
Vendored
Raw Blame History

crypto.tools.apy

To obtain charts, make sure to add chart=True as the last parameter

Get underlying data

###crypto.tools.apy(apr: float, compounding_times: int) -> Tuple[pandas.core.frame.DataFrame, str]

Converts apr into apy

Parameters
----------
apr: float
    value in percentage
compounding_times: int
    number of compounded periods in a year

Returns
-------
Tuple:
    - pd.DataFrame: dataframe with results
    - str: narrative version of results

Getting charts

###crypto.tools.apy(apr: float, compounding_times: int, narrative: bool = False, export: str = '', chart=True)

Displays APY value converted from APR

Parameters
----------
apr: float
    value in percentage
compounding_times: int
    number of compounded periods in a year
narrative: str
    display narrative version instead of dataframe
export : str
    Export dataframe data to csv,json,xlsx file

Returns
-------