diff --git a/website/content/common/behavioural_analysis/bullbear/_index.md b/website/content/common/behavioural_analysis/bullbear/_index.md index 17cdd0e329c..0c5f30185fb 100755 --- a/website/content/common/behavioural_analysis/bullbear/_index.md +++ b/website/content/common/behavioural_analysis/bullbear/_index.md @@ -2,11 +2,11 @@ usage: bullbear [-h] ``` -Print bullbear sentiment based on last 30 messages on the board. Also prints the watchlist_count. [Source: Stocktwits] +Shows the bull/bear sentiment for the loaded ticker based on last 30 messages on the board. Also prints the watchlist_count. Source: [Stocktwits](https://stocktwits.com) ``` optional arguments: -h, --help show this help message (default: False) ``` -sentiment +sentiment diff --git a/website/content/common/behavioural_analysis/getdd/_index.md b/website/content/common/behavioural_analysis/getdd/_index.md index d9a2877c03e..882eaf30bf8 100755 --- a/website/content/common/behavioural_analysis/getdd/_index.md +++ b/website/content/common/behavioural_analysis/getdd/_index.md @@ -2,7 +2,7 @@ usage: getdd [-l N_LIMIT] [-d N_DAYS] [-a] [-h] ``` -Print top stock's due diligence from other users. [Source: Reddit] +Show the latest DD from other users on Reddit. Source: [Reddit](https://reddit.com) ``` optional arguments: @@ -16,4 +16,4 @@ optional arguments: ``` -popular +getdd diff --git a/website/content/common/behavioural_analysis/headlines/_index.md b/website/content/common/behavioural_analysis/headlines/_index.md index 20dda92a5d9..53c50864e52 100755 --- a/website/content/common/behavioural_analysis/headlines/_index.md +++ b/website/content/common/behavioural_analysis/headlines/_index.md @@ -2,13 +2,13 @@ usage: headlines [-h] ``` -FinBrain collects the news headlines from 15+ major financial news sources on a daily basis and analyzes them to generate sentiment scores for more than 4500 US stocks. FinBrain Technologies develops deep learning algorithms for financial analysis and prediction, which currently serves traders from more than 150 countries all around the world. [Source: See https://finbrain.tech] +FinBrain collects the news headlines from 15+ major financial news sources on a daily basis and analyzes them to generate sentiment scores for more than 4500 US stocks. FinBrain Technologies develops deep learning algorithms for financial analysis and prediction, which currently serves traders from more than 150 countries all around the world. Source: [FinBrain](https://finbrain.tech) ``` optional arguments: -h, --help show this help message (default: False) ``` -![finbrain2](https://user-images.githubusercontent.com/25267873/111629515-49c97000-87e9-11eb-92a6-a9eebb4b4bd9.png) +headlines2 -Captura de ecrã 2021-03-18, às 12 53 31 +headlines diff --git a/website/content/common/behavioural_analysis/infer/_index.md b/website/content/common/behavioural_analysis/infer/_index.md index ece9ef94ba8..e5e79e3613e 100755 --- a/website/content/common/behavioural_analysis/infer/_index.md +++ b/website/content/common/behavioural_analysis/infer/_index.md @@ -2,8 +2,8 @@ usage: infer [-n N_NUM] [-h] ``` -Print quick sentiment inference from last tweets that contain the ticker. This model splits the text into character-level tokens and uses vader -sentiment analysis. [Source: Twitter] +Displays a quick sentiment inference from last tweets that contain the ticker. This model splits the text into character-level tokens and uses vader +sentiment analysis. Source: https://Twitter.com ``` optional arguments: @@ -12,4 +12,4 @@ optional arguments: -h, --help show this help message (default: False) ``` -Captura de ecrã 2021-08-06, às 21 49 29 +Features Screenshot - infer diff --git a/website/content/common/behavioural_analysis/mentions/_index.md b/website/content/common/behavioural_analysis/mentions/_index.md index 1716ff6402a..565610186c4 100755 --- a/website/content/common/behavioural_analysis/mentions/_index.md +++ b/website/content/common/behavioural_analysis/mentions/_index.md @@ -2,7 +2,7 @@ usage: mentions [-s START] [-h] ``` -Plot weekly bars of stock's interest over time. other users watchlist. [Source: Google] +Uses Google metrics to plot ticker mentions over time. ``` optional arguments: @@ -11,4 +11,4 @@ optional arguments: -h, --help show this help message (default: False) ``` -![gme](https://user-images.githubusercontent.com/25267873/108776894-e9813e80-755a-11eb-8b7e-654124c0ef8f.png) +Feature Screenshot - mentions diff --git a/website/content/stocks/backtesting/ema/_index.md b/website/content/stocks/backtesting/ema/_index.md index 8f9efe6085b..a60d8529f9b 100755 --- a/website/content/stocks/backtesting/ema/_index.md +++ b/website/content/stocks/backtesting/ema/_index.md @@ -2,7 +2,7 @@ usage: ema [-l LENGTH] [--spy] [--no_bench] [--export {csv,json,xlsx}] [-h] ``` -Strategy where stock is bought when Price > EMA(l) +A simple investment strategy where stock is bought when Price > EMA(l) ``` optional arguments: @@ -14,5 +14,5 @@ optional arguments: -h, --help show this help message (default: False) ``` -![ema](https://user-images.githubusercontent.com/25267873/116769584-1eb37c80-aa35-11eb-898b-efa36d4a8f5c.png) -ema2 +ema +ema2 diff --git a/website/content/stocks/backtesting/ema_cross/_index.md b/website/content/stocks/backtesting/ema_cross/_index.md index 0f96e1ce8ff..f5de4bbaccd 100755 --- a/website/content/stocks/backtesting/ema_cross/_index.md +++ b/website/content/stocks/backtesting/ema_cross/_index.md @@ -2,7 +2,7 @@ usage: ema_cross [-l LONG] [-s SHORT] [--spy] [--no_bench] [--no_short] [--export {csv,json,xlsx}] [-h] ``` -Cross between a long and a short Exponential Moving Average. +The price point where a long and a short Exponential Moving Average cross. ``` optional arguments: @@ -17,5 +17,5 @@ optional arguments: -h, --help show this help message (default: False) ``` -![ema_cross](https://user-images.githubusercontent.com/25267873/116769581-1ce9b900-aa35-11eb-85e9-133b3c0b09ad.png) -ema_cross2 +ema_cross +ema_cross2 diff --git a/website/content/stocks/backtesting/rsi/_index.md b/website/content/stocks/backtesting/rsi/_index.md index 5ef95dcc527..2b60696c3ad 100755 --- a/website/content/stocks/backtesting/rsi/_index.md +++ b/website/content/stocks/backtesting/rsi/_index.md @@ -2,7 +2,7 @@ usage: rsi [-p PERIODS] [-u HIGH] [-l LOW] [--spy] [--no_bench] [--no_short] [--export {csv,json,xlsx}] [-h] ``` -Strategy that buys when the stock is less than a threshold and shorts when it exceeds a threshold. +A long-short equity strategy that buys when the price is below a defined threshold and shorts when it exceeds an upper bound threshold. ``` optional arguments: @@ -17,6 +17,5 @@ optional arguments: Export dataframe data to csv,json,xlsx file (default: ) -h, --help show this help message (default: False) ``` - -![rsi](https://user-images.githubusercontent.com/25267873/116769576-19eec880-aa35-11eb-9e60-f77a31e51db0.png) -rsi2 +rsi +rsi2 diff --git a/website/content/stocks/comparison_analysis/add/_index.md b/website/content/stocks/comparison_analysis/add/_index.md index 2af8232253c..030bc4d0915 100755 --- a/website/content/stocks/comparison_analysis/add/_index.md +++ b/website/content/stocks/comparison_analysis/add/_index.md @@ -2,7 +2,7 @@ usage: add [-s L_SIMILAR] [-h] ``` -Add similar companies to compare with. +Add tickers to compare against the loaded stock. Add multiple tickers with a comma-separated list. ``` optional arguments: @@ -11,4 +11,4 @@ optional arguments: -h, --help show this help message (default: False) ``` -Captura de ecrã 2021-05-06, às 23 09 22 +Feature Screenshot - add diff --git a/website/content/stocks/comparison_analysis/balance/_index.md b/website/content/stocks/comparison_analysis/balance/_index.md index 2347ffb31dc..65147c87bf7 100755 --- a/website/content/stocks/comparison_analysis/balance/_index.md +++ b/website/content/stocks/comparison_analysis/balance/_index.md @@ -2,7 +2,7 @@ usage: balance [-s L_SIMILAR] [-a L_ALSO] [-t 31-Dec-2020/2017] [-q] ``` -Prints either yearly or quarterly balance statement the company, and compares it against similar companies. +Compares financial statement data of the selected companies. ``` optional arguments: @@ -13,5 +13,4 @@ optional arguments: Export dataframe data to csv,json,xlsx file (default: ) -h, --help show this help message (default: False) ``` - -Captura de ecrã 2021-03-20, às 09 10 53 + diff --git a/website/content/stocks/comparison_analysis/cashflow/_index.md b/website/content/stocks/comparison_analysis/cashflow/_index.md index 8a07cf37210..e17489c6cdb 100755 --- a/website/content/stocks/comparison_analysis/cashflow/_index.md +++ b/website/content/stocks/comparison_analysis/cashflow/_index.md @@ -2,7 +2,7 @@ usage: cashflow [-q] [-t S_TIMEFRAME] [--export {csv,json,xlsx}] [-h] ``` -Prints either yearly or quarterly cashflow statement the company, and compares it against similar companies. +Compares the cashflow statements of the selected companies. ``` optional arguments: @@ -13,5 +13,4 @@ optional arguments: Export dataframe data to csv,json,xlsx file (default: ) -h, --help show this help message (default: False) ``` - -Captura de ecrã 2021-03-20, às 09 12 59 +Feature Screenshot - cashflow diff --git a/website/content/stocks/comparison_analysis/financial/_index.md b/website/content/stocks/comparison_analysis/financial/_index.md index aa4b253c91b..44d903109cb 100755 --- a/website/content/stocks/comparison_analysis/financial/_index.md +++ b/website/content/stocks/comparison_analysis/financial/_index.md @@ -2,13 +2,12 @@ usage: financial [--export {csv,json,xlsx}] [-h] ``` -Prints screener data of similar companies. [Source: Finviz] +Shows stock data comparing the returns, margins, and prices of the added companies. Source: https://finviz.com ``` optional arguments: --export {csv,json,xlsx} Export dataframe data to csv,json,xlsx file (default: ) - -h, --help show this help message (default: False) + -h, --help show this help message (default: False) ``` - -financial +Feature Screenshot - financial diff --git a/website/content/stocks/comparison_analysis/getfinnhub/_index.md b/website/content/stocks/comparison_analysis/getfinnhub/_index.md index 44a1fe0e5ab..4866cfafeea 100755 --- a/website/content/stocks/comparison_analysis/getfinnhub/_index.md +++ b/website/content/stocks/comparison_analysis/getfinnhub/_index.md @@ -2,9 +2,10 @@ usage: getfinnhub [-h] ``` -Get similar companies from finnhubto compare with. +Automatically find and add similar companies with the Finnhub API. ``` optional arguments: -h, --help show this help message (default: False) ``` +Feature Screenshot - getfinnhub diff --git a/website/content/stocks/comparison_analysis/getfinviz/_index.md b/website/content/stocks/comparison_analysis/getfinviz/_index.md index b12603ae054..ad2f1b0510e 100755 --- a/website/content/stocks/comparison_analysis/getfinviz/_index.md +++ b/website/content/stocks/comparison_analysis/getfinviz/_index.md @@ -2,10 +2,12 @@ usage: getfinviz [--nocountry] [-h] ``` -Get similar companies from finviz to compare with. +Get similar companies to compare from [Finviz](https://finviz.com) ``` optional arguments: --nocountry Similar stocks from finviz using only Industry and Sector. (default: False) -h, --help show this help message (default: False) ``` +Feature Screenshot - getfinviz + diff --git a/website/content/stocks/comparison_analysis/getpoly/_index.md b/website/content/stocks/comparison_analysis/getpoly/_index.md index c76adb20925..627796c6b2b 100755 --- a/website/content/stocks/comparison_analysis/getpoly/_index.md +++ b/website/content/stocks/comparison_analysis/getpoly/_index.md @@ -2,9 +2,10 @@ usage: getpoly [-h] ``` -Get similar companies from polygon to compare with. +Use the Polygon API to automatically source and add similar companies. ``` optional arguments: -h, --help show this help message (default: False) ``` +Feature Screenshot - getpoly diff --git a/website/content/stocks/comparison_analysis/hcorr/_index.md b/website/content/stocks/comparison_analysis/hcorr/_index.md index dea62b3c7cc..f8c905d4aac 100755 --- a/website/content/stocks/comparison_analysis/hcorr/_index.md +++ b/website/content/stocks/comparison_analysis/hcorr/_index.md @@ -2,7 +2,7 @@ usage: corr [-t {o,h,l,c,a}] [-h] ``` -Correlation heatmap based on historical price comparison between similar companies. +A correlation heatmap for the selected tickers, using optional arguments described below. Scores range from +1 to -1 with 0 being completely neutral. ``` optional arguments: @@ -11,4 +11,4 @@ optional arguments: -h, --help show this help message (default: False) ``` -![corr](https://user-images.githubusercontent.com/25267873/110699596-efc41b80-81e6-11eb-924f-8739058aa54e.png) +Feature Screenshot - corr diff --git a/website/content/stocks/comparison_analysis/historical/_index.md b/website/content/stocks/comparison_analysis/historical/_index.md index 9a1d3d6341b..f69eba3ce52 100755 --- a/website/content/stocks/comparison_analysis/historical/_index.md +++ b/website/content/stocks/comparison_analysis/historical/_index.md @@ -2,7 +2,7 @@ usage: historical [-t {o,h,l,c,a}] [-s] [--export {csv,json,xlsx}] [-h] ``` -Historical price comparison between similar companies. +Historical price comparison between the added tickers. ``` optional arguments: @@ -14,4 +14,5 @@ optional arguments: -h, --help show this help message (default: False) ``` -![historical](https://user-images.githubusercontent.com/25267873/110699590-ef2b8500-81e6-11eb-95e3-144793a83a80.png) +Feature Screenshot - historical +Feature Screenshot - historical normalized diff --git a/website/content/stocks/comparison_analysis/income/_index.md b/website/content/stocks/comparison_analysis/income/_index.md index d99a1e52a91..95f90a3d57a 100755 --- a/website/content/stocks/comparison_analysis/income/_index.md +++ b/website/content/stocks/comparison_analysis/income/_index.md @@ -2,7 +2,7 @@ usage: income [-q] [-t S_TIMEFRAME] [--export {csv,json,xlsx}] [-h] ``` -Prints either yearly or quarterly income statement the company, and compares it against similar companies. +Compares detailed income statements from the chosen stocks. ``` optional arguments: @@ -13,5 +13,4 @@ optional arguments: Export dataframe data to csv,json,xlsx file (default: ) -h, --help show this help message (default: False) ``` - -Captura de ecrã 2021-03-20, às 09 10 02 +Feature Screenshot - income diff --git a/website/content/stocks/comparison_analysis/load/_index.md b/website/content/stocks/comparison_analysis/load/_index.md index 33e269a3296..058b36d6cf9 100755 --- a/website/content/stocks/comparison_analysis/load/_index.md +++ b/website/content/stocks/comparison_analysis/load/_index.md @@ -1,9 +1,7 @@ ```text usage: load [-t S_TICKER] [-s S_START_DATE] [-i {1,5,15,30,60}] [--source {yf,av,iex}] [-p] [-h] ``` - -Load stock ticker to perform analysis on. When the data source is 'yf', an Indian ticker can be loaded by using '.NS' at the end, e.g. 'SBIN.NS'. See -available market in https://help.yahoo.com/kb/exchanges-data-providers-yahoo-finance-sln2310.html. +Shortcut to the [load](https://gamestonkterminal.github.io/GamestonkTerminal/stocks/load/) feature. ``` optional arguments: diff --git a/website/content/stocks/comparison_analysis/overview/_index.md b/website/content/stocks/comparison_analysis/overview/_index.md index a070df1fa90..65afc7f52e0 100755 --- a/website/content/stocks/comparison_analysis/overview/_index.md +++ b/website/content/stocks/comparison_analysis/overview/_index.md @@ -2,7 +2,7 @@ usage: overview [--export {csv,json,xlsx}] [-h] ``` -Prints screener data of similar companies. [Source: Finviz] +Displays the broad overview for each company added. Source: https://finviz.com ``` optional arguments: @@ -10,5 +10,6 @@ optional arguments: Export dataframe data to csv,json,xlsx file (default: ) -h, --help show this help message (default: False) ``` +Feature Screenshot - overview + -overview diff --git a/website/content/stocks/comparison_analysis/ownership/_index.md b/website/content/stocks/comparison_analysis/ownership/_index.md index 8e40401c3f9..08afc510ea7 100755 --- a/website/content/stocks/comparison_analysis/ownership/_index.md +++ b/website/content/stocks/comparison_analysis/ownership/_index.md @@ -2,7 +2,7 @@ usage: ownership [--export {csv,json,xlsx}] [-h] ``` -Prints screener data of similar companies. [Source: Finviz] +Compare the outstanding shares, market cap, short interest and more. Source: https://finviz.com ``` optional arguments: @@ -10,5 +10,5 @@ optional arguments: Export dataframe data to csv,json,xlsx file (default: ) -h, --help show this help message (default: False) ``` +Feature Screenshot - ownership -ownership diff --git a/website/content/stocks/comparison_analysis/performance/_index.md b/website/content/stocks/comparison_analysis/performance/_index.md index 504e8499068..27bd44238a2 100755 --- a/website/content/stocks/comparison_analysis/performance/_index.md +++ b/website/content/stocks/comparison_analysis/performance/_index.md @@ -2,7 +2,7 @@ usage: performance [--export {csv,json,xlsx}] [-h] ``` -Prints screener data of similar companies. [Source: Finviz] +Compares the performance breakdown over time. Source: https://finviz.com ``` optional arguments: @@ -10,5 +10,5 @@ optional arguments: Export dataframe data to csv,json,xlsx file (default: ) -h, --help show this help message (default: False) ``` +Feature Screenshot - performance -performance diff --git a/website/content/stocks/comparison_analysis/select/_index.md b/website/content/stocks/comparison_analysis/select/_index.md index 30e00008b40..cb28ef89a2d 100755 --- a/website/content/stocks/comparison_analysis/select/_index.md +++ b/website/content/stocks/comparison_analysis/select/_index.md @@ -2,7 +2,7 @@ usage: select [-s L_SIMILAR] [-h] ``` -Select similar companies to compare with. +Clear the list of added companies and create a new one by entering comma-separated tickers. ``` optional arguments: @@ -10,3 +10,4 @@ optional arguments: similar companies to compare with. (default: []) -h, --help show this help message (default: False) ``` +Feature Screenshot - select diff --git a/website/content/stocks/comparison_analysis/sentiment/_index.md b/website/content/stocks/comparison_analysis/sentiment/_index.md index 97827e78fae..1b136f8dc75 100755 --- a/website/content/stocks/comparison_analysis/sentiment/_index.md +++ b/website/content/stocks/comparison_analysis/sentiment/_index.md @@ -2,7 +2,7 @@ usage: sentiment_compare [-r] [--export {csv,json,xlsx}] [-h] ``` -FinBrain's sentiment comparison across similar tickers. +FinBrain's sentiment comparison across the selected tickers over time. ``` optional arguments: @@ -11,5 +11,4 @@ optional arguments: Export dataframe data to csv,json,xlsx file (default: ) -h, --help show this help message (default: False) ``` - -Captura de ecrã 2021-03-20, às 15 57 06 +Feature Screenshot - sentiment diff --git a/website/content/stocks/comparison_analysis/technical/_index.md b/website/content/stocks/comparison_analysis/technical/_index.md index 0fd12e51b84..fdb686f199e 100755 --- a/website/content/stocks/comparison_analysis/technical/_index.md +++ b/website/content/stocks/comparison_analysis/technical/_index.md @@ -2,7 +2,7 @@ usage: technical [--export {csv,json,xlsx}] [-h] ``` -Prints screener data of similar companies. [Source: Finviz] +Compares technical stock price data for the added companies. Source: https://finviz.com ``` optional arguments: @@ -10,5 +10,6 @@ optional arguments: Export dataframe data to csv,json,xlsx file (default: ) -h, --help show this help message (default: False) ``` +Feature Screenshot - technical + -technical diff --git a/website/content/stocks/comparison_analysis/tsne/_index.md b/website/content/stocks/comparison_analysis/tsne/_index.md index ebb64179d1c..bd4d0fa5058 100755 --- a/website/content/stocks/comparison_analysis/tsne/_index.md +++ b/website/content/stocks/comparison_analysis/tsne/_index.md @@ -11,3 +11,4 @@ optional arguments: -p, --no_plot -h, --help show this help message (default: False) ``` +Feature Screenshot - tsne diff --git a/website/content/stocks/comparison_analysis/valuation/_index.md b/website/content/stocks/comparison_analysis/valuation/_index.md index cc3492c234f..b2309f2f45c 100755 --- a/website/content/stocks/comparison_analysis/valuation/_index.md +++ b/website/content/stocks/comparison_analysis/valuation/_index.md @@ -1,14 +1,13 @@ ```text usage: valuation [--export {csv,json,xlsx}] [-h] ``` - -Prints screener data of similar companies. [Source: Finviz] - +Shows the valuation comparisons between the chosen stocks. ``` optional arguments: --export {csv,json,xlsx} Export dataframe data to csv,json,xlsx file (default: ) -h, --help show this help message (default: False) ``` +Feature Screenshot - valuation + -valuation diff --git a/website/content/stocks/comparison_analysis/volume/_index.md b/website/content/stocks/comparison_analysis/volume/_index.md index 2d0bccf6c5e..af5c5b17bc8 100755 --- a/website/content/stocks/comparison_analysis/volume/_index.md +++ b/website/content/stocks/comparison_analysis/volume/_index.md @@ -2,7 +2,7 @@ usage: volume [-s] [--export {csv,json,xlsx}] [-h] ``` -Historical volume comparison between similar companies. +Charts historical volume of the added tickers. ``` optional arguments: @@ -11,5 +11,4 @@ optional arguments: Export dataframe data to csv,json,xlsx file (default: ) -h, --help show this help message (default: False) ``` - -Captura de ecrã 2021-03-20, às 09 10 53 +Feature Screenshot - volume diff --git a/website/content/stocks/dark_pool_shorts/volexch/_index.md b/website/content/stocks/dark_pool_shorts/volexch/_index.md index 795b7a2e4b6..65b83659e04 100644 --- a/website/content/stocks/dark_pool_shorts/volexch/_index.md +++ b/website/content/stocks/dark_pool_shorts/volexch/_index.md @@ -4,7 +4,7 @@ usage: volexch [--raw] [-s {,NetShort,Date,TotalVolume,PctShort}] [-a] [-m] [-h] Displays short volume based on exchange. -This data is pulled from https://ftp.nyse.com/ShortData/ daily. When updating data, this command may not not be available. +This data is pulled from the NYSE daily. When updating data, this command may not not be available. ``` optional arguments: @@ -17,3 +17,5 @@ optional arguments: --export {png,jpg,pdf,svg} Export or figure into png, jpg, pdf, svg ``` +Feature Screenshot - volexch +