diff --git a/README.md b/README.md index 05cfb32c920..d92eca840be 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,190 @@ -# StockMarketBot -Your to-go favourite Stock Market Bot +# GamestonkTerminal 🚀 + +## About + +Gamestonk Terminal is an awesome stock market terminal that has been developed for fun, while I saw my GME shares tanking. But hey, I like the stock 💎🙌. + +The implementation (in python) allows to easily add more commands, and expand on their configuration. + +Feel free to request features, I'll be happy to work on them on my spare time. + +## Table of contents + +* [Features](#Features) + * [Discover Stocks](#Discover_Stocks) + * [Market Sentiment](#Market_Sentiment) + * [Research Web pages](#Research_Web_pages) + * [Fundamental Analysis](#Fundamental_Analysis) + * [Technical Analysis](#Technical_Analysis) + * [Due Diligence](#Due_Diligence) + * [Prediction Techniques](#Prediction_Techniques) +* [Install](#Install) +* [API Keys](#API_Keys) +* [Disclaimer](#Disclaimer) + +## Features + +The main menu allows to pre-select a ticker with commands load, clear it and view. +Talk about the dates. + +### Discover Stocks +``` +map S&P500 index stocks map [Finviz] +sectors show sectors performance [Alpha Vantage] +gainers show latest top gainers [Yahoo Finance] +orders Orders by Fidelity Customers [Fidelity] +earnings next earnings release dates [Seeking Alpha] +high_short show top high short interest stocks of over 20% ratio [www.highshortinterest.com] +low_float show low float stocks under 10M shares float [www.lowfloat.com] +sw Simply Wall St. research data [Simply Wall St.] +spachero Best website for SPACs research [SpacHero] +uwhales Good website for SPACs research [UnusualWhales] +``` + +### Market Sentiment +``` +Reddit: +wsb show what WSB gang is up to in subreddit wallstreetbets +watchlist show other users watchlist +popular show popular tickers +spac show other users spacs announcements +spac_c show other users spacs announcements from subreddit SPACs + +Stocktwits: +sentiment estimate quick sentiment from last 30 messages on board +messages output up to the 30 last messages on the board +trending trending stocks +stalker stalk stocktwits user's last messages +``` + +### Research Web pages +``` +macroaxis www.macroaxis.com +yahoo www.finance.yahoo.com +finviz www.finviz.com +marketwatch www.marketwatch.com +fool www.fool.com +businessinsider www.markets.businessinsider.com +fmp www.financialmodelingprep.com +fidelity www.eresearch.fidelity.com +tradingview www.tradingview.com +marketchameleon www.marketchameleon.com +stockrow www.stockrow.com +barchart www.barchart.com +grufity www.grufity.com +fintel www.fintel.com +zacks www.zacks.com +macrotrends www.macrotrends.net +newsfilter www.newsfilter.io + +resources www.tradinganalysisresources.com +``` + +### Fundamental Analysis +``` +Daily Stock: BB (from 2020-06-04) + +screener screen info about the company [Finviz] +mgmt management team of the company [Business Insider] + +Market Watch API +income income statement of the company +assets assets of the company +liabilities liabilities and shareholders equity of the company +operating cash flow operating activities of the company +investing cash flow investing activities of the company +financing cash flow financing activities of the company + +Yahoo Finance API +info information scope of the company +shrs hareholders of the company +sust sustainability values of the company +cal calendar earnings and estimates of the company + +Alpha Vantage API +overview overview of the company +income income statements of the company +balance balance sheet of the company +cash cash flow of the company +earnings earnings dates and reported EPS + +Financial Modeling Prep API +profile profile of the company +quote quote of the company +enterprise enterprise value of the company over time +dcf discounted cash flow of the company over time +inc income statements of the company +bal balance sheet of the company +cashf cash flow of the company +metrics key metrics of the company +ratios financial ratios of the company +growth financial statement growth of the company +``` + +### Technical Analysis +``` +overlap: +ema exponential moving average +sma simple moving average +vwap volume weighted average price +momentum: +cci commodity channel index +macd moving average convergence/divergence +rsi relative strength index +stoch stochastic oscillator +trend: +adx average directional movement index +aroon aroon indicator +volatility: +bbands bollinger bands +volume: +ad chaikin accumulation/distribution line values +obv on balance volume +``` + +### Due Diligence +``` +news latest news of the company [Finviz] +red gets due diligence from another user's post [Reddit] +analyst analyst prices and ratings of the company [Finviz] +rating rating of the company from strong sell to strong buy [FMP] +pt price targets over time [Business Insider] +est quarter and year analysts earnings estimates [Business Insider] +ins insider activity over time [Business Insider] +insider insider trading of the company [Finviz] +sec SEC filings [Market Watch] +short short interest [Quandl] +warnings company warnings according to Sean Seah book [Market Watch] +``` + +### Prediction Techniques +``` +sma simple moving average +knn k-Nearest Neighbors +linear linear regression (polynomial 1) +quadratic quadratic regression (polynomial 2) +cubic cubic regression (polynomial 3) +regression regression (other polynomial) +arima autoregressive integrated moving average +prophet Facebook's prophet prediction +mlp MultiLayer Perceptron +rnn Recurrent Neural Network +lstm Long-Short Term Memory +``` + +## Install + +Which Python version does this support +Explain how to run pip install -r requirements.txt... +Add requirements.txt file +Make sure it works + + +## API Keys + +Necessary API Keys, and how to get them! + + +## 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