mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 07:51:49 +00:00
4ad995fdd0
* 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>
2.9 KiB
Vendored
2.9 KiB
Vendored
title, description, keywords
| title | description | keywords | ||||||
|---|---|---|---|---|---|---|---|---|
| tyld | This page provides documentation for retrieving and displaying historical yield data using the 'tyld' and 'tyld_chart' functions in the OpenBB finance module. This data can be filtered based on various parameters including the interval, maturity and start date. For more in-depth details and access to the source code, please refer to the respective sections. |
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
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