Go to file
Danglewood 6e9b0d8ec9 Adds an additional ~50 global or sector indices; improves global coverage and autocomplete. (#1746)
* Adds about 50 global or sector indices; improves sorting of arguments field.

The change to this file adds approximately fifty global indices to autocomplete and  the table: /economy/index -si

For country-specific indices (outside of US or 'global'), the argument is prefaced with the standard two-letter country code for the index. All volatility indices are prefaced with cboe. I.e., cboe-vix, cboe-shortvol.

Where not using USD as the denominating index base currency, the currency is listed in the name.

```
│ nl-amx            │ Euronext Dutch Mid Cap Index (EUR)              │ ^AMX          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ at-atx            │ Wiener Börse Austrian 20 Index (EUR)            │ ^ATX          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ ch-stoxx          │ Zurich STXE 600 PR Index (EUR)                  │ ^STOXX        │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ ch-stoxx50e       │ Zurich ESTX 50 PR Index (EUR)                   │ ^STOXX50E     │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ ch-ssip           │ Swiss All Shares Index (CHF)                    │ SSIP.SW       │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ ch-airlines       │ STXE TM Airlines Index (EUR)                    │ U0A.Z         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ omxn40            │ OMX Nordic 40 (EUR)                             │ ^OMXN40       │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ se-omx30          │ OMX Stockholm 30 Index (SEK)                    │ ^OMX          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ se-omxspi         │ OMX Stockholm All Share PI (SEK)                │ ^OMXSPI       │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ se-benchmark      │ OMX Stockholm Benchmark GI (SEK)                │ ^OMXSBGI      │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ dk-benchmark      │ OMX Copenhagen Benchamrk GI (DKK)               │ ^OMXCBGI      │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ dk-omxc25         │ OMX Copenhagen 25 Index (DKK)                   │ ^OMXC25       │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ fi-omxhbgi        │ OMX Helsinki Benchmark GI (EUR)                 │ ^OMXHPI       │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ fi-omxh25         │ OMX Helsinki 25 (EUR)                           │ ^OMXH25       │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ de-dax40          │ DAX Performance Index (EUR)                     │ ^GDAXI        │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ de-mdax60         │ DAX Mid Cap Performance Index (EUR)             │ ^MDAXI        │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ de-sdax70         │ DAX Small Cap Performance Index (EUR)           │ ^SDAXI        │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ de-tecdax30       │ DAX Tech Sector TR Index (EUR)                  │ ^TECDAX       │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ fr-cac40          │ CAC 40 PR Index (EUR)                           │ ^FCHI         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ fr-next20         │ CAC Next 20 Index (EUR)                         │ ^CN20         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ fr-sbf120         │ Paris SBF 120 Index (EUR)                       │ ^SBF120       │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ it-mib40          │ FTSE MIB 40 Index (EUR)                         │ FTSEMIB.MI    │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ be-bel20          │ BEL 20 Brussels Index (EUR)                     │ ^BFX          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ pt-bvlg           │ Lisbon PSI All-Share Index GR (EUR)             │ ^BVLG         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ es-ibex35         │ IBEX 35 - Madrid CATS (EUR)                     │ ^IBEX         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ in-bse            │ S&P Bombay SENSEX (INR)                         │ ^BSESN        │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ in-bse-mcap       │ S&P Bombay Mid Cap Index (INR)                  │ BSE-MIDCAP.BO │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ in-bse-scap       │ S&P Bombay Small Cap Index (INR)                │ BSE-SMLCAP.BO │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ in-nse50          │ NSE Nifty 50 Index (INR)                        │ ^NSEI         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ in-nse-mcap       │ NSE Nifty 50 Mid Cap Index (INR)                │ ^NSEMDCP50    │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ in-nse-bank       │ NSE Nifty Bank Industry Index (INR)             │ ^NSEBANK      │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ in-nse500         │ NSE Nifty 500 Index (INR)                       │ ^CRSLDX       │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ il-ta125          │ Tel-Aviv 125 Index (ILS)                        │ ^TA125.TA     │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ za-shariah        │ Johannesburg Shariah All Share Index (ZAR)      │ ^J143.JO      │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ za-jo             │ Johannesburg All Share Index (ZAR)              │ ^J203.JO      │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ za-jo-mcap        │ Johannesburg Large and Mid Cap Index (ZAR)      │ ^JO206.JO     │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ za-jo-altex       │ Johannesburg Alt Exchange Index (ZAR)           │ ^J232.JP      │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ ru-moex           │ MOEX Russia Index (RUB)                         │ IMOEX.ME      │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ au-asx200         │ S&P/ASX 200 Index (AUD)                         │ ^AXJO         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ au-aord           │ Australia All Ordinary Share Index (AUD)        │ ^AORD         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ nz50              │ S&P New Zealand 50 Index (NZD)                  │ ^nz50         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ kr-kospi          │ KOSPI Composite Index (KRW)                     │ ^KS11         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ jp-arca           │ NYSE ARCA Japan Index (JPY)                     │ ^JPN          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ jp-n225           │ Nikkei 255 Index (JPY)                          │ ^N225         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ jp-n300           │ Nikkei 300 Index (JPY)                          │ ^N300         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ jp-nknr           │ Nikkei Avg Net TR Index (JPY)                   │ ^NKVI.OS      │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ jp-nkrc           │ Nikkei Avg Risk Control Index (JPY)             │ ^NKRC.OS      │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ jp-nklv           │ Nikkei Avg Leverage Index (JPY)                 │ ^NKLV.OS      │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ jp-nkcc           │ Nikkei Avg Covered Call Index (JPY)             │ ^NKCC.OS      │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ jp-nkhd           │ Nikkei Avg High Dividend Yield Index (JPY)      │ ^NKHD.OS      │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ jp-auto           │ Nikkei 500 Auto & Auto Parts Index (JPY)        │ ^NG17.OS      │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ jp-fintech        │ Global Fintech Japan Hedged Index (JPY)         │ ^FDSFTPRJPY   │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ jp-nkdh           │ Nikkei Average USD Hedge Index (JPY)            │ ^NKDH.OS      │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ jp-nkeh           │ Nikkei Average EUR Hedghe Index (JPY)           │ ^NKEH.OS      │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ cn-sse-comp       │ SSE Composite Index (CNY)                       │ 000001.SS     │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ cn-sse-a          │ SSE A Share Index (CNY)                         │ 000002.SS     │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ cn-szse-comp      │ SZSE Component Index (CNY)                      │ 399001.SZ     │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ cn-szse-a         │ SZSE A-Shares Index (CNY)                       │ 399107.SZ     │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ tw-twii           │ TSEC Weighted Index (TWD)                       │ ^TWII         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ tw-tpai           │ TSEC Paper and Pulb Subindex (TWD)              │ ^TPAI         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ hk-hsi            │ Hang Seng Index (HKD)                           │ ^HSI          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ hk-hko            │ NYSE ARCA Hong Kong Options Index (USD)         │ ^HKO          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ id-jkse           │ Jakarta Composite Index (IDR)                   │ ^JKSE         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ my-klci           │ FTSE Bursa Malaysia KLCI (MYR)                  │ ^KLSE         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ sg-sti            │ STI Singapore Index (SGD)                       │ ^STI          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ sp-materials      │ S&P 500 Materials Sector Index                  │ ^SP500-15     │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ sp-industrials    │ S&P 500 Industrials Sector Index                │ ^SP500-20     │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ sp-discretionary  │ S&P 500 Consumer Discretionary Index            │ ^SP500-25     │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ sp-staples        │ S&P 500 Consumer Staples Sector Index           │ ^SP500-30     │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ sp-health         │ S&P 500 Health Care Sector Index                │ ^SP500-35     │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ sp-financials     │ S&P 500 Financials Sector Index                 │ ^SP500-40     │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ sp-it             │ S&P 500 IT Sector Index                         │ ^SP500-45     │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ sp-communications │ S&P 500 Communications Sector Index             │ ^SP500-50     │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ sp-utilities      │ S&P 500 Utilities Sector Index                  │ ^SP500-55     │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ sp-real_estate    │ S&P 500 Real Estate Sector Index                │ ^SP500-60     │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ sp-airlines       │ S&P 500 Airlines Industry Index                 │ ^SP500-203020 │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ sp-tech_hardware  │ S&P 500 Technology Hardware Industry            │ ^SP500-452020 │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ sphyda            │ S&P High Yield Aristocrats Index                │ ^SPHYDA       │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ dow-djt           │ Dow Jones Transportation Average Index          │ ^DJT          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ dow-dju           │ Dow Jones Utility Average Index                 │ ^DJU          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ dow-rci           │ Dow Jones Composite All REIT Index              │ ^RCI          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ reit-fnar         │ FTSE Nareit All Equity REITs Index              │ ^FNAR         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ nq-q50            │ NASDAQ Q50 Index                                │ ^NXTQ         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ nq-ixch           │ NASDAQ Health Care Index                        │ ^IXCH         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ nq-tech           │ NASDAQ 100 Technology Sector Index              │ ^NDXT         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ nq-ex-tech        │ NASDAQ 100 Ex-Tech Total Return Index           │ ^NXTR         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ nq-ixtc           │ NASDAQ Telecommunications Index                 │ ^IXTC         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ nq-inds           │ NASDAQ Industrial Index                         │ ^INDS         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ nq-ixco           │ NASDAQ Computer Index                           │ ^INCO         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ nq-bank           │ NASDAQ Bank Index                               │ ^BANK         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ nq-tran           │ NASDAQ Transportation Index                     │ ^TRAN         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ ice-auto          │ ICE FactSet Global NextGen Auto Index           │ ^ICEFSNA      │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ ice-comm          │ ICE FactSet Global NextGen Communications Index │ ^ICEFSNC      │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ nyse-nyl          │ NYSE World Leaders Index                        │ ^NYL          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ nyse-nyi          │ NYSE International 100 Index                    │ ^NYI          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ nyse-nyy          │ NYSE TMT Index                                  │ ^NYY          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ arca-xmi          │ NYSE ARCA Major Market Index                    │ ^XMI          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ arca-xbd          │ NYSE ARCA Securities Broker/Dealer Index        │ ^XBD          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ arca-xii          │ NYSE ARCA Institutional Index                   │ ^XII          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ arca-xoi          │ NYSE ARCA Oil and Gas Index                     │ ^XOI          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ arca-xng          │ NYSE ARCA Natural Gas Index                     │ ^XNG          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ arca-hui          │ NYSE ARCA Gold Bugs Index                       │ ^HUI          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ arca-ixb          │ NYSE Materials Select Sector Index              │ ^IXB          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ arca-drg          │ NYSE ARCA Phramaceutical Index                  │ ^DRG          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ arca-btk          │ NYSE ARCA Biotech Index                         │ ^BKT          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ arca-pse          │ NYSE ARCA Tech 100 Index                        │ ^PSE          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ arca-nwx          │ NYSE ARCA Networking Index                      │ ^NWX          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ arca-xci          │ NYSE ARCA Computer Tech Index                   │ ^XCI          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ arca-xal          │ NYSE ARCA Airline Index                         │ ^XAL          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ arca-xtc          │ NYSE ARCA N.A. Telecom Industry Index           │ ^XTC          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ phlx-sox          │ PHLX Semiconductor Index                        │ ^SOX          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ phlx-xau          │ PHLX Gold/Silver Index                          │ ^XAU          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ phlx-hgx          │ PHLX Housing Sector Index                       │ ^HGX          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ phlx-osx          │ PHLX Oil Services Sector Index                  │ ^OSX          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ phlx-uty          │ PHLX Utility Sector Index                       │ ^UTY          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ w5000             │ Wilshire 5000                                   │ ^W5000        │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ w5000flt          │ Wilshire 5000 Float Adjusted Index              │ ^W5000FLT     │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ reit-wgreit       │ Wilshire Global REIT Index                      │ ^WGREIT       │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ reit-wgresi       │ Wilshire Global Real Estate Sector Index        │ ^WGRESI       │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ reit-wilreit      │ Wilshire US REIT Index                          │ ^WILREIT      │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ reit-wilresi      │ Wilshire US Real Estate Security Index          │ ^WILRESI      │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ cboe-bxm          │ CBOE Buy-Write Monthly Index                    │ ^BXM          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ cboe-vix          │ CBOE Volatility Index                           │ ^VIX          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ cboe-vin          │ CBOE Near-Term VIX Index                        │ ^VIN          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ cobe-vvix         │ CBOE VIX Volatility Index                       │ ^VVIX         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ cboe-shortvol     │ CBOE Short VIX Futures Index                    │ ^SHORTVOL     │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ cboe-skew         │ CBOE Skew Index                                 │ ^SKEW         │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ cboe-vxn          │ CBOE NASDAQ 100 Volatility Index                │ ^VXN          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ cboe-gvz          │ CBOE Gold Volatility Index                      │ ^GVZ          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ cboe-ovx          │ CBOE Crude Oil Volatility Index                 │ ^OVX          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ cboe-tnx          │ CBOE Interest Rate 10 Year T-Note               │ ^TNX          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ cboe-tyx          │ CBOE 30 year Treasury Yields                    │ ^TYX          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ cboe-irx          │ CBOE 13 Week Treasury Bill                      │ ^IRX          │
├───────────────────┼─────────────────────────────────────────────────┼───────────────┤
│ us-dx-y           │ US Dollar Index                                 │ DX-Y.NYB      │
└───────────────────┴─────────────────────────────────────────────────┴───────────────┘
```

* run black

Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
Co-authored-by: didierlopes.eth <dro.lopes@campus.fct.unl.pt>
Co-authored-by: james <jmaslek11@gmail.com>
2022-05-03 12:08:24 +02:00
2022-04-27 23:20:08 +02:00
2022-04-26 14:48:28 +03:00
2022-03-29 09:46:26 -04:00
2022-04-01 18:20:24 +03:00
2022-03-29 09:46:26 -04:00
2022-01-07 16:22:24 +00:00
2021-04-30 01:24:08 +03:00
2021-12-30 12:22:21 +00:00
2021-02-24 01:24:26 +00:00
2022-04-26 14:48:28 +03:00
2021-12-24 00:56:19 +00:00
2022-04-26 14:48:28 +03:00
2022-04-26 14:48:28 +03:00
2022-04-26 14:48:28 +03:00
2021-11-09 17:08:43 +00:00
2022-04-26 14:48:28 +03:00
2021-11-19 19:11:08 +03:00

Stargazers Forks Contributors MIT License

Issues Bugs Open Bugs Closed

Build Status Documentation Status GitHub release Code style: black TODOs

Discord Shield Twitter


Logo

OpenBB Terminal 🚀

Click on the GIF below for a DEMO of the terminal.

drawing

Investment research for everyone.
≪ GETTING STARTED   ·   SEE FEATURES »

Report Bug · Suggest Improvement · Request a Feature

Table of Contents

  1. About The Project
  2. Installation
  3. Contributing
  4. License
  5. Disclaimer
  6. Contacts
  7. Acknowledgments

About The Project

How it started:

OpenBB Terminal is an awesome stock and crypto market terminal that has been developed for fun, while I saw my GME shares tanking. But hey, I like the stock 💎🙌.

How it's going:

OpenBB Terminal provides a modern Python-based integrated environment for investment research, that allows an average joe retail trader to leverage state-of-the-art Data Science and Machine Learning technologies.

As a modern Python-based environment, OpenBBTerminal opens access to numerous Python data libraries in Data Science (Pandas, Numpy, Scipy, Jupyter), Machine Learning (Pytorch, Tensorflow, Sklearn, Flair), and Data Acquisition (Beautiful Soup, and numerous third-party APIs).

Installation

If you wish to install the Terminal, there are currently four options:

Contributing

There are 3 main ways of contributing to this project.

For a 1 hour coding session where the architecture of the repo is explained while a new feature is added, check here.

Become a Contributor 🦍

Recommended if you bought the dip, and the share price keeps dipping. You may as well keep yourself busy while stonks go up.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Install the pre-commit hooks by running: pre-commit install. Any time you commit a change, linters will be run automatically. On changes, you will have to re-commit.
  4. Commit your Changes (git commit -m 'Add some AmazingFeature')
  5. Push to your Branch (git push origin feature/AmazingFeature)
  6. Open a Pull Request

Raise an Issue

Recommended if you adopted a strategy of buying high and selling low.

We are interested in your view on what sort of features would make you buy even higher and selling even lower.

Also, if somehow you're sitting in several mils due to this terminal, don't forget to report a bug so that the team can fix, and keep the old ways.

Join Us and Contribute

Welcome to the club, and feel free to support the developers behind this amazing open-source project.

If you're interested in contributing fork us! Grab an issue or enhancement and put in a PR request with the fix.

License

Distributed under the MIT License. See LICENSE for more information.

Disclaimer

"A few things I am not. I am not a cat. I am not an institutional investor, nor am I a hedge fund. I do not have clients and I do not provide personalized investment advice for fees or commissions." DFV

Trading in financial instruments involves high risks including the risk of losing some, or all, of your investment amount, and may not be suitable for all investors. Before deciding to trade in financial instrument you should be fully informed of the risks and costs associated with trading the financial markets, carefully consider your investment objectives, level of experience, and risk appetite, and seek professional advice where needed. The data contained in GST is not necessarily accurate. GST and any provider of the data contained in this website will not accept liability for any loss or damage as a result of your trading, or your reliance on the information displayed.

Contacts

Didier Rodrigues Lopes - dro.lopes@campus.fct.unl.pt

Artem Veremy - artem@veremey.net

James Maslek - jmaslek11@gmail.com

Feel free to share loss porn, memes or any questions at:

Contributors

Star History

Star History Chart

Acknowledgments

Description
Mirror of OpenBB-finance/OpenBB (OpenBB Platform + CLI), pulled every 8h
Readme Apache-2.0 3.2 GiB
Languages
Python 100%