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>
81 lines
8.5 KiB
Markdown
Vendored
81 lines
8.5 KiB
Markdown
Vendored
---
|
|
title: fred
|
|
description: This documentation page provides information on using the fred command
|
|
to query the FRED database, plot data, and handle Macro Economic data. It includes
|
|
details on parameters, usage, and examples including Python code snippets.
|
|
keywords:
|
|
- FRED database
|
|
- Query
|
|
- Series ID
|
|
- Fred command
|
|
- Macro Economic
|
|
- Data plotting
|
|
- Start date
|
|
- End date
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="economy /fred - Reference | OpenBB Terminal Docs" />
|
|
|
|
Query the FRED database and plot data based on the Series ID. [Source: FRED]
|
|
|
|
### Usage
|
|
|
|
```python
|
|
fred [-p PARAMETER] [-s START_DATE] [-e END_DATE] [-q QUERY]
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Description | Default | Optional | Choices |
|
|
| ---- | ----------- | ------- | -------- | ------- |
|
|
| parameter | Series ID of the Macro Economic data from FRED | | True | None |
|
|
| start_date | Starting date (YYYY-MM-DD) of data | None | True | None |
|
|
| end_date | Ending date (YYYY-MM-DD) of data | None | True | None |
|
|
| query | Query the FRED database to obtain Series IDs given the query search term. | None | True | None |
|
|
|
|
|
|
---
|
|
|
|
## Examples
|
|
|
|
```python
|
|
2022 Mar 15, 07:08 (🦋) /economy/ $ fred -q treasuries
|
|
Search results for treasuries
|
|
┏━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
|
┃ Series ID ┃ Title ┃ Description ┃
|
|
┡━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
|
│ T10Y2Y │ 10-Year Treasury Constant Maturity Minus 2-Year │ Starting with the update on June 21, 2019, the Treasury bond data used in calculating interest rate │
|
|
│ │ Treasury Constant Maturity │ spreads is obtained directly from the U.S. Treasury Department (https://www.treasury.gov/resource- │
|
|
│ │ │ center/data-chart-center/interest-rates/Pages/TextView.aspx?data=yield). Series is calculated as │
|
|
│ │ │ the spread between 10-Year Treasury Constant Maturity (BC_10YEAR) and 2-Year Treasury Constant │
|
|
│ │ │ Maturity (BC_2YEAR). Both underlying series are published at the U.S. Treasury Department │
|
|
│ │ │ (https://www.treasury.gov/resource-center/data-chart-center/interest- │
|
|
│ │ │ rates/Pages/TextView.aspx?data=yield). │
|
|
├───────────┼─────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤
|
|
│ T10Y2YM │ 10-Year Treasury Constant Maturity Minus 2-Year │ Series is calculated as the spread between 10-Year Treasury Constant Maturity (BC_10YEARM) and │
|
|
│ │ Treasury Constant Maturity │ 2-Year Treasury Constant Maturity (BC_2YEARM). Starting with the update on June 21, 2019, the │
|
|
│ │ │ Treasury bond data used in calculating interest rate spreads is obtained directly from the U.S. │
|
|
│ │ │ Treasury Department (https://www.treasury.gov/resource-center/data-chart-center/interest- │
|
|
│ │ │ rates/Pages/TextView.aspx?data=yield). │
|
|
├───────────┼─────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤
|
|
│ DFII10 │ Market Yield on U.S. Treasury Securities at │ For further information regarding treasury constant maturity data, please refer to the Board of │
|
|
│ │ 10-Year Constant Maturity, Inflation-Indexed │ Governors ( http://www.federalreserve.gov/releases/h15/current/h15.pdf) and the Treasury │
|
|
│ │ │ (http://www.treasury.gov/resource-center/data-chart-center/interest-rates/Pages/yieldmethod.aspx). │
|
|
├───────────┼─────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤
|
|
│ FII10 │ Market Yield on U.S. Treasury Securities at │ For further information regarding treasury constant maturity data, please refer to │
|
|
│ │ 10-Year Constant Maturity, Inflation-Indexed │ http://www.federalreserve.gov/releases/h15/current/h15.pdf and http://www.treasury.gov/resource- │
|
|
│ │ │ center/data-chart-center/interest-rates/Pages/yieldmethod.aspx. │
|
|
├───────────┼─────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤
|
|
│ WFII10 │ Market Yield on U.S. Treasury Securities at │ For further information regarding treasury constant maturity data, please refer to │
|
|
│ │ 10-Year Constant Maturity, Inflation-Indexed │ http://www.federalreserve.gov/releases/h15/current/h15.pdf and http://www.treasury.gov/resource- │
|
|
│ │ │ center/data-chart-center/interest-rates/Pages/yieldmethod.aspx. │
|
|
└───────────┴─────────────────────────────────────────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────┘
|
|
```
|
|
|
|
|
|
---
|