From 8d7126ca1eda402bf42caf4614e51592892f49a8 Mon Sep 17 00:00:00 2001 From: DidierRLopes Date: Thu, 18 Feb 2021 23:33:46 +0000 Subject: [PATCH 1/9] Initial README implementation --- README.md | 192 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 190 insertions(+), 2 deletions(-) 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 From eef49d5cd024b39895fefaa0a41b728402b9f3ca Mon Sep 17 00:00:00 2001 From: DidierRLopes Date: Thu, 18 Feb 2021 23:55:56 +0000 Subject: [PATCH 2/9] Test README in discovery folder --- discovery/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 discovery/README.md diff --git a/discovery/README.md b/discovery/README.md new file mode 100644 index 00000000000..98aaac70feb --- /dev/null +++ b/discovery/README.md @@ -0,0 +1,3 @@ +# DISCOVERY + +## Test From 9962071187a5df5c5404e64be0e961545a06fc30 Mon Sep 17 00:00:00 2001 From: DidierRLopes Date: Fri, 19 Feb 2021 00:25:01 +0000 Subject: [PATCH 3/9] Create discovery folder readme --- discovery/README.md | 37 +++++++++++++++++++++++++++++++++++-- 1 file changed, 35 insertions(+), 2 deletions(-) diff --git a/discovery/README.md b/discovery/README.md index 98aaac70feb..77d0d902f0f 100644 --- a/discovery/README.md +++ b/discovery/README.md @@ -1,3 +1,36 @@ -# DISCOVERY +# DISCOVER STOCKS -## Test +This menu aims to discover new stocks, and the usage of the following commands along with an example will be exploited below. + +``` +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] +``` + +## map + +## sectors + +## gainers + +## orders + +## earnings + +## high_short + +## low_float + +## sw + +## spachero + +## uwhales From def63e30009a948d7ac57f192815a3feb4b6df86 Mon Sep 17 00:00:00 2001 From: DidierRLopes Date: Fri, 19 Feb 2021 00:27:16 +0000 Subject: [PATCH 4/9] Create README for Due Diligence folder --- due_diligence/README.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 due_diligence/README.md diff --git a/due_diligence/README.md b/due_diligence/README.md new file mode 100644 index 00000000000..8ab1c1be923 --- /dev/null +++ b/due_diligence/README.md @@ -0,0 +1,39 @@ +# DUE DILIGENCE + +This menu aims to help in due-diligence of a pre-loaded stock, and the usage of the following commands along with an example will be exploited below. + +``` +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] +``` + +## news + +## red + +## analyst + +## rating + +## pt + +## est + +## ins + +## insider + +## sec + +## short + +## warnings From 1790dca6d5807e4e5e2828f070634456602cd81a Mon Sep 17 00:00:00 2001 From: DidierRLopes Date: Fri, 19 Feb 2021 00:35:33 +0000 Subject: [PATCH 5/9] Create Readme under Fundamental Analysis folder --- fundamental_analysis/README.md | 106 +++++++++++++++++++++++++++++++++ 1 file changed, 106 insertions(+) create mode 100644 fundamental_analysis/README.md diff --git a/fundamental_analysis/README.md b/fundamental_analysis/README.md new file mode 100644 index 00000000000..e26bb8120b3 --- /dev/null +++ b/fundamental_analysis/README.md @@ -0,0 +1,106 @@ +# FUNDAMENTAL ANALYSIS + +This menu aims to extract all fundamentals of a pre-loaded company, and the usage of the following commands along with an example will be exploited below. + +``` +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 +``` + +### screener + +### mgmt + +# Market Watch API + +## income + +## assets + +## liabilities + +## operating + +## investing + +## financing + + +# Yahoo Finance API + +## info + +## shrs + +## sust + +## cal + + +# Alpha Vantage API + +## overview + +## income + +## balance + +## cash + +## earnings + + +# Financial Modeling Prep API + +## profile + +## quote + +## enterprise + +## dcf + +## inc + +## bal + +## cashf + +## metrics + +## ratios + +## growth From 7afff30537dba63ae594b8ebc9ad66be1a4010d4 Mon Sep 17 00:00:00 2001 From: DidierRLopes Date: Fri, 19 Feb 2021 00:38:08 +0000 Subject: [PATCH 6/9] Create README file under technical analysis directory --- technical_analysis/README.md | 57 ++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 technical_analysis/README.md diff --git a/technical_analysis/README.md b/technical_analysis/README.md new file mode 100644 index 00000000000..8d9f0f8197e --- /dev/null +++ b/technical_analysis/README.md @@ -0,0 +1,57 @@ +# TECHNICAL ANALYSIS + +This menu aims to perform a technical analysis on a pre-loaded ticker chart, and the usage of the following commands along with an example will be exploited below. + +``` +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 +``` + +# overlap + +## ema + +## sma + +## vwap + +# momentum + +## cci + +## macd + +## rsi + +## stoch + +# trend + +## adx + +##aroon + +# volatility + +## bbands + +# volume + +## ad + +## obv From f14afc09f19e2e31a39de0b64f00f7d480facc46 Mon Sep 17 00:00:00 2001 From: DidierRLopes Date: Fri, 19 Feb 2021 00:46:16 +0000 Subject: [PATCH 7/9] Add README under technical analysis folder --- prediction_techniques/README.md | 57 +++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 prediction_techniques/README.md diff --git a/prediction_techniques/README.md b/prediction_techniques/README.md new file mode 100644 index 00000000000..8d9f0f8197e --- /dev/null +++ b/prediction_techniques/README.md @@ -0,0 +1,57 @@ +# TECHNICAL ANALYSIS + +This menu aims to perform a technical analysis on a pre-loaded ticker chart, and the usage of the following commands along with an example will be exploited below. + +``` +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 +``` + +# overlap + +## ema + +## sma + +## vwap + +# momentum + +## cci + +## macd + +## rsi + +## stoch + +# trend + +## adx + +##aroon + +# volatility + +## bbands + +# volume + +## ad + +## obv From 1f4a8efbf43bd337f26f705b3a131582406430ae Mon Sep 17 00:00:00 2001 From: DidierRLopes Date: Fri, 19 Feb 2021 00:48:10 +0000 Subject: [PATCH 8/9] Create README under sentiment folder --- sentiment/README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 sentiment/README.md diff --git a/sentiment/README.md b/sentiment/README.md new file mode 100644 index 00000000000..7d888bb47c2 --- /dev/null +++ b/sentiment/README.md @@ -0,0 +1,40 @@ +# MARKET SENTIMENT + +This menu aims to extrapolate market's sentiment regarding a pre-loaded ticker, and the usage of the following commands along with an example will be exploited below. + +``` +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 +``` + +# Reddit + +## wsb + +## watchlist + +## popular + +## spac + +## spac_c + +# Stocktwits + +## sentiment + +## messages + +## trending + +## stalker From fa98483172109c57e421d3e25e98b3d0c6cda687 Mon Sep 17 00:00:00 2001 From: DidierRLopes Date: Fri, 19 Feb 2021 00:53:11 +0000 Subject: [PATCH 9/9] Update main README features headers to hyperlink to corresponding READMEs --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d92eca840be..273388bfa08 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ Feel free to request features, I'll be happy to work on them on my spare time. The main menu allows to pre-select a ticker with commands load, clear it and view. Talk about the dates. -### Discover Stocks +### [Discover Stocks](discovery/README.md) ``` map S&P500 index stocks map [Finviz] sectors show sectors performance [Alpha Vantage] @@ -41,7 +41,7 @@ spachero Best website for SPACs research [SpacHero] uwhales Good website for SPACs research [UnusualWhales] ``` -### Market Sentiment +### [Market Sentiment](sentiment/README.md) ``` Reddit: wsb show what WSB gang is up to in subreddit wallstreetbets @@ -80,7 +80,7 @@ newsfilter www.newsfilter.io resources www.tradinganalysisresources.com ``` -### Fundamental Analysis +### [Fundamental Analysis](fundamental_analysis/README.md) ``` Daily Stock: BB (from 2020-06-04) @@ -121,7 +121,7 @@ ratios financial ratios of the company growth financial statement growth of the company ``` -### Technical Analysis +### [Technical Analysis](technical_analysis/README.md) ``` overlap: ema exponential moving average @@ -142,7 +142,7 @@ ad chaikin accumulation/distribution line values obv on balance volume ``` -### Due Diligence +### [Due Diligence](due_diligence/README.md) ``` news latest news of the company [Finviz] red gets due diligence from another user's post [Reddit] @@ -157,7 +157,7 @@ short short interest [Quandl] warnings company warnings according to Sean Seah book [Market Watch] ``` -### Prediction Techniques +### [Prediction Techniques](prediction_techniques/README.md) ``` sma simple moving average knn k-Nearest Neighbors