Investment Research for Everyone, Anywhere.
MIT License
17819
234
1875

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 🚀

Documentation can be found at: https://openbb.co/docs

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

OpenBB Terminal Illustration

Investment research for everyone.
≪ GETTING STARTED   ·   CONTRIBUTING   ·   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. Star History
  8. Contributors

1. About The Project

How it started:

OpenBBTerminal 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:

OpenBBTerminal provides a 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 Python-based environment, OpenBBTerminal opens access to numerous Python data libraries in Data Science (Pandas, Numpy, Scipy, Jupyter), Machine Learning (Pytorch, Sklearn, Flair), and Data Acquisition (Beautiful Soup, and numerous third-party APIs).

2. Installation

If you wish to install the OpenBB Terminal or the OpenBB SDK, please use one of the following options:

OpenBB Terminal Usage
Windows Installer Recommended way for Windows if you just want to use the OpenBB Terminal
MacOS Installer Recommended way for MacOS if you just want to use the OpenBB Terminal
Docker An alternative way if you just want to use the OpenBB Terminal
Python If you wish to contribute to the development of the OpenBB Terminal
OpenBB SDK         Usage
PyPi Recommended way if you just want to use the OpenBB SDK
Python If you wish to contribute to the development of the OpenBB SDK        

3. Contributing

There are three main ways of contributing to this project. (Hopefully you have starred the project by now ⭐️)

BECOME A CONTRIBUTOR

  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

You can read more details about adding a feature in our CONTRIBUTING GUIDELINES.

RAISE AN ISSUE OR REQUEST A FEATURE

JOIN US

Join our Discord and provide us any feedback on The OpenBB Terminal.

4. License

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

5. 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 a 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 the OpenBBTerminal is not necessarily accurate.

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

6. Contacts

If you have any questions about the terminal or anything OpenBB, feel free to email us at support@openbb.co

If you want to say hi, or are interested in partnering with us, feel free to reach us at hello@openbb.co

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

7. Star History

Star History Chart

8. Contributors

Contributors

DidierRLopes
jmaslek
aia
colin99d
alokan
Chavithra
jose-donato
simmonsj330
piiq
montezdesousa
deeleeramone
JerBouma
minhhoang1023
cclauss
hjoaquim
lolrenx
northern-64bit
soggyomelette
devwolff
martinb-bb
hinxx
shadycuz
buzzCraft
clothespin
arcutright
LBolte29
JakubPluta
jperkins12
andrewkenreich
tehcoderer
Deel18
nodesocket
stkerr
akx
PzaThief
sigaloid
jfarid27
pchaganti
FedericoGarza
danielorf
henrytdsimmons
alexferrari88
patrickdevivo
RowanHarley
Traceabl3
0xDareDevil
Jrryy
gmerrall
qTipTip
erlandsen-tech
pauljsymonds
sabujp
CoconutMacaroon
bfxavier
catalintoma
noufal85
et41
nav1s
benkulbertis
donno2048
gsegatti
kaitj
k297lee
lepla
marcelonyc
sandsturm
bohruz
boyestrous
kairosdojo
ricleal-fugue
rmassoth
buahaha
Vinnie117
wonhyeongseo
asymness
nickvin
pftp-jz
raviolispy
lotia
Atem18
Avani1994
breck7
CameronBeebe
gnzng
dakhouya
daxxog
Deadolus
DiGyt
drashtishah
dreamerc
Deucedadorian
Felixkruemel
backhand
grvsaxena419
glaucocustodio
guanquann
josephjacks
JamesWalden97
javad94
jaymgonzalez