diff options
| author | andrewkenreich <andrew.kenreich@gmail.com> | 2022-11-29 09:50:04 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-29 09:50:04 -0500 |
| commit | 5b1d7d95c0f52860294e12ce81c00d7b890aefc2 (patch) | |
| tree | fd3942f77f5265b7e3c33cec5c04051c614d310f | |
| parent | 9e87d6e56cb29af35e5629faf2af9633295be228 (diff) | |
docs - links and order (#3649)
* docs - links and order
* few more on sdk side
17 files changed, 886 insertions, 820 deletions
diff --git a/website/content/sdk/guides/intros/econometrics.md b/website/content/sdk/guides/intros/econometrics.md index 2b4bf9eecc9..51b7554b45a 100644 --- a/website/content/sdk/guides/intros/econometrics.md +++ b/website/content/sdk/guides/intros/econometrics.md @@ -109,8 +109,7 @@ file_load = openbb.econometric.load("PATH_TO_FILE/FILE.xlsx") ### Working with Time Series data To demonstrate the usage of the Econometrics SDK for time series data, the -<a href="https://www.statsmodels.org/dev/datasets/generated/longley.html" target="_blank" rel="noreferrer noopener">longley</a> -dataset is loaded in. +<a href="https://www.statsmodels.org/dev/datasets/generated/longley.html" target="_blank" rel="noreferrer noopener">longley</a> dataset is loaded in. ```python # Load the data diff --git a/website/content/sdk/guides/intros/portfolio/po.md b/website/content/sdk/guides/intros/portfolio/po.md index 875496df27c..b4f65f0e81e 100644 --- a/website/content/sdk/guides/intros/portfolio/po.md +++ b/website/content/sdk/guides/intros/portfolio/po.md @@ -7,7 +7,7 @@ optimization techniques and provides a brief description of its sub-menus" --- The Portfolio Optimization menu allows the user to apply advanced optimization techniques to a portfolio of any type and of any size. It does so by introducing a multitude of optimization techniques ranging from <a href="https://www.investopedia.com/terms/m/meanvariance-analysis.asp" target="_blank" rel="noreferrer noopener">mean-variance optimization</a> to <a href="https://www.investopedia.com/terms/r/risk-parity.asp" target="_blank" rel="noreferrer noopener">risk parity models</a> and <a href="https://www.investopedia.com/terms/c/cluster_analysis.asp" target="_blank" rel="noreferrer noopener">hierarchical clustering models</a>. By providing Excel templates, the user can make sense of the vast array of parameters that each command has. E.g. think of the historic period you wish to use or which of the more than 10 risk measures and covariance methods should be used? These are questions the templates make easier to answer. -The capabilities of the [Portfolio Optiminzation menu](/terminal/guides/intros/portfolio/po) from the OpenBB Terminal are wrapped into a powerful SDK, enabling users to work with the data in a flexible environment that can be fully customized to meet the needs of any user. These functionalities allow the user to apply advanced optimization techniques to a portfolio of any type and of any size. It does so by introducing a multitude of optimization techniques ranging from <a href="https://www.investopedia.com/terms/m/meanvariance-analysis.asp" target="_blank" rel="noreferrer noopener">mean-variance optimization</a> to <a href="https://www.investopedia.com/terms/r/risk-parity.asp" target="_blank" rel="noreferrer noopener">risk parity models</a> and <a href="https://www.investopedia.com terms/c/cluster_analysis.asp" target="_blank" rel="noreferrer noopener">hierarchical clustering models</a>. By providing Excel templates, the user can make sense of the vast array of parameters that each command has. E.g. think of the historic period you wish to use or which of the more than 10 risk measures and covariance methods should be used? These are questions the templates make easier to answer. +The capabilities of the [Portfolio Optiminzation menu](/terminal/guides/intros/portfolio/po) from the OpenBB Terminal are wrapped into a powerful SDK, enabling users to work with the data in a flexible environment that can be fully customized to meet the needs of any user. These functionalities allow the user to apply advanced optimization techniques to a portfolio of any type and of any size. It does so by introducing a multitude of optimization techniques ranging from <a href="https://www.investopedia.com/terms/m/meanvariance-analysis.asp" target="_blank" rel="noreferrer noopener">mean-variance optimization</a> to <a href="https://www.investopedia.com/terms/r/risk-parity.asp" target="_blank" rel="noreferrer noopener">risk parity models</a> and <a href="https://www.investopedia.com/terms/c/cluster_analysis.asp" target="_blank" rel="noreferrer noopener">hierarchical clustering models</a>. By providing Excel templates, the user can make sense of the vast array of parameters that each command has. E.g. think of the historic period you wish to use or which of the more than 10 risk measures and covariance methods should be used? These are questions the templates make easier to answer. ## How to use Start a Python script or Notebook file by importing the module: diff --git a/website/content/sdk/index.md b/website/content/sdk/index.md index 9fd3c408aed..2863bc43a2b 100644 --- a/website/content/sdk/index.md +++ b/website/content/sdk/index.md @@ -36,7 +36,7 @@ To know more about OpenBB SDK, you can start by reading the [Installation Guide] ### Using OpenBB SDK -To learn how to use OpenBB SDK, you can start by reading the [Structure of the SDK](/sdk/guides/basics/structure) and [Using the SDK](/sdk/guides/basics/using) guides. +To learn how to use OpenBB SDK, you can start by reading the [Basics Guide](/sdk/guides/basics). ### SDK Reference diff --git a/website/content/sdk/quickstart/installation.md b/website/content/sdk/quickstart/installation.md index a4047d38d5a..4e1bcdfefb1 100644 --- a/website/content/sdk/quickstart/installation.md +++ b/website/content/sdk/quickstart/installation.md @@ -1,3 +1,8 @@ +--- +title: Installation +sidebar_position: 2 +--- + # Installation We provide a simple installation method in order to utilize the OpenBB SDK. You must first create an environment, which allows you to isolate the SDK from the rest of your system. It is our recommendation that you utilize a `conda` environment because there are optional features, such as `forecast`, that utilize libraries that are specifically sourced from `conda-forge`. Due to this, if you do not use a conda environment, you will not be able to use some of these features. As such, the installation steps will be written under the assumption that you are using conda. diff --git a/website/content/terminal/guides/basics/index.md b/website/content/terminal/guides/basics/index.md index d08c8d70ca5..efa441bbe38 100644 --- a/website/content/terminal/guides/basics/index.md +++ b/website/content/terminal/guides/basics/index.md @@ -44,7 +44,7 @@ the commands that you are able to use from any menu in the terminal (see <a href command. For example, within the `stocks` menu, `about candle` opens <a href="/terminal/reference/stocks/candle/" target="_blank" rel="noreferrer noopener">this guide</a>. - `wiki`: search for a given expression on the Wikipedia without leaving the terminal. -Continuing with the example mentioned at `quit`, revisit the `stocks` menu and look at the commands. At the top you will see a command named <a href="/terminal/stocks/load" target="_blank" rel="noreferrer noopener">load</a>. To understand what this command can do, you can use `load -h` followed by `ENTER` (⏎). The `-h` stands for `help` and every command will have this feature. This will return the following: +Continuing with the example mentioned at `quit`, revisit the `stocks` menu and look at the commands. At the top you will see a command named <a href="/terminal/reference/stocks/load" target="_blank" rel="noreferrer noopener">load</a>. To understand what this command can do, you can use `load -h` followed by `ENTER` (⏎). The `-h` stands for `help` and every command will have this feature. This will return the following: ``` 2022 May 19, 05:27 (🦋) /stocks/ $ load -h @@ -129,7 +129,7 @@ We can check that this period has changed by looking into the <a href="https://w <a target="_blank" href="https://user-images.githubusercontent.com/46355364/169503345-a9409637-dc7a-4193-9c87-38b1b6ee1a08.png"><img src="https://user-images.githubusercontent.com/46355364/169503345-a9409637-dc7a-4193-9c87-38b1b6ee1a08.png" alt="Amazon Candle Chart" width="800"/></a> -As mentioned in the <a href="#explanation-of-menus">Explanation of Menus</a>, some information also transfers over to other menus and this includes the loaded market data from <a href="/terminal/stocks/load" target="_blank" rel="noreferrer noopener">load</a>. So, if you would visit the `ta` menu (which stands for <a href="https://www.investopedia.com/terms/t/technicalanalysis.asp" target="_blank" rel="noreferrer noopener">Technical Analysis</a>) you will see that, by running any command, the selected period above is depicted again. Return to the Stocks menu again by using `q` and use it again to return to the home screen which can be shown with `?`. +As mentioned in the <a href="#explanation-of-menus">Explanation of Menus</a>, some information also transfers over to other menus and this includes the loaded market data from <a href="/terminal/reference/stocks/load" target="_blank" rel="noreferrer noopener">load</a>. So, if you would visit the `ta` menu (which stands for <a href="https://www.investopedia.com/terms/t/technicalanalysis.asp" target="_blank" rel="noreferrer noopener">Technical Analysis</a>) you will see that, by running any command, the selected period above is depicted again. Return to the Stocks menu again by using `q` and use it again to return to the home screen which can be shown with `?`. ### Defining your own source of data diff --git a/website/content/terminal/guides/intros/common/ba.md b/website/content/terminal/guides/intros/common/ba.md index f657781f268..c0c7ca9f85d 100644 --- a/website/content/terminal/guides/intros/common/ba.md +++ b/website/content/terminal/guides/intros/common/ba.md @@ -73,7 +73,7 @@ Some data sources will require a valid API key, which can be obtained for free a - <a href="https://sentimentinvestor.com/" target="_blank" rel="noreferrer noopener">Sentiment Investor</a><br/> -See the <a href="/terminal/guides/advanced/keys" target="_blank" rel="noreferrer noopener">Set API keys</a> for help with API keys in the Terminal. +See the <a href="/terminal/guides/advanced/api-keys" target="_blank" rel="noreferrer noopener">Set API keys</a> for help with API keys in the Terminal. ### Examples @@ -169,7 +169,7 @@ The <a href="/terminal/reference/stocks/ba/sentiment/" target="_blank" rel="nore <img alt="sentiment" src="https://user-images.githubusercontent.com/46355364/170243539-1ea3fc6a-d7ec-4991-a6bb-ed5879753328.png"></img> -More advanced techniques can also be applied by using tools from <a href="https://sentimentinvestor.com" target="_blank" rel="noreferrer noopener">Sentiment Investor</a> that analyzes millions of messages to show the most talked about stocks by hour. This has the ability to show the most trending tickers with <a href="/terminal/reference/stocks/ba/trending/" target="_blank" rel="noreferrer noopener">trending</a> and historical sentiment data with <a href="/terminal/reference/stocks/ba/hist/" target="_blank" rel="noreferrer noopener">hist</a>. +More advanced techniques can also be applied by using tools from <a href="https://sentimentinvestor.com" target="_blank" rel="noreferrer noopener">Sentiment Investor</a> that analyzes millions of messages to show the most talked about stocks by hour. This has the ability to show the most trending tickers with <a href="/terminal/reference/stocks/ba/trending/" target="_blank" rel="noreferrer noopener">trending</a>. ``` (🦋) /stocks/ba/ $ trending @@ -188,13 +188,8 @@ Most trending stocks at 2022-05-23 00:00 | NVAX | 13.00 | 4.00 | 0.47 | 0.40 | | NVDA | 12.00 | 11.00 | 0.45 | 0.47 | | DIS | 12.00 | 1.00 | 0.69 | 0.44 | - - -(🦋) /stocks/ba/ $ hist -s 2022-05-01 ``` -<a target="_blank" href="https://user-images.githubusercontent.com/46355364/170243719-fccf414b-3a89-4776-88de-e30f4eb34f89.png"><img alt="hist" src="https://user-images.githubusercontent.com/46355364/170243719-fccf414b-3a89-4776-88de-e30f4eb34f89.png"></img></a> - Inspired by the Twitter user, <a href="https://twitter.com/CramerTracker" target="_blank" rel="noreferrer noopener">@cramertracker</a>, the final two features follow (CNBC Talking Head) Jim Cramer stock recommendations as satire that rings true. ``` diff --git a/website/content/terminal/guides/intros/crypto/dd.md b/website/content/terminal/guides/intros/crypto/dd.md index feb3587b752..25cb9bc239f 100644 --- a/website/content/terminal/guides/intros/crypto/dd.md +++ b/website/content/terminal/guides/intros/crypto/dd.md @@ -6,7 +6,7 @@ with a brief overview of the features." geekdocCollapseSection: true --- -The Cryptocurrency Due Diligence menu gives the user the ability to delve deeper into the coin of choice. To be able to do this, the menu offers basic information about the loaded coin (<a href="/terminal/reference/crypto/dd/info" target="_blank" rel="noreferrer noopener">info</a> and <a href="/terminal/reference/crypto/dd/basic" target="_blank" rel="noreferrer noopener">basic</a>), information about the project, technology details, audits etcetera (<a href="/terminal/reference/crypto/dd/pi" target="_blank" rel="noreferrer noopener">pi</a>), insights into the coin balance and order book (<a href="/terminal/reference/crypto/dd/balance" target="_blank" rel="noreferrer noopener">balance</a> and <a href="/terminal/reference/crypto/dd/cbbook" target="_blank" rel="noreferrer noopener">cbbook</a>), the tokenomics and fundraising details +The Cryptocurrency Due Diligence menu gives the user the ability to delve deeper into the coin of choice. To be able to do this, the menu offers basic information about the loaded coin (<a href="/terminal/reference/crypto/dd/info" target="_blank" rel="noreferrer noopener">info</a> and <a href="/terminal/reference/crypto/dd/basic" target="_blank" rel="noreferrer noopener">basic</a>), information about the project, technology details, audits etcetera (<a href="/terminal/reference/crypto/dd/pi" target="_blank" rel="noreferrer noopener">pi</a>), insights into the coin balance (<a href="/terminal/reference/crypto/dd/balance" target="_blank" rel="noreferrer noopener">balance</a>), the tokenomics and fundraising details (<a href="/terminal/reference/crypto/dd/tk" target="_blank" rel="noreferrer noopener">tk</a> and <a href="/terminal/reference/crypto/dd/fr" target="_blank" rel="noreferrer noopener">fr</a>) and lastly, social media activity (<a href="/terminal/reference/crypto/dd/mt" target="_blank" rel="noreferrer noopener">mt</a>, <a href="/terminal/reference/crypto/dd/twitter" target="_blank" rel="noreferrer noopener">twitter</a> and <a href="/terminal/reference/crypto/dd/dev" target="_blank" rel="noreferrer noopener">dev</a>). ### How to use diff --git a/website/content/terminal/guides/intros/crypto/index.md b/website/content/terminal/guides/intros/crypto/index.md index 658bdc1d311..5baaeb98fd7 100644 --- a/website/content/terminal/guides/intros/crypto/index.md +++ b/website/content/terminal/guides/intros/crypto/index.md @@ -6,7 +6,7 @@ excerpt: "The Introduction to Cryptocurrency explains how to use the Cryptocurre The Cryptocurrency menu allows you to discover trending cryptocurrency (<a href="/terminal/guides/intros/crypto/disc/" target="_blank" rel="noreferrer noopener">disc</a>). Additionally, you can also perform research of a specific coin (<a href="/terminal/guides/intros/crypto/dd" target="_blank" rel="noreferrer noopener">dd</a>), NFT (<a href="/terminal/guides/intros/crypto/nft" target="_blank" rel="noreferrer noopener">nft</a>) or most lucrative Defi project -(<a href="/terminal//guides/intros/crypto/defi" target="_blank" rel="noreferrer noopener">defi</a>). It does so by handing you tools to (among other things) perform technical analysis (<a href="/terminal/guides/intros/common/ta/" target="_blank" rel="noreferrer noopener">ta</a>), quantitative analysis (<a href="/terminal/guides/intros/common/qa" target="_blank" rel="noreferrer noopener">qa</a>), and give you access to onchain information (<a href="/terminal/guides/intros/crypto/onchain/" target="_blank" rel="noreferrer noopener">onchain</a>). +(<a href="/terminal/guides/intros/crypto/defi" target="_blank" rel="noreferrer noopener">defi</a>). It does so by handing you tools to (among other things) perform technical analysis (<a href="/terminal/guides/intros/common/ta/" target="_blank" rel="noreferrer noopener">ta</a>), quantitative analysis (<a href="/terminal/guides/intros/common/qa" target="_blank" rel="noreferrer noopener">qa</a>), and give you access to onchain information (<a href="/terminal/guides/intros/crypto/onchain/" target="_blank" rel="noreferrer noopener">onchain</a>). ### How to use @@ -46,7 +46,6 @@ The Cryptocurrency menu has an extensive list of available sub-menus ranging fro - [Introduction to Cryptocurrency Overview](/terminal/guides/intros/crypto/ov/): gives the overview of the cryptocurrency market, including global Defi market, stablecoins, exchanges as well as latest news. - [Introduction to Cryptocurrency Onchain](/terminal/guides/intros/crypto/onchain/): provides information on different blockchains, whales transaction and traded volumes on certain crypto pair. You can also specify a Ethereum address and look up past transactions and balance history. - [Introduction to Cryptocurrency Decentralized Finance (DeFi)](/terminal/guides/intros/crypto/defi/): explore the decentralized finance market through a variety of indicators and data, from lending interests, staking ratio, Uniswap pools to top Defi dApps. -- [Introduction to Cryptocurrency Tools](/terminal/guides/intros/crypto/tools/): gives you the tool to calculate crypto metrics, such as impermanent loss and converting APR to APY. - [Introduction to Non Fungible Tokens (NFTs)](/terminal/guides/intros/crypto/nft/): Discover latest NFT drops and OpenSea's NFT Collection statistics. - [Introduction to Cryptocurrency Due Diligence](/terminal/guides/intros/crypto/dd/): performs due diligence on a chosen coin based on, among other things, tokenomics, roadmaps, news, and community. - [Introduction to Technical Analysis](/terminal/guides/intros/common/ta/): analyzes the chosen coin's historical data extensively with moving averages and momentum, trend, volatility and volume indicators. diff --git a/website/content/terminal/guides/intros/etf.md b/website/content/terminal/guides/intros/etf.md index 741b50d2487..9ab3c7c803c 100644 --- a/website/content/terminal/guides/intros/etf.md +++ b/website/content/terminal/guides/intros/etf.md @@ -6,7 +6,7 @@ menu and provides a brief description of its sub-menus" --- -The ETF menu enables you to lookup any ETFand obtain an <a href="/terminal/reference/etf/overview" target="_blank" rel="noreferrer noopener">overview</a>, <a href="/terminal/reference/etf/holdings" target="_blank" rel="noreferrer noopener">holdings</a>, <a href="/terminal/reference/etf/weights" target="_blank" rel="noreferrer noopener">weights</a> and <a href="/terminal/reference/etf/news" target="_blank" rel="noreferrer noopener">news</a> about the chosen ETF. Furthermore, sub-menus reside in this menu that can be used to <a href="/terminal/guides/intros/stocks/ca" target="_blank" rel="noreferrer noopener">compare companies</a> within the ETF, discover gainers and losers within <a href="/terminal/reference/etf/disc" target="_blank" rel="noreferrer noopener">discovery</a> and apply advanced <a href="/terminal/guides/intros/common/ta" target="_blank" rel="noreferrer noopener">technical indicators</a> and <a href="/terminal/guides/intros/forecast" target="_blank" rel="noreferrer noopener">Forecasting menu</a>. Lastly, it also has the option to export multiple ETFs to Excel with <a href="/terminal/reference/etf/pir" target="_blank" rel="noreferrer noopener">pir</a>. +The ETF menu enables you to lookup any ETFand obtain an <a href="/terminal/reference/etf/overview" target="_blank" rel="noreferrer noopener">overview</a>, <a href="/terminal/reference/etf/holdings" target="_blank" rel="noreferrer noopener">holdings</a>, <a href="/terminal/reference/etf/weights" target="_blank" rel="noreferrer noopener">weights</a> and <a href="/terminal/reference/etf/news" target="_blank" rel="noreferrer noopener">news</a> about the chosen ETF. Furthermore, sub-menus reside in this menu that can be used to <a href="/terminal/guides/intros/stocks/comparison" target="_blank" rel="noreferrer noopener">compare companies</a> within the ETF, discover gainers and losers within <a href="/terminal/reference#disc" target="_blank" rel="noreferrer noopener">discovery</a> and apply advanced <a href="/terminal/guides/intros/common/ta" target="_blank" rel="noreferrer noopener">technical indicators</a> and <a href="/terminal/guides/intros/forecast" target="_blank" rel="noreferrer noopener">Forecasting menu</a>. Lastly, it also has the option to export multiple ETFs to Excel with <a href="/terminal/reference/etf/pir" target="_blank" rel="noreferrer noopener">pir</a>. ### How to use @@ -77,7 +77,7 @@ Which shows the following graph: The ETF menu has a few sub-menus available to delve further into a specific ETF or screen multiple ETFs at the same time. To find more information about each menu, click on one of the following: -- <a href="/terminal/guides/intros/stocks/ca/" target="_blank" rel="noreferrer noopener">Introduction to Comparison Analysis</a>: have the ability to compare companies within the ETF based on, among other things, correlation, financial statements, sentiment, valuations and performance. +- <a href="/terminal/guides/intros/stocks/comparison" target="_blank" rel="noreferrer noopener">Introduction to Comparison Analysis</a>: have the ability to compare companies within the ETF based on, among other things, correlation, financial statements, sentiment, valuations and performance. - <a href="/terminal/guides/intros/common/ta" target="_blank" rel="noreferrer noopener">Introduction to Technical Analysis</a>: analysis the chosen ETF's historical data extensively with moving averages and momentum, trend, volatility and volume indicators. - <a href="/terminal/guides/intros/forecast/" target="_blank" rel="noreferrer noopener">Introduction to Forecasting menu</a>: apply advanced AI and Machine Learning models to form prediction of future ETF prices including Recurrent Neural Network (RNN), Autoregressive Integrated Moving Average (ARIMA) and Monte Carlo forecasting. diff --git a/website/content/terminal/guides/intros/stocks/dark-pool-shorts.md b/website/content/terminal/guides/intros/stocks/dark-pool-shorts.md index e4587ba173c..8f8e0ac9de3 100644 --- a/website/content/terminal/guides/intros/stocks/dark-pool-shorts.md +++ b/website/content/terminal/guides/intros/stocks/dark-pool-shorts.md @@ -13,7 +13,7 @@ The purpose of this menu is to provide the user with tools for gauging the level <img alt="The Dark Pools Menu" src="https://user-images.githubusercontent.com/46355364/171151760-9f65424e-b4d6-41a7-b31f-e9bc1c723bd9.png"></img> -To use every feature in the Dark Pools menu, an API key for <a href="https://www.quandl.com/" target="_blank" rel="noreferrer noopener">Quandl</a> must be obtained (for free) and authorized on the local installation. See the <a href="/terminal/quickstart/keys" target="_blank" rel="noreferrer noopener">Getting Started Guide</a> for help setting up the API keys in the OpenBB Terminal. The four commands at the bottom of the menu rely on a loaded ticker while the six above do not. +To use every feature in the Dark Pools menu, an API key for <a href="https://www.quandl.com/" target="_blank" rel="noreferrer noopener">Quandl</a> must be obtained (for free) and authorized on the local installation. See the <a href="/terminal/guides/advanced/api-keys" target="_blank" rel="noreferrer noopener">Getting Started Guide</a> for help setting up the API keys in the OpenBB Terminal. The four commands at the bottom of the menu rely on a loaded ticker while the six above do not. ### How to use @@ -255,4 +255,4 @@ The data from `dpotc`, statistics for individual NMS tickers, shows weekly OTC a <img alt="dpotc" src="https://user-images.githubusercontent.com/46355364/171170366-234aea6b-fe0d-4735-8942-4a672d0683ef.png"></img> -Run a live demo of these features by entering `exe routines/darkpool_demo.openbb` into the Terminal from the home screen.
\ No newline at end of file +Run a live demo of these features by entering `exe routines/darkpool_demo.openbb` into the Terminal from the home screen. diff --git a/website/content/terminal/guides/intros/stocks/gov.md b/website/content/terminal/guides/intros/stocks/gov.md index 1331755d399..4a9266384c4 100644 --- a/website/content/terminal/guides/intros/stocks/gov.md +++ b/website/content/terminal/guides/intros/stocks/gov.md @@ -29,7 +29,7 @@ excerpt: "This guide introduces the Government submenu, within the Stocks menu, geekdocCollapseSection: true --- -The features in this menu are intended to show the reported trades of elected officials, lobbyist activity, awarded contracts, and general spending of the United States Treasury Department. This menu only covers the USA, or companies that trade on US exchanges. The information in this menu is compiled by <a href="https://quiverquant.com" target="_blank" rel="noreferrer noopener">QuiverQuant</a>. A ticker is not required to enter the menu; navigate there from anywhere in the terminal with absolute path jumping: `/stocks/gov` +The features in this menu are intended to show the reported trades of elected officials, lobbyist activity, awarded contracts, and general spending of the United States Treasury Department. This menu only covers the USA, or companies that trade on US exchanges. The information in this menu is compiled by <a href="https://www.quiverquant.com/" target="_blank" rel="noreferrer noopener">QuiverQuant</a>. A ticker is not required to enter the menu; navigate there from anywhere in the terminal with absolute path jumping: `/stocks/gov`  diff --git a/website/content/terminal/guides/intros/stocks/index.md b/website/content/terminal/guides/intros/stocks/index.md index cd97fa9f536..cc9e9236886 100644 --- a/website/content/terminal/guides/intros/stocks/index.md +++ b/website/content/terminal/guides/intros/stocks/index.md @@ -96,7 +96,6 @@ The Stock menu has an extensive list of available sub-menus ranging from fundame - <a href="/terminal/guides/intros/stocks/comparison" target="_blank" rel="noreferrer noopener">Introduction to Comparison Analysis</a>: have the ability to compare companies based on, among other things, correlation, financial statements, sentiment, valuations and performance. - <a href="/terminal/guides/intros/stocks/fa" target="_blank" rel="noreferrer noopener">Introduction to Fundamental Analysis</a>: look into the fundamentals of a chosen company including financial statements, SEC filings, investing scores, discounted cash flow analysis (DCF), sustainability scores and key ratios. - <a href="/terminal/guides/intros/stocks/dd" target="_blank" rel="noreferrer noopener">Introduction to Due Diligence</a>: explore analyst recommendations, ratings over time, price targets and quarterly and yearly earnings estimates. -- <a href="/terminal/guides/intros/stocks/bt" target="_blank" rel="noreferrer noopener">Introduction to Strategy Backtesting</a>: explore back testing strategies based on technical indicators. - <a href="/terminal/guides/intros/common/ta" target="_blank" rel="noreferrer noopener">Introduction to Technical Analysis</a>: analysis the chosen company's historical data extensively with moving averages and momentum, trend, volatility and volume indicators. - <a href="/terminal/guides/intros/common/qa" target="_blank" rel="noreferrer noopener">Introduction to Quantitative Analysis</a>: delve deeper in the historical data with quantitative methods including cumulative distribution function (CDF), (conditional) Value at Risk and rolling ratios. - <a href="/terminal/guides/intros/forecast/" target="_blank" rel="noreferrer noopener">Introduction to Forecasting menu</a>: apply advanced AI and Machine Learning models to form prediction of future stock prices including Recurrent Neural Network (RNN), Autoregressive Integrated Moving Average (ARIMA) and Monte Carlo forecasting. @@ -156,11 +155,11 @@ We can now plot the corresponding stock chart with <a href="/terminal/reference/  -Now we can go ahead and enter the Fundamental Analysis menu by typing `fa`. Please see <a href="fundamental_analysis" target="_blank" rel="noreferrer noopener">Introduction to Fundamental Analysis</a> for a more detailed guide on this menu. This will open the following: +Now we can go ahead and enter the Fundamental Analysis menu by typing `fa`. Please see <a href="/terminal/guides/intros/fa" target="_blank" rel="noreferrer noopener">Introduction to Fundamental Analysis</a> for a more detailed guide on this menu. This will open the following:  -Within this menu, I am now able to present the quarterly income statements over the last 3 years (or any other period) by using <a href="/terminal/reference/stocks/fundamental_analysis/income/" target="_blank" rel="noreferrer noopener">income</a>. +Within this menu, I am now able to present the quarterly income statements over the last 3 years (or any other period) by using <a href="/terminal/reference/stocks/fa/income/" target="_blank" rel="noreferrer noopener">income</a>. ``` 2022 May 18, 05:52 (🦋) /stocks/fa/ $ income -q -l 12 diff --git a/website/content/terminal/guides/intros/stocks/options/index.md b/website/content/terminal/guides/intros/stocks/options/index.md index e2628aa00e3..1cc794cbaf2 100644 --- a/website/content/terminal/guides/intros/stocks/options/index.md +++ b/website/content/terminal/guides/intros/stocks/options/index.md @@ -11,7 +11,7 @@ Navigate to the menu by typing `options`, from the `Stocks` menu, and then press  -By default, the Terminal loads a ticker using <a href="https://developer.tradier.com/" target="_blank" rel="noreferrer noopener">Tradier</a> as the source. Sign up for a free developer account and then enter that token using the <a href="/terminal/quickstart/keys" target="_blank" rel="noreferrer noopener">`Keys menu`</a>. Alternatively, there is a choice to use yFinance data sets by attaching the argument as shown below. Help dialogues are displayed for any command by adding `-h` to the string. It is worth noting that this load command is different than the load command elsewhere. +By default, the Terminal loads a ticker using <a href="https://developer.tradier.com/" target="_blank" rel="noreferrer noopener">Tradier</a> as the source. Sign up for a free developer account and then enter that token using the <a href="/terminal/guides/advanced/api-keys" target="_blank" rel="norefer |