mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-09 10:51:57 +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>
70 lines
3.6 KiB
Markdown
Vendored
70 lines
3.6 KiB
Markdown
Vendored
---
|
|
title: treasury
|
|
description: This page provides detailed information and instructions on how to obtain
|
|
and plot any set of U.S. treasuries through different parameters including maturity,
|
|
frequency and type. It provides flexibility with regards to date ranges.
|
|
keywords:
|
|
- U.S. treasuries
|
|
- maturity
|
|
- frequency
|
|
- plot
|
|
- date range
|
|
- parameters
|
|
- instructions
|
|
- EconDB
|
|
- FED
|
|
- inflation-adjusted
|
|
- secondary markets
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="economy /treasury - Reference | OpenBB Terminal Docs" />
|
|
|
|
Obtain any set of U.S. treasuries and plot them together. These can be a range of maturities for nominal, inflation-adjusted (on long term average of inflation adjusted) and secondary markets over a lengthy period. Note: 3-month and 10-year treasury yields for other countries are available via the command 'macro' and parameter 'M3YD' and 'Y10YD'. [Source: EconDB / FED]
|
|
|
|
### Usage
|
|
|
|
```python
|
|
treasury [-m MATURITY] [--show] [--freq {annually,monthly,weekly,daily}] [-t TYPE] [-s START_DATE] [-e END_DATE]
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Description | Default | Optional | Choices |
|
|
| ---- | ----------- | ------- | -------- | ------- |
|
|
| maturity | The preferred maturity which is dependent on the type of the treasury | 10y | True | None |
|
|
| show_maturities | Show the maturities available for every instrument. | False | True | None |
|
|
| frequency | The frequency, this can be annually, monthly, weekly or daily | monthly | True | annually, monthly, weekly, daily |
|
|
| type | Choose from: nominal, inflation, average, secondary | nominal | True | None |
|
|
| start_date | The start date of the data (format: YEAR-MONTH-DAY, i.e. 2010-12-31) | 1934-01-31 | True | None |
|
|
| end_date | The end date of the data (format: YEAR-DAY-MONTH, i.e. 2021-06-02) | 2022-11-25 | True | None |
|
|
|
|
|
|
---
|
|
|
|
## Examples
|
|
|
|
```python
|
|
2022 Mar 15, 07:33 (🦋) /economy/ $ treasury -sm
|
|
Maturity options per instrument
|
|
┏━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
|
┃ Instrument ┃ Maturities ┃
|
|
┡━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
|
│ nominal │ 1m, 3m, 6m, 1y, 2y, 3y, 5y, 7y, 10y, 20y, 30y │
|
|
├────────────┼───────────────────────────────────────────────┤
|
|
│ inflation │ 5y, 7y, 10y, 20y, 30y │
|
|
├────────────┼───────────────────────────────────────────────┤
|
|
│ average │ Defined by function │
|
|
├────────────┼───────────────────────────────────────────────┤
|
|
│ secondary │ 4w, 3m, 6m, 1y │
|
|
└────────────┴───────────────────────────────────────────────┘
|
|
```
|
|
|
|
|
|
|
|
|
|
---
|