diff --git a/website/content/stocks/candle/_index.md b/website/content/stocks/candle/_index.md index cf117821c08..318152afcc2 100755 --- a/website/content/stocks/candle/_index.md +++ b/website/content/stocks/candle/_index.md @@ -2,7 +2,7 @@ usage: candle [-s S_START] [--plotly] [-h] [--raw] [-e {csv, json, xlsx}] -s SORT] [-d] ``` -Displays candle chart of loaded ticker, or shows raw data with --raw +Displays candle chart of loaded ticker, or shows raw data with --raw (Test change) ``` optional arguments: @@ -14,6 +14,6 @@ optional arguments: -s, --sort Which column to sort the information by -d, --descending Show the information in descending order -h, --help show this help message (default: False) -``` +``` ![nio](https://user-images.githubusercontent.com/25267873/111053397-4d609e00-845b-11eb-9c94-89b8892a8e81.png) diff --git a/website/content/stocks/dark_pool_shorts/dpotc/_index.md b/website/content/stocks/dark_pool_shorts/dpotc/_index.md index ccebf1732de..30dec04dc4b 100755 --- a/website/content/stocks/dark_pool_shorts/dpotc/_index.md +++ b/website/content/stocks/dark_pool_shorts/dpotc/_index.md @@ -2,7 +2,15 @@ usage: dpotc [--export {csv,json,xlsx}] [-h] ``` -Display barchart of dark pool (ATS) and OTC (Non ATS) data. [Source: FINRA] +Dark Pool traffic is considered to be all orders executed off-exchange and does not fall under the direct oversight of the SEC, ceding disciplinary actions to the discretion of an industry self-regulating organization, FINRA. The ability to circumvent reporting obligations to the SEC is a major motivating factor in the use of Dark Pools. Discount Brokers typically execute orders through internalizers which are routed through OTC channels, avoiding execution on a public exchange entirely. + +While much of the OTC volume here can be classified as retail purchases through discount brokers, it is important to recognize that OTC transactions frequently happen in the form of block trades and exotic options/derivatives products, and many companies listed on the NASDAQ/NYSE also have dual listings on the OTCX market. + +Alternative Trading Systems (ATS) are off-exchange venues operated by firms with proprietary trading desks. This data is reported weekly and includes individual tickers, the weekly share volume, and the weekly number of total trades. The major advantage a broker/dealer/HF/HFT has over an individual investor is the direct access to live data feeds from the unlit order books held off-exchange. + +The data released to the public as "transparency" is strategically delayed and does not offer direct accountability for the positions held by individual firms. The many loopholes that exist in reporting obligations create an environment favourable to malicious actors and predatory short sellers. The quality of reported data for public consumption may improve in the near future, however, pushback from proprietary trading firms is likely to delay or degrade any progressions towards fair and transparent markets. + +Use the command 'dpotc' to display a barchart comparing dark pool (ATS) and OTC (Non ATS) volume. The raw data sets are available through the '--export' argument. Source: https://otctransparency.finra.org/otctransparency/ ``` optional arguments: @@ -10,3 +18,5 @@ optional arguments: Export dataframe data to csv,json,xlsx file (default: ) -h, --help show this help message (default: False) ``` +Feature Screenshot - dpotc Graph +Feature Screenshot - dpotc export diff --git a/website/content/stocks/dark_pool_shorts/ftd/_index.md b/website/content/stocks/dark_pool_shorts/ftd/_index.md index 5d010eb7c0b..0501932a94c 100755 --- a/website/content/stocks/dark_pool_shorts/ftd/_index.md +++ b/website/content/stocks/dark_pool_shorts/ftd/_index.md @@ -1,8 +1,10 @@ ``` usage: ftd [-s START] [-e END] [-n N_NUM] [--raw] [--export {csv,json,xlsx}] [-h] ``` +Display Fails to Deliver statistics for the [loaded ticker](https://gamestonkterminal.github.io/GamestonkTerminal/stocks/load/). Source: https://www.sec.gov/data/foiadocsfailsdatahtm -Prints latest fails-to-deliver data. [Source: SEC] +For an in-depth look at the complex iregularities of the securities settlement process, review this PDF: +[Naked Short Sales and Fails to Deliver: An Overview of Clearing and Settlement Procedures for Stock Trades in the US](https://github.com/deeleeramone/GamestonkTerminal/files/7489219/Naked.Short.Sales.and.Fails.to.Deliver.pdf) ``` optional arguments: @@ -16,3 +18,7 @@ optional arguments: Export dataframe data to csv,json,xlsx file -h, --help show this help message ``` +Feature Screenshot - FTD + +Feature Screenshot - ftd raw + diff --git a/website/content/stocks/dark_pool_shorts/hsi/_index.md b/website/content/stocks/dark_pool_shorts/hsi/_index.md index c1fe25df1fd..6a3402508b9 100755 --- a/website/content/stocks/dark_pool_shorts/hsi/_index.md +++ b/website/content/stocks/dark_pool_shorts/hsi/_index.md @@ -2,7 +2,7 @@ usage: hsi [-n N_NUM] [--export {csv,json,xlsx}] [-h] ``` -Print top stocks being more heavily shorted. HighShortInterest.com provides a convenient sorted database of stocks which have a short interest of over 20 percent. Additional key data such as the float, number of outstanding shares, and company industry is displayed. Data is presented for the Nasdaq Stock Market, the New York Stock Exchange, and the American Stock Exchange. [Source: www.highshortinterest.com] +Browse a sorted database of stocks which have a short interest of over 20 percent. Additional key data such as the float, number of outstanding shares, and company industry is displayed. Data is presented for the Nasdaq Stock Market, the New York Stock Exchange, and the American Stock Exchange. Source: https://www.highshortinterest.com ``` optional arguments: diff --git a/website/content/stocks/dark_pool_shorts/pos/_index.md b/website/content/stocks/dark_pool_shorts/pos/_index.md index a871e523135..84c1e3e9285 100755 --- a/website/content/stocks/dark_pool_shorts/pos/_index.md +++ b/website/content/stocks/dark_pool_shorts/pos/_index.md @@ -2,7 +2,13 @@ usage: pos [-n NUM] [-s {sv,sv_pct,nsv,nsv_dollar,dpp,dpp_dollar}] [-a] [--export {csv,json,xlsx}] [-h] ``` -Get dark pool short positions. [Source: Stockgrid] +Request a list of up to 200 (either positive or negative using the -a argument) Dark Pool Positions using the optional arguments to the feature command as described below. Source: https://www.stockgrid.io/darkpools + +Volume and short sale data for tickers trading on US-regulated public markets is updated daily on the [FINRA website](https://www.finra.org/finra-data/browse-catalog/short-sale-volume-data/daily-short-sale-volume-files) at approximately 6PM EST. + +A 'position' is the result of the net aggregagte short sale volume over a rolling twenty day period. The available daily data sets currently go back as far as 2020. For an explanation on reading this data, consult the white paper from SqueezeMetrics linked below. + +https://squeezemetrics.com/monitor/download/pdf/short_is_long.pdf? ``` optional arguments: @@ -15,3 +21,5 @@ optional arguments: Export dataframe data to csv,json,xlsx file (default: ) -h, --help show this help message (default: False) ``` +Feature Screenshot - pos positive +Feature Screenshot - pos negative diff --git a/website/content/stocks/dark_pool_shorts/prom/_index.md b/website/content/stocks/dark_pool_shorts/prom/_index.md index 5d04de4550a..a2268d6b67e 100755 --- a/website/content/stocks/dark_pool_shorts/prom/_index.md +++ b/website/content/stocks/dark_pool_shorts/prom/_index.md @@ -2,8 +2,7 @@ usage: prom [-n N_NUM] [-t N_TOP] [--tier {T1,T2,OTCE}] [--export {csv,json,xlsx}] [-h] ``` -Display dark pool (ATS) data of tickers with growing trades activity - +Display and filter dark pool (ATS) data of tickers with growing trades activity outside of the NYSE/NASDAQ/AMEX/CBOE/ICE systems. Source: http://finra-markets.morningstar.com/MarketData/EquityOptions/default.jsp ``` optional arguments: -n N_NUM, --num N_NUM @@ -15,3 +14,4 @@ optional arguments: Export dataframe data to csv,json,xlsx file (default: ) -h, --help show this help message (default: False) ``` +Feature Screenshot - prom diff --git a/website/content/stocks/dark_pool_shorts/psi/_index.md b/website/content/stocks/dark_pool_shorts/psi/_index.md index 3927a1de87b..2d630ab736c 100755 --- a/website/content/stocks/dark_pool_shorts/psi/_index.md +++ b/website/content/stocks/dark_pool_shorts/psi/_index.md @@ -2,7 +2,7 @@ usage: psi [--source {quandl,stockgrid}] [--nyse] [-n NUM] [-r] [--export {csv,json,xlsx}] [-h] ``` -Shows price vs short interest volume. [Source: Quandl/Stockgrid] +Shows a graph of price vs short interest volume over a variable number of days, selectable from two sources: [StockGrid](https://Stockgrid.io) and [Quandl API](https://data.nasdaq.com/publishers/qdl). Print the raw data using the '-r' argument for closer scrutiny of the data. Data is updated daily after market close. ``` optional arguments: @@ -15,3 +15,8 @@ optional arguments: Export dataframe data to csv,json,xlsx file -h, --help show this help message ``` +Feature Screenshot - psi stockgrid +Feature Screenshot - psi quandl nasdaq +Feature Screenshot - quandl nyse + +Feature Screenshot - psi raw diff --git a/website/content/stocks/dark_pool_shorts/shorted/_index.md b/website/content/stocks/dark_pool_shorts/shorted/_index.md index f3a96be001c..f4b20f8df9c 100755 --- a/website/content/stocks/dark_pool_shorts/shorted/_index.md +++ b/website/content/stocks/dark_pool_shorts/shorted/_index.md @@ -2,7 +2,7 @@ usage: shorted [-n NUM] [--export {csv,json,xlsx}] [-h] ``` -Print up to 25 top ticker most shorted. [Source: Yahoo Finance] +Request a list of up to 25 stocks that have accumulated the most short interest. Source: https://finance.yahoo.com/screener/predefined/most_shorted_stocks/ ``` optional arguments: @@ -11,3 +11,4 @@ optional arguments: Export dataframe data to csv,json,xlsx file (default: ) -h, --help show this help message (default: False) ``` +Feature Screenshot - shorted diff --git a/website/content/stocks/dark_pool_shorts/sidtc/_index.md b/website/content/stocks/dark_pool_shorts/sidtc/_index.md index 1bb4942a736..4b201f91659 100755 --- a/website/content/stocks/dark_pool_shorts/sidtc/_index.md +++ b/website/content/stocks/dark_pool_shorts/sidtc/_index.md @@ -2,7 +2,9 @@ usage: sidtc [-n NUM] [-s {float,dtc,si}] [--export {csv,json,xlsx}] [-h] ``` -Print short interest and days to cover. [Source: Stockgrid] +Request a list of shorted stocks, sorted by the optional arguments described below. Source: https://www.stockgrid.io/shortinterest + +Note: This data is delayed as per the short interest reporting schedule dictated by FINRA. https://www.nasdaqtrader.com/trader.aspx?id=shortintpubsch ``` optional arguments: @@ -13,3 +15,4 @@ optional arguments: Export dataframe data to csv,json,xlsx file (default: ) -h, --help show this help message (default: False) ``` +Feature Screenshot - sidtc diff --git a/website/content/stocks/dark_pool_shorts/spos/_index.md b/website/content/stocks/dark_pool_shorts/spos/_index.md index f0de38dec0e..4277718e27a 100755 --- a/website/content/stocks/dark_pool_shorts/spos/_index.md +++ b/website/content/stocks/dark_pool_shorts/spos/_index.md @@ -2,7 +2,7 @@ usage: spos [-n NUM] [-r] [--export {csv,json,xlsx}] [-h] ``` -Shows Net Short Vol. vs Position. [Source: Stockgrid] +Displays a charty of Net Short Vol. vs Position over a selectable number of days. Print the raw data for closer scrutiny. Source: https://www.stockgrid.io/darkpools ``` optional arguments: @@ -12,3 +12,5 @@ optional arguments: Export dataframe data to csv,json,xlsx file -h, --help show this help message ``` +Feature Screenshot - spos +Feature Screeshot - spos raw diff --git a/website/content/stocks/discovery/_index.md b/website/content/stocks/discovery/_index.md index 093e02e215d..f3e8ce43f7c 100755 --- a/website/content/stocks/discovery/_index.md +++ b/website/content/stocks/discovery/_index.md @@ -1,5 +1,2 @@ ---- -geekdocCollapseSection: true ---- - -{{< toc-tree >}} +Use the 'disc' command to navigate to the Discovery Submenu +Feature Screenshot - Disc diff --git a/website/content/stocks/discovery/active/_index.md b/website/content/stocks/discovery/active/_index.md index 92abb0753b5..af60e01c390 100755 --- a/website/content/stocks/discovery/active/_index.md +++ b/website/content/stocks/discovery/active/_index.md @@ -2,7 +2,7 @@ usage: active [-n NUM] [--export {csv,json,xlsx}] [-h] ``` -Print up to 25 top most actively traded intraday tickers. [Source: Yahoo Finance] +Print up to 25 top most actively traded intraday tickers. [Source: Yahoo Finance](https://finance.yahoo.com/most-active/?count=25&offset=0) ``` optional arguments: @@ -11,3 +11,4 @@ optional arguments: Export dataframe data to csv,json,xlsx file (default: ) -h, --help show this help message (default: False) ``` +Feature Screenshot - Disc-Active diff --git a/website/content/stocks/discovery/arkord/_index.md b/website/content/stocks/discovery/arkord/_index.md index 8cf8c9d335b..36d700f102d 100755 --- a/website/content/stocks/discovery/arkord/_index.md +++ b/website/content/stocks/discovery/arkord/_index.md @@ -2,7 +2,7 @@ usage: arkord [-n N_NUM] [--export {csv,json,xlsx}] [-h] ``` -Orders by ARK Investment Management LLC - https://ark-funds.com/. [Source: https://cathiesark.com] +Track the orders by ARK Investment Management LLC with an exportable table - https://cathiesark.com/ark-funds-combined/complete-holdings ``` optional arguments: @@ -12,5 +12,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-10, às 21 36 38 +Feature Screenshot - Arkord diff --git a/website/content/stocks/discovery/asc/_index.md b/website/content/stocks/discovery/asc/_index.md index 98613f93b91..6d838bdaf69 100755 --- a/website/content/stocks/discovery/asc/_index.md +++ b/website/content/stocks/discovery/asc/_index.md @@ -2,7 +2,7 @@ usage: asc [-n NUM] [--export {csv,json,xlsx}] [-h] ``` -Print up to 25 small cap stocks with earnings growth rates better than 25%. [Source: Yahoo Finance] +Print up to 25 small cap stocks with earnings growth rates better than 25%. Source: [Yahoo Finance](https://finance.yahoo.com/screener/predefined/aggressive_small_caps) ``` optional arguments: @@ -11,3 +11,4 @@ optional arguments: Export dataframe data to csv,json,xlsx file (default: ) -h, --help show this help message (default: False) ``` +Feature Screenshot - asc diff --git a/website/content/stocks/discovery/fds/_index.md b/website/content/stocks/discovery/fds/_index.md index af474dc77fd..3440973a395 100644 --- a/website/content/stocks/discovery/fds/_index.md +++ b/website/content/stocks/discovery/fds/_index.md @@ -7,6 +7,8 @@ usage: fds [-c --country COUNTRY [COUNTRY ...]] [-s --sector SECTOR [SECTOR ...] Display a selection of Equities based on country, sector, industry, name and/or description filtered by market cap. If no arguments are given, return the equities with the highest market cap. +Source: https://github.com/JerBouma/FinanceDatabase + * -c --country: Specify the Equities selection based on a country * -s --sector: Specify the Equities selection based on a sector * -i --industry: Specify the Equities selection based on an industry @@ -15,3 +17,4 @@ If no arguments are given, return the equities with the highest market cap. * -ie --include_exchanges: If used, you also obtain Equities from different exchanges (a lot of data) * -a --amount: Enter the number of Equities you wish to see in the Tabulate window * -o --options: Obtain the available options for country, sector and industry +Feature Screeshot - fds diff --git a/website/content/stocks/discovery/fipo/_index.md b/website/content/stocks/discovery/fipo/_index.md index 61127208247..09b596a6ae6 100755 --- a/website/content/stocks/discovery/fipo/_index.md +++ b/website/content/stocks/discovery/fipo/_index.md @@ -2,7 +2,7 @@ usage: fipo [-n NUM] [--export {csv,json,xlsx}] [-h] ``` -Future IPOs dates. [Source: https://finnhub.io] +Scan future IPOs by date. Source: https://finnhub.io ``` 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-05-03, às 12 54 44 +Feature Screenshot - fipo diff --git a/website/content/stocks/discovery/ford/_index.md b/website/content/stocks/discovery/ford/_index.md index 92ef53fc567..e8af2dc375e 100755 --- a/website/content/stocks/discovery/ford/_index.md +++ b/website/content/stocks/discovery/ford/_index.md @@ -3,7 +3,7 @@ usage: ford [-n N_NUM] [--export {csv,json,xlsx}] [-h] ``` Orders by Fidelity customers. Information shown in the table below is based on the volume of orders entered on the "as of" date shown. Securities -identified are not recommended or endorsed by Fidelity and are displayed for informational purposes only. [Source: Fidelity] +identified are not recommended or endorsed by Fidelity and are displayed for informational purposes only. Source: https://eresearch.fidelity.com/eresearch/gotoBL/fidelityTopOrders.jhtml ``` optional arguments: @@ -13,5 +13,5 @@ optional arguments: Export dataframe data to csv,json,xlsx file (default: ) -h, --help show this help message (default: False) ``` +Feature Screenshot - ford -Captura de ecrã 2021-02-20, às 11 45 43 diff --git a/website/content/stocks/discovery/gainers/_index.md b/website/content/stocks/discovery/gainers/_index.md index 4b00764e0f6..73683fb4676 100755 --- a/website/content/stocks/discovery/gainers/_index.md +++ b/website/content/stocks/discovery/gainers/_index.md @@ -2,7 +2,7 @@ usage: gainers [-n NUM] [--export {csv,json,xlsx}] [-h] ``` -Print up to 25 top gainers. [Source: Yahoo Finance] +Top Stock Gainers from Yfinance. Source: https://finance.yahoo.com/gainers/?offset=0&count=100 ``` optional arguments: @@ -12,4 +12,4 @@ optional arguments: -h, --help show this help message (default: False) ``` -Captura de ecrã 2021-02-20, às 11 46 09 +Feature Screenshot - gainers diff --git a/website/content/stocks/discovery/gtech/_index.md b/website/content/stocks/discovery/gtech/_index.md index e85b42435af..caaaac2164f 100755 --- a/website/content/stocks/discovery/gtech/_index.md +++ b/website/content/stocks/discovery/gtech/_index.md @@ -2,7 +2,7 @@ usage: gtech [-n NUM] [--export {csv,json,xlsx}] [-h] ``` -Print up to 25 top tech stocks with revenue and earnings growth in excess of 25%. [Source: Yahoo Finance] +Print up to 25 top tech stocks with revenue and earnings growth in excess of 25%. Source: https://finance.yahoo.com/screener/predefined/growth_technology_stocks/ ``` optional arguments: @@ -11,3 +11,5 @@ optional arguments: Export dataframe data to csv,json,xlsx file (default: ) -h, --help show this help message (default: False) ``` + +Feature Screeshot - gtech diff --git a/website/content/stocks/discovery/hotpenny/_index.md b/website/content/stocks/discovery/hotpenny/_index.md index af9a30eaf98..9c239ece126 100755 --- a/website/content/stocks/discovery/hotpenny/_index.md +++ b/website/content/stocks/discovery/hotpenny/_index.md @@ -1,12 +1,9 @@ ``` usage: hotpenny [-n N_NUM] [--export {csv,json,xlsx}] [-h] ``` +Requests a list of the most active and trending OTC 'Penny Stocks', sorted by number of trades. Source: https://pennystockflow.com -This site provides a list of todays most active and hottest penny stocks. While not for everyone, penny stocks can be exciting and rewarding investments -in many ways. With penny stocks, you can get more bang for the buck. You can turn a few hundred dollars into thousands, just by getting in on the right -penny stock at the right time. Penny stocks are increasing in popularity. More and more investors of all age groups and skill levels are getting -involved, and the dollar amounts they are putting into these speculative investments are representing a bigger portion of their portfolios. [Source: -www.pennystockflow.com] +While some individuals swear by Penny Stocks, this is generally a field for the less scrupulous investor looking for big payouts. The risk/reward ratio here is high. ``` optional arguments: @@ -16,3 +13,4 @@ optional arguments: Export dataframe data to csv,json,xlsx file (default: ) -h, --help show this help message (default: False) ``` +Feature Screenshot - hotpenny diff --git a/website/content/stocks/discovery/losers/_index.md b/website/content/stocks/discovery/losers/_index.md index d4888e924e0..f1fe25dc4db 100755 --- a/website/content/stocks/discovery/losers/_index.md +++ b/website/content/stocks/discovery/losers/_index.md @@ -2,7 +2,7 @@ usage: losers [-n NUM] [--export {csv,json,xlsx}] [-h] ``` -Print up to 25 top losers. [Source: Yahoo Finance] +Calls a list of the biggest losers for the day in US markets. Source: https://finance.yahoo.com/losers/ ``` optional arguments: @@ -11,5 +11,5 @@ optional arguments: Export dataframe data to csv,json,xlsx file (default: ) -h, --help show this help message (default: False) ``` +Feature Screenshot - losers -Captura de ecrã 2021-03-14, às 20 23 21 diff --git a/website/content/stocks/discovery/lowfloat/_index.md b/website/content/stocks/discovery/lowfloat/_index.md index 4634a88e468..711c9341476 100755 --- a/website/content/stocks/discovery/lowfloat/_index.md +++ b/website/content/stocks/discovery/lowfloat/_index.md @@ -2,10 +2,7 @@ usage: lowfloat [-n N_NUM] [--export {csv,json,xlsx}] [-h] ``` -Print top stocks with lowest float. LowFloat.com provides a convenient sorted database of stocks which have a float of under 10 million shares. -Additional key data such as the number of outstanding shares, short interest, and company industry is displayed. Data is presented for the Nasdaq Stock -Market, the New York Stock Exchange, the American Stock Exchange, and the Over the Counter Bulletin Board. [Source: www.lowfloat.com] - +Request a list of stocks with floats under ten million shares, covering: NASDAQ, NYSE, AMEX, and OTC markets. Companies with low floats are easier targets for price manipulation; it takes fewer millions to move the needle. Many of these companies also accrue high levels of short interest. Source: (https://lowfloat.com) ``` optional arguments: -n N_NUM, --num N_NUM @@ -14,3 +11,4 @@ optional arguments: Export dataframe data to csv,json,xlsx file (default: ) -h, --help show this help message (default: False) ``` +Feature Screeshot - lowfloat diff --git a/website/content/stocks/discovery/pipo/_index.md b/website/content/stocks/discovery/pipo/_index.md index dc94e5235e2..239f466ea7a 100755 --- a/website/content/stocks/discovery/pipo/_index.md +++ b/website/content/stocks/discovery/pipo/_index.md @@ -2,7 +2,7 @@ usage: pipo [-n NUM] [--export {csv,json,xlsx}] [-h] ``` -Past IPOs dates. [Source: https://finnhub.io] +Browse IPOs from recent history, use the '-n' argument in the command string to include the number of previous days. Source: https://finnhub.io ``` optional arguments: @@ -11,3 +11,4 @@ optional arguments: Export dataframe data to csv,json,xlsx file (default: ) -h, --help show this help message (default: False) ``` +Feature Screenshot - pipo diff --git a/website/content/stocks/discovery/trending/_index.md b/website/content/stocks/discovery/trending/_index.md index 7de48ebe192..6b3ef4e775f 100755 --- a/website/content/stocks/discovery/trending/_index.md +++ b/website/content/stocks/discovery/trending/_index.md @@ -2,7 +2,7 @@ usage: trending [-i N_ID] [-n N_NUM] [-d S_DATE] [--export {csv,json,xlsx}] [-h] ``` -Trending news articles. [Source: Seeking Alpha] +Trending news articles from [Seeking Alpha](https://seekingalpha.com/market-news/trending) ``` optional arguments: @@ -16,4 +16,4 @@ optional arguments: -h, --help show this help message (default: False) ``` -trending +Feature Screenshot - Trending diff --git a/website/content/stocks/discovery/ulc/_index.md b/website/content/stocks/discovery/ulc/_index.md index 5e4cbfc0ae8..31e17e4a4ee 100755 --- a/website/content/stocks/discovery/ulc/_index.md +++ b/website/content/stocks/discovery/ulc/_index.md @@ -2,7 +2,7 @@ usage: ulc [-n NUM] [--export {csv,json,xlsx}] [-h] ``` -Print up to 25 potentially undervalued large cap stocks. [Source: Yahoo Finance] +Print up to 25 potentially undervalued large cap stocks. Source: https://finance.yahoo.com/screener/predefined/undervalued_large_caps/ ``` optional arguments: @@ -11,3 +11,4 @@ optional arguments: Export dataframe data to csv,json,xlsx file (default: ) -h, --help show this help message (default: False) ``` +Feature Screenshot - ulc diff --git a/website/content/stocks/discovery/upcoming/_index.md b/website/content/stocks/discovery/upcoming/_index.md index e3dba4c2c69..a2b6f4ff364 100755 --- a/website/content/stocks/discovery/upcoming/_index.md +++ b/website/content/stocks/discovery/upcoming/_index.md @@ -2,7 +2,7 @@ usage: upcoming [-p N_PAGES] [-n N_NUM] [--export {csv,json,xlsx}] [-h] ``` -Upcoming earnings release dates. [Source: Seeking Alpha] +Upcoming earnings release dates. Source: https://seekingalpha.com/earnings/earnings-calendar ``` optional arguments: @@ -14,3 +14,4 @@ optional arguments: Export dataframe data to csv,json,xlsx file (default: ) -h, --help show this help message (default: False) ``` +Feature Screenshot - upcoming diff --git a/website/content/stocks/insider/act/_index.md b/website/content/stocks/insider/act/_index.md index 5a20695f737..10aeddc3475 100755 --- a/website/content/stocks/insider/act/_index.md +++ b/website/content/stocks/insider/act/_index.md @@ -2,8 +2,7 @@ usage: act [-n N_NUM] [--raw] [--export {csv,json,xlsx}] [-h] ``` -Prints insider activity over time [Source: Business Insider] - +Prints executive, or director, dispositions or acquisitions over time using information collected by: [Business Insider](https://markets.businessinsider.com/stocks) ``` optional arguments: -n N_NUM, --num N_NUM @@ -13,3 +12,5 @@ optional arguments: Export dataframe data to csv,json,xlsx file -h, --help show this help message ``` +Feature Screenshot - act graph +Feature Screenshot - act raw diff --git a/website/content/stocks/insider/blcp/_index.md b/website/content/stocks/insider/blcp/_index.md index 360a1d919dd..139cff83b64 100755 --- a/website/content/stocks/insider/blcp/_index.md +++ b/website/content/stocks/insider/blcp/_index.md @@ -2,7 +2,7 @@ usage: blcp [-n NUM] [-h] ``` -Print big latest CEO/CFO purchases ($25k+) [Source: OpenInsider] +Search a SEC Form 4 database for the latest excutive and director dispositions or acquisitions and the corporations they are associated with. Sourece: http://openinsider.com ``` optional arguments: @@ -10,4 +10,5 @@ optional arguments: -h, --help show this help message (default: False) ``` -blcp + +Feature Screenshot - ins blcp diff --git a/website/content/stocks/insider/blcs/_index.md b/website/content/stocks/insider/blcs/_index.md index 48e4a12a178..c237e4abe16 100755 --- a/website/content/stocks/insider/blcs/_index.md +++ b/website/content/stocks/insider/blcs/_index.md @@ -2,7 +2,7 @@ usage: blcs [-n NUM] [-h] ``` -Print big latest CEO/CFO sales ($100k+) [Source: OpenInsider] +Print big latest CEO/CFO sales ($100k+) Source: http://openinsider.com ``` optional arguments: @@ -10,4 +10,4 @@ optional arguments: -h, --help show this help message (default: False) ``` -blcs +blcs diff --git a/website/content/stocks/insider/blip/_index.md b/website/content/stocks/insider/blip/_index.md index 7828ffc9f80..8ffaaa608f0 100755 --- a/website/content/stocks/insider/blip/_index.md +++ b/website/content/stocks/insider/blip/_index.md @@ -2,7 +2,7 @@ usage: blip [-n NUM] [-h] ``` -Print big latest insider purchases ($25k+) [Source: OpenInsider] +Print big latest insider purchases ($25k+) Source: http://openinsider.com ``` optional arguments: @@ -10,4 +10,4 @@ optional arguments: -h, --help show this help message (default: False) ``` -blip +blip diff --git a/website/content/stocks/insider/blis/_index.md b/website/content/stocks/insider/blis/_index.md index 001e9219edc..85fd8ae8c28 100755 --- a/website/content/stocks/insider/blis/_index.md +++ b/website/content/stocks/insider/blis/_index.md @@ -2,7 +2,7 @@ usage: blis [-n NUM] [-h] ``` -Print latest insider sales 100k [Source: OpenInsider] +Print latest insider sales 100k Source: http://openinsider.com ``` optional arguments: @@ -10,4 +10,4 @@ optional arguments: -h, --help show this help message (default: False) ``` -blis +blis diff --git a/website/content/stocks/insider/blop/_index.md b/website/content/stocks/insider/blop/_index.md index dc875b7365f..f76fa026bc3 100755 --- a/website/content/stocks/insider/blop/_index.md +++ b/website/content/stocks/insider/blop/_index.md @@ -2,7 +2,7 @@ usage: blop [-n NUM] [-h] ``` -Print big latest officer purchases ($25k+) [Source: OpenInsider] +Print big latest officer purchases ($25k+) Source: https://openinsider.com ``` optional arguments: @@ -10,4 +10,4 @@ optional arguments: -h, --help show this help message (default: False) ``` -blop +blop diff --git a/website/content/stocks/insider/blos/_index.md b/website/content/stocks/insider/blos/_index.md index 63c71488c6d..6da82ae90ab 100755 --- a/website/content/stocks/insider/blos/_index.md +++ b/website/content/stocks/insider/blos/_index.md @@ -2,7 +2,7 @@ usage: blos [-n NUM] [-h] ``` -Print big latest officer sales ($100k+) [Source: OpenInsider] +Print big latest officer sales ($100k+) Source: https://Openinsider.com ``` optional arguments: @@ -10,4 +10,4 @@ optional arguments: -h, --help show this help message (default: False) ``` -blos +blos diff --git a/website/content/stocks/insider/filter/_index.md b/website/content/stocks/insider/filter/_index.md index f82e061973e..aa3d549aac3 100755 --- a/website/content/stocks/insider/filter/_index.md +++ b/website/content/stocks/insider/filter/_index.md @@ -2,7 +2,7 @@ usage: filter [-n NUM] [-t TICKER] [-l] [-h] ``` -Print open insider filtered data using loaded preset, or selected ticker. [Source: OpenInsider] +Print open insider filtered data using loaded preset, or selected ticker. Source: http://openinsider.com ``` optional arguments: @@ -13,6 +13,11 @@ optional arguments: -h, --help show this help message (default: False) ``` -Captura de ecrã 2021-07-23, às 21 41 57 +Feature Screenshot - ins filter -Captura de ecrã 2021-07-23, às 21 42 18 +Feature Screenshot - ins view + + +Captura de ecrã 2021-07-23, às 21 41 57 + +Captura de ecrã 2021-07-23, às 21 42 18 diff --git a/website/content/stocks/insider/lcb/_index.md b/website/content/stocks/insider/lcb/_index.md index 32295bc2144..44ecbb893aa 100755 --- a/website/content/stocks/insider/lcb/_index.md +++ b/website/content/stocks/insider/lcb/_index.md @@ -2,7 +2,7 @@ usage: lcb [-n NUM] [-h] ``` -Print latest cluster buys [Source: OpenInsider] +Print latest cluster buys Source: https://Openinsider.com ``` optional arguments: @@ -10,4 +10,4 @@ optional arguments: -h, --help show this help message (default: False) ``` -lcb +lcb diff --git a/website/content/stocks/insider/lins/_index.md b/website/content/stocks/insider/lins/_index.md index 5cf3fcfb2b9..4db2d6baf1d 100755 --- a/website/content/stocks/insider/lins/_index.md +++ b/website/content/stocks/insider/lins/_index.md @@ -2,7 +2,7 @@ usage: lins [-n N_NUM] [--export {csv,json,xlsx}] [-h] ``` -Prints information about inside traders. The following fields are expected: Date, Relationship, Transaction, #Shares, Cost, Value ($), #Shares Total, Insider Trading, SEC Form 4. [Source: Finviz] +Prints information about insider acquisitions or dispositions with fields: Date, Relationship, Transaction, #Shares, Cost, Value ($), Total Shares, Insider Trader's Identity, SEC Form 4 Date. Source: https://finviz.com/insidertrading.ashx ``` optional arguments: @@ -12,3 +12,4 @@ optional arguments: Export dataframe data to csv,json,xlsx file -h, --help show this help message ``` +Feature Screenshot - ins lins diff --git a/website/content/stocks/insider/lip/_index.md b/website/content/stocks/insider/lip/_index.md index 5ace5a71386..9067865afb2 100755 --- a/website/content/stocks/insider/lip/_index.md +++ b/website/content/stocks/insider/lip/_index.md @@ -2,7 +2,7 @@ usage: lip [-n NUM] [-h] ``` -Print latest insider purchases [Source: OpenInsider] +Print the latest insider purchases recorded by the SEC. Source: http://Openinsider.com ``` optional arguments: @@ -10,4 +10,4 @@ optional arguments: -h, --help show this help message (default: False) ``` -lip +lip diff --git a/website/content/stocks/insider/lis/_index.md b/website/content/stocks/insider/lis/_index.md index 3143569dcc2..3b8067baf02 100755 --- a/website/content/stocks/insider/lis/_index.md +++ b/website/content/stocks/insider/lis/_index.md @@ -2,7 +2,7 @@ usage: lis [-n NUM] [-h] ``` -Print insider sales [Source: OpenInsider] +The latest insider dispositions across the corporate landscape in America. Source: http://openinsider.com ``` optional arguments: @@ -10,4 +10,4 @@ optional arguments: -h, --help show this help message (default: False) ``` -lis +lis diff --git a/website/content/stocks/insider/lit/_index.md b/website/content/stocks/insider/lit/_index.md index 4038e73ea7c..28324e0f672 100755 --- a/website/content/stocks/insider/lit/_index.md +++ b/website/content/stocks/insider/lit/_index.md @@ -2,7 +2,7 @@ usage: lit [-n NUM] [-h] ``` -Print latest insider trading (all filings) [Source: OpenInsider] +Print latest insider trading (all filings) Source: http://openinsider.com ``` optional arguments: @@ -10,4 +10,4 @@ optional arguments: -h, --help show this help message (default: False) ``` -lit +lit diff --git a/website/content/stocks/insider/load/_index.md b/website/content/stocks/insider/load/_index.md index 38b142e645d..12ebd07c0d3 100755 --- a/website/content/stocks/insider/load/_index.md +++ b/website/content/stocks/insider/load/_index.md @@ -2,8 +2,7 @@ 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. +See: [load](https://gamestonkterminal.github.io/GamestonkTerminal/stocks/load/) ``` optional arguments: diff --git a/website/content/stocks/insider/lpsb/_index.md b/website/content/stocks/insider/lpsb/_index.md index 24723beb71b..eb9bc403202 100755 --- a/website/content/stocks/insider/lpsb/_index.md +++ b/website/content/stocks/insider/lpsb/_index.md @@ -2,7 +2,7 @@ usage: lpsb [-n NUM] [-h] ``` -Print latest penny stock buys [Source: OpenInsider] +See the latest, penny stock, executive and director acquisitions. Source: http://openinsider.com ``` optional arguments: diff --git a/website/content/stocks/insider/set/_index.md b/website/content/stocks/insider/set/_index.md index 8c42ecc9fcf..374f2eac928 100755 --- a/website/content/stocks/insider/set/_index.md +++ b/website/content/stocks/insider/set/_index.md @@ -2,7 +2,7 @@ usage: set [-p {template,whales}] [-h] ``` -Set preset from under [presets folder](/gamestonk_terminal/insider/presets/). +Set the preset from the available list of user-generated presets. Use the template file, save as the desired name for the new preset in the same directory. ``` optional arguments: @@ -10,3 +10,5 @@ optional arguments: Filter presets -h, --help show this help message ``` +Feature Screenshot - ins filter +Feature Screenshot - ins view diff --git a/website/content/stocks/insider/tippm/_index.md b/website/content/stocks/insider/tippm/_index.md index fe8c0e79dcf..72718cbd1be 100755 --- a/website/content/stocks/insider/tippm/_index.md +++ b/website/content/stocks/insider/tippm/_index.md @@ -2,7 +2,7 @@ usage: tippm [-n NUM] [-h] ``` -Print top insider purchases past month [Source: OpenInsider] +Show the top insider acquisitions this month. Source: http://openinsider.com ``` optional arguments: @@ -10,4 +10,4 @@ optional arguments: -h, --help show this help message (default: False) ``` -tippm +tippm diff --git a/website/content/stocks/insider/tippw/_index.md b/website/content/stocks/insider/tippw/_index.md index 159329771b9..524b16b9ecd 100755 --- a/website/content/stocks/insider/tippw/_index.md +++ b/website/content/stocks/insider/tippw/_index.md @@ -2,7 +2,7 @@ usage: tippw [-n NUM] [-h] ``` -Print top insider purchases past week [Source: OpenInsider] +The top insider acquisitions this week. Source: http://openinsider.com ``` optional arguments: @@ -10,4 +10,4 @@ optional arguments: -h, --help show this help message (default: False) ``` -tippw +tippw diff --git a/website/content/stocks/insider/tipt/_index.md b/website/content/stocks/insider/tipt/_index.md index 1485adeb5a3..15de19f605e 100755 --- a/website/content/stocks/insider/tipt/_index.md +++ b/website/content/stocks/insider/tipt/_index.md @@ -2,7 +2,7 @@ usage: tipt [-n NUM] [-h] ``` -Print top insider purchases today [Source: OpenInsider] +The top insider acquisitions today. Source: http://openinsider.com ``` optional arguments: @@ -10,4 +10,4 @@ optional arguments: -h, --help show this help message (default: False) ``` -tipt +tipt diff --git a/website/content/stocks/insider/tispm/_index.md b/website/content/stocks/insider/tispm/_index.md index 87bd3b7d961..df5f7b634e1 100755 --- a/website/content/stocks/insider/tispm/_index.md +++ b/website/content/stocks/insider/tispm/_index.md @@ -2,7 +2,7 @@ usage: tispm [-n NUM] [-h] ``` -Print top insider sales past month [Source: OpenInsider] +Top insider dispositions this month. Source: http://openinsider.com ``` optional arguments: @@ -10,4 +10,4 @@ optional arguments: -h, --help show this help message (default: False) ``` -tispm +tispm diff --git a/website/content/stocks/insider/tispw/_index.md b/website/content/stocks/insider/tispw/_index.md index 5756ec9fe31..681e5b830c3 100755 --- a/website/content/stocks/insider/tispw/_index.md +++ b/website/content/stocks/insider/tispw/_index.md @@ -2,7 +2,7 @@ usage: tispw [-n NUM] [-h] ``` -Print top insider sales past week [Source: OpenInsider] +This week's top insider dispositions. Source: http://openinsider.com ``` optional arguments: @@ -10,4 +10,4 @@ optional arguments: -h, --help show this help message (default: False) ``` -tispw +tispw diff --git a/website/content/stocks/insider/tist/_index.md b/website/content/stocks/insider/tist/_index.md index dd8c1a85918..5776f43b0b3 100755 --- a/website/content/stocks/insider/tist/_index.md +++ b/website/content/stocks/insider/tist/_index.md @@ -2,7 +2,7 @@ usage: tist [-n NUM] [-h] ``` -Print top insider sales today [Source: OpenInsider] +Today's top insider dispositions. Source: http://openinsider.com ``` optional arguments: @@ -10,4 +10,4 @@ optional arguments: -h, --help show this help message (default: False) ``` -tist +tist diff --git a/website/content/stocks/insider/toppm/_index.md b/website/content/stocks/insider/toppm/_index.md index 26a5280ba1c..9aee4005887 100755 --- a/website/content/stocks/insider/toppm/_index.md +++ b/website/content/stocks/insider/toppm/_index.md @@ -2,7 +2,7 @@ usage: toppm [-n NUM] [-h] ``` -Print top officer purchases past month [Source: OpenInsider] +Top officer acquisitions this month Source: http://openinsider.com ``` optional arguments: @@ -10,4 +10,4 @@ optional arguments: -h, --help show this help message (default: False) ``` -toppm +toppm diff --git a/website/content/stocks/insider/toppw/_index.md b/website/content/stocks/insider/toppw/_index.md index 8df7d079af4..2a582a00e9c 100755 --- a/website/content/stocks/insider/toppw/_index.md +++ b/website/content/stocks/insider/toppw/_index.md @@ -2,7 +2,7 @@ usage: toppw [-n NUM] [-h] ``` -Print top officer purchases past week [Source: OpenInsider] +Corporate officers making acquisitions this week. Source: http://openinsider.com ``` optional arguments: @@ -10,4 +10,4 @@ optional arguments: -h, --help show this help message (default: False) ``` -toopw +toopw diff --git a/website/content/stocks/insider/topt/_index.md b/website/content/stocks/insider/topt/_index.md index 36756c5d344..fe77085456c 100755 --- a/website/content/stocks/insider/topt/_index.md +++ b/website/content/stocks/insider/topt/_index.md @@ -2,12 +2,11 @@ usage: topt [-n NUM] [-h] ``` -Print top officer purchases of the day [Source: OpenInsider] +Corporate officer acquisitions today. Source: http://openinsider.com ``` optional arguments: -n NUM, --num NUM Number of datarows to display (default: 20) -h, --help show this help message (default: False) ``` - -topt +Feature Screenshot - ins topt diff --git a/website/content/stocks/insider/view/_index.md b/website/content/stocks/insider/view/_index.md index cd95fc740ac..cbdceb5c13f 100755 --- a/website/content/stocks/insider/view/_index.md +++ b/website/content/stocks/insider/view/_index.md @@ -2,7 +2,7 @@ usage: view [-p {template,whales}] [-h] ``` -View available presets under [presets folder](/gamestonk_terminal/insider/presets/). +View the list of available presets and their selected filters. Source: http://openinsider.com ``` optional arguments: @@ -11,4 +11,4 @@ optional arguments: -h, --help show this help message ``` -Captura de ecrã 2021-07-23, às 21 38 46 +Captura de ecrã 2021-07-23, às 21 38 46 diff --git a/website/content/stocks/load/_index.md b/website/content/stocks/load/_index.md index 1713ebec912..566a7ecb674 100755 --- a/website/content/stocks/load/_index.md +++ b/website/content/stocks/load/_index.md @@ -1,9 +1,6 @@ ``` 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. - ``` optional arguments: -t S_TICKER, --ticker S_TICKER @@ -16,3 +13,20 @@ optional arguments: -p, --prepost Pre/After market hours. Only works for 'yf' source, and intraday data (default: False) -h, --help show this help message (default: False) ``` +Load a symbol to perform analysis using the string above as a template. Optional arguments and their descriptions are listed above. + +The default source is, yFinance (https://pypi.org/project/yfinance/). Alternatively, one may select either AlphaVantage (https://www.alphavantage.co/documentation/) or IEX Cloud (https://iexcloud.io/docs/api/) as the data source for the analysis. Please note that certain analytical features are exclusive to the source. + +To load a symbol from an exchange outside of the NYSE/NASDAQ default, use yFinance as the source and add the corresponding exchange to the end of the symbol. i.e. 'BNS.TO'. + +BNS is a dual-listed stock, there are separate options chains and order books for each listing. Opportunities for arbitrage may arise from momentary pricing discrepancies between listings with a dynamic exchange rate as a second order opportunity in ForEx spreads. + +Find the full list of supported exchanges here: https://help.yahoo.com/kb/exchanges-data-providers-yahoo-finance-sln2310.html + +Certain analytical features, such as VWAP, require the ticker to be loaded as intraday using the '-i x' argument. When encountering this error, simply reload the symbol using the interval argument. i.e. 'load -t BNS -s YYYY-MM-DD -i 1 -p' loads one-minute intervals, including Pre/After Market data, using the default source, yFinance. + +Certain features, such as the Prediction menu, require the symbol to be loaded as daily and not intraday. + +Feature Screenshot - Load + + diff --git a/website/content/stocks/news/_index.md b/website/content/stocks/news/_index.md index 8eee19690b2..2ff7fe50b04 100755 --- a/website/content/stocks/news/_index.md +++ b/website/content/stocks/news/_index.md @@ -1,8 +1,7 @@ ``` usage: news [-n N_NUM] [-d N_START_DATE] [-o] [-s N_SOURCES [N_SOURCES ...]] [-h] ``` - -Prints latest news about company, including date, title and web link. [Source: News API] +Using the [loaded ticker](https://gamestonkterminal.github.io/GamestonkTerminal/stocks/load/), the 'news' command will search articles and blogs with the [News API](https://newsapi.org) where the ticker symbol or company name are mentioned. Searches are limited to the past thirty days when using the free API key available. Searches may bring unwanted results when the ticker or business name contains words used as the Dictionary defines. Optional arguments can be added to the command string as described below. ``` optional arguments: @@ -15,3 +14,4 @@ optional arguments: Show news only from the sources specified (e.g bbc yahoo.com) -h, --help show this help message ``` +Feature Screenshot - News diff --git a/website/content/stocks/quote/_index.md b/website/content/stocks/quote/_index.md index d918dc7312f..1a9314dfd64 100755 --- a/website/content/stocks/quote/_index.md +++ b/website/content/stocks/quote/_index.md @@ -2,7 +2,7 @@ usage: quote [-t S_TICKER] [-h] ``` -Current quote for stock ticker +Retrieves a current quote from the currently [loaded ticker](https://gamestonkterminal.github.io/GamestonkTerminal/stocks/load/). To view a quote from a different symbol than what is currently loaded, add the '-t' argument to the command string. ``` optional arguments: @@ -11,4 +11,5 @@ optional arguments: -h, --help show this help message (default: False) ``` -Captura de ecrã 2021-08-06, às 21 31 12 + +Feature Screenshot - Quote