Files
OpenBB/website/content/terminal/reference/economy/overview.md
teh_coderer 79046608b6 Docs Fix (#3543)
* Update generate_terminal_markdown.py

* updates

* update workflows

* Automated Change

* tests

* tests

* Automated Change

* Update test_generate_docs.py

* Automated Change

* updates

* Automated Change

* Update gen-docs.yml

* Update test.yml

* Automated Change

* Update test.yml

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* test

* Automated Change

* testtt23

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* Automated Change

* added empting reference folders before autogen docs

* updates

* Automated Change

* update tests gitactions

* Automated Change

* up

* Automated Change

* Automated Change

* update pytest

* Automated Change

* tests

* Automated Change

* examples update

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* Update test.yml

* Update generate_sdk_markdown.py

* strip

* Automated Change

* Workflow : check test update

* Automated Change

* Automated Change

* Automated Change

* Update test.yml

* Automated Change

* Update test.yml

* Automated Change

* Automated Change

* up

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* update workflows

* fix guides

* testing

* Update gh-pages.yml

* Update gh-pages.yml

Co-authored-by: tehcoderer <tehcoderer@users.noreply.github.com>
Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
Co-authored-by: Chavithra <Chavithra@users.noreply.github.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
2022-11-25 17:19:08 -05:00

13 KiB
Vendored

title, description
title description
overview OpenBB Terminal Function

overview

Provide a market overview of a variety of options. This can be a general overview, indices, bonds and currencies. [Source: Wall St. Journal]

Usage

overview [-t {indices,usbonds,glbonds,currencies}]

Parameters

Name Description Default Optional Choices
type Obtain either US indices, US Bonds, Global Bonds or Currencies True indices, usbonds, glbonds, currencies

Examples

2022 Mar 15, 06:59 (🦋) /economy/ $ overview
                 Market Overview
┏━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━┓
┃                   ┃ Price    ┃ Chg     ┃ %Chg  ┃
┡━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━┩
│ DJIA              │ 32945.24 │ 1.05    │ 0.00  │
├───────────────────┼──────────┼─────────┼───────┤
│ S&P 500           │ 4173.11  │ -31.20  │ -0.74 │
├───────────────────┼──────────┼─────────┼───────┤
│ Nasdaq Composite  │ 12581.22 │ -262.59 │ -2.04 │
├───────────────────┼──────────┼─────────┼───────┤
│ Japan: Nikkei 225 │ 25346.48 │ 38.63   │ 0.15  │
├───────────────────┼──────────┼─────────┼───────┤
│ UK: FTSE 100      │ 7117.67  │ -75.80  │ -1.05 │
├───────────────────┼──────────┼─────────┼───────┤
│ Crude Oil Futures │ 97.12    │ -5.89   │ -5.72 │
├───────────────────┼──────────┼─────────┼───────┤
│ Gold Futures      │ 1932.30  │ -28.50  │ -1.45 │
├───────────────────┼──────────┼─────────┼───────┤
│ Yen               │ 118.01   │ -0.18   │ -0.15 │
├───────────────────┼──────────┼─────────┼───────┤
│ Euro              │ 1.0996   │ 0.0055  │ 0.50  │
└───────────────────┴──────────┴─────────┴───────┘

2022 Mar 15, 07:00 (🦋) /economy/ $ overview indices
                      US Indices
┏━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━┓
┃                       ┃ Price    ┃ Chg     ┃ %Chg  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━┩
│ DJIA                  │ 32945.24 │ 1.05    │ 0.00  │
├───────────────────────┼──────────┼─────────┼───────┤
│ Nasdaq Composite      │ 12581.22 │ -262.59 │ -2.04 │
├───────────────────────┼──────────┼─────────┼───────┤
│ S&P 500               │ 4173.11  │ -31.20  │ -0.74 │
├───────────────────────┼──────────┼─────────┼───────┤
│ DJ Total Stock Market │ 42169.18 │ -412.17 │ -0.97 │
├───────────────────────┼──────────┼─────────┼───────┤
│ Russell 2000          │ 1941.72  │ -37.95  │ -1.92 │
├───────────────────────┼──────────┼─────────┼───────┤
│ NYSE Composite        │ 15694.35 │ -59.35  │ -0.38 │
├───────────────────────┼──────────┼─────────┼───────┤
│ Barron's 400          │ 968.62   │ -6.27   │ -0.64 │
├───────────────────────┼──────────┼─────────┼───────┤
│ CBOE Volatility       │ 32.57    │ 0.80    │ 2.52  │
├───────────────────────┼──────────┼─────────┼───────┤
│ DJIA Futures          │ 32786    │ -52     │ -0.16 │
├───────────────────────┼──────────┼─────────┼───────┤
│ S&P 500 Futures       │ 4160.25  │ -3.25   │ -0.08 │
└───────────────────────┴──────────┴─────────┴───────┘

2022 Mar 15, 07:00 (🦋) /economy/ $ overview usbonds
ov                     US Bonds
┏━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━┓
┃              ┃ Rate (%) ┃ Yld (%) ┃ Yld Chg (%) ┃
┡━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━┩
│ 30-Year Bond │ 2.25     │ 2.462   │ -0.016      │
├──────────────┼──────────┼─────────┼─────────────┤
│ 10-Year Note │ 1.88     │ 2.119   │ -0.025      │
├──────────────┼──────────┼─────────┼─────────────┤
│ 7-Year Note  │ 1.88     │ 2.131   │ -0.023      │
├──────────────┼──────────┼─────────┼─────────────┤
│ 5-Year Note  │ 1.88     │ 2.070   │ -0.023      │
├──────────────┼──────────┼─────────┼─────────────┤
│ 3-Year Note  │ 1.75     │ 2.020   │ -0.035      │
├──────────────┼──────────┼─────────┼─────────────┤
│ 2-Year Note  │ 1.50     │ 1.835   │ -0.032      │
├──────────────┼──────────┼─────────┼─────────────┤
│ 1-Year Bill  │ 0.00     │ 1.202   │ -0.003      │
├──────────────┼──────────┼─────────┼─────────────┤
│ 6-Month Bill │ 0.00     │ 0.830   │ 0.087       │
├──────────────┼──────────┼─────────┼─────────────┤
│ 3-Month Bill │ 0.00     │ 0.442   │ -0.019      │
├──────────────┼──────────┼─────────┼─────────────┤
│ 1-Month Bill │ 0.00     │ 0.200   │ -0.007      │
└──────────────┴──────────┴─────────┴─────────────┘

2022 Mar 15, 07:00 (🦋) /economy/ $ overview glbonds
                              Global Bonds
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━┓
┃                                   ┃ Rate (%) ┃ Yld (%) ┃ Yld Chg (%) ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━┩
│ U.S. 10 Year Treasury Note        │ 1.875    │ 2.118   │ -0.026      │
├───────────────────────────────────┼──────────┼─────────┼─────────────┤
│ Germany 10 Year Government Bond   │ 0.000    │ 0.359   │ -0.009      │
├───────────────────────────────────┼──────────┼─────────┼─────────────┤
│ U.K. 10 Year Gilt                 │ 4.250    │ 1.591   │ -0.006      │
├───────────────────────────────────┼──────────┼─────────┼─────────────┤
│ Japan 10 Year Government Bond     │ 0.100    │ 0.210   │ 0.015       │
├───────────────────────────────────┼──────────┼─────────┼─────────────┤
│ Australia 10 Year Government Bond │ 1.000    │ 2.505   │ 0.061       │
├───────────────────────────────────┼──────────┼─────────┼─────────────┤
│ China 10 Year Government Bond     │ 2.890    │ 2.846   │ 0.055       │
└───────────────────────────────────┴──────────┴─────────┴─────────────┘

2022 Mar 15, 07:00 (🦋) /economy/ $ overview currencies
                      Currencies
┏━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━┓
┃                        ┃ Last    ┃ Chng    ┃ %Chng ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━┩
│ Euro (EUR/USD)         │ 1.0996  │ 0.0055  │ 0.50  │
├────────────────────────┼─────────┼─────────┼───────┤
│ Japanese Yen (USD/JPY) │ 118.03  │ -0.16   │ -0.14 │
├────────────────────────┼─────────┼─────────┼───────┤
│ U.K. Pound (GBP/USD)   │ 1.3036  │ 0.0035  │ 0.27  │
├────────────────────────┼─────────┼─────────┼───────┤
│ Swiss Franc (USD/CHF)  │ 0.9388  │ 0.0002  │ 0.02  │
├────────────────────────┼─────────┼─────────┼───────┤
│ Chinese Yuan (USD/CNY) │ 6.3740  │ 0.0086  │ 0.14  │
├────────────────────────┼─────────┼─────────┼───────┤
│ Canadian $ (USD/CAD)   │ 1.2846  │ 0.0020  │ 0.16  │
├────────────────────────┼─────────┼─────────┼───────┤
│ Mexican Peso (USD/MXN) │ 20.8658 │ -0.0495 │ -0.24 │
├────────────────────────┼─────────┼─────────┼───────┤
│ Bitcoin (BTC/USD)      │ 38691   │ -46     │ -0.12 │
├────────────────────────┼─────────┼─────────┼───────┤
│ WSJ Dollar Index       │ 91.76   │ -0.21   │ -0.23 │
├────────────────────────┼─────────┼─────────┼───────┤
│ U.S. Dollar Index      │ 98.78   │ -0.22   │ -0.22 │
└────────────────────────┴─────────┴─────────┴───────┘