apy
- Model
- Chart
Converts apr into apy
Source Code: [link]
openbb.crypto.tools.apy(apr: float, compounding_times: int)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| apr | float | value in percentage | None | False |
| compounding_times | int | number of compounded periods in a year | None | False |
Returns
| Type | Description |
|---|---|
| Tuple[pd.DataFrame, str] | - pd.DataFrame: dataframe with results - str: narrative version of results |
Displays APY value converted from APR
Source Code: [link]
openbb.crypto.tools.apy_chart(apr: float, compounding_times: int, narrative: bool = False, export: str = "")
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| apr | float | value in percentage | None | False |
| compounding_times | int | number of compounded periods in a year | None | False |
| narrative | str | display narrative version instead of dataframe | False | True |
| export | str | Export dataframe data to csv,json,xlsx file | True |
Returns
This function does not return anything