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
faa1e896fa66eda12edea8cd4e9df75ebbffd937
OpenBB/website/content/sdk/reference/crypto/tools/apy.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.1 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
apy This documentation page provides information about the apy and apr functions in openbb.crypto.tools. It features source code links, parameter descriptions, return values, and the option to view the chart or export data.
apy
apr
compounding times
cryptocurrency
openbb.crypto.tools
dataframe
narrative version
export data

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

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

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