jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-05 00:42:19 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd08218c35aed534ad59309ff2ca99d08e94de6a
OpenBB/website/content/sdk/reference/economy/ycrv.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.0 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
ycrv This documentation page guides users on how to use the 'ycrv' function in OpenBB software to retrieve and display yield curve data.
ycrv
yield curve
Treasury rates
data retrieval
data display
frontend development
FRED source code
economic data visualization

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

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

Gets yield curve data from FRED

Source Code: [link]

openbb.economy.ycrv(date: datetime.datetime = None)

Parameters

Name Type Description Default Optional
date datetime Date to get curve for. If None, gets most recent date None True

Returns

Type Description
Tuple[pd.DataFrame, datetime] Dataframe of yields and maturities,
Date for which the yield curve is obtained

Examples

from openbb_terminal.sdk import openbb
ycrv_df = openbb.economy.ycrv()

Display yield curve based on US Treasury rates for a specified date.

Source Code: [link]

openbb.economy.ycrv_chart(date: datetime.datetime = None, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, raw: bool = False, export: str = "")

Parameters

Name Type Description Default Optional
date datetime Date to get yield curve for None True
external_axes Optional[List[plt.Axes]] External axes to plot data on None True

Returns

This function does not return anything