jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-30 05:52:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ee2fffdba320aacdb00a461bfb86707f58e9b3d3
OpenBB/gamestonk_terminal/econ
History
DidierRLopes b33975c551 Update fred_view.py
2021-05-05 22:33:49 +01:00
..
__init__.py
refactor fred -> econ menu. Added single vix command. black likely not updates from previous pr
2021-04-26 12:41:38 -04:00
econ_controller.py
improve description
2021-05-02 19:34:28 +01:00
finnhub_view.py
flake8 remove unused imports
2021-05-02 19:46:50 +01:00
fred_view.py
Update fred_view.py
2021-05-05 22:33:49 +01:00
README.md
Update README.md
2021-05-02 20:01:21 +01:00

README.md

ECONOMY

This menu aims to assess economy data, and the usage of the following commands along with an example will be exploited below.

  • events
    • economic impact events [Finnhub]
  • fred
  • vixcls
    • Volatility Index
  • gdp
    • Gross Domestic Product
  • unrate
    • Unemployment Rate
  • dgs1
    • 1-Year Treasury Constant Maturity Rate
  • dgs5
    • 5-Year Treasury Constant Maturity Rate
  • dgs10
    • 10-Year Treasury Constant Maturity Rate
  • dgs30
    • 30-Year Treasury Constant Maturity Rate
  • mortgage30us
    • 30-Year Fixed Rate Mortgage Average
  • fedfunds
    • Effective Federal Funds Rate
  • aaa
    • Moody's Seasoned AAA Corporate Bond Yield
  • dexcaus
    • Canada / U.S. Foreign Exchange Rate (CAD per 1 USD)

events 

usage: events [-c {NZ,AU,ERL,CA,EU,US,JP,CN,GB,CH}] [-i {low,medium,high,all}] [-n NUM]

Output economy impact calendar impact events. [Source: https://finnhub.io]

  • -c : Country from where to get economy calendar impact events, between NZ,AU,ERL,CA,EU,US,JP,CN,GB,CH. Default: US.
  • -i : Impact of the economy event, between low,medium,high,all. Default: all.
  • -n : Number economy calendar impact events to display. Default: 10.
Captura de ecrã 2021-05-02, às 19 51 47

fred 

usage: fred [-i SERIES_ID] [-s START_DATE] [-t]

Display customized Federal Reserve Economic Data (FRED) from https://fred.stlouisfed.org.

  • -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.

vixcls 

usage: vixcls [-s START_DATE] [-t]

Volatility Index

  • -s : Starting date (YYYY-MM-DD) of data. Default: 2019-01-01.
  • -t : Only output text data.

vixcls

gdp 

usage: gdp [-s START_DATE] [-t]

Gross Domestic Product

  • -s : Starting date (YYYY-MM-DD) of data. Default: 2019-01-01.
  • -t : Only output text data.

gdp

unrate 

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

dgs1 

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

dgs5 

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

dgs10 

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

dgs30 

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

mortgage30us 

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

fedfunds 

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

aaa 

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

dexcaus 

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