jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 13:01:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f2cf772d7937ca3583a784fca2e1ce814b19842e
OpenBB/website/versioned_docs/version-v3/sdk/reference/crypto/tools/apy.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

1.7 KiB
Vendored
Raw Blame History

title, description
title description
apy OpenBB SDK Function

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

apy

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