jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-31 06:22:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
DidierRLopes
2021-05-01 04:04:44 +01:00
committed by GitHub
parent 35b0abf60a
commit 1ee7b01382
1 changed files with 153 additions and 110 deletions
Download Patch File Download Diff File Expand all files Collapse all files

263
gamestonk_terminal/econ/README.md
View File

@@ -3,138 +3,181 @@
This menu aims to assess economy data, and the usage of the following commands along with an example will be exploited below.
* [fred](#fred)
* Get customized Federal Reserve Economic Data (FRED) from https://fred.stlouisfed.org.
* display customized FRED from https://fred.stlouisfed.org
* [vixcls](#vixcls)
* Volatility Index
* [gdp](#gdp)
* Gross domestic product
* [vix](#vix)
* Volatility index
* [t1](#t1)
* Gross Domestic Product
* [unrate](#unrate)
* Unemployment Rate
* [dgs1](#dgs1)
* 1-Year Treasury Constant Maturity Rate
* [t5](#t5)
* [dgs5](#dgs5)
* 5-Year Treasury Constant Maturity Rate
* [t10](#t10)
* [dgs10](#dgs10)
* 10-Year Treasury Constant Maturity Rate
* [t30](#t30)
* [dgs30](#dgs30)
* 30-Year Treasury Constant Maturity Rate
* [mort30](#mort30)
* [mortgage30us](#mortgage30us)
* 30-Year Fixed Rate Mortgage Average
* [fedrate](#fedrate)
* [fedfunds](#fedfunds)
* Effective Federal Funds Rate
* [moodAAA](#moodAAA)
* [aaa](#aaa)
* Moody's Seasoned AAA Corporate Bond Yield
* [usdcad](#usdcad)
* [dexcaus](#dexcaus)
* Canada / U.S. Foreign Exchange Rate (CAD per 1 USD)
## predefined <a name="predefined"></a>
## fred <a name="fred"></a>
```text
usage: selected [-n N_TO_GET] [-s START_DATE] [--noplot] [--hidedata]
usage: fred [-i SERIES_ID] [-s START_DATE] [-t]
```
Gets predefined data. Arguments
* selected : Key from the predefined list.
* -s : Start Date. Format YYYY-mm-dd. First point to get. Defaults to Jan 1 2019
* --noplot : Flag to hide plot
* --hidedata : Flag to suppress printing output. Useful for data released daily/weekly.
To plot the 30-Year Mortgage rates since 2018-01-01 suppressing the output.
````
mort30 -s 2018-01-01 --hidedata
````
Display customized Federal Reserve Economic Data (FRED) from https://fred.stlouisfed.org.
![mort30](https://user-images.githubusercontent.com/18151143/111521185-3d80dc80-872f-11eb-989d-c2bb256aa213.png)
To show all GDP data since 1/1/2016, with no plot.
````
gdp -s 2016-01-01 --noplot
````
Output:
````
GDP
Date
2016-01-01 18470.156
2016-04-01 18656.207
2016-07-01 18821.359
2016-10-01 19032.580
2017-01-01 19237.435
2017-04-01 19379.232
2017-07-01 19617.288
2017-10-01 19937.963
2018-01-01 20242.215
2018-04-01 20552.653
2018-07-01 20742.723
2018-10-01 20909.853
2019-01-01 21115.309
2019-04-01 21329.877
2019-07-01 21540.325
2019-10-01 21747.394
2020-01-01 21561.139
2020-04-01 19520.114
2020-07-01 21170.252
2020-10-01 21487.896
````
* -i : FRED Series ID from https://fred.stlouisfed.org.
* -s : Starting date (YYYY-MM-DD) of data. Default: 2019-01-01.
* -t : Only output text data.
## cust <a name="cust"></a>
## vixcls <a name="vixcls"></a>
```text
usage: vixcls [-s START_DATE] [-t]
```
The fred database has many different datasets freely available. They each have their own custom SERIES_ID which can be obtained through the website.
Volatility Index
````
usage: cust [-i --id] [-s START_DATE] [--noplot] [--hidedata]
````
* -i/--id : Series ID for FRED data. Required argument
* -s : Start Date. Format YYYY-mm-dd. First point to get. Defaults to Jan 1 2015.
* --noplot : Flag to suppress output plot.
* --hidedata : Flag to suppress data output
* -s : Starting date (YYYY-MM-DD) of data. Default: 2019-01-01.
* -t : Only output text data.
An example of custom data could be the USD/EURO exchange rate.
According to https://fred.stlouisfed.org/series/DEXUSEU , the series ID is DEXUSEU. So to plot this from the start of February 2021 to now (3/17)
![vixcls](https://user-images.githubusercontent.com/25267873/116769167-160d7700-aa32-11eb-8874-3b864908c9c2.png)
````
cust --id DEXUSEU -s 2021-02-01
````
This will plot and display:
![cust](https://user-images.githubusercontent.com/18151143/111521481-92bcee00-872f-11eb-8a02-e7346e56e462.png)
````
DEXUSEU
Date
2021-02-01 1.2070
2021-02-02 1.2020
2021-02-03 1.2025
2021-02-04 1.1974
2021-02-05 1.2035
2021-02-08 1.2045
2021-02-09 1.2106
2021-02-10 1.2132
2021-02-11 1.2127
2021-02-12 1.2126
2021-02-15 NaN
2021-02-16 1.2107
2021-02-17 1.2042
2021-02-18 1.2078
2021-02-19 1.2136
2021-02-22 1.2155
2021-02-23 1.2142
2021-02-24 1.2143
2021-02-25 1.2229
2021-02-26 1.2093
2021-03-01 1.2054
2021-03-02 1.2079
2021-03-03 1.2073
2021-03-04 1.2045
2021-03-05 1.1914
2021-03-08 1.1849
2021-03-09 1.1885
2021-03-10 1.1900
2021-03-11 1.1978
````
## gdp <a name="gdp"></a>
```text
usage: gdp [-s START_DATE] [-t]
```
Note the NaN on 2-15, which corresponds to President's Day.
Gross Domestic Product
## VIX
* -s : Starting date (YYYY-MM-DD) of data. Default: 2019-01-01.
* -t : Only output text data.
This command pulls historical VIX data from yfinance module.
````
usage: view [-s START_DATE]
````
* -s Start date to plot historical VIX data
![gdp](https://user-images.githubusercontent.com/25267873/116769162-14dc4a00-aa32-11eb-886a-b5368146ed37.png)
## unrate <a name="unrate"></a>
```text
usage: unrate [-s START_DATE] [-t]
```
Unemployment Rate
* -s : Starting date (YYYY-MM-DD) of data. Default: 2019-01-01.
* -t : Only output text data.
![unrate](https://user-images.githubusercontent.com/25267873/116769161-14dc4a00-aa32-11eb-91f3-a0f80d687a12.png)
## dgs1 <a name="dgs1"></a>
```text
usage: dgs1 [-s START_DATE] [-t]
```
1-year Treasury Constant Maturity Rate
* -s : Starting date (YYYY-MM-DD) of data. Default: 2019-01-01.
* -t : Only output text data.
![dgs1](https://user-images.githubusercontent.com/25267873/116769166-160d7700-aa32-11eb-9247-78156af4d527.png)
## dgs5 <a name="dgs5"></a>
```text
usage: dgs5 [-s START_DATE] [-t]
```
5-year Treasury Constant Maturity Rate
* -s : Starting date (YYYY-MM-DD) of data. Default: 2019-01-01.
* -t : Only output text data.
![dgs5](https://user-images.githubusercontent.com/25267873/116769165-1574e080-aa32-11eb-96ee-c57728d8f57c.png)
## dgs10 <a name="dgs10"></a>
```text
usage: dgs10 [-s START_DATE] [-t]
```
10-year Treasury Constant Maturity Rate
* -s : Starting date (YYYY-MM-DD) of data. Default: 2019-01-01.
* -t : Only output text data.
![dgs10](https://user-images.githubusercontent.com/25267873/116769164-1574e080-aa32-11eb-93a0-3b8a2b7cb3d2.png)
## dgs30 <a name="dgs30"></a>
```text
usage: dgs30 [-s START_DATE] [-t]
```
30-year Treasury Constant Maturity Rate
* -s : Starting date (YYYY-MM-DD) of data. Default: 2019-01-01.
* -t : Only output text data.
![dgs30](https://user-images.githubusercontent.com/25267873/116769159-13ab1d00-aa32-11eb-8c3d-e53c8d1f1a19.png)
## mortgage30us <a name="mortgage30us"></a>
```text
usage: mortgage30us [-s START_DATE] [-t]
```
30-year Fixed Rate Mortgage Average
* -s : Starting date (YYYY-MM-DD) of data. Default: 2019-01-01.
* -t : Only output text data.
![mortgage30us](https://user-images.githubusercontent.com/25267873/116769157-13128680-aa32-11eb-8826-ccb2e6ae764e.png)
## fedfunds <a name="fedfunds"></a>
```text
usage: fedfunds [-s START_DATE] [-t]
```
Effective Federal Funds Rate
* -s : Starting date (YYYY-MM-DD) of data. Default: 2019-01-01.
* -t : Only output text data.
![fedfunds](https://user-images.githubusercontent.com/25267873/116769158-13ab1d00-aa32-11eb-9dc2-8296bc4f7e2c.png)
## aaa <a name="aaa"></a>
```text
usage: aaa [-s START_DATE] [-t]
```
Moody's Seasoned AAA Corporate Bond Yield
* -s : Starting date (YYYY-MM-DD) of data. Default: 2019-01-01.
* -t : Only output text data.
![aaa](https://user-images.githubusercontent.com/25267873/116769160-1443b380-aa32-11eb-84a8-036e15b47c9b.png)
## dexcaus <a name="dexcaus"></a>
```text
usage: dexcaus [-s START_DATE] [-t]
```
Canada / U.S. Foreign Exchange Rate (CAD per 1 USD)
* -s : Starting date (YYYY-MM-DD) of data. Default: 2019-01-01.
* -t : Only output text data.
![dexcaus](https://user-images.githubusercontent.com/25267873/116769155-10b02c80-aa32-11eb-8ece-d8e92b8df1af.png)