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
f68929fa1efaa5e9abb7911029e287c975b37fd3
OpenBB/website/content/sdk/reference/economy/tyld.md
jose-donato 2e7eb4c9b6 New documentation website (#3526) 
* fix(docs): added margin between sections

* feat: removed unused files; updated ga

* fix: juan stuff doesnt work

* fix: random fix

* moon at noon

* fix: update docusaurus config

* Update controller_doc_classes.py

* fix: temp fix

* fix: temp fix

* Update controller_doc_classes.py

* fix: remove old content

* fix: taggfix

* init

* fix: styling and moved file

* Update generate_terminal_markdown.py

* fix: removed unused images

* fix: port new files

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 16:47:03 +00:00

2.3 KiB
Vendored
Raw Blame History

title, description
title description
tyld OpenBB SDK Function

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

tyld

Get historical yield for a given maturity

Source Code: [link]

openbb.economy.tyld(interval: str = "m", maturity: str = "10y", start_date: str = "2010-01-01")

Parameters

Name Type Description Default Optional
interval str Interval for data. Can be "d","w","m" for daily, weekly or monthly, by default "m" m True
start_date str Start date for data. Should be in YYYY-MM-DD format, by default "2010-01-01" 2010-01-01 True
maturity str Maturity timeline. Can be "3mo","5y","10y" or "30y", by default "10y" 10y True

Returns

Type Description
pd.DataFrame Dataframe of historical yields

Display historical treasury yield for given maturity

Source Code: [link]

openbb.economy.tyld_chart(interval: str = "m", maturity: str = "10y", start_date: str = "2010-01-01", raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)

Parameters

Name Type Description Default Optional
interval str Interval for data. Can be "d","w","m" for daily, weekly or monthly, by default "m" m True
maturity str Maturity timeline. Can be "3mo","5y","10y" or "30y", by default "10y" 10y True
start_date str Start date for data. Should be in YYYY-MM-DD format, by default "2010-01-01" 2010-01-01 True
raw bool Flag to display raw data, by default False False True
export str Format to export data, by default "" True
external_axes Optional[List[plt.Axes]] External axes (1 axis is expected in the list), by default None None True

Returns

This function does not return anything