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>
3.6 KiB
Vendored
3.6 KiB
Vendored
title, description, keywords
| title | description | keywords | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| treasury | The page provides comprehensive documentation and source code for fetching and visualizing U.S. treasury rates data with different options for type of treasuries, maturities, and data frequencies. |
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
Get U.S. Treasury rates [Source: EconDB]
Source Code: [link]
openbb.economy.treasury(instruments: list = None, maturities: list = None, frequency: str = "monthly", start_date: str = "1900-01-01", end_date: Optional[str] = None)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| instruments | list | Type(s) of treasuries, nominal, inflation-adjusted (long term average) or secondary market. Available options can be accessed through economy.treasury_maturities(). |
None | True |
| maturities | list | Treasury maturities to get. Available options can be accessed through economy.treasury_maturities(). | None | True |
| frequency | str | Frequency of the data, this can be annually, monthly, weekly or daily. | monthly | True |
| start_date | str | Starting date, format "YEAR-MONTH-DAY", i.e. 2010-12-31. | 1900-01-01 | True |
| end_date | Optional[str] | End date, format "YEAR-MONTH-DAY", i.e. 2020-06-05. | None | True |
Returns
| Type | Description |
|---|---|
| pd.Dataframe | Holds data of the selected types and maturities |
Examples
from openbb_terminal.sdk import openbb
openbb.economy.treasury()
Display U.S. Treasury rates [Source: EconDB]
Source Code: [link]
openbb.economy.treasury_chart(instruments: list = None, maturities: list = None, frequency: str = "monthly", start_date: str = "1900-01-01", end_date: Optional[str] = None, raw: bool = False, external_axes: Optional[List[axes]] = None, export: str = "")
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| instruments | list | Type(s) of treasuries, nominal, inflation-adjusted or secondary market. Available options can be accessed through economy.treasury_maturities(). |
None | True |
| maturities | list | Treasury maturities to display. Available options can be accessed through economy.treasury_maturities(). | None | True |
| frequency | str | Frequency of the data, this can be daily, weekly, monthly or annually | monthly | True |
| start_date | str | Starting date, format "YEAR-MONTH-DAY", i.e. 2010-12-31. | 1900-01-01 | True |
| end_date | Optional[str] | End date, format "YEAR-MONTH-DAY", i.e. 2020-06-05. | None | True |
| raw | bool | Whether to display the raw output. | False | True |
| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True |
| export | str | Export data to csv,json,xlsx or png,jpg,pdf,svg file | True |
Returns
| Type | Description |
|---|---|
| Plots the Treasury Series. |