From ddc013f090fdfd0ccf269598b9fe8f6248b42f30 Mon Sep 17 00:00:00 2001 From: jose-donato Date: Thu, 15 Dec 2022 16:33:05 +0000 Subject: [PATCH 01/37] fix: wordwrap --- website/generate_sdk_markdown.py | 2 +- website/generate_terminal_markdown.py | 2 +- website/package.json | 1 + website/src/theme/CodeBlock/Content/String.js | 2 +- 4 files changed, 4 insertions(+), 3 deletions(-) diff --git a/website/generate_sdk_markdown.py b/website/generate_sdk_markdown.py index 4e3e71e9dc1..31bdb1c3d86 100644 --- a/website/generate_sdk_markdown.py +++ b/website/generate_sdk_markdown.py @@ -296,7 +296,7 @@ def generate_markdown_section(meta: Dict[str, Any]): markdown = ( f"{meta['description']}\n\nSource Code: [[link]({meta['source_code_url']})]\n\n" ) - markdown += f"```python\n{meta['func_def']}\n```\n\n" + markdown += f"```python wordwrap\n{meta['func_def']}\n```\n\n" markdown += "---\n\n## Parameters\n\n" if meta["params"]: diff --git a/website/generate_terminal_markdown.py b/website/generate_terminal_markdown.py index 358c3b9a1e3..5dd50846577 100644 --- a/website/generate_terminal_markdown.py +++ b/website/generate_terminal_markdown.py @@ -171,7 +171,7 @@ description: OpenBB Terminal Function # head meta https://docusaurus.io/docs/markdown-features/head-metadata markdown += f"# {cmd_meta['cmd_name']}\n\n{cmd_meta['description']}\n\n" - markdown += f"### Usage\n\n```python\n{cmd_meta['usage']}\n```\n\n" + markdown += f"### Usage\n\n```python wordwrap\n{cmd_meta['usage']}\n```\n\n" markdown += "---\n\n## Parameters\n\n" if cmd_meta["actions"]: diff --git a/website/package.json b/website/package.json index 89911afef64..72868971cc5 100644 --- a/website/package.json +++ b/website/package.json @@ -4,6 +4,7 @@ "private": true, "scripts": { "docusaurus": "docusaurus", + "dev": "docusaurus start", "start": "docusaurus start", "build": "docusaurus build", "swizzle": "docusaurus swizzle", diff --git a/website/src/theme/CodeBlock/Content/String.js b/website/src/theme/CodeBlock/Content/String.js index 884601d7eb8..ea672e06047 100644 --- a/website/src/theme/CodeBlock/Content/String.js +++ b/website/src/theme/CodeBlock/Content/String.js @@ -42,7 +42,7 @@ export default function CodeBlockString({ const showLineNumbers = showLineNumbersProp ?? containsLineNumbers(metastring); - const shouldWordwrapByDefault = code.startsWith("openbb.") + const shouldWordwrapByDefault = metastring?.includes("wordwrap") return ( Date: Tue, 14 Feb 2023 23:18:07 +0000 Subject: [PATCH 02/37] fix: algolia --- website/docusaurus.config.js | 1 + 1 file changed, 1 insertion(+) diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 30ffaf6aaa0..9917af2ae21 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -99,6 +99,7 @@ const config = { appId: "7D1HQ0IXAS", apiKey: "a2e289977b4b663ed9cf3d4635a438fd", indexName: "openbbterminal", + contextualSearch: false, }, }), }; From dac5b59e633ac0b5eff47f420804e40adcea865b Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 09:35:54 +0100 Subject: [PATCH 03/37] New images in Basics --- .../content/terminal/guides/basics/index.md | 32 +++++++++++-------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/website/content/terminal/guides/basics/index.md b/website/content/terminal/guides/basics/index.md index be83451a7c9..71cf1aa1963 100644 --- a/website/content/terminal/guides/basics/index.md +++ b/website/content/terminal/guides/basics/index.md @@ -8,7 +8,7 @@ The OpenBB Terminal is based off the +image The OpenBB Terminal is centered around keyboard input. To navigate and perform analysis you will have to type in the name of the command followed by an `ENTER` (⏎). If you wish to see information about the OpenBB Terminal you can do so by typing `about` and then press `ENTER` (⏎). As you are typing, you will notice that you receive suggestions, by using the `DOWN` (⌄) arrow and pressing `ENTER` (⏎) you can select the command and execute it. @@ -24,7 +24,7 @@ Throughout the entire terminal, the same set of colors are used which all share Menus, depicted in Dark Blue, take you to a new section of the terminal referred to as a menu. For example, if you wish to view information about stocks, you can do so by typing `stocks` and pressing `ENTER` (⏎). This opens a new menu as depicted below. -Stocks Menu +image Depending on the menu you are in, you are presented with a new set of commands and menus you can select. There are interactions in place between each menu. For example, when selecting a company within the `stocks` menu, the terminal will remember your selection when you visit the `fa` or `options` menu. See [Introduction to Stocks](/terminal/guides/intros/stocks). @@ -48,18 +48,18 @@ the commands that you are able to use from any menu in the terminal (see load. 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 -usage: load [-t TICKER] [-s START] [-e END] [-i {1,5,15,30,60}] [-p] [-f FILEPATH] [-m] [-w] [-r {ytd,1y,2y,5y,6m}] [--exchange] [--performance] [-h] [--export EXPORT] - [--source {YahooFinance,AlphaVantage,Polygon,EODHD}] +usage: load [-t TICKER] [-s START] [-e END] [-i {1,5,15,30,60}] [-p] [-f FILEPATH] [-m] [-w] [--exchange] [--performance] [-h] [--export EXPORT] [--sheet-name SHEET_NAME [SHEET_NAME ...]] + [--source {YahooFinance,AlphaVantage,Polygon,EODHD,Intrinio}] -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'. +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 TICKER, --ticker TICKER Stock ticker (default: None) -s START, --start START - The starting date (format YYYY-MM-DD) of the stock (default: 2020-01-09) - -e END, --end END The ending date (format YYYY-MM-DD) of the stock (default: 2023-01-13) + The starting date (format YYYY-MM-DD) of the stock (default: 2020-02-11) + -e END, --end END The ending date (format YYYY-MM-DD) of the stock (default: 2023-02-15) -i {1,5,15,30,60}, --interval {1,5,15,30,60} Intraday stock minutes (default: 1440) -p, --prepost Pre/After market hours. Only works for 'yf' source, and intraday data (default: False) @@ -71,7 +71,9 @@ optional arguments: --performance Show performance information. (default: False) -h, --help show this help message (default: False) --export EXPORT Export raw data into csv, json, xlsx (default: ) - --source {YahooFinance,AlphaVantage,Polygon,EODHD} + --sheet-name SHEET_NAME [SHEET_NAME ...] + Name of excel sheet to save data to. Only valid for .xlsx files. (default: None) + --source {YahooFinance,AlphaVantage,Polygon,EODHD,Intrinio} Data source to select from (default: YahooFinance) For more information and examples, use 'about load' to access the related guide. @@ -81,9 +83,10 @@ For more information and examples, use 'about load' to access the related guide. This shows you all **arguments** the command has. These are additional options you can provide to the command. Each default value is also displayed which is used when you do not select this option. For example, if I would use the stock ticker of Amazon (AMZN, which can also be found with `search amazon`), I can use `load AMZN` which will return the following: ``` -2023 Jan 13, 11:22 (🦋) /stocks/ $ load AMZN +(🦋) /stocks/ $ load AMZN + +Loading Daily data for AMZN with starting period 2020-02-11. -Loading Daily data for AMZN with starting period 2020-01-09. ``` The default values you see within `load -h` have been inputted here. E.g. the starting period is 2019-05-15. I can decide to change these default values by calling the argument and inputting a different value. @@ -93,18 +96,19 @@ Whenever you wish to apply an optional argument, you use the related shortcode, Let's change the starting and ending period of the data that is being loaded in by doing the following: ``` -2023 Jan 13, 11:23 (🦋) /stocks/ $ load AMZN -s 2005-01-01 -e 2010-01-01 +(🦋) /stocks/ $ load AMZN -s 2005-01-01 -e 2010-01-01 Loading Daily data for AMZN with starting period 2005-01-03. + ``` We can check that this period has changed by looking into the candle chart with `candle`. This, again shares the same `-h` argument. This results in the following which indeed depicts our selected period. ``` -2022 May 19, 05:44 (🦋) /stocks/ $ candle +(🦋) /stocks/ $ candle ``` -Amazon Candle Chart +![Candlestick Chart Amazon](https://user-images.githubusercontent.com/46355364/218974887-f7d6bc81-4d25-4ef2-9854-0a6bebc351d1.png) As mentioned in the Explanation of Menus, some information also transfers over to other menus and this includes the loaded market data from load. So, if you would visit the `ta` menu (which stands for Technical Analysis) 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 `?`. From 841f0bfa755ee5bc1fd8eeabb980d6814f691b8c Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 09:39:10 +0100 Subject: [PATCH 04/37] Update --- .../terminal/guides/intros/common/ba.md | 34 ++----------------- 1 file changed, 2 insertions(+), 32 deletions(-) diff --git a/website/content/terminal/guides/intros/common/ba.md b/website/content/terminal/guides/intros/common/ba.md index 6156f5b2ee5..db3c1d889f6 100644 --- a/website/content/terminal/guides/intros/common/ba.md +++ b/website/content/terminal/guides/intros/common/ba.md @@ -6,41 +6,11 @@ description: The Behavioural Analysis menu offers the user tools for gauging the The Behavioural Analysis menu offers the user tools for gauging the overall public sentiment of a company online. The complexity of the tools range from message board scrapers to deep learning algorithms for financial analysis and prediction. Sentiment is particularly useful for momentum trading strategies, discovery, and general fundamental research. Navigate into the menu from the Stocks menu by entering, `ba`; or, using absolute paths from anywhere in the Terminal: `/stocks/ba` -The Behavioural Analysis submenu +image ### How to use -The commands with text, representing commands, do not require a ticker, faded commands will turn light blue when there is a ticker loaded. - -``` -(🦋) /stocks/ba/ $ load gme - -Loading Daily GME stock with starting period 2019-05-20 for analysis. - -Datetime: 2022 May 23 12:13 -Timezone: America/New_York -Currency: USD -Market: CLOSED -Company: GameStop Corporation - -(🦋) /stocks/ba/ $ ? -``` - -The Behavioural Analysis Menu with a loaded ticker - -Some data sources will require a valid API key, which can be obtained for free and then set using the Keys menu. To use all the features in this menu, obtain free API keys from these providers: - -- Finnhub
-- Twitter
-- Reddit
-- Sentiment - Investor
- -See the Set API keys for help with API keys in the Terminal. - -### Examples - -As with every command, using the `-h` argument displays the help dialogue. Running the headlines command returns the following: +Some data sources will require a valid API key, which can be obtained for free and then set using the [Keys menu](https://docs.openbb.co/terminal/guides/advanced/api-keys). As with every command, using the `-h` argument displays the help dialogue. Running the headlines command returns the following: ``` (🦋) /stocks/ba/ $ headlines From 3e8585d22e61d2d46d6bcb01e70638e7b2b83c0f Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 09:44:51 +0100 Subject: [PATCH 05/37] Update qa.md --- .../terminal/guides/intros/common/qa.md | 74 +++++++++++++------ 1 file changed, 52 insertions(+), 22 deletions(-) diff --git a/website/content/terminal/guides/intros/common/qa.md b/website/content/terminal/guides/intros/common/qa.md index 1ddf7f4c9ca..ce1c53be71e 100644 --- a/website/content/terminal/guides/intros/common/qa.md +++ b/website/content/terminal/guides/intros/common/qa.md @@ -12,14 +12,12 @@ The Quantitative Analysis menu is a common menu to three asset classes: - Forex - Stocks -The Quantitative Analysis menu +image ### How to use Enter the menu, through one of the asset classes listed above, by entering `qa` in the Terminal. The ticker that is loaded before entering the menu will determine the timeframe for the analysis. To alter it, use the `load` function and pick a new `--start` and `--end` for the observation window. The QA functions target a specified column of the data. By default, this is returns. Use the `pick` command to chose a new target column. -Picking a new target column - The menu is divided into five categories of functions: - Statistics @@ -28,41 +26,73 @@ The menu is divided into five categories of functions: - Risk - Other -A summary of exportable statistics is displayed with the command, `summary`. The example here shows $APPL. +A summary of exportable statistics is displayed with the command, `summary`. The example here shows AAPL. -QA summary for Apple +``` +(🦋) /stocks/qa/ $ summary -A simple line chart for the target column as a time-series is called with the `line` command. + Summary Statistics +┏━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━┓ +┃ ┃ open ┃ high ┃ low ┃ close ┃ adjclose ┃ volume ┃ dividends ┃ stock splits ┃ returns ┃ logret ┃ logprice ┃ +┡━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━┩ +│ count │ 758.000 │ 758.000 │ 758.000 │ 758.000 │ 758.000 │ 758.000 │ 758.000 │ 758.000 │ 758.000 │ 758.000 │ 758.000 │ +├───────┼─────────┼─────────┼─────────┼─────────┼──────────┼──────────────────────┼───────────┼──────────────┼─────────┼─────────┼──────────┤ +│ mean │ 131.385 │ 133.089 │ 129.757 │ 131.491 │ 131.491 │ 109761415.963 │ 0.003 │ 0.005 │ 0.001 │ 0.001 │ 4.849 │ +├───────┼─────────┼─────────┼─────────┼─────────┼──────────┼──────────────────────┼───────────┼──────────────┼─────────┼─────────┼──────────┤ +│ std │ 29.088 │ 29.309 │ 28.833 │ 29.086 │ 29.086 │ 56077677.683 │ 0.027 │ 0.145 │ 0.023 │ 0.023 │ 0.258 │ +├───────┼─────────┼─────────┼─────────┼─────────┼──────────┼──────────────────────┼───────────┼──────────────┼─────────┼─────────┼──────────┤ +│ min │ 55.908 │ 56.011 │ 52.116 │ 54.999 │ 54.999 │ 35195900.000 │ 0.000 │ 0.000 │ -0.129 │ -0.138 │ 4.007 │ +├───────┼─────────┼─────────┼─────────┼─────────┼──────────┼──────────────────────┼───────────┼──────────────┼─────────┼─────────┼──────────┤ +│ 10% │ 79.502 │ 80.013 │ 79.051 │ 79.648 │ 79.648 │ 63139770.000 │ 0.000 │ 0.000 │ -0.026 │ -0.026 │ 4.378 │ +├───────┼─────────┼─────────┼─────────┼─────────┼──────────┼──────────────────────┼───────────┼──────────────┼─────────┼─────────┼──────────┤ +│ 25% │ 118.253 │ 119.721 │ 116.983 │ 118.555 │ 118.555 │ 74846950.000 │ 0.000 │ 0.000 │ -0.011 │ -0.011 │ 4.775 │ +├───────┼─────────┼─────────┼─────────┼─────────┼──────────┼──────────────────────┼───────────┼──────────────┼─────────┼─────────┼──────────┤ +│ 50% │ 136.551 │ 138.402 │ 134.433 │ 136.614 │ 136.614 │ 91962650.000 │ 0.000 │ 0.000 │ 0.001 │ 0.001 │ 4.917 │ +├───────┼─────────┼─────────┼─────────┼─────────┼──────────┼──────────────────────┼───────────┼──────────────┼─────────┼─────────┼──────────┤ +│ 75% │ 149.976 │ 151.796 │ 148.598 │ 150.446 │ 150.446 │ 124897575.000 │ 0.000 │ 0.000 │ 0.014 │ 0.014 │ 5.014 │ +├───────┼─────────┼─────────┼─────────┼─────────┼──────────┼──────────────────────┼───────────┼──────────────┼─────────┼─────────┼──────────┤ +│ 90% │ 166.432 │ 168.413 │ 164.183 │ 165.460 │ 165.460 │ 177115490.000 │ 0.000 │ 0.000 │ 0.026 │ 0.026 │ 5.109 │ +├───────┼─────────┼─────────┼─────────┼─────────┼──────────┼──────────────────────┼───────────┼──────────────┼─────────┼─────────┼──────────┤ +│ max │ 181.299 │ 181.607 │ 177.815 │ 180.684 │ 180.684 │ 426510000.000 │ 0.230 │ 4.000 │ 0.120 │ 0.113 │ 5.197 │ +├───────┼─────────┼─────────┼─────────┼─────────┼──────────┼──────────────────────┼───────────┼──────────────┼─────────┼─────────┼──────────┤ +│ var │ 846.131 │ 858.993 │ 831.359 │ 845.978 │ 845.978 │ 3144705934370881.500 │ 0.001 │ 0.021 │ 0.001 │ 0.001 │ 0.067 │ +└───────┴─────────┴─────────┴─────────┴─────────┴──────────┴──────────────────────┴───────────┴──────────────┴─────────┴─────────┴──────────┘ +``` -![Line chart of Apple highs over time](https://user-images.githubusercontent.com/85772166/183483733-043f9c21-c408-4526-8c39-16937a05d46a.png) +A simple line chart for the target column as a time-series is called with the `line` command, for example the `returns` column. + +![Line Apple](https://user-images.githubusercontent.com/46355364/218976712-2d9c14ce-c89f-484d-81ca-a8f5d1ef6d7b.png) Optional arguments to this command allows the user to draw and annotate on the chart. ``` -2022 Aug 08, 12:14 /stocks/qa/ $ line -h usage: line [--log] [-d] [--ml ML] -[--ms MS] [-h] [--export EXPORT] +(🦋) /stocks/qa/ $ line -h + +usage: line [--log] [--ml ML] [--ms MS] [-h] [--export EXPORT] Show line plot of selected data or highlight specific datetimes. -options: --log Plot with y on log scale (default: False) --ml ML Draw vertical -line markers to highlight certain events (default: ) --ms MS Draw scatter -markers to highlight certain events (default: ) -h, --help show this help -message (default: False) --export EXPORT Export figure into png, jpg, pdf, svg -(default: ) +optional arguments: + --log Plot with y on log scale (default: False) + --ml ML Draw vertical line markers to highlight certain events (default: ) + --ms MS Draw scatter markers to highlight certain events (default: ) + -h, --help show this help message (default: False) + --export EXPORT Export figure into png, jpg, pdf, svg (default: ) For more information and examples, use 'about line' to access the related guide. + +(🦋) /stocks/qa/ $ + 2022 Aug 08, 12:20 /stocks/qa/ $ pick high Compare the beta between the loaded asset and another, using the `-r` flag to deviate from the defaulted comparison, $SPY. -2022 Aug 08, 12:34 /stocks/qa/ $ beta -r MSFT - -Loading Daily MSFT stock with starting period 2019-08-05 for analysis. +(🦋) /stocks/qa/ $ beta -r MSFT ``` -Beta of $AAPL relative to $MSFT +![Beta](https://user-images.githubusercontent.com/46355364/218977134-52b00eec-a7f5-4dc9-ba62-343d0b546d30.png) Most outputs are equipped with an `--export` flag, allowing the user to save the tables as a CSV, JSON, or XLSX file. The exports can then be imported into other menus like Econometrics. Additional information on each specific command is displayed by attaching `-h` to it. @@ -71,13 +101,13 @@ Most outputs are equipped with an `--export` flag, allowing the user to save the Box and Whisker plots for monthly and yearly scales: ``` -2022 Aug 08, 12:47 /stocks/qa/ $ bw +(🦋) /stocks/qa/$ bw ``` ![Monthly box and whisker plot for Apple](https://user-images.githubusercontent.com/85772166/183483965-a6c2d076-4896-47ec-a314-fc6a574ad8de.png) ``` -2022 Aug 08, 12:47 /stocks/qa/ $ bw -y +(🦋) /stocks/qa/ $ bw -y ``` ![Yearly box and whisker plot for Apple](https://user-images.githubusercontent.com/85772166/183484096-73eadd0c-1618-4e95-a27b-79e81cd6afad.png) @@ -85,9 +115,9 @@ Box and Whisker plots for monthly and yearly scales: Pick `logret` for rate of change to the returns of the asset: ``` -2022 Aug 08, 12:47 /stocks/qa/ $ pick logret +(🦋) /stocks/qa/ $ pick logret -2022 Aug 08, 12:51 /stocks/qa/ $ bw -y +(🦋) /stocks/qa/ $ bw -y ``` ![Yearly rate of change on returns from Apple](https://user-images.githubusercontent.com/85772166/183484172-5c001e9d-911c-44cd-848c-9ae5ec13dbc2.png) From 640259fc5c53cd4ea2165fb7d5392597ae204401 Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 09:47:25 +0100 Subject: [PATCH 06/37] Update ta.md --- .../terminal/guides/intros/common/ta.md | 29 +++++++++++++++++-- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/website/content/terminal/guides/intros/common/ta.md b/website/content/terminal/guides/intros/common/ta.md index e9a9c49bacc..865c395b5cd 100644 --- a/website/content/terminal/guides/intros/common/ta.md +++ b/website/content/terminal/guides/intros/common/ta.md @@ -26,7 +26,7 @@ All commands in this menu will rely on the interval and window chosen when Choose a beginning and end date to see a volume-weighted average price chart of the loaded ticker. `vwap --start 2022-01-01 --end 2022-06-17` @@ -58,7 +58,30 @@ The asset price is between the Middle and the Lower Bollinger Bands. `recom` projects buy & sell signals for the short-term. -![Recommendations from T/A](https://user-images.githubusercontent.com/85772166/174499195-9d4f8604-dec9-453f-815d-6c89f2b8b216.png) +``` +(🦋) /stocks/ta/ $ recom + + Ticker Recommendation +┏━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━┳━━━━━━┳━━━━━━━━━┓ +┃ ┃ RECOMMENDATION ┃ BUY ┃ SELL ┃ NEUTRAL ┃ +┡━━━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━╇━━━━━━╇━━━━━━━━━┩ +│ 1 month │ SELL │ 2 │ 15 │ 9 │ +├─────────┼────────────────┼─────┼──────┼─────────┤ +│ 1 week │ SELL │ 5 │ 11 │ 10 │ +├─────────┼────────────────┼─────┼──────┼─────────┤ +│ 1 day │ BUY │ 11 │ 5 │ 10 │ +├─────────┼────────────────┼─────┼──────┼─────────┤ +│ 4 hours │ BUY │ 15 │ 2 │ 9 │ +├─────────┼────────────────┼─────┼──────┼─────────┤ +│ 1 hour │ BUY │ 14 │ 3 │ 9 │ +├─────────┼────────────────┼─────┼──────┼─────────┤ +│ 15 min │ BUY │ 15 │ 3 │ 8 │ +├─────────┼────────────────┼─────┼──────┼─────────┤ +│ 5 min │ BUY │ 16 │ 2 │ 8 │ +├─────────┼────────────────┼─────┼──────┼─────────┤ +│ 1 min │ BUY │ 16 │ 3 │ 7 │ +└─────────┴────────────────┴─────┴──────┴─────────┘ +``` Bollinger Bands with a 1-minute resolution for AMZN - `bbands` @@ -67,4 +90,4 @@ Bollinger Bands with a 1-minute resolution for AMZN - `bbands` The Accumulation/Distribution line of AMZN - `ad` -![AMZN Accumulation/Distribution Line](https://user-images.githubusercontent.com/85772166/174499247-e63f8f57-a06a-446b-bca3-0fe89258fd4b.png) \ No newline at end of file +![AMZN Accumulation/Distribution Line](https://user-images.githubusercontent.com/85772166/174499247-e63f8f57-a06a-446b-bca3-0fe89258fd4b.png) From f3a64892568649b87f52186cdceed4a2c70a80ae Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 09:51:12 +0100 Subject: [PATCH 07/37] Update comparison.md --- .../guides/intros/stocks/comparison.md | 26 +++++++------------ 1 file changed, 9 insertions(+), 17 deletions(-) diff --git a/website/content/terminal/guides/intros/stocks/comparison.md b/website/content/terminal/guides/intros/stocks/comparison.md index 98a3bbc3c21..220205dcde9 100644 --- a/website/content/terminal/guides/intros/stocks/comparison.md +++ b/website/content/terminal/guides/intros/stocks/comparison.md @@ -5,35 +5,27 @@ description: The Comparison Analysis menu provides the user with tools for compa --- The Comparison Analysis menu provides the user with tools for comparison (similar) stocks. It is not necessary to load a ticker from the Stocks menu to use these features. Enter the Comparison Analysis submenu by typing `ca` and pressing `ENTER` (⏎). -Comparison Analysis Menu +image ### How to use -To add a primary ticker, or to swap it for another, enter `ticker AMZN`. The command has three sources, use: `getfinnhub`, `getpolygon` +To add a primary ticker, or to swap it for another, enter `ticker WMT`. The command has three sources, use: `getfinnhub`, `getpolygon` and `getfinviz` to access the different sources. Sources may return different results. ```` -(🦋) /stocks/ca/ $ getfinviz -[Finviz] Similar Companies: WMT, BIG, BJ, COST, DG, DLTR, OLLI, PSMT, TGT, TUEM +(🦋) /stocks/ca/ $ get --source Finviz + +[Finviz] Similar Companies: WMT, BIG, BJ, COST, DG, DLTR, OLLI, PSMT, TGT + +(🦋) /stocks/ca/ $ get --source Polygon -(🦋) /stocks/ca/ $ getpoly [Polygon] Similar Companies: WMT, AMZN, COST, EBAY, DLTR, KSS, JCP, TGT, M, DG - -(🦋) /stocks/ca/ $ getfinnhub -[Finnhub] Similar Companies: WMT, COST, BJ, PSMT ```` -Using any of these commands will automatically populate the list of similar companies for analysis. Furthermore, `add` & `rmv` allows the user to make modifications, or create a list from scratch. -Get similar companies for analysis - -To show a correlation matrix, use the `hcorr` command. The start dates can be modified, which changes the results, to show correlation over different periods. For example, obtain a one year correlation matrix with `hcorr`: +Using any of these commands will automatically populate the list of similar companies for analysis. Furthermore, `add` & `rmv` allows the user to make modifications, or create a list from scratch. To show a correlation matrix, use the `hcorr` command. The start dates can be modified, which changes the results, to show correlation over different periods. For example, obtain a one year correlation matrix with `hcorr`: One year correlation matrix -Or, by adjusting the date, it is possible to define a correlation matrix with a different time horizon, e.g `hcorr -s 2022-01-01`: - -YTD correlation matrix - The list of similar companies can be compared by a number of fundamental metrics. `valuation` displays earnings and valuation multiples. @@ -295,4 +287,4 @@ Other available yearly timeframes are: 2017, 2018, 2019, 2020, 2021 ├──────────────────────────────────────────────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────┼──────────┼───────────┼──────────┼──────────┤ │ Diluted Shares Outstanding │ 444.2M │ 8.56B │ 2.05B │ 1.35B │ 3.03B │ 355.8M │ 426M │ 4.1B │ 1.82B │ 1.49B │ └──────────────────────────────────────────────┴──────────┴──────────┴──────────┴──────────┴──────────┴─────────┴──────────┴───────────┴──────────┴──────────┘ -```` \ No newline at end of file +```` From 81431cef03474e4c5f59e3509a30064d9cdf12a5 Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 09:53:32 +0100 Subject: [PATCH 08/37] Update dark-pool-shorts.md --- .../guides/intros/stocks/dark-pool-shorts.md | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) 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 10b0585ee2a..24f4ec64a17 100644 --- a/website/content/terminal/guides/intros/stocks/dark-pool-shorts.md +++ b/website/content/terminal/guides/intros/stocks/dark-pool-shorts.md @@ -6,9 +6,9 @@ description: The Introduction to Dark Pools & Short Data, within the Stocks menu The purpose of this menu is to provide the user with tools for gauging the level of short interest, FTD rate, and off-exchange volume in a NMS security. There are also commands for looking at market as a whole. Enter the submenu from the Stocks menu by typing, `dps`, and hitting `ENTER` (⏎). -The Dark Pools Menu +image -To use every feature in the Dark Pools menu, an API key for Quandl must be obtained (for free) and authorized on the local installation. See the Getting Started Guide 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 Quandl must be obtained (for free) and authorized on the local installation. See the Setting API Keys Guide 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 @@ -215,12 +215,6 @@ Load AAPL and request a 1-year chart of the net short volume and position. This Loading Daily AAPL stock with starting period 2019-05-28 for analysis. -Datetime: 2022 May 30 14:59 -Timezone: America/New_York -Currency: USD -Market: CLOSED -Company: Apple Inc. - (🦋) /stocks/dps/ $ spos ```` @@ -248,4 +242,4 @@ The data from `dpotc`, statistics for individual NMS tickers, shows weekly OTC a (🦋) /stocks/dps/ $ dpotc ```` -dpotc \ No newline at end of file +dpotc From 5d396737e86e562414ab52525e63616087ffa806 Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 09:54:23 +0100 Subject: [PATCH 09/37] Update disc.md --- website/content/terminal/guides/intros/stocks/disc.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/content/terminal/guides/intros/stocks/disc.md b/website/content/terminal/guides/intros/stocks/disc.md index d41e69bc62e..18a067f7b60 100644 --- a/website/content/terminal/guides/intros/stocks/disc.md +++ b/website/content/terminal/guides/intros/stocks/disc.md @@ -5,7 +5,7 @@ description: Introducing the Discovery menu, within the Stocks menu. This guide --- The set of features within the Stocks Discovery submenu provides tools for discovering trade setups, for following trends, and for staying up with current events. Enter the menu from the Stocks menu by typing, `disc`, and pressing, `ENTER` (⏎). Absolute path jumping is possible from anywhere, to anywhere. For example, jumping from the Portfolio Optimization submenu to the Stocks Discovery submenu: -Absolute path jumping to the Stocks Discovery submenu +image ### How to use @@ -114,4 +114,4 @@ https://seekingalpha.com/news/3910095-nasdaq-sp-dow-trade-lower-on-fears-of-zero 2022-11-21 10:25:11 - 3909955 - Nasdaq, S&P, Dow slip as China COVID curbs hit sentiment https://seekingalpha.com/news/3909955-nasdaq-sp-500-dow-jones-stock-market -``` \ No newline at end of file +``` From dc65ed3f74c4c0aa3b623d0f6473387084d453de Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 09:55:51 +0100 Subject: [PATCH 10/37] Update fa.md --- website/content/terminal/guides/intros/stocks/fa.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/content/terminal/guides/intros/stocks/fa.md b/website/content/terminal/guides/intros/stocks/fa.md index b5fe7cb19e8..b1efd2a6380 100644 --- a/website/content/terminal/guides/intros/stocks/fa.md +++ b/website/content/terminal/guides/intros/stocks/fa.md @@ -10,7 +10,7 @@ The Fundamental Analysis menu is a set of tools for measuring a company's intrin Enter the submenu from the Stocks menu, with a ticker loaded. -Fundamental Analysis Menu +image Some commands offer interpretations of the data, but, the majority are statements reported to the SEC. The `overview` command is a table of basic statistics, including price. ```` @@ -500,4 +500,4 @@ Fiscal Date Ending 2020 https://www.sec.gov/Archives/edgar/data/1092796/000156459020029954/0001564590-20-029954-index.htm 2021 https://www.sec.gov/Archives/edgar/data/1092796/000156459021033352/0001564590-21-033352-index.htm 2022 https://www.sec.gov/Archives/edgar/data/1092796/000095017022012043/0000950170-22-012043-index.htm -``` \ No newline at end of file +``` From 6ccc468fd6b881b23daff13572850c496c13bd82 Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 09:56:47 +0100 Subject: [PATCH 11/37] Update gov.md --- website/content/terminal/guides/intros/stocks/gov.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/terminal/guides/intros/stocks/gov.md b/website/content/terminal/guides/intros/stocks/gov.md index e84f1b45e44..8aed21683be 100644 --- a/website/content/terminal/guides/intros/stocks/gov.md +++ b/website/content/terminal/guides/intros/stocks/gov.md @@ -6,7 +6,7 @@ description: This guide introduces the Government submenu, within the Stocks men 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 QuiverQuant. A ticker is not required to enter the menu; navigate there from anywhere in the terminal with absolute path jumping: `/stocks/gov` -![The Government Menu](https://user-images.githubusercontent.com/85772166/173205843-1d9d5679-df73-4ec3-8b98-937f38ccac35.png) +image ### How to use From 3f3e6dca8e0c52ccaac1737e0102ef8b8460c5bd Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 10:07:34 +0100 Subject: [PATCH 12/37] Update index since for some silly reason it used SPY --- .../terminal/guides/intros/stocks/index.md | 273 +++++++++--------- 1 file changed, 138 insertions(+), 135 deletions(-) diff --git a/website/content/terminal/guides/intros/stocks/index.md b/website/content/terminal/guides/intros/stocks/index.md index a83f0ecccc1..4c5fa8f75e1 100644 --- a/website/content/terminal/guides/intros/stocks/index.md +++ b/website/content/terminal/guides/intros/stocks/index.md @@ -36,19 +36,23 @@ news -h Which prints the reference information on the screen: ```console -usage: news [-d N_START_DATE] [-o] [-s SOURCES] [-h] [--export {csv,json,xlsx}] [-l LIMIT] [--source {Feedparser,NewsApi}] +usage: news [-t TICKER] [-d N_START_DATE] [-o] [-s SOURCES] [-h] [--export EXPORT] [--sheet-name SHEET_NAME [SHEET_NAME ...]] [-l LIMIT] + [--source {Feedparser,NewsApi}] latest news of the company optional arguments: + -t TICKER, --ticker TICKER + Ticker to get data for -d N_START_DATE, --date N_START_DATE The starting date (format YYYY-MM-DD) to search articles from -o, --oldest Show oldest articles first -s SOURCES, --sources SOURCES Show news only from the sources specified (e.g bloomberg,reuters) -h, --help show this help message - --export {csv,json,xlsx} - Export raw data into csv, json, xlsx + --export EXPORT Export raw data into csv, json, xlsx + --sheet-name SHEET_NAME [SHEET_NAME ...] + Name of excel sheet to save data to. Only valid for .xlsx files. -l LIMIT, --limit LIMIT Number of entries to show in data. --source {Feedparser,NewsApi} @@ -57,21 +61,9 @@ optional arguments: For more information and examples, use 'about news' to access the related guide. ``` -### Data Sources +The first step in many workflows will be to load a stock symbol with historical data. The amount, granularity, and market coverage will vary by source. Users can elect to subscribe to any of the data sources accordingly. While no API keys are required to get started using the Terminal, acquiring these credentials at the free level will enhance the user experience with additional functionality. Refer to the [API keys guide](https://docs.openbb.co/terminal/guides/advanced/api-keys) for links to obtain each. -The first step in many workflows will be to load a stock symbol with historical data. The amount, granularity, and market coverage will vary by source. Users can elect to subscribe to any of the data sources accordingly. While no API keys are required to get started using the Terminal, acquiring these credentials at the free level will enhance the user experience with additional functionality. Refer to the [API keys guide](https://docs.openbb.co/terminal/guides/advanced/api-keys) for links to obtain each. The data sources used in the Stocks menu that require API credentials are: - -- AlphaVantage -- EODHD -- Financial Modeling Prep -- News -- Polygon -- Quandl -- Tradier - -The data source for each function is located on the right-side of the menu. In the image below, this is depicted by the text in [blue]. - -![Stocks Menu](https://user-images.githubusercontent.com/85772166/205688600-afaf4663-37f7-492e-aa9b-7d5263abe27b.png "Stocks Menu") +image Attaching the source argument to a command enables users to select their preferred source. The default sources can be changed from the [`/sources` menu](https://docs.openbb.co/terminal/guides/advanced/changing-sources). To select the `source` as `NewsApi`, use the block below. @@ -79,28 +71,8 @@ Attaching the source argument to a command enables users to select their preferr news --source NewsApi ``` -### Sub-Menus - -Access the sub-menus, like `Fundamental Analysis` and `Technical Analysis`, by entering the abbreviation on the left-side of the screen, beside `>`, and pressing return. Alternatively, navigation can take the form of absolute paths. This makes it possible to quickly jump between all menus, from anywhere. - -[Fundamental Analysis](https://docs.openbb.co/terminal/guides/intros/stocks/fa) - -```console -/stocks/fa -``` - -[Technical Analysis](https://docs.openbb.co/terminal/guides/intros/common/ta) - -```console -/stocks/ta -``` - -Let's get started using the Stocks menu with some examples. - ## Examples -### Load - The `load` function is a starting point for most functions, and parameters can be adjusted for intraday and resolution. It has many optional arguments which can be displayed for reference by attaching, `-h`, or, `--help`, to any function. Entering: ```console @@ -110,12 +82,18 @@ load -h Prints the dialogue on the screen: ```console +usage: load [-t TICKER] [-s START] [-e END] [-i {1,5,15,30,60}] [-p] [-f FILEPATH] [-m] [-w] [--exchange] [--performance] [-h] [--export EXPORT] + [--sheet-name SHEET_NAME [SHEET_NAME ...]] [--source {YahooFinance,AlphaVantage,Polygon,EODHD,Intrinio}] + +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 TICKER, --ticker TICKER Stock ticker (default: None) -s START, --start START - The starting date (format YYYY-MM-DD) of the stock (default: 2020-01-09) - -e END, --end END The ending date (format YYYY-MM-DD) of the stock (default: 2023-01-13) + The starting date (format YYYY-MM-DD) of the stock (default: 2020-02-11) + -e END, --end END The ending date (format YYYY-MM-DD) of the stock (default: 2023-02-15) -i {1,5,15,30,60}, --interval {1,5,15,30,60} Intraday stock minutes (default: 1440) -p, --prepost Pre/After market hours. Only works for 'yf' source, and intraday data (default: False) @@ -127,74 +105,78 @@ optional arguments: --performance Show performance information. (default: False) -h, --help show this help message (default: False) --export EXPORT Export raw data into csv, json, xlsx (default: ) - --source {YahooFinance,AlphaVantage,Polygon,EODHD} + --sheet-name SHEET_NAME [SHEET_NAME ...] + Name of excel sheet to save data to. Only valid for .xlsx files. (default: None) + --source {YahooFinance,AlphaVantage,Polygon,EODHD,Intrinio} Data source to select from (default: YahooFinance) + +For more information and examples, use 'about load' to access the related guide. ``` By default, a daily period, with three-years of OHLC+V data, from YahooFinance, is loaded to memory. Use the default settings like this: ```console -load SPY +load MSFT ``` A message will print indicating the starting date from which the data begins. ```console -Loading Daily data for SPY with starting period 2019-11-27. +Loading Daily data for MSFT with starting period 2019-11-27. ``` A simple way to get the entire history available from a source is to use an arbitrary starting date from a long time ago, like `1900-01-01`. ```console -load SPY -s 1990-01-01 +load MSFT -s 1990-01-01 ``` The console print indicates the first date of history, provided by this source, is January 29, 1993. ```console -Loading Daily data for SPY with starting period 1993-01-29. +Loading Daily data for MSFT with starting period 1993-01-29. ``` A range-bound window can also be loaded; for example, the dot-com era: ```console -load SPY -s 1997-01-01 -e 2003-01-01 +load MSFT -s 1997-01-01 -e 2003-01-01 ``` The interval of the data can also be set as weekly or monthly; `-w` for weekly, and `-m` for monthly candles. The data will now start on a Monday or at the beginning of a month. ```console -load SPY -s 1997-01-01 -e 2003-01-01 -w +load MSFT -s 1997-01-01 -e 2003-01-01 -w ``` Intraday data is also requested this way, only using the `-i` or `--interval` argument. One-minute data can be loaded like this: ```console -load SPY -i 1 +load MSFT -i 1 ``` The performance table will not be displayed with intraday data, and we can see that five-days of one-minute candles are available from YahooFinance. ```console -Loading Intraday 1min data for SPY with starting period 2022-11-25. +Loading Intraday 1min data for MSFT with starting period 2022-11-25. ``` This can be augmented further by adding pre/post market price candles. The `-p` flag is only applicable to YahooFinance, Polygon will automatically include the candles from 4AM-8PM US/Eastern when intraday is selected. ```console -load spy -i 1 -p +load MSFT -i 1 -p ``` Data can also be exported directly from the `load` function as a CSV, JSON, or XLSX file. The file is created in the OpenBBUserData folder. ```console -load spy -s 1990-01-01 -m --export spy_monthly.csv +load MSFT -s 1990-01-01 -m --export msft_monthly.csv ``` ```console -Loading Daily data for SPY with starting period 1993-02-01. +Loading Daily data for MSFT with starting period 1993-02-01. -Saved file: /Users/{username}/OpenBBUserData/exports/spy_monthly.csv +Saved file: /Users/{username}/OpenBBUserData/exports/msft_monthly.csv ``` Exported files can also be loaded by declaring the `--file` argument. Place the file to import in the folder: `OpenBBUserData/custom_imports/stocks` @@ -204,10 +186,14 @@ Exported files can also be loaded by declaring the `--file` argument. Place the The `candle` command displays a chart of the loaded symbol. It needs no arguments to display, but modifiers can enhance the content of the chart. Commands can also be sequenced together with a `/` separating each individual command. ```console -/stocks/load SPY -s 1990-01-01 -m/candle +(🦋) /stocks/ $ load MSFT + +cLoading Daily data for MSFT with starting period 2020-02-11. + +(🦋) /stocks/ $ candle ``` -![candle](https://user-images.githubusercontent.com/85772166/205693156-18328092-f423-4a9b-a3c3-47319b3d27b3.png "candle") +![candle](https://user-images.githubusercontent.com/46355364/218981911-90d38930-a621-43cc-873a-1c55db842e95.png) The help dialogue for the `candle` command shows how this chart can be supplemented with additional data; specifically, `-t` for trend, `--ma` for moving averages, and `--log` for a log scale. @@ -218,22 +204,27 @@ candle -h Which prints to screen: ```console -usage: candle [-p] [--sort {adjclose,open,close,high,low,volume,returns,logret}] [-r] [--raw] [-t] [--ma MOV_AVG] [--log] [-h] [--export {csv,json,xlsx,png,jpg,pdf,svg}] [-l LIMIT] +usage: candle [-t TICKER] [-p] [--sort {adjclose,open,close,high,low,volume,returns,logret}] [-r] [--raw] [--trend] [--ma MOV_AVG] [--log] [-h] [--export EXPORT] [--sheet-name SHEET_NAME [SHEET_NAME ...]] [-l LIMIT] Shows historic data for a stock optional arguments: + -t TICKER, --ticker TICKER + Ticker to analyze (default: None) -p, --plotly Flag to show interactive plotly chart (default: True) --sort {adjclose,open,close,high,low,volume,returns,logret} Choose a column to sort by. Only works when raw data is displayed. (default: ) - -r, --reverse Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. (default: False) + -r, --reverse Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. + (default: False) --raw Shows raw data instead of chart. (default: False) - -t, --trend Flag to add high and low trends to candle (default: False) - --ma MOV_AVG Add moving average in number of days to plot and separate by a comma. Value for ma (moving average) keyword needs to be greater than 1. (default: None) + --trend Flag to add high and low trends to candle (default: False) + --ma MOV_AVG Add moving average in number of days to plot and separate by a comma. Value for ma (moving average) keyword needs to be greater than 1. + (default: None) --log Plot with y axis on log scale (default: False) -h, --help show this help message (default: False) - --export {csv,json,xlsx,png,jpg,pdf,svg} - Export raw data into csv, json, xlsx and figure into png, jpg, pdf, svg (default: ) + --export EXPORT Export raw data into csv, json, xlsx and figure into png, jpg, pdf, svg (default: ) + --sheet-name SHEET_NAME [SHEET_NAME ...] + Name of excel sheet to save data to. Only valid for .xlsx files. (default: None) -l LIMIT, --limit LIMIT Number of entries to show in data. (default: 20) @@ -243,14 +234,10 @@ For more information and examples, use 'about candle' to access the related guid Be sure to adjust the values for moving averages to correspond with the interval of the data loaded. Below adds movings averages for one and four year periods (because data loaded is monthly), and changes the y-axis to a log-scale. ```console -candle --ma 12,48 --log +candle --ma 20,30 --log ``` -![candle](https://user-images.githubusercontent.com/85772166/205697995-f4032ab5-143b-461b-a016-5b8e91a40374.png "candle") - -The look and feel of the `candle` chart can be altered with [custom style sheets](https://matplotlib.org/stable/tutorials/introductory/customizing.html#the-default-matplotlibrc-file) placed in `OpenBBUserData/styles/user`. - -### News +![candle moving average log](https://user-images.githubusercontent.com/46355364/218982220-411e780a-aa8d-436e-b2db-3c95a981b6eb.png) Get ticker-related news headlines by entering `news` after loading a ticker. @@ -261,45 +248,43 @@ news --source NewsApi The output will look like: ```console -135 news articles for SPDR+S&P+500 were found since 2022-11-24 +(🦋) /stocks/ $ news --source NewsApi - Earnings Results: Big Lots to address weak results with even lower prices: ‘We will own bargains and treasures’ -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Content ┃ -┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ -│ 2022-12-01 18:41:00 │ -├──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│ Big Lots says it will address weak results by leaning into bargains and treasures in a much bigger way. │ -├──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│ https://www.marketwatch.com/story/big-lots-to-address-weak-results-with-even-lower-prices-we-will-own-bargains-and-treasures-11669920117 │ -└──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ +346 news articles for Tesla,+Inc. were found since 2023-02-08 - Costco's Sales Update Slams the Stock. Strong Grocery Sales Weren't Enough. -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Content ┃ -┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ -│ 2022-12-01 17:48:00 │ -├────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│ Sales of food and sundries climbed by double digits, while, non-food categories were largely lower, hurt by products like electronics and jewelry. │ -├────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│ https://www.barrons.com/articles/costco-november-sales-51669916824 │ -└────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ - - Investors Pull $8 Billion From Major Stock ETFs -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Content ┃ -┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ -│ 2022-12-01 17:34:05 │ -├─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│ (Bloomberg) -- Exchange-traded fund investors took Wednesday’s stock-market surge as an opportunity to offload $8 billion of holdings in two of the │ -│ biggest equity funds. Most Read from Bloomberg Investors pulled $5.8 billion from the $380 billion SPDR S&P 500… │ -├─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│ https://biztoc.com/x/b81c9c421015a955 │ -└─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ + Elon Musk says he may lead Twitter for almost another year +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Content ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ +│ 2023-02-15 07:57:55 │ +├───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│ The billionaire executive embarked on a search for a new CEO for Twitter in December, a person familiar with the search said at the time. │ +├───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│ https://www.moneycontrol.com/news/world/elon-musk-says-he-may-lead-twitter-for-almost-another-year-10088481.html │ +└───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ + Elon Musk Gave $1.9 Billion of Tesla Shares to Charity Last Year +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Content ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ +│ 2023-02-15 06:46:08 │ +├────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│ Tesla CEO Elon Musk now owns around 13% of the company. Elon Musk donated roughly $1.9 billion of Tesla Inc. stock to charity last year, according to a regulatory │ +│ filing made Tuesday. Mr. Musk, Tesla’s chief executive, reported having donated roughly 11.6 mil… │ +├────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│ https://biztoc.com/x/99aa746544171bae │ +└────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ + Elon Musk Aims to Find Twitter CEO Successor Toward End of 2023 +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Content ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ +│ 2023-02-15 06:14:49 │ +├───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│ Elon Musk is aiming to find his successor to lead Twitter Inc. as chief executive officer toward the end of 2023. │ +├───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│ https://www.bloomberg.com/news/articles/2023-02-15/musk-aims-to-replace-himself-as-twitter-ceo-toward-end-of-2023 │ +└───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ ``` -### TOB - The `tob` function is the "Top of Book", and it returns data during market hours. ```console @@ -325,8 +310,6 @@ Which displays an output like: └──────────┴───────────┴───────────┴──────────┘ ``` -### Quote - Get the current market price, during exchange hours. ```console @@ -336,35 +319,57 @@ quote Displays a table: ```console - Ticker Quote -┏━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┓ -┃ ┃ SPY ┃ -┡━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━┩ -│ Name │ SPDR S&P 500 │ -├────────────────┼──────────────┤ -│ Price │ 407.69 │ -├────────────────┼──────────────┤ -│ Open │ 408.77 │ -├────────────────┼──────────────┤ -│ High │ 410.00 │ -├────────────────┼──────────────┤ -│ Low │ 404.75 │ -├────────────────┼──────────────┤ -│ Previous Close │ 407.68 │ -├────────────────┼──────────────┤ -│ Volume │ 52,458,993 │ -├────────────────┼──────────────┤ -│ 52 Week High │ 479.98 │ -├────────────────┼──────────────┤ -│ 52 Week Low │ 348.11 │ -├────────────────┼──────────────┤ -│ Change │ 0.01 │ -├────────────────┼──────────────┤ -│ Change % │ 0.00% │ -└────────────────┴──────────────┘ -``` +(🦋) /stocks/ $ quote -### Codes + TSLA Quote +┏━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┓ +┃ ┃ ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━┩ +│ Symbol │ TSLA │ +├───────────────────────┼─────────────────────┤ +│ Name │ Tesla, Inc. │ +├───────────────────────┼─────────────────────┤ +│ Price │ 209.25 │ +├───────────────────────┼─────────────────────┤ +│ Changes percentage │ 7.51 │ +├───────────────────────┼─────────────────────┤ +│ Change │ 14.61 │ +├───────────────────────┼─────────────────────┤ +│ Day low │ 189.45 │ +├───────────────────────┼─────────────────────┤ +│ Day high │ 209.82 │ +├───────────────────────┼─────────────────────┤ +│ Year high │ 384.29 │ +├───────────────────────┼─────────────────────┤ +│ Year low │ 101.81 │ +├───────────────────────┼─────────────────────┤ +│ Market cap │ 662.088 B │ +├───────────────────────┼─────────────────────┤ +│ Price avg50 │ 152.95 │ +├───────────────────────┼─────────────────────┤ +│ Price avg200 │ 225.47 │ +├───────────────────────┼─────────────────────┤ +│ Exchange │ NASDAQ │ +├───────────────────────┼─────────────────────┤ +│ Volume │ 214.769 M │ +├───────────────────────┼─────────────────────┤ +│ Avg volume │ 156755621 │ +├───────────────────────┼─────────────────────┤ +│ Open │ 191.94 │ +├───────────────────────┼─────────────────────┤ +│ Previous close │ 194.64 │ +├───────────────────────┼─────────────────────┤ +│ Eps │ 3.44 │ +├───────────────────────┼─────────────────────┤ +│ Pe │ 60.83 │ +├───────────────────────┼─────────────────────┤ +│ Earnings announcement │ 2023-04-18 10:59:00 │ +├───────────────────────┼─────────────────────┤ +│ Shares outstanding │ 3.164 B │ +├───────────────────────┼─────────────────────┤ +│ Timestamp │ 1676408405 │ +└───────────────────────┴─────────────────────┘ +``` `codes` prints the CIK, Composite FIGI, Share Class FIGI, and SIC codes - when available - for a US-listed stock. This function requires a free API key from Polygon. @@ -389,8 +394,6 @@ Prints the output: └──────────────────┴──────────────┘ ``` -### Search - The `search` function provides a way to find stocks by name, region, sector, industry and exchange location. The results can be easily exported as a CSV, JSON, or XLSX file. ```console @@ -402,8 +405,8 @@ Prints the help dialogue for the command: ```console usage: search [-q QUERY [QUERY ...]] [-c country] [-s sector] [-i industry] [-e exchange] [-a] [-h] [--export EXPORT] [--sheet-name SHEET_NAME [SHEET_NAME ...]] [-l LIMIT] -Show companies matching the search query, country, sector, industry and/or exchange. Note that by default only the United States exchanges are searched which tend to contain the most extensive -data for each company. To search all exchanges use the --all-exchanges flag. +Show companies matching the search query, country, sector, industry and/or exchange. Note that by default only the United States exchanges are searched which tend +to contain the most extensive data for each company. To search all exchanges use the --all-exchanges flag. optional arguments: -q QUERY [QUERY ...], --query QUERY [QUERY ...] From 187a9700eb8c6d54a74fa92a6502cb9d724439bc Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 10:09:11 +0100 Subject: [PATCH 13/37] Update ins.md --- website/content/terminal/guides/intros/stocks/ins.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/terminal/guides/intros/stocks/ins.md b/website/content/terminal/guides/intros/stocks/ins.md index d96f63adc99..a5a30b317b9 100644 --- a/website/content/terminal/guides/intros/stocks/ins.md +++ b/website/content/terminal/guides/intros/stocks/ins.md @@ -6,7 +6,7 @@ description: This guide introduces the Insider Trading submenu, within the Stock The Insider Trading menu gives stock screener for SEC Form 4 filings and researching individual companies for executive and director transactions. Navigate to the Insider Trading submenu from the `stocks` menu by typing `ins` and pressing `enter`. The features in this menu function only for companies registered with the SEC, that also trade in public markets. -Insider Trading Menu +image ### How to use From ff81210852e80b326b2747fe21c69da29023e836 Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 10:11:01 +0100 Subject: [PATCH 14/37] Update screener.md --- website/content/terminal/guides/intros/stocks/screener.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/website/content/terminal/guides/intros/stocks/screener.md b/website/content/terminal/guides/intros/stocks/screener.md index 022a848bafe..47ebc461b38 100644 --- a/website/content/terminal/guides/intros/stocks/screener.md +++ b/website/content/terminal/guides/intros/stocks/screener.md @@ -5,7 +5,7 @@ description: This guide introduces the Stock Screener, within the Stocks menu, b --- The Stock sScreener menu is a diverse tool for stock discovery. There are categories of statistics to use as metrics to sort the criteria defined in the preset file. The preset files are `.ini` files stored locally in the application folder: `~/OpenBBUserData/presets/stocks/screener` and they can be modified in any text editor. Get to the Stock Screener from the `Stocks` menu by typing `scr` and then pressing `enter`. -The Stock Screener submenu +image ### How to use @@ -54,11 +54,11 @@ To get started, simply choose one of the categories, like `technical`. The columns can be sorted with the optional argument `-s`, and autocomplete will present a list of choices. -Sorting results +Sorting results To see a description of each preset, use `view`, and autocomplete will allow the user to scroll presets with the arrow keys to `set` the choice. -Autocomplete with the set function +image ### Examples @@ -167,4 +167,4 @@ Using `set triangle_ascending.ini`, show `techincal` & `overview` tables: ├────────┼───────────────────────────────────────────┼─────────────────┼─────────────────────────────┼────────────────┼────────────┼────────┼───────┼────────┼─────────┤ │ ORLA │ Orla Mining Ltd. │ Basic Materials │ Gold │ Canada │ 1.1 B │ 350.00 │ 3.73 │ 0.07 │ 331.2 K │ └────────┴───────────────────────────────────────────┴─────────────────┴─────────────────────────────┴────────────────┴────────────┴────────┴───────┴────────┴─────────┘ -``` \ No newline at end of file +``` From f841a2a3b46d8f953f84b86749c1649eab2f6e61 Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 10:20:10 +0100 Subject: [PATCH 15/37] Update sia.md --- .../terminal/guides/intros/stocks/sia.md | 25 ++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/website/content/terminal/guides/intros/stocks/sia.md b/website/content/terminal/guides/intros/stocks/sia.md index 23429069833..2d3b1d7c8e7 100644 --- a/website/content/terminal/guides/intros/stocks/sia.md +++ b/website/content/terminal/guides/intros/stocks/sia.md @@ -7,4 +7,27 @@ A sector analysis is a study of the economic and financial state and prospects o The most promising sectors are chosen first under the top-down strategy, and then the investor evaluates stocks within that sector to choose which ones will be purchased. Investing in specific equities or using sector-based exchange-traded funds can be used to implement a sector rotation strategy (ETFs). -SIA Menu +## How to use + +When you have loaded in a ticker, the menu automatically finds the corresponding industry, sector, country and market cap. + +image + +Based on this information, you can get insights in a variety of datapoints, for example with `cps` you are able to see the companies based per sector and market cap: + +![CPS](https://user-images.githubusercontent.com/46355364/218984262-a5b5e8e7-ddd3-4b07-80b2-40c9e760f102.png) + +Whenever you want to adjust the parameters you can do so with `industry`, `sector`, `country` and `mktcap`. These have multiple options depending on your selection as you will see that the options expand when you use `clear` followed by a param, e.g. `clear --param mktcap` which removes the market cap value: + +``` +│ Industry : Auto Manufacturers │ +│ Sector : Consumer Cyclical │ +│ Country : United States │ +│ Market Cap : │ +│ Exclude Exchanges : True │ +│ Period : Annual +``` + +This means that if you now obtain data for this selection, you get data for all companies in this combination of industry, sector and country instead of just the ones that have a Mega Cap. In the case of our loaded ticker, TSLA, it was quite clear that with this parameter only a few companies would show up whereas if we now use `metric --metric roa`, displaying the Return on Assets (RoA) gives a lot more insights. + +![Metric ROA](https://user-images.githubusercontent.com/46355364/218985528-755a6c27-fa41-4c62-b115-d38a1e0c2a5d.png) From 2fb7e0291b554216b4bf50d4114dc5ccea416e11 Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 10:21:58 +0100 Subject: [PATCH 16/37] Update tradinghours.md --- .../guides/intros/stocks/tradinghours.md | 45 +++++++++++++++++-- 1 file changed, 41 insertions(+), 4 deletions(-) diff --git a/website/content/terminal/guides/intros/stocks/tradinghours.md b/website/content/terminal/guides/intros/stocks/tradinghours.md index 1ba86d50fb4..c40a3bf9bd5 100644 --- a/website/content/terminal/guides/intros/stocks/tradinghours.md +++ b/website/content/terminal/guides/intros/stocks/tradinghours.md @@ -5,9 +5,9 @@ description: An Introduction to the Trading Hours menu, within the Stocks menu. --- This set of features is for checking the operating status of markets globally. To access the Trading Hours features, enter `th` from the Stocks menu. Alternatively, a user can access the submenu with absolute path navigation from anywhere in the Terminal: `/stocks/th` -Trading Hours +image -### How to use +## How to use A symbol is not required to be loaded. Once in the Trading Hours menu, the operation is simple. Choose from: open, closed, all or exchange. @@ -91,9 +91,46 @@ Below, examples are given what these commands display, note that the tables are ```` Lastly, exchange shows the status of a single venue. -Trading Hours Autocomplete +``` +(🦋) /stocks/th/ $ exchange --name ARCA + + PCX NYSE Arca + Name: name, dtype: object +┏━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ ┃ PCX ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ +│ name │ NYSE Arca │ +├───────────────────────┼──────────────────────────────────────────────┤ +│ short_name │ ARCA │ +├───────────────────────┼──────────────────────────────────────────────┤ +│ website │ https://www.nyse.com/markets/hours-calendars │ +├───────────────────────┼──────────────────────────────────────────────┤ +│ market_open │ 09:30:00 │ +├───────────────────────┼──────────────────────────────────────────────┤ +│ market_close │ 16:00:00 │ +├───────────────────────┼──────────────────────────────────────────────┤ +│ lunchbreak_start │ None │ +├───────────────────────┼──────────────────────────────────────────────┤ +│ lunchbreak_end │ None │ +├───────────────────────┼──────────────────────────────────────────────┤ +│ opening_auction_start │ 04:00:00 │ +├───────────────────────┼──────────────────────────────────────────────┤ +│ opening_auction_end │ 09:30:00 │ +├───────────────────────┼──────────────────────────────────────────────┤ +│ closing_auction_start │ 16:00:00 │ +├───────────────────────┼──────────────────────────────────────────────┤ +│ closing_auction_end │ 20:00:00 │ +├───────────────────────┼──────────────────────────────────────────────┤ +│ timezone │ US/Eastern │ +├───────────────────────┼──────────────────────────────────────────────┤ +│ flag │ 🇺🇸 │ +├───────────────────────┼──────────────────────────────────────────────┤ +│ open │ False │ +└───────────────────────┴──────────────────────────────────────────────┘ +``` + +## Examples -### Examples Below an example is given for a symbol and whether that market is open. By calling exchange you can obtain more information about the exchange (e.g. enter `BO`) ```` (🦋) /stocks/th/ $ symbol RY.TO From 4367e73569a1a3bc27267d2e4aba4592356d5647 Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 10:23:40 +0100 Subject: [PATCH 17/37] Update index.md --- .../guides/intros/stocks/options/index.md | 23 ++++++------------- 1 file changed, 7 insertions(+), 16 deletions(-) diff --git a/website/content/terminal/guides/intros/stocks/options/index.md b/website/content/terminal/guides/intros/stocks/options/index.md index d76ae572548..48118ad881b 100644 --- a/website/content/terminal/guides/intros/stocks/options/index.md +++ b/website/content/terminal/guides/intros/stocks/options/index.md @@ -9,35 +9,30 @@ The Options menu provides the user with a comprehensive set of tools for analyzi Navigate to the menu by typing `options`, from the `Stocks` menu, and then pressing enter. Alternatively, absolute path navigation can jump straight there, from anywhere. `/stocks/options` -![The Options Menu](https://user-images.githubusercontent.com/85772166/172717122-a857dd69-6e79-4773-996a-74ea71f8ee86.png) +image By default, the Terminal loads a ticker using Tradier as the source. Sign up for a free developer account and then enter that token using the `Keys menu`. 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. ```` (🦋) /stocks/options/ $ load -h -usage: load [-t TICKER] [--source {tradier,yf}] [-h] +usage: load [-t TICKER] [-h] [--source {YahooFinance,Tradier,Nasdaq,Intrinio}] Load a ticker into option menu optional arguments: -t TICKER, --ticker TICKER Stock ticker (default: None) - --source {tradier ,yf} Tradier or Yahoo Finance (default: tr) - Source to get option expirations from (default: None) -h, --help show this help message (default: False) + --source {YahooFinance,Tradier,Nasdaq,Intrinio} + Data source to select from (default: YahooFinance) + +For more information and examples, use 'about load' to access the related guide. ```` -### Submenus Available - -At the bottom of the menu, and near the top, there are items prefaced with `>`. Like everywhere else in the OpenBB Terminal, this indicates the presence of a submenu. - - - `screen` is a dedicated options screener that uses `.ini` files from the local installation folder `/OpenBBUserData/stocks/presets/options/`. Refer to the Options Screener guide here. - - `pricing` is another method for calculating options prices. See the guide for this submenu here. - - `hedge` is a group of features for calculating a delta-neutral position. The guide for this submenu is located here. - ### Examples To begin, a ticker must be loaded with an expiration date selected. Enter these commands to display the list of expiration dates for AAPL options chains. + ```` (🦋) /stocks/options/ $ load aapl @@ -94,10 +89,6 @@ Choose an expiration date with the corresponding Identifier value on the left, f Expiration set to 2023-09-15 ```` -Setting the chain for analysis will change the text colour at the bottom of the Options menu. These commands require loaded data. - -![The Options menu with a loaded ticker and expiration date](https://user-images.githubusercontent.com/85772166/172724623-dbb16566-5dfa-482c-a67e-948e01444ca8.png) - The `info` command displays a table of statistics regarding the chosen option expiration date. ```` (🦋) /stocks/options/ $ info From 84f946dc188553c40e02db7dfadec49e3b35b975 Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 10:27:18 +0100 Subject: [PATCH 18/37] Update hedge.md --- .../guides/intros/stocks/options/hedge.md | 80 ++++++++++++++----- 1 file changed, 59 insertions(+), 21 deletions(-) diff --git a/website/content/terminal/guides/intros/stocks/options/hedge.md b/website/content/terminal/guides/intros/stocks/options/hedge.md index b92abdff079..ef78668cc95 100644 --- a/website/content/terminal/guides/intros/stocks/options/hedge.md +++ b/website/content/terminal/guides/intros/stocks/options/hedge.md @@ -5,40 +5,78 @@ excerpt: This guide introduces the Hedge submenu, within the Options menu, provi --- The Hedge menu is designed to help the user calculate positions within the selected expiration chain to be directionally neutral. Enter the submenu after choosing the desired expiration date by using the command, `hedge`, from the Options menu. -![The Options Hedge Submenu](https://user-images.githubusercontent.com/85772166/172286199-ec6e202d-4955-4557-9ba6-7d4db6fbdd55.png) +image ### How to use The first step is to pick the underlying position for the calculation. Scroll the list populated by autocomplete, or type in the choice. -![Picking underlying position](https://user-images.githubusercontent.com/85772166/172286267-9c164764-271f-4847-adc7-52bfb82e1138.png) +``` +(🦋) /stocks/options/hedge/ $ pick --pick 130_long_call +``` The strike prices for puts and calls are shown with the `list` command. Use this table to add or remove options from the calculation. -![List of strikes](https://user-images.githubusercontent.com/85772166/172286323-62e69fe1-dc37-42a1-8fdb-d3287ff0ac38.png) +``` +(🦋) /stocks/options/hedge/ $ list + + Available Calls and Puts +┏━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┓ +┃ Identifier ┃ Calls ┃ Puts ┃ +┡━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━┩ +│ 0 │ 110.00 │ 110.00 │ +├────────────┼────────┼────────┤ +│ 1 │ 115.00 │ 115.00 │ +├────────────┼────────┼────────┤ +│ 2 │ 120.00 │ 120.00 │ +├────────────┼────────┼────────┤ +│ 3 │ 125.00 │ 125.00 │ +├────────────┼────────┼────────┤ +│ 4 │ 130.00 │ 130.00 │ +├────────────┼────────┼────────┤ +│ 5 │ 135.00 │ 135.00 │ +├────────────┼────────┼────────┤ +│ 6 │ 140.00 │ 140.00 │ +├────────────┼────────┼────────┤ +│ 7 │ 145.00 │ 145.00 │ +├────────────┼────────┼────────┤ +│ 8 │ 150.00 │ 150.00 │ +├────────────┼────────┼────────┤ +│ 9 │ 155.00 │ 155.00 │ +├────────────┼────────┼────────┤ +│ 10 │ 160.00 │ 160.00 │ +├────────────┼────────┼────────┤ + + +``` Add the first option with the corresponding index number for the strike price, attaching flags for a put and for short, `-s` & `-p`. -![Adding Option A to the calculation](https://user-images.githubusercontent.com/85772166/172286367-a15f57fe-a10f-402c-9bf6-5e7dd34dedb4.png) +``` +(🦋) /stocks/options/hedge/ $ add 70 -The `rmv` command removes added options. With an underlying position and two positions added, `sop` will display the results based on the inputs provided. +┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┓ +┃ ┃ Positions ┃ +┡━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━┩ +│ Delta │ 0.00 │ +├────────────────────┼───────────┤ +│ Gamma │ 0.00 │ +├────────────────────┼───────────┤ +│ Vega │ 0.00 │ +├────────────────────┼───────────┤ +│ Implied Volatility │ 0.50 │ +├────────────────────┼───────────┤ +│ Strike Price │ 350.00 │ +└────────────────────┴───────────┘ -![Position sizing for delta neutral](https://user-images.githubusercontent.com/85772166/172286429-a0d6710d-a5a0-49e5-9938-f3b9aaebb236.png) + Current Option Positions +┏━━━━━━┳━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━┳━━━━━━━━━━┓ +┃ Type ┃ Hold ┃ Strike ┃ Implied Volatility ┃ Cost ┃ Currency ┃ +┡━━━━━━╇━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━╇━━━━━━━━━━┩ +│ Call │ Long │ 350.00 │ 0.50 │ 0.01 │ USD │ +└──────┴──────┴────────┴────────────────────┴──────┴──────────┘ +``` `plot` will display an options payoff chart, using the provided values. -![Options payoff diagram](https://user-images.githubusercontent.com/85772166/172286525-4ede89ec-4ed7-4843-a0fa-ec306efe3b67.png) - -### Examples - -Substituting Option A for a different trade. - -![Hedge Example](https://user-images.githubusercontent.com/85772166/172286582-1f5e153a-a900-427a-a7fc-f596648de599.png) - -Substuting Option B from the same example above. - -![Hedge Example](https://user-images.githubusercontent.com/85772166/172286627-0f6f6a60-d76c-4e24-9fdd-8e65e137097e.png) - -Moving Option B down one strike. - -![Hedge Example](https://user-images.githubusercontent.com/85772166/172286669-82a98127-fe74-43fd-bcc9-ed874f746bdc.png) \ No newline at end of file +![Figure_1](https://user-images.githubusercontent.com/46355364/218987648-a5218bc4-8c27-49ce-9ca4-4275035d5525.png) From 508ed5334f5cb6b6cf18b639444cb49a28b3b2f6 Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 10:29:42 +0100 Subject: [PATCH 19/37] Update pricing.md --- .../guides/intros/stocks/options/pricing.md | 55 ++++++++++++++----- 1 file changed, 40 insertions(+), 15 deletions(-) diff --git a/website/content/terminal/guides/intros/stocks/options/pricing.md b/website/content/terminal/guides/intros/stocks/options/pricing.md index 9594b0bf222..5e2efc1470b 100644 --- a/website/content/terminal/guides/intros/stocks/options/pricing.md +++ b/website/content/terminal/guides/intros/stocks/options/pricing.md @@ -8,28 +8,53 @@ This set of features is for composing hypothetical outcomes through user-defined The Pricing submenu is accessible after selecting anexpiration date for the options chain. Type, `pricing`, and press enter for access. -![The Options Pricing Submenu](https://user-images.githubusercontent.com/85772166/172729310-dd341d26-c55e-4e29-a190-3e1eea1a6950.png) +image -### How to use +## How to use -Use the `add` command to build the list, and use the `rmv` command to take away any entries. +Use the `add` command to build the list, and use the `rmv` command to take away any entries. `show` will print a table of the inputs. Multiple price points can be added, assuming that probability always sums at 100%. -![Add and remove](https://user-images.githubusercontent.com/85772166/172732199-cb6f0cc9-0713-4bab-8e0c-5cd3e458f74a.png) +``` +(🦋) /stocks/options/pricing/ $ add -p 125 -c 1 -`show` will print a table of the inputs. Multiple price points can be added, assuming that probability always sums at 100%. -![Calculated outputs for calls](https://user-images.githubusercontent.com/85772166/172732726-09fcdcda-cb2a-46fd-ba0b-23c3b27c6067.png) +(🦋) /stocks/options/pricing/ $ show -

Examples

+Estimated price(s) of MSFT at 2023-02-17 +┏━━━━━━━━┳━━━━━━━━┓ +┃ Price ┃ Chance ┃ +┡━━━━━━━━╇━━━━━━━━┩ +│ 125.00 │ 1.00 │ +└────────┴────────┘ +``` + +## Examples Adding the optional argument, `-p`, will calculate the puts in the chain. -![Calculating for puts](https://user-images.githubusercontent.com/85772166/172733009-5a58a7f2-577d-4599-956e-29df2cdb3f91.png) +``` +(🦋) /stocks/options/pricing/ $ rnval -p -m 70 -M 150 -r 1.25 -Removing the risk-free rate variable makes a substantial difference to the calculated value of an option. - -![Puts calculations with RFR = 0](https://user-images.githubusercontent.com/85772166/172733137-8588b7a5-6384-4ba4-9d3c-943a10af280d.png) - -RFR as 0 for call options - -![RFR as 0 for call options](https://user-images.githubusercontent.com/85772166/172734277-223f855a-8ad1-4f45-ad5b-0a1d92d94290.png) \ No newline at end of file + Risk Neutral Values +┏━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━┳━━━━━━━━━━━━┓ +┃ Strike ┃ Last Price ┃ Value ┃ Difference ┃ +┡━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━╇━━━━━━━━━━━━┩ +│ 110.00 │ 0.02 │ 0.00 │ 0.02 │ +├────────┼────────────┼───────┼────────────┤ +│ 115.00 │ 0.01 │ 0.00 │ 0.01 │ +├────────┼────────────┼───────┼────────────┤ +│ 120.00 │ 0.01 │ 0.00 │ 0.01 │ +├────────┼────────────┼───────┼────────────┤ +│ 125.00 │ 0.02 │ 0.00 │ 0.02 │ +├────────┼────────────┼───────┼────────────┤ +│ 130.00 │ 0.01 │ 4.98 │ -4.97 │ +├────────┼────────────┼───────┼────────────┤ +│ 135.00 │ 0.01 │ 9.96 │ -9.95 │ +├────────┼────────────┼───────┼────────────┤ +│ 140.00 │ 0.01 │ 14.93 │ -14.92 │ +├────────┼────────────┼───────┼────────────┤ +│ 145.00 │ 0.01 │ 19.91 │ -19.90 │ +├────────┼────────────┼───────┼────────────┤ +│ 150.00 │ 0.01 │ 24.89 │ -24.88 │ +└────────┴────────────┴───────┴────────────┘ +``` From 4ead1c0884e0c08041332eaca20ad575f407666b Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 10:35:04 +0100 Subject: [PATCH 20/37] Update screener.md --- .../terminal/guides/intros/stocks/options/screener.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/website/content/terminal/guides/intros/stocks/options/screener.md b/website/content/terminal/guides/intros/stocks/options/screener.md index 11cd0997fda..4670b12089c 100644 --- a/website/content/terminal/guides/intros/stocks/options/screener.md +++ b/website/content/terminal/guides/intros/stocks/options/screener.md @@ -5,7 +5,7 @@ description: This guide introduces the user to the Options Screener, located wit --- The OpenBB options screener is a versatile discovery tool for an options trader. -![The Options Screener Menu](https://user-images.githubusercontent.com/85772166/172467269-8752d7fe-a9c6-4cf6-bc6f-3f5a011037e4.png) +image The screener makes use of presets (.ini files) that are stored locally within `~/OpenBBUserData/presets/stocks/options/` @@ -192,7 +192,7 @@ max-vega-100d = min-rho-100d = max-rho-100d = ```` -### How to use +## How to use The commands `set` and `view` will show the filters present. The command reads the contents of the preset file every time the command is called, which makes changes fast and easy; simply open it in a text editor. @@ -222,11 +222,8 @@ The columns for the output of the screener have been abbreviated to be: ```` CS: Contract Symbol; S: Symbol, T: Option Type; Str: Strike; Exp v: Expiration; IV: Implied Volatility; LP: Last Price; B: Bid; A: Ask; V: Volume; OI: Open Interest; Y: Yield; MY: Monthly Yield; SMP: Regular Market Price; SMDL: Regular Market Day Low; SMDH: Regular Market Day High; LU: Last Trade Date; LC: Last Crawl; ITM: In The Money; PC: Price Change; PB: Price-to-book. ```` -The default number of results returned is 10, add the `-l` flag with the number of desired results to change. -![Options Screener preset: Highest OI](https://user-images.githubusercontent.com/85772166/172467821-9f548d96-c97a-4933-86b4-7eb0946bc6db.png) - -

Examples

+## Examples Using the preset, "3DTE_Degenerate": @@ -238,4 +235,4 @@ Using the preset, "SPY_ATM_POOTS": The video below shows the process for building an options screener preset. Any simple text editor will work to make changes. Build a preset and share it with OpenBB on social media! -![Options Template Screener Demo](https://user-images.githubusercontent.com/85772166/172468268-fc839bf1-54f1-4e91-b1e2-82c8e711dea4.gif) \ No newline at end of file +![Options Template Screener Demo](https://user-images.githubusercontent.com/85772166/172468268-fc839bf1-54f1-4e91-b1e2-82c8e711dea4.gif) From 9fb2f786e762e876064553e4c6eae13261ebb9bb Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 10:40:26 +0100 Subject: [PATCH 21/37] Update econometrics.md --- .../terminal/guides/intros/econometrics.md | 66 ++++++++++--------- 1 file changed, 34 insertions(+), 32 deletions(-) diff --git a/website/content/terminal/guides/intros/econometrics.md b/website/content/terminal/guides/intros/econometrics.md index a6007bbdfcf..7cfc9dc9093 100644 --- a/website/content/terminal/guides/intros/econometrics.md +++ b/website/content/terminal/guides/intros/econometrics.md @@ -10,7 +10,7 @@ The Econometrics menu's purpose is to provide the user the ability to perform st The Econometrics menu is called upon by typing `econometrics` which opens the following menu: -![Econometrics Menu OpenBB Terminal](https://user-images.githubusercontent.com/46355364/174588406-7f120cf7-933e-4bef-a7f6-ba0c7c7d5028.png) +image You have the ability to load in your own custom datasets but there is also the option to use example datasets which are used within this guide as well. These datasets can be found by using the load command and typing `load --examples`. See below: @@ -88,20 +88,22 @@ As there is a clear difference between time series data, which is 1-dimensional To demonstrate the usage of the menu, the longley dataset is loaded in. This can be done by `load longley` as shown below: ``` -2022 Jun 20, 04:36 (🦋) /econometrics/ $ load longley +(🦋) /econometrics/ $ load --file longley + + +(🦋) /econometrics/ $ ? -2022 Jun 20, 04:38 (🦋) /econometrics/ $ ? ╭─────────────────────────────────────────────────────────────────────────────────────────────────── Econometrics ───────────────────────────────────────────────────────────────────────────────────────────────────╮ │ │ │ Looking for data in: │ -│ │ -│ /Users/jeroenbouma/Documents/OpenBB Terminal/custom_imports │ +│ /Users/jeroenbouma/OpenBBUserData/exports │ +│ /Users/jeroenbouma/OpenBBUserData/custom_imports/econometrics │ │ │ │ load load a dataset (also works with StatsModels datasets) │ │ remove remove one of the loaded datasets │ │ │ │ Loaded files and data columns: │ -│ longley : totemp, gnpdefl, gnp, unemp, armed, pop, year │ +│ longley : totemp, gnpdefl, gnp, unemp, armed, pop, year │ │ │ │ Exploration: │ │ show show a portion of a loaded dataset │ @@ -129,13 +131,13 @@ To demonstrate the usage of the menu, the ols command. To see a portion of this dataset, the show command can be used as shown below: ``` -2022 Jun 20, 04:38 (🦋) /econometrics/ $ show +(🦋) /econometrics/ $ show Dataset longley | Showing 10 of 16 rows ┏━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━┓ @@ -166,7 +168,7 @@ Beneath `Loaded files and data columns` you can find the longley dataset and its This can be extended by also showing the descriptive statistics, this can be done with the desc command and including the `longley` dataset. This command also allows descriptive statistics for individual columns to be displayed (e.g. `desc longley.totemp`) ``` -2022 Jun 20, 04:44 (🦋) /econometrics/ $ desc longley +(🦋) /econometrics/ $ desc longley Statistics for dataset: 'longley' ┏━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━┓ @@ -193,7 +195,7 @@ This can be extended by also showing the descriptive statistics, this can be don It is possible to check for a variety of assumptions, e.g. normality, unit root, granger and co-integration. The commands `norm` and `root` are shown below. Note that due to the small size of the dataset, many of these tests are not statistically significant. ``` -2022 Jun 20, 04:49 (🦋) /econometrics/ $ norm longley.gnp +(🦋) /econometrics/ $ norm longley.gnp Normality test from dataset 'longley' of 'gnp' ┏━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┓ @@ -205,7 +207,7 @@ It is possible to check for a variety of assumptions, e.g. normality, unit root, └───────────┴──────────┴──────────┴─────────────┴──────────────┴────────────────────┘ -2022 Jun 20, 04:49 (🦋) /econometrics/ $ root longley.pop +(🦋) /econometrics/ $ root longley.pop Unitroot from dataset 'longley of 'pop' ┏━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━┓ @@ -226,7 +228,7 @@ Unitroot from dataset 'longley of 'pop' The longley dataset is known for the ability to create an OLS regression that results in a R-squared of 1.0 due to the fact that the US macroeconomic variables are known to be highly collinear. See the following regression performed with the ols command: ``` -2022 Jun 20, 04:56 (🦋) /econometrics/ $ ols -d longley.totemp -i longley.gnpdefl,longley.gnp,longley.unemp,longley.armed,longley.pop,longley.year +(🦋) /econometrics/ $ ols -d longley.totemp -i longley.gnpdefl,longley.gnp,longley.unemp,longley.armed,longley.pop,longley.year OLS Regression Results ======================================================================================= Dep. Variable: longley.totemp R-squared (uncentered): 1.000 @@ -269,7 +271,7 @@ The argument `-d` refers to the dependent variable, in this example `longley.tot After running the regression estimation, it is possible to perform tests on the residuals of the model. E.g. for autocorrelation and heteroscedasity as shown below with the bgod and bpag commands. ``` -2022 Jun 20, 05:00 (🦋) /econometrics/ $ bgod +(🦋) /econometrics/ $ bgod Breusch-Godfrey autocorrelation test [Lags: 3] ┏━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┓ @@ -286,7 +288,7 @@ Breusch-Godfrey autocorrelation test [Lags: 3] The result 0.02 indicates no existence of autocorrelation. -2022 Jun 20, 05:00 (🦋) /econometrics/ $ bpag +(🦋) /econometrics/ $ bpag Breusch-Pagan heteroscedasticity test ┏━━━━━━━━━━┳━━━━━━━━━━━━━━━┓ @@ -311,20 +313,22 @@ Within the examples of `load --examples` there is one panel dataset available na Here, the dataset is loaded in and an alias is used by using the `-a` argument. The available columns are displayed under `Loaded files and data columns`. ``` -2022 Jun 20, 05:13 (🦋) /econometrics/ $ load wage_panel -a wp +(🦋) /econometrics/ $ load --file wage_panel -a wp + + +(🦋) /econometrics/ $ ? -2022 Jun 20, 05:13 (🦋) /econometrics/ $ ? ╭─────────────────────────────────────────────────────────────────────────────────────────────────── Econometrics ───────────────────────────────────────────────────────────────────────────────────────────────────╮ │ │ │ Looking for data in: │ -│ │ -│ /Users/jeroenbouma/Documents/OpenBB Terminal/custom_imports │ +│ /Users/jeroenbouma/OpenBBUserData/exports │ +│ /Users/jeroenbouma/OpenBBUserData/custom_imports/econometrics │ │ │ │ load load a dataset (also works with StatsModels datasets) │ │ remove remove one of the loaded datasets │ │ │ │ Loaded files and data columns: │ -│ wp : nr, year, black, exper, hisp, hours, married, educ, union, lwage, expersq, occupation │ +│ wp : nr, year, black, exper, hisp, hours, married, educ, union, lwage, expersq, occupation │ │ │ │ Exploration: │ │ show show a portion of a loaded dataset │ @@ -352,20 +356,20 @@ Here, the dataset is loaded in and an alias is used by using the `-a` argument. │ bgod Breusch-Godfrey autocorrelation tests with lags on the residuals of the regression │ │ bpag Breusch-Pagan heteroscedasticity test on the residuals of the regression │ │ │ -╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── OpenBB Terminal v1.3.0 (https://openbb.co) ─╯ +╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── OpenBB Terminal v2.4.0 (https://openbb.co) ─╯ ``` To run panel regressions with panel it is important to define both _entity_ (e.g. company) and _time_ (e.g. year). Trying to run the `panel` command would right now result in the following: ``` -2022 Jun 20, 05:17 (🦋) /econometrics/ $ panel -d wp.lwage -i wp.black,wp.hisp,wp.exper,wp.expersq,wp.married,wp.educ,wp.union,wp.year +(🦋) /econometrics/ $ panel -d wp.lwage -i wp.black,wp.hisp,wp.exper,wp.expersq,wp.married,wp.educ,wp.union,wp.year The column 'lwage' from the dataset 'wp' is not a MultiIndex. Make sure you set the index correctly with the index (e.g. index wp -i lwage,nr) command where the first level is the entity (e.g. Tesla Inc.) and the second level the date (e.g. 2021-03-31) ``` To see the effect of defining a `MultiIndex`, first a portion of the data is shown with the show command as seen below: ``` -2022 Jun 20, 05:22 (🦋) /econometrics/ $ show +(🦋) /econometrics/ $ show Dataset wp | Showing 10 of 4360 rows ┏━━━┳━━━━━━━┳━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━┓ @@ -396,10 +400,10 @@ To see the effect of defining a `MultiIndex`, first a portion of the data is sho Within this dataset the `nr` and `year` columns define the _entity_ and _time_. To allow panel regression estimations, it is important that this is defined accordingly with the index command. This can be done with the following (and showing the changed dataset afterwards): ``` -2022 Jun 20, 05:22 (🦋) /econometrics/ $ index wp -i nr,year +(🦋) /econometrics/ $ index wp -i nr,year Successfully updated 'wp' index to be 'nr, year' -2022 Jun 20, 05:27 (🦋) /econometrics/ $ show +(🦋) /econometrics/ $ show Dataset wp | Showing 10 of 4360 rows ┏━━━━━━━━━━━━┳━━━━━━━┳━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━┓ @@ -430,7 +434,7 @@ Successfully updated 'wp' index to be 'nr, year' The columns `nr` and `year` still exists within the dataset and could have been dropped with the `-d` argument if desired. However, in this case the `year` column is relevant for generating time effects in Pooled OLS, Fixed Effects and Random Effects estimations. To be able to do this, the type of the year column needs to be changed accordingly. The type of the columns can be displayed with the type command as follows: ``` -2022 Jun 20, 05:27 (🦋) /econometrics/ $ type wp +(🦋) /econometrics/ $ type wp wp ┏━━━━━━━━━━━━┳━━━━━━━━━┓ @@ -476,10 +480,10 @@ The dtype `int64` refers to numbers without decimals (e.g. 1, 2, 3) while the dt For the panel regressions, it can be beneficial to see time effects from `year`. Therefore, the type of the `year` column should be altered to `category`. This can be done with the following command: ``` -2022 Jun 20, 05:33 (🦋) /econometrics/ $ type wp.year --format category +(🦋) /econometrics/ $ type wp.year --format category Update 'wp.year' with type 'category' -2022 Jun 20, 05:40 (🦋) /econometrics/ $ type +(🦋) /econometrics/ $ type wp ┏━━━━━━━━━━━━┳━━━━━━━━━━┓ @@ -522,7 +526,7 @@ The dataset is now properly configured to allow for proper panel regressions. Th As an example, a **Random Effects** regression is performed. Here, the column after the `-d` argument refers to the dependent variable and the columns after the `-i` argument refer to the independent variables. ``` -2022 Jun 20, 05:51 (🦋) /econometrics/ $ panel -d wp.lwage -i wp.black,wp.hisp,wp.exper,wp.expersq,wp.married,wp.educ,wp.union,wp.year -r re +(🦋) /econometrics/ $ panel -d wp.lwage -i wp.black,wp.hisp,wp.exper,wp.expersq,wp.married,wp.educ,wp.union,wp.year -r re RandomEffects Estimation Summary @@ -570,9 +574,7 @@ wp.year.1987 0.1348 0.0817 1.6504 0.0989 -0.0253 0.2950 Doing research both as a student or professor for a university or as a professional often requires the findings to be easily replicated. Furthermore, as many steps could be required it can be very beneficial to have the ability to make small adjustments without needing to re-do every single step again. This is where `.openbb` files play an important role. -By going to the main menu as depicted below, the `exe` command can be used. With this command you can run `.openbb` scripts that automatically run a set of commands similarly to that of the Stata do-files and SPSS syntax files. These scripts are located where the application is located inside the `routines` folder. - -![Econometrics Menu Routine Exe OpenBB Terminal](https://user-images.githubusercontent.com/46355364/174588513-5c52ea20-548a-4c2b-a4c1-6054e2d71786.png) +By going to the main menu as depicted below, the `exe` command can be used. With this command you can run `.openbb` scripts that automatically run a set of commands similarly to that of the Stata do-files and SPSS syntax files. These scripts are located where the application is located inside the `routines` folder. Please find a more elaborate explanation in the [Scripts & Routines Guide](/terminal/guides/advanced/scripts-and-routines). This demo file has the following contents: @@ -650,4 +652,4 @@ wp.year.1987 0.1738 0.1348 0.5952 --------------------------------------------------------------- T-stats reported in parentheses -``` \ No newline at end of file +``` From f3fccf3192c8498c2a58b997cb00a56a33bc87e1 Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 10:43:01 +0100 Subject: [PATCH 22/37] Update economy.md --- .../content/terminal/guides/intros/economy.md | 63 +++++++------------ 1 file changed, 22 insertions(+), 41 deletions(-) diff --git a/website/content/terminal/guides/intros/economy.md b/website/content/terminal/guides/intros/economy.md index b1b3c3a3e7a..bd29dcd16ec 100644 --- a/website/content/terminal/guides/intros/economy.md +++ b/website/content/terminal/guides/intros/economy.md @@ -6,20 +6,20 @@ description: The Economy menu enables you to obtain market overviews, see yield The Economy menu enables you to obtain market overviews (overview and futures), see yield curves of any country (ycrv) and discover sector, industry and country performance (performance). Next to that, the databases of EconDB, FRED and Yahoo Finance can be accessed via macro, fred and index respectively. All of this can also be further analysed with Forecasting menu (`forecast`) and Quantitative Techniques (`qa`). -### How to use +## How to use The Economy menu is called upon by typing `economy` which opens the following menu: -![Economy Menu](https://user-images.githubusercontent.com/46355364/176679746-21b28263-96be-4701-9fd1-8657602e0214.png) +image Within the Economy menu you have a variety of options ranging from treasury rates to population growth to country financial performance. As this is quite extensive, the guide has two sections. The first section will discuss valuations and performance and the second section discusses the databases. -#### Performance and valuations +### Performance and valuations By using overview we can look into market overviews from the perspective of indices (`indices`), bonds (`usbonds` and `glbonds`), currencies (`currencies`) and in general. E.g. let's look at global bond performance by adding the `-t` argument: ``` -2022 Jun 29, 09:56 (🦋) /economy/ $ overview -t glbonds +(🦋) /economy/ $ overview -t glbonds Global Bonds ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━┓ @@ -42,7 +42,7 @@ By using futures of a variety of commodities. For example, let's look at a general overview: ``` -2022 Jun 29, 09:58 (🦋) /economy/ $ futures +(🦋) /economy/ $ futures Futures/Commodities [Source: Wall St. Journal] ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━┓ @@ -70,18 +70,10 @@ Next to that, to better understand the current commodity market we can look into └───────────────────────────┴─────────┴─────────┴───────┘ ``` -Furthermore, we can look into yield curves of any country, by default this is set to the United States, but it can be any: - -![Yield Curves Options Menu](https://user-images.githubusercontent.com/46355364/176679828-bd90df8c-bff3-42a7-8e03-897c0be99443.png) - -Which then returns the following plot: - -![Yield Curve](https://user-images.githubusercontent.com/46355364/176679949-dd8b5b47-1125-4b1c-9558-25f1d2d70ffc.png) - -Lastly, we can also show industry, sector and country performance with performance. For example, looking at the `sectors` returns the following: +We can also show industry, sector and country performance with performance. For example, looking at the `sectors` returns the following: ``` -2022 Jun 29, 10:03 (🦋) /economy/ $ performance -g sector +(🦋) /economy/ $ performance -g sector Group Performance Data ┏━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━┓ @@ -111,12 +103,12 @@ Lastly, we can also show industry, sector and country performance with macro) a large selection of Economic data can be obtained. What can be obtained is easily found by typing `macro --show parameters` which returns the following: ``` -2022 Jun 29, 10:16 (🦋) /economy/ $ macro --show parameters +(🦋) /economy/ $ macro --show parameters ┏━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┃ Parameter ┃ Name ┃ Period ┃ Description ┃ @@ -140,7 +132,7 @@ Starting with the EconDB database (via plot command where you can combine the datasets from the above commands into one graph. For example, it seems there is a relationship between the inflation rates and the unemployment rate (source) which we can graphically show with: ``` -2022 Jun 29, 10:38 (🦋) /economy/ $ macro -p URATE -s 2010-01-01 +(🦋) /economy/ $ macro -p URATE -s 2010-01-01 -2022 Jun 29, 10:39 (🦋) /economy/ $ fred T5YIEM -s 2010-01-01 +(🦋) /economy/ $ fred T5YIEM -s 2010-01-01 -2022 Jun 29, 10:39 (🦋) /economy/ $ plot --y1 United_States_URATE --y2 T5YIEM +🦋) /economy/ $ plot --y1 United_States_URATE --y2 T5YIEM ``` Resulting in the following graph: ![Combine plots of Unemployment Rate and Break Even Inflation](https://user-images.githubusercontent.com/46355364/176680454-b878604e-08a2-474e-ad9f-3b695ee958d1.png) -### Sub-menus available - -The Economy menu has a few sub-menus available to delve further into a specific macroeconomic indicator. To find more information about each menu, click on oneof the following: - -- Introduction to Forecasting menu: apply advanced AI and Machine Learning models to form prediction of future macroeconomic indicators including Recurrent Neural Network (RNN), Autoregressive Integrated Moving Average (ARIMA) and Monte Carlo forecasting. -- Introduction to Quantitative Analysis: analyse the macroeconomic indicators extensively for seasonality, rolling windows and statistical techniques. - -### Examples +## Examples Starting off, let's looking at current performance of energy futures with `futures`. ``` -2022 Jun 30, 05:39 (🦋) /economy/ $ futures energy +(🦋) /economy/ $ futures energy Future Table [Source: FinViz] ┏━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━┓ @@ -325,7 +306,7 @@ Starting off, let's looking at current performance of energy futures with `futur This gives insights in the current future contracts and their (relative) performance. Here, we take a closer look at `Crude Oil Brent` by querying the FRED database, with `fred`, for a dataset that is relevant: ``` -2022 Jun 30, 05:43 (🦋) /economy/ $ fred -q oil index +(🦋) /economy/ $ fred -q oil index Search results for oil index ┏━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┃ Series ID ┃ Title ┃ Description ┃ @@ -354,7 +335,7 @@ This gives insights in the current future contracts and their (relative) perform Here, we take the `CBOE Crude OIL ETF Volatility Index` to get some understanding of how volatile oil is. Here, a period is defined from 2008 to 2015, showing the influence of the Financial Crisis of 2008. ``` -2022 Jun 30, 06:22 (🦋) /economy/ $ fred OVXCLS -s 2008-01-01 -e 2015-01-01 +(🦋) /economy/ $ fred OVXCLS -s 2008-01-01 -e 2015-01-01 ``` This plots the following graph: @@ -364,7 +345,7 @@ This plots the following graph: A hypothesis could be that the more volatile the price of oil is, the lower the confidence of the consumers is. It is possible to visually depict this. First, let's plot the consumer confidence of Germany. ``` -2022 Jun 30, 07:59 (🦋) /economy/ $ macro -p CONF -c Germany -s 2008-01-01 -e 2015-01-01 +(🦋) /economy/ $ macro -p CONF -c Germany -s 2008-01-01 -e 2015-01-01 ``` ![Consumer Confidence Germany](https://user-images.githubusercontent.com/46355364/176680603-1ace9534-f18a-4362-a1c0-d28c675d9415.png) From 6586c09eb839ff11665ee8775c0ca4b564226954 Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 10:43:12 +0100 Subject: [PATCH 23/37] Update economy.md --- website/content/terminal/guides/intros/economy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/terminal/guides/intros/economy.md b/website/content/terminal/guides/intros/economy.md index bd29dcd16ec..e44c555376a 100644 --- a/website/content/terminal/guides/intros/economy.md +++ b/website/content/terminal/guides/intros/economy.md @@ -353,7 +353,7 @@ A hypothesis could be that the more volatile the price of oil is, the lower the Now, combine these two graphs with the `plot` command. This helps in visually depicting a (negative) relationship. ``` -2022 Jun 30, 08:00 (🦋) /economy/ $ plot --y1 Germany_CONF --y2 OVXCLS +(🦋) /economy/ $ plot --y1 Germany_CONF --y2 OVXCLS ``` ![CBOE Crude OIL ETF Volatility Index and Consumer Confidence Germany](https://user-images.githubusercontent.com/46355364/176680645-79b8f44d-adc7-49e4-b749-80188f22850f.png) From 0489eea5366a6637784a0d9e7da8699f6293d2ea Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 10:46:04 +0100 Subject: [PATCH 24/37] Update etf.md --- website/content/terminal/guides/intros/etf.md | 29 +++++-------------- 1 file changed, 8 insertions(+), 21 deletions(-) diff --git a/website/content/terminal/guides/intros/etf.md b/website/content/terminal/guides/intros/etf.md index b7afb86ec9b..fac61abb4ad 100644 --- a/website/content/terminal/guides/intros/etf.md +++ b/website/content/terminal/guides/intros/etf.md @@ -10,11 +10,10 @@ The ETF menu enables you to lookup any ETF and obtain an You now have the ability to look up any ETF. With the example below, the `load` command is used to load an ETF. - ``` (🦋) /etf/ $ load voo @@ -23,7 +22,6 @@ Loading Daily data for VOO with starting period 2022-02-08. Now we can use `holdings` to see the makeup of VOO - ``` 2022 Jun 21, 09:14 (🦋) /etf/ holdings @@ -53,41 +51,29 @@ Now we can use `holdings` to see the makeup of VOO └───────┴─────────────────────────────────┴──────────┴───────────┘ ``` - To then view the stock chart, you can call candle which shows a candle chart for the defined period (by default set to a year by `load`): ![Candle Chart of VOO](https://user-images.githubusercontent.com/46355364/174823545-6695f9b0-864c-4b94-a612-baa8087d1858.png) -By calling `?` or `help` the ETF menu re-appears. Here you can see that multiple commands menus have turned blue. Because of loading a ticker, these menus can now be used in combination with the chosen ticker. - -![ETF Menu with ETF Loaded](https://openbb-web-assets.s3.amazonaws.com/docs/load_etf.png) - -For example, the ETF's weights can now be depicted with the following: +The ETF's weights can now be depicted with the following: ``` -2022 Jun 21, 09:45 (🦋) /etf/ $ weights +(🦋) /etf/ $ weights ``` Which shows the following graph: -![Weights of VOO](https://user-images.githubusercontent.com/46355364/174823708-bdf1221f-c183-435a-b436-f0319123f13d.png) +![Figure_1](https://user-images.githubusercontent.com/46355364/218991849-d75c51f7-2343-4614-ad26-0f435670f4f0.png) -### Sub-menus available - -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: - -- Introduction to Comparison Analysis: have the ability to compare companies within the ETF based on, among other things, correlation, financial statements, sentiment, valuations and performance. -- Introduction to Technical Analysis: analysis the chosen ETF's historical data extensively with moving averages and momentum, trend, volatility and volume indicators. -- Introduction to Forecasting menu: 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. - -### Examples +## Examples If we want to learn more about a total market ETF, we can do the following, starting from the `etf` menu and using the `ld` command where we specify with `-l` we wish to see `15` ETFs max. ``` (🦋) /etf/ $ search --description total market -l 15 - ETFs by Total Assets + + ETFs by Total Assets ┏━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┃ ┃ Name ┃ Family ┃ Category ┃ ┡━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ @@ -141,6 +127,7 @@ We can now plot the corresponding ETF chart with holdings. +``` (🦋) /etf/ $ holdings ETF Holdings From e610f70e9f7b4dd12703617520a18d5be53d1373 Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 10:50:03 +0100 Subject: [PATCH 25/37] Update forex.md --- .../content/terminal/guides/intros/forex.md | 28 +++++-------------- 1 file changed, 7 insertions(+), 21 deletions(-) diff --git a/website/content/terminal/guides/intros/forex.md b/website/content/terminal/guides/intros/forex.md index 795227dc182..091b55df57e 100644 --- a/website/content/terminal/guides/intros/forex.md +++ b/website/content/terminal/guides/intros/forex.md @@ -10,15 +10,7 @@ The Forex menu enables you to load as follows: - -![Load Currency Pair](https://user-images.githubusercontent.com/46355364/176427457-611077c5-6c9c-44f2-85e4-e7bbcb04d761.png) - -When you do so, a lot of commands turn Blue. These can now be used to analyse the selected currency pair. - -![Forex Menu with Currency Pair Loaded](https://user-images.githubusercontent.com/46355364/176427750-e7ed2d63-295c-46c9-b044-abaf56d64d95.png) +image For example, you are able to show the quote of the currency pair by using the quote command: @@ -46,7 +38,7 @@ For example, you are able to show the quote of the currency pair by using the candle as follows: ``` -2022 Jun 29, 07:09 (🦋) /forex/ $ candle +(🦋) /forex/ $ candle ``` Which returns the following: @@ -56,7 +48,7 @@ Which returns the following: Lastly, insights in the forward valuations can also be given with fwd. ``` -2022 Jun 29, 07:19 (🦋) /forex/ $ fwd +(🦋) /forex/ $ fwd Forward rates for USD/EUR ┏━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┓ @@ -102,16 +94,14 @@ Lastly, insights in the forward valuations can also be given with Technical Analysis menu by typing `ta`: - -![Technical Analysis for Forex](https://user-images.githubusercontent.com/46355364/176427913-ad960b1b-7a0d-4143-85d6-925e0d5797dd.png) +Furthermore, the ability exists to take the currency pair to the Technical Analysis menu by typing `ta`. ### Examples First, let's start with looking at the currency pair USD and GBP. These are the U.S. Dollars and the Pound sterling. This is done by using the `load` command as follows with the addition that the `-s` command is used to change the start date: ``` -2022 Jun 29, 07:16 (🦋) /forex/ $ load USDGBP -s 2015-01-01 +(🦋) /forex/ $ load USDGBP -s 2015-01-01 USD-GBP loaded. ``` @@ -119,18 +109,14 @@ Then, let's see how this currency pair has changed over the last years with `can ![Candle with Moving Averages](https://user-images.githubusercontent.com/46355364/176427947-26346800-173b-4195-8a58-1add2a66ae31.png) -Now it's time to take this to the Quantitative Analysis menu by typing `qa`. This returns the following: - -![Quantitative Analysis menu for Forex](https://user-images.githubusercontent.com/46355364/176427981-4157b6ef-5fea-4c02-a7a1-d34400b7cbc1.png) - -Within this menu we can show some rolling statistics, for example show the rolling values for the mean and standard deviation of the currency pair: +Now it's time to take this to the Quantitative Analysis menu by typing `qa`. This returns the following. Within this menu we can show some rolling statistics, for example show the rolling values for the mean and standard deviation of the currency pair: ![Rolling Statistics for Forex](https://user-images.githubusercontent.com/46355364/176428039-4dcff70e-84e2-441d-9710-4d3f06af4175.png) Lastly, more advanced techniques can also be applied regarding seasonality with `decompose`: ``` -2022 Jun 29, 07:26 (🦋) /forex/qa/ $ decompose +(🦋) /forex/qa/ $ decompose Time-Series Level is 0.75 Strength of Trend: 421.7107 From 0bfc287a508e155f46d457afcb0b73df06028946 Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 10:50:48 +0100 Subject: [PATCH 26/37] Update futures.md --- website/content/terminal/guides/intros/futures.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/content/terminal/guides/intros/futures.md b/website/content/terminal/guides/intros/futures.md index f5ad97f2405..56b8ced24f2 100644 --- a/website/content/terminal/guides/intros/futures.md +++ b/website/content/terminal/guides/intros/futures.md @@ -6,9 +6,9 @@ description: The Futures menu provides historical prices and the current term st The Futures menu provides historical prices and the current term structure for an asset. This menu is accessible from the Main menu by typing `futures` and pressing the `enter` key. -Futures Menu +image -### How to Use +## How to Use There are three basic functions within this menu Search, Historical and Curve. @@ -60,4 +60,4 @@ Multiple continuous charts can be plotted on the same chart by using a comma-sep historical GE,ZQ -s 2007-01-01 ``` -Historical Price of GE=F & ZQ=F \ No newline at end of file +Historical Price of GE=F & ZQ=F From 459fc2d298d4a5a5fd7fc8d29c62857f8998cbf8 Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 10:52:21 +0100 Subject: [PATCH 27/37] Update dd.md --- website/content/terminal/guides/intros/crypto/dd.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/website/content/terminal/guides/intros/crypto/dd.md b/website/content/terminal/guides/intros/crypto/dd.md index 7deaffac69f..ce629487d83 100644 --- a/website/content/terminal/guides/intros/crypto/dd.md +++ b/website/content/terminal/guides/intros/crypto/dd.md @@ -11,12 +11,12 @@ The Cryptocurrency Due Diligence menu gives the user the ability to delve deeper The Cryptocurrency Due Diligence menu is called upon by typing `dd` (after loading a coin), while inside the `crypto` menu, which opens the following menu: -![Cryptocurrency Due Diligence menu](https://user-images.githubusercontent.com/46355364/178734389-dcee7a96-bb57-42fb-ad8e-13f27662e03b.png) +image This menu requires you to load a coin with the `load` command. Thus, alternatively, you can also type `/crypto/load BTC/dd`. Within the Cryptocurrency Due Diligence menu you can find features examining an extensive amount of metrics about the loaded coin. As an example, you can see the latest trades done on the loaded coin with `trades`: ``` -2022 Jul 13, 07:42 (🦋) /crypto/dd/ $ trades +(🦋) /crypto/dd/ $ trades ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━┓ ┃ time ┃ price ┃ size ┃ side ┃ @@ -58,7 +58,7 @@ This menu requires you to load a coin with the `load` command. Thus, alternative To get an understanding of the coin we are looking at, it is possible to look into some basic information with `basic`: ``` -2022 Jul 13, 07:45 (🦋) /crypto/dd/ $ basic +(🦋) /crypto/dd/ $ basic Basic Coin Information ┏━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ @@ -88,7 +88,7 @@ To get an understanding of the coin we are looking at, it is possible to look in Then, we have the option to look into the project information with `pi`. Note that this requires an API Key from Messari which you can find more information about here. This command returns the following: ``` -2022 Jul 13, 07:51 (🦋) /crypto/dd/ $ pi +(🦋) /crypto/dd/ $ pi BTC General Info ┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ @@ -151,7 +151,7 @@ Then, we have the option to look into the project information with `pi`. Note th Looking ahead, we can use the command (coming from the same source) `rm` which discusses plans for the future. E.g. if we load in `ETH` with `load ETH` and use `rm` we receive the following: ``` -2022 Jul 13, 07:57 (🦋) /crypto/dd/ $ rm +(🦋) /crypto/dd/ $ rm ETH Roadmap ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ @@ -220,7 +220,7 @@ As well as a graph that depicts price movements after these announcements. Lastly, keeping the ETH coin loaded, we can also look at some sentiment analysis by acquiring the different sentiment scores with `score` as follows: ``` -2022 Jul 13, 08:00 (🦋) /crypto/dd/ $ score +(🦋) /crypto/dd/ $ score Different Scores for Loaded Coin ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓ From 979728d476fe9610f03e616d72c3c8e50a9f13b8 Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 10:53:04 +0100 Subject: [PATCH 28/37] Update defi.md --- website/content/terminal/guides/intros/crypto/defi.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/website/content/terminal/guides/intros/crypto/defi.md b/website/content/terminal/guides/intros/crypto/defi.md index 1e930c16672..eb5e8976768 100644 --- a/website/content/terminal/guides/intros/crypto/defi.md +++ b/website/content/terminal/guides/intros/crypto/defi.md @@ -10,7 +10,7 @@ The Cryptocurrency Decentralized Finance (DeFi) menu gives the user the ability The Cryptocurrency Decentralized Finance (DeFi) menu is called upon by typing `defi`, while inside the `crypto` menu, which opens the following menu: -![Cryptocurrency Decentralized Finance (DeFi) menu](https://user-images.githubusercontent.com/46355364/178734540-716f2232-20a4-4f31-b8a8-10c0badfd5dd.png) +image Alternatively, you can also type `/crypto/defi`. Within the Cryptocurrency Decentralized Finance (DeFi) menu you can find features that delve deeper in the world of decentralized finance. @@ -19,7 +19,7 @@ Alternatively, you can also type `/crypto/defi`. Within the Cryptocurrency Decen Delving deeper in Uniswap, we can start bij looking at the tokens trade-able with `tokens`: ```txt -2022 Jul 19, 11:04 (🦋) /crypto/defi/ $ tokens +(🦋) /crypto/defi/ $ tokens UniSwarp DEX Trade-able Tokens ┏━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━┓ @@ -70,7 +70,7 @@ Delving deeper in Uniswap, we can start bij looking at the tokens trade-able wit Furthermore, we can also look at the recently added pairs with `pairs`: ```txt -2022 Jul 19, 11:03 (🦋) /crypto/defi/ $ pairs +(🦋) /crypto/defi/ $ pairs Latest Added Pairs on Uniswap DEX ┏━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━┓ @@ -101,7 +101,7 @@ When interested in dApps, it is possible to find the top DeFI dApps grouped by c Including a list of recent dApps with `ldapps`: ```txt -2022 Jul 19, 11:01 (🦋) /crypto/defi/ $ ldapps +(🦋) /crypto/defi/ $ ldapps ┏━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━┓ ┃ Name ┃ Symbol ┃ Category ┃ Chains ┃ Change 1H ┃ Change 1D (%) ┃ Change 7D ┃ TVL ($) ┃ From 0ff9f683a17486651322427b7e594c1ff6e551b0 Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 10:53:36 +0100 Subject: [PATCH 29/37] Update disc.md --- website/content/terminal/guides/intros/crypto/disc.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/website/content/terminal/guides/intros/crypto/disc.md b/website/content/terminal/guides/intros/crypto/disc.md index 736dc6905c5..ca919c1ba61 100644 --- a/website/content/terminal/guides/intros/crypto/disc.md +++ b/website/content/terminal/guides/intros/crypto/disc.md @@ -10,12 +10,12 @@ The Cryptocurrency Discovery menu provides the option to look into a wide select The Cryptocurrency Discovery menu is called upon by typing `disc`, while inside the `crypto` menu, which opens the following menu: -![Cryptocurrency Discovery Menu](https://user-images.githubusercontent.com/46355364/178532081-747a3a32-df67-4714-b969-074a4ee3e885.png) +image Alternatively, you can also type `/crypto/disc`. Within the Cryptocurrency Discovery menu you have a variety of options to find that information about a coin, a NFT, a specific blockchain game, decentralized app or exchange. E.g. we can look into the top coins by typing `top` which returns the following table: ``` -2022 Jul 12, 05:06 (🦋) /crypto/disc/ $ top +(🦋) /crypto/disc/ $ top ┏━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┓ ┃ Symbol ┃ Name ┃ Volume [$] ┃ Market Cap ┃ Market Cap Rank ┃ 7D Change [%] ┃ 24H Change [%] ┃ @@ -47,7 +47,7 @@ Alternatively, you can also type `/crypto/disc`. Within the Cryptocurrency Disco It is possible to delve deeper into a specific country by defining this for `top`. For example, you can look at stable coins by typing `top stablecoins` which returns the following: ``` -2022 Jul 12, 05:13 (🦋) /crypto/disc/ $ top stablecoins +(🦋) /crypto/disc/ $ top stablecoins ┏━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┓ ┃ Symbol ┃ Name ┃ Volume [$] ┃ Market Cap ┃ Market Cap Rank ┃ 7D Change [%] ┃ 24H Change [%] ┃ @@ -77,7 +77,7 @@ It is possible to delve deeper into a specific country by defining this for `top Furthermore, we can also look into NFTs by calling `nft` where we can apply sorting by using the `--sort` flag and selecting one of the options (using the arrow keys). For example: ``` -2022 Jul 12, 05:16 (🦋) /crypto/disc/ $ nft --sort Avg Price [$] +(🦋) /crypto/disc/ $ nft --sort Avg Price [$] Top NFT collections ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓ @@ -118,7 +118,7 @@ Furthermore, we can also look into NFTs by calling `nft` where we can apply sort Lastly, we can obtain the top 5 decentralized applications, sorted by daily user by using `dapps` which returns the following: ``` -2022 Jul 12, 05:19 (🦋) /crypto/disc/ $ dapps -l 5 +(🦋) /crypto/disc/ $ dapps -l 5 Top Decentralized Applications ┏━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┓ From 73ec82bf568999c6c5b603f1cca598a5ed26839c Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 10:57:09 +0100 Subject: [PATCH 30/37] Update index.md --- .../terminal/guides/intros/crypto/index.md | 149 ++++++++---------- 1 file changed, 68 insertions(+), 81 deletions(-) diff --git a/website/content/terminal/guides/intros/crypto/index.md b/website/content/terminal/guides/intros/crypto/index.md index 445bfe9a6ea..af7facf31ea 100644 --- a/website/content/terminal/guides/intros/crypto/index.md +++ b/website/content/terminal/guides/intros/crypto/index.md @@ -12,31 +12,66 @@ NFT ( +image You have the ability to search a coin with `find` based on its name or symbol. An example: -image +``` +(🦋) /crypto/ $ find btc + + Similar Coins +┏━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ index ┃ symbol ┃ id ┃ name ┃ +┡━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━┩ +│ 0 │ btc │ bitcoin │ Bitcoin │ +├───────┼────────┼────────────────────────┼────────────────────────┤ +│ 1 │ xbtc │ wrapped-bitcoin-stacks │ Wrapped Bitcoin-Stacks │ +├───────┼────────┼────────────────────────┼────────────────────────┤ +│ 2 │ wbtc │ wrapped-bitcoin │ Wrapped Bitcoin │ +├───────┼────────┼────────────────────────┼────────────────────────┤ +│ 3 │ vbtc │ venus-btc │ Venus BTC │ +├───────┼────────┼────────────────────────┼────────────────────────┤ +│ 4 │ tbtc │ t-bitcoin │ τBitcoin │ +├───────┼────────┼────────────────────────┼────────────────────────┤ +│ 4 │ tbtc │ tbtc │ tBTC │ +├───────┼────────┼────────────────────────┼────────────────────────┤ +│ 5 │ tbtc │ t-bitcoin │ τBitcoin │ +├───────┼────────┼────────────────────────┼────────────────────────┤ +│ 5 │ tbtc │ tbtc │ tBTC │ +├───────┼────────┼────────────────────────┼────────────────────────┤ +│ 6 │ sbtc │ sbtc │ sBTC │ +├───────┼────────┼────────────────────────┼────────────────────────┤ +│ 6 │ sbtc │ siambitcoin │ SiamBitcoin │ +├───────┼────────┼────────────────────────┼────────────────────────┤ +│ 7 │ sbtc │ sbtc │ sBTC │ +├───────┼────────┼────────────────────────┼────────────────────────┤ +│ 7 │ sbtc │ siambitcoin │ SiamBitcoin │ +├───────┼────────┼────────────────────────┼────────────────────────┤ +│ 8 │ rbtc │ rootstock │ Rootstock RSK │ +├───────┼────────┼────────────────────────┼────────────────────────┤ +│ 9 │ pbtc │ ptokens-btc │ pTokens BTC [OLD] │ +├───────┼────────┼────────────────────────┼────────────────────────┤ +│ 9 │ pbtc │ ptokens-btc-2 │ pTokens BTC │ +└───────┴────────┴────────────────────────┴────────────────────────┘ +``` As a result, you can see a list of coins matching your search criteria. Once you identify the coin you are looking for, next step is to `load` it. See the example below: -image +``` +(🦋) /crypto/ $ load BTC + + BTC/USD Performance +┏━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┓ +┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ +┃ Price (USD) ┃ 1D ┃ 7D ┃ 1M ┃ 1Y ┃ YTD ┃ Volatility (1Y) ┃ Volume (7D avg) ┃ Circulating Supply ┃ +┡━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━┩ +│ 22220.80 │ 1.99 % │ -4.49 % │ 6.42 % │ -47.82 % │ 33.15 % │ 62.15 % │ 24.32 B │ 19.291 M │ +└─────────────┴────────┴─────────┴────────┴──────────┴─────────┴─────────────────┴─────────────────┴────────────────────┘ +``` To view the candle chart for the loaded crypto, you can call `candle`. This will show you the coin's historical prices and volume, as follows: -image - -In case you want to adjust the default period, you can do so by specifying the number of days to go back in time. - -image - -You might be wondering, how can I know about all possible options? You can type in `command_name -h` or `load -h` in this case. Here you will find available optional arguments that you can play with. - -image - -Lastly, by calling `?` or `help` or `h`, the `crypto` menu will be re-populated. Here you can see that several menus have turned blue, which mean you can enter any of them now. In order to use these menus, you are required to first `load` a coin. - -image +image ### Sub-menus available @@ -55,74 +90,26 @@ The Cryptocurrency menu has an extensive list of available sub-menus ranging fro When entering the `crypto` menu, you would typically want to load in a coin. Let's go with Ethereum. You can do this by specifying its symbol: `load eth` -![Load ETH](https://user-images.githubusercontent.com/40023817/175827660-3b106e6e-2638-4536-939e-e38692ec1003.png) +``` +(🦋) /crypto/ $ load eth + + ETH/USD Performance +┏━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┓ +┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ +┃ Price (USD) ┃ 1D ┃ 7D ┃ 1M ┃ 1Y ┃ YTD ┃ Volatility (1Y) ┃ Volume (7D avg) ┃ Circulating Supply ┃ +┡━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━┩ +│ 1556.88 │ 2.76 % │ -6.89 % │ 0.28 % │ -46.93 % │ 28.17 % │ 83.45 % │ 7.44 B │ 120.500 M │ +└─────────────┴────────┴─────────┴────────┴──────────┴─────────┴─────────────────┴─────────────────┴────────────────────┘ + +``` Let's checkout its sentiments from major headlines news by typing: `headlines` -image +image -To perform further analysis, the best menu to enter is `dd`: +To perform further analysis, the best menu to enter is `dd`. We can check out the project's roadmap and its effect to historical price, by typing `rm` -``` -2022 Jun 29, 08:58 (🦋) /crypto/ $ dd -╭────────────────────────────────────────────────────────────────────────────────────────────── Crypto - Due Diligence ──────────────────────────────────────────────────────────────────────────────────────────────╮ -│ │ -│ load load a specific cryptocurrency for analysis │ -│ │ -│ Coin: eth │ -│ Source: │ -│ │ -│ Overview: │ -│ info basic information about loaded coin [CoinGecko] │ -│ basic basic information about loaded coin [CoinPaprika] │ -│ ath all time high related stats for loaded coin [CoinGecko] │ -│ atl all time low related stats for loaded coin [CoinGecko] │ -│ web found websites for loaded coin e.g forum, homepage [CoinGecko] │ -│ pi project information e.g. technology details, public repos, audits, vulns [Messari] │ -│ gov governance details [Messari] │ -│ stats coin stats [Coinbase] │ -│ bc links to blockchain explorers for loaded coin [CoinGecko] │ -│ Market: │ -│ market market stats about loaded coin [CoinGecko] │ -│ mkt all markets for loaded coin [CoinPaprika] │ -│ binbook order book [Binance] │ -│ balance coin balance [Binance] │ -│ cbbook order book [Coinbase] │ -│ trades last trades [Coinbase] │ -│ ex all exchanges where loaded coin is listed [CoinPaprika] │ -│ oi open interest per exchange [Coinglass] │ -│ eb total balance held on exchanges (in percentage and units) [Glassnode] │ -│ Metrics: │ -│ mcapdom market cap dominance [Messari] │ -│ active active addresses [Glassnode] │ -│ nonzero addresses with non-zero balances [Glassnode] │ -│ change 30d change of supply held on exchange wallets [Glassnode] │ -│ ps price and supply related metrics for loaded coin [CoinPaprika] │ -│ mt messari timeseries e.g. twitter followers, circ supply, etc [Messari] │ -│ Contributors and Investors: │ -│ team contributors (individuals and organizations) [Messari] │ -│ inv investors (individuals and organizations) [Messari] │ -│ Tokenomics: │ -│ tk tokenomics e.g. circulating/max/total supply, emission type, etc [Messari] │ -│ fr fundraising details e.g. treasury accounts, sales rounds, allocation [Messari] │ -│ Roadmap and News: │ -│ rm roadmap [Messari] │ -│ events events related to loaded coin [CoinPaprika] │ -│ news loaded coin's most recent news [CryptoPanic] │ -│ Activity and Community: │ -│ links links e.g. whitepaper, github, twitter, youtube, reddit, telegram [Messari] │ -│ social social portals urls for loaded coin, e.g reddit, twitter [CoinGecko] │ -│ twitter tweets for loaded coin [CoinPaprika] │ -│ score different kind of scores for loaded coin, e.g developer score, sentiment score [CoinGecko] │ -│ dev github, bitbucket coin development statistics [CoinGecko] │ -│ gh github activity over time [Santiment] │ -│ │ -╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── OpenBB Terminal v1.5.0 (https://openbb.co) ─╯ -``` - -We can check out the project's roadmap and its effect to historical price, by typing `rm` - -image +image Once you have finished analyzing a specific coin, you would want to get a good understanding of the overall crypto market. To do that, head over to `ov` by typing `../ov`. @@ -130,8 +117,8 @@ Once you have finished analyzing a specific coin, you would want to get a good u > performing 2 separate commands, you can combine them together using `/`. As > such `../ov` will take us back to previous menu, and then enter the `ov` menu. -image +image Bitcoin has such a big influence on the entire crypto market. So seeing whether we are in a Bitcoin season or a Altcoin season will be useful to your investment decisions. `altindex` is a great command for this purpose. -image +image From 5b9b5a955c552fd6fa9a2244936936a2fb8d7551 Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 10:57:39 +0100 Subject: [PATCH 31/37] Update nft.md --- website/content/terminal/guides/intros/crypto/nft.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/content/terminal/guides/intros/crypto/nft.md b/website/content/terminal/guides/intros/crypto/nft.md index f082fcc5604..96005391bf6 100644 --- a/website/content/terminal/guides/intros/crypto/nft.md +++ b/website/content/terminal/guides/intros/crypto/nft.md @@ -6,11 +6,11 @@ description: An Introduction to Non Fungible Token (NFT), within the Cryptocurre The Non Fungible Token (NFT) menu gives the user the ability to dive into certain NFTs (stats). -### How to use +## How to use The Non Fungible Token (NFT) menu is called upon by typing `nft`, while inside the `crypto` menu, which opens the following menu: -![Non Fungible Token (NFT) menu](https://user-images.githubusercontent.com/46355364/178734682-24b58a33-ae3d-4ef9-9f07-44fe713f6f16.png) +image Alternatively, you can also type `/crypto/nft`. Within the Non Fungible Token (NFT) menu you can explore the statistics of specific NFTs you are interested in. From 402c3a79533aaf1c0746ea532c9df1dfac6041aa Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 10:58:22 +0100 Subject: [PATCH 32/37] Update onchain.md --- .../terminal/guides/intros/crypto/onchain.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/website/content/terminal/guides/intros/crypto/onchain.md b/website/content/terminal/guides/intros/crypto/onchain.md index c71921ae3d8..fda107ce861 100644 --- a/website/content/terminal/guides/intros/crypto/onchain.md +++ b/website/content/terminal/guides/intros/crypto/onchain.md @@ -6,16 +6,16 @@ description: An Introduction to Cryptocurrency Onchain, within the Cryptocurrenc The Cryptocurrency Onchain menu provides access to features that determine market sentiment by leveraging data from a blockchain ledger. This can be, among other things, blockchain hashrates (hr), confirmed transactions (btcct) and top traded crypto pairs (ttcp). -### How to use +## How to use The Cryptocurrency Onchain menu is called upon by typing `onchain`, while inside the `crypto` menu, which opens the following menu: -![Cryptocurrency Onchain Menu](https://user-images.githubusercontent.com/46355364/178532254-8f4ef039-fab5-4ac5-afbf-584f8ce711c4.png) +image Alternatively, you can also type `/crypto/onchain`. Within the Cryptocurrency Onchain menu you can find features examining transaction data and crypto wallet balances, both of which are helpful when deciding whether to invest. E.g. we can look into the top ERC20 token by typing `top` which returns the following table: ``` -2022 Jul 12, 08:45 (🦋) /crypto/onchain/ $ top +(🦋) /crypto/onchain/ $ top Top ERC20 Tokens ┏━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┓ @@ -43,18 +43,18 @@ Alternatively, you can also type `/crypto/onchain`. Within the Cryptocurrency On └──────┴─────────────────┴─────────┴──────────┴──────────┴────────────────┴──────────────┴──────────────┴─────────────────┘ ``` -### Examples +## Examples To access much of the Ethereum features, an ethereum address needs to be entered. As an example this can be `0x71C7656EC7ab88b098defB751B7401B5f6d8976F` which can be entered within the address command as follows: ``` -2022 Jul 12, 08:48 (🦋) /crypto/onchain/ $ address 0x71C7656EC7ab88b098defB751B7401B5f6d8976F +(🦋) /crypto/onchain/ $ address 0x71C7656EC7ab88b098defB751B7401B5f6d8976F ``` Which allows you to see the balance and hist which returns the following for `balance`: ``` -2022 Jul 12, 08:53 (🦋) /crypto/onchain/ $ balance +(🦋) /crypto/onchain/ $ balance Blockchain Token Information ┏━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┓ @@ -85,8 +85,7 @@ Which allows you to see the global), find cryptocurrency indexes and derivatives (indexes and derivatives), news feeds (news) and fees (wf and ewf) -### How to use +## How to use The Cryptocurrency Overview menu is called upon by typing `ov`, while inside the `crypto` menu, which opens the following menu: -![Cryptocurrency Overview menu](https://user-images.githubusercontent.com/46355364/178532373-d03c32f5-df7b-487e-a4ae-b60f7297c48e.png) +image Alternatively, you can also type `/crypto/ov`. Within the Cryptocurrency Overview menu you have a variety of options to get an understanding of the global market, derivatives, heatmaps, a full list of exchanges, news, fees and borrow rates. Taking one of these as an example, `derivatives` returns a Futures table: ``` -2022 Jul 12, 05:36 (🦋) /crypto/ov/ $ derivatives +(🦋) /crypto/ov/ $ derivatives Crypto Derivatives ┏━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┓ @@ -58,7 +58,7 @@ Alternatively, you can also type `/crypto/ov`. Within the Cryptocurrency Overvie We can start by looking at some general information about the Cryptocurrency market by using `global`: ``` -2022 Jul 12, 05:38 (🦋) /crypto/ov/ $ global +(🦋) /crypto/ov/ $ global Global Statistics ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┓ @@ -87,7 +87,7 @@ We can start by looking at some general information about the Cryptocurrency mar To find an overview of all coins without segregating between different types of coins, we can use `info` which returns the following table: ``` -2022 Jul 12, 05:40 (🦋) /crypto/ov/ $ info +(🦋) /crypto/ov/ $ info Displaying data vs USD @@ -140,7 +140,7 @@ Displaying data vs USD And lastly, it is also possible to look at the stable coins in the market instead of the entire Cryptocurrency investment universe. This can be done with `stables` which returns the following: ``` -2022 Jul 12, 05:40 (🦋) /crypto/ov/ $ stables +(🦋) /crypto/ov/ $ stables First 15 stablecoins have a total 152.551 B dollars of market cap. From 253842b1bd37a50fd11c2fce159492d7190c55e2 Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 11:00:41 +0100 Subject: [PATCH 34/37] Update index.md --- .../terminal/guides/intros/portfolio/index.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/website/content/terminal/guides/intros/portfolio/index.md b/website/content/terminal/guides/intros/portfolio/index.md index 13dbeaa7021..aaab76e5535 100644 --- a/website/content/terminal/guides/intros/portfolio/index.md +++ b/website/content/terminal/guides/intros/portfolio/index.md @@ -7,11 +7,11 @@ description: The Portfolio menu, and its sub-menus, are dedicated to properly ex The Portfolio menu, and its sub-menus, are dedicated to properly explaining and optimizing your own portfolio. With features to load your own orderbook (transactions) it is possible to compare your results to that of a benchmark. For example, you are able to load both your portfolio and a benchmark (load and bench), then have the option to look into the performance compared to the benchmark asking the question "_What if I invested all my money in the benchmark instead?_" (perf) as well as see a wide variety of statistics and metrics (rsharpe, distr, var and metric). Next to that, with these findings you can apply optimization techniques to your portfolio through the Portfolio Optimization menu. -### How to use +## How to use The Portfolio menu is called upon by typing `portfolio` which opens the following menu: -![Portfolio Menu](https://user-images.githubusercontent.com/46355364/180178234-0cb80009-74d8-41fb-9f4c-fa393361903a.png) +image The first step in using this menu is loading a portfolio with load. Within this guide, we provide an example file when running `load --example` which will be used to explain the functionality through the guide. @@ -107,11 +107,7 @@ After loading in the portfolio, it is time to select a benchmark. By default, th Note that the `bench` command has a large selection of products you can choose from. Instead of taking the index directly, an ETF product is used to represent something that you could have actually invested in. By using the `DOWN` (⌄) arrow and pressing `ENTER` (⏎) you can select a different benchmark. -After defining both the portfolio and the benchmark, a lot more options become available: - -![Portfolio Menu after loading Portfolio and Benchmark](https://user-images.githubusercontent.com/46355364/180178329-0aca57bf-ad29-47cc-a787-298a4de4070a.png) - -For example, with `perf`, we can see how the portfolio performed compared to if you invested the same amount of money into the benchmark instead. This reflects the capabilities of you, as an investor, to outperform a passive strategy. +With `perf`, we can see how the portfolio performed compared to if you invested the same amount of money into the benchmark instead. This reflects the capabilities of you, as an investor, to outperform a passive strategy. ``` (🦋) /portfolio/ $ perf @@ -161,7 +157,7 @@ Volatility for Portfolio and Benchmark └─────┴───────────────┴───────────────┘ ``` -### Examples +## Examples Starting off by loading in the OpenBB Example Portfolio again and changing the benchmark, the Vanguard Total Stock Market ETF (VTI). From a97001349535a82b9796798cf5cc5c0dc4cd4d4f Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 11:01:27 +0100 Subject: [PATCH 35/37] Update po.md --- website/content/terminal/guides/intros/portfolio/po.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/terminal/guides/intros/portfolio/po.md b/website/content/terminal/guides/intros/portfolio/po.md index e7730d20c4e..f5f31ccebc6 100644 --- a/website/content/terminal/guides/intros/portfolio/po.md +++ b/website/content/terminal/guides/intros/portfolio/po.md @@ -10,7 +10,7 @@ The Portfolio Optimization menu allows the user to apply advanced optimization t The portfolio optimization menu can be reached by visiting the `portfolio` menu and typing `po` (or alternatively, typing `/portfolio/po` from any location). This opens the following menu: - +image The first step in using this menu is loading a portfolio with load. Within this guide, we provide an example file when running `load --example` which will be used to explain the functionality through the guide. From 8016bde69813d223db6c8bf8f0c5d4ed8f311876 Mon Sep 17 00:00:00 2001 From: Jeroen Bouma Date: Wed, 15 Feb 2023 13:01:34 +0100 Subject: [PATCH 36/37] forgot one --- website/content/terminal/guides/advanced/api-keys.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/terminal/guides/advanced/api-keys.md b/website/content/terminal/guides/advanced/api-keys.md index 79a7ab10d32..b9e0a0d0fb3 100644 --- a/website/content/terminal/guides/advanced/api-keys.md +++ b/website/content/terminal/guides/advanced/api-keys.md @@ -17,7 +17,7 @@ API_FINNHUB_KEY not defined. Set API Keys in ~/.openbb_terminal/.env or under ke You can access the `keys` menu as mentioned above from the homepage with `keys` (or directly from your current menu with `/keys`). This will open the menu as shown below: -image +image Within this menu you are able to set your API keys to access the commands that require that key. You can do so by typing the command followed by the API key, for example: `fred a215egade08a8d47cfd49c849658a2be`. When you press `ENTER` (⏎) the terminal will test whether this API key works. If it does, you receive the message `defined, test passed` and if it does not, you receive the message `defined, test failed`. From eae5f304ab8e35410055160ec7d063e64ce10394 Mon Sep 17 00:00:00 2001 From: jeroen Date: Wed, 15 Feb 2023 15:22:35 +0100 Subject: [PATCH 37/37] Fix the stuff --- website/content/terminal/guides/advanced/api-keys.md | 2 +- website/content/terminal/guides/basics/index.md | 4 ++-- website/content/terminal/guides/intros/common/ba.md | 2 +- website/content/terminal/guides/intros/common/qa.md | 2 +- website/content/terminal/guides/intros/common/ta.md | 2 +- website/content/terminal/guides/intros/crypto/dd.md | 2 +- website/content/terminal/guides/intros/crypto/defi.md | 2 +- website/content/terminal/guides/intros/crypto/disc.md | 2 +- website/content/terminal/guides/intros/crypto/index.md | 2 +- website/content/terminal/guides/intros/crypto/nft.md | 2 +- website/content/terminal/guides/intros/crypto/onchain.md | 2 +- website/content/terminal/guides/intros/crypto/ov.md | 2 +- website/content/terminal/guides/intros/econometrics.md | 2 +- website/content/terminal/guides/intros/economy.md | 2 +- website/content/terminal/guides/intros/etf.md | 2 +- website/content/terminal/guides/intros/forex.md | 2 +- website/content/terminal/guides/intros/futures.md | 2 +- website/content/terminal/guides/intros/portfolio/index.md | 2 +- website/content/terminal/guides/intros/portfolio/po.md | 2 +- website/content/terminal/guides/intros/stocks/comparison.md | 2 +- .../content/terminal/guides/intros/stocks/dark-pool-shorts.md | 2 +- website/content/terminal/guides/intros/stocks/disc.md | 2 +- website/content/terminal/guides/intros/stocks/fa.md | 2 +- website/content/terminal/guides/intros/stocks/gov.md | 2 +- website/content/terminal/guides/intros/stocks/index.md | 2 +- website/content/terminal/guides/intros/stocks/ins.md | 2 +- .../content/terminal/guides/intros/stocks/options/hedge.md | 2 +- .../content/terminal/guides/intros/stocks/options/index.md | 2 +- .../content/terminal/guides/intros/stocks/options/pricing.md | 2 +- .../content/terminal/guides/intros/stocks/options/screener.md | 2 +- website/content/terminal/guides/intros/stocks/screener.md | 4 ++-- website/content/terminal/guides/intros/stocks/sia.md | 2 +- website/content/terminal/guides/intros/stocks/tradinghours.md | 2 +- 33 files changed, 35 insertions(+), 35 deletions(-) diff --git a/website/content/terminal/guides/advanced/api-keys.md b/website/content/terminal/guides/advanced/api-keys.md index b9e0a0d0fb3..8676aba6f3c 100644 --- a/website/content/terminal/guides/advanced/api-keys.md +++ b/website/content/terminal/guides/advanced/api-keys.md @@ -17,7 +17,7 @@ API_FINNHUB_KEY not defined. Set API Keys in ~/.openbb_terminal/.env or under ke You can access the `keys` menu as mentioned above from the homepage with `keys` (or directly from your current menu with `/keys`). This will open the menu as shown below: -image +image Within this menu you are able to set your API keys to access the commands that require that key. You can do so by typing the command followed by the API key, for example: `fred a215egade08a8d47cfd49c849658a2be`. When you press `ENTER` (⏎) the terminal will test whether this API key works. If it does, you receive the message `defined, test passed` and if it does not, you receive the message `defined, test failed`. diff --git a/website/content/terminal/guides/basics/index.md b/website/content/terminal/guides/basics/index.md index 71cf1aa1963..848c1fc79e8 100644 --- a/website/content/terminal/guides/basics/index.md +++ b/website/content/terminal/guides/basics/index.md @@ -8,7 +8,7 @@ The OpenBB Terminal is based off the +image The OpenBB Terminal is centered around keyboard input. To navigate and perform analysis you will have to type in the name of the command followed by an `ENTER` (⏎). If you wish to see information about the OpenBB Terminal you can do so by typing `about` and then press `ENTER` (⏎). As you are typing, you will notice that you receive suggestions, by using the `DOWN` (⌄) arrow and pressing `ENTER` (⏎) you can select the command and execute it. @@ -24,7 +24,7 @@ Throughout the entire terminal, the same set of colors are used which all share Menus, depicted in Dark Blue, take you to a new section of the terminal referred to as a menu. For example, if you wish to view information about stocks, you can do so by typing `stocks` and pressing `ENTER` (⏎). This opens a new menu as depicted below. -image +image Depending on the menu you are in, you are presented with a new set of commands and menus you can select. There are interactions in place between each menu. For example, when selecting a company within the `stocks` menu, the terminal will remember your selection when you visit the `fa` or `options` menu. See [Introduction to Stocks](/terminal/guides/intros/stocks). diff --git a/website/content/terminal/guides/intros/common/ba.md b/website/content/terminal/guides/intros/common/ba.md index db3c1d889f6..45b291c0c8c 100644 --- a/website/content/terminal/guides/intros/common/ba.md +++ b/website/content/terminal/guides/intros/common/ba.md @@ -6,7 +6,7 @@ description: The Behavioural Analysis menu offers the user tools for gauging the The Behavioural Analysis menu offers the user tools for gauging the overall public sentiment of a company online. The complexity of the tools range from message board scrapers to deep learning algorithms for financial analysis and prediction. Sentiment is particularly useful for momentum trading strategies, discovery, and general fundamental research. Navigate into the menu from the Stocks menu by entering, `ba`; or, using absolute paths from anywhere in the Terminal: `/stocks/ba` -image +image ### How to use diff --git a/website/content/terminal/guides/intros/common/qa.md b/website/content/terminal/guides/intros/common/qa.md index ce1c53be71e..9403d6b3a9a 100644 --- a/website/content/terminal/guides/intros/common/qa.md +++ b/website/content/terminal/guides/intros/common/qa.md @@ -12,7 +12,7 @@ The Quantitative Analysis menu is a common menu to three asset classes: - Forex - Stocks -image +image ### How to use diff --git a/website/content/terminal/guides/intros/common/ta.md b/website/content/terminal/guides/intros/common/ta.md index 865c395b5cd..f3da5560aa7 100644 --- a/website/content/terminal/guides/intros/common/ta.md +++ b/website/content/terminal/guides/intros/common/ta.md @@ -26,7 +26,7 @@ All commands in this menu will rely on the interval and window chosen when +image Choose a beginning and end date to see a volume-weighted average price chart of the loaded ticker. `vwap --start 2022-01-01 --end 2022-06-17` diff --git a/website/content/terminal/guides/intros/crypto/dd.md b/website/content/terminal/guides/intros/crypto/dd.md index ce629487d83..5744c6cfac0 100644 --- a/website/content/terminal/guides/intros/crypto/dd.md +++ b/website/content/terminal/guides/intros/crypto/dd.md @@ -11,7 +11,7 @@ The Cryptocurrency Due Diligence menu gives the user the ability to delve deeper The Cryptocurrency Due Diligence menu is called upon by typing `dd` (after loading a coin), while inside the `crypto` menu, which opens the following menu: -image +image This menu requires you to load a coin with the `load` command. Thus, alternatively, you can also type `/crypto/load BTC/dd`. Within the Cryptocurrency Due Diligence menu you can find features examining an extensive amount of metrics about the loaded coin. As an example, you can see the latest trades done on the loaded coin with `trades`: diff --git a/website/content/terminal/guides/intros/crypto/defi.md b/website/content/terminal/guides/intros/crypto/defi.md index eb5e8976768..e540fc56fda 100644 --- a/website/content/terminal/guides/intros/crypto/defi.md +++ b/website/content/terminal/guides/intros/crypto/defi.md @@ -10,7 +10,7 @@ The Cryptocurrency Decentralized Finance (DeFi) menu gives the user the ability The Cryptocurrency Decentralized Finance (DeFi) menu is called upon by typing `defi`, while inside the `crypto` menu, which opens the following menu: -image +image Alternatively, you can also type `/crypto/defi`. Within the Cryptocurrency Decentralized Finance (DeFi) menu you can find features that delve deeper in the world of decentralized finance. diff --git a/website/content/terminal/guides/intros/crypto/disc.md b/website/content/terminal/guides/intros/crypto/disc.md index ca919c1ba61..d7fab0b87cc 100644 --- a/website/content/terminal/guides/intros/crypto/disc.md +++ b/website/content/terminal/guides/intros/crypto/disc.md @@ -10,7 +10,7 @@ The Cryptocurrency Discovery menu provides the option to look into a wide select The Cryptocurrency Discovery menu is called upon by typing `disc`, while inside the `crypto` menu, which opens the following menu: -image +image Alternatively, you can also type `/crypto/disc`. Within the Cryptocurrency Discovery menu you have a variety of options to find that information about a coin, a NFT, a specific blockchain game, decentralized app or exchange. E.g. we can look into the top coins by typing `top` which returns the following table: diff --git a/website/content/terminal/guides/intros/crypto/index.md b/website/content/terminal/guides/intros/crypto/index.md index af7facf31ea..b3fc1ea1797 100644 --- a/website/content/terminal/guides/intros/crypto/index.md +++ b/website/content/terminal/guides/intros/crypto/index.md @@ -12,7 +12,7 @@ NFT ( +image You have the ability to search a coin with `find` based on its name or symbol. An example: diff --git a/website/content/terminal/guides/intros/crypto/nft.md b/website/content/terminal/guides/intros/crypto/nft.md index 96005391bf6..8960ec990c0 100644 --- a/website/content/terminal/guides/intros/crypto/nft.md +++ b/website/content/terminal/guides/intros/crypto/nft.md @@ -10,7 +10,7 @@ The Non Fungible Token (NFT) menu gives the user the ability to dive into certai The Non Fungible Token (NFT) menu is called upon by typing `nft`, while inside the `crypto` menu, which opens the following menu: -image +image Alternatively, you can also type `/crypto/nft`. Within the Non Fungible Token (NFT) menu you can explore the statistics of specific NFTs you are interested in. diff --git a/website/content/terminal/guides/intros/crypto/onchain.md b/website/content/terminal/guides/intros/crypto/onchain.md index fda107ce861..f689fa360a0 100644 --- a/website/content/terminal/guides/intros/crypto/onchain.md +++ b/website/content/terminal/guides/intros/crypto/onchain.md @@ -10,7 +10,7 @@ The Cryptocurrency Onchain menu provides access to features that determine marke The Cryptocurrency Onchain menu is called upon by typing `onchain`, while inside the `crypto` menu, which opens the following menu: -image +image Alternatively, you can also type `/crypto/onchain`. Within the Cryptocurrency Onchain menu you can find features examining transaction data and crypto wallet balances, both of which are helpful when deciding whether to invest. E.g. we can look into the top ERC20 token by typing `top` which returns the following table: diff --git a/website/content/terminal/guides/intros/crypto/ov.md b/website/content/terminal/guides/intros/crypto/ov.md index 0046f7be47b..c2bc636490b 100644 --- a/website/content/terminal/guides/intros/crypto/ov.md +++ b/website/content/terminal/guides/intros/crypto/ov.md @@ -10,7 +10,7 @@ The Cryptocurrency Overview menu provides, among other things, the option to obt The Cryptocurrency Overview menu is called upon by typing `ov`, while inside the `crypto` menu, which opens the following menu: -image +image Alternatively, you can also type `/crypto/ov`. Within the Cryptocurrency Overview menu you have a variety of options to get an understanding of the global market, derivatives, heatmaps, a full list of exchanges, news, fees and borrow rates. Taking one of these as an example, `derivatives` returns a Futures table: diff --git a/website/content/terminal/guides/intros/econometrics.md b/website/content/terminal/guides/intros/econometrics.md index 7cfc9dc9093..560ae61a662 100644 --- a/website/content/terminal/guides/intros/econometrics.md +++ b/website/content/terminal/guides/intros/econometrics.md @@ -10,7 +10,7 @@ The Econometrics menu's purpose is to provide the user the ability to perform st The Econometrics menu is called upon by typing `econometrics` which opens the following menu: -image +image You have the ability to load in your own custom datasets but there is also the option to use example datasets which are used within this guide as well. These datasets can be found by using the load command and typing `load --examples`. See below: diff --git a/website/content/terminal/guides/intros/economy.md b/website/content/terminal/guides/intros/economy.md index e44c555376a..c3f5b8d361c 100644 --- a/website/content/terminal/guides/intros/economy.md +++ b/website/content/terminal/guides/intros/economy.md @@ -10,7 +10,7 @@ The Economy menu enables you to obtain market overviews ( +image Within the Economy menu you have a variety of options ranging from treasury rates to population growth to country financial performance. As this is quite extensive, the guide has two sections. The first section will discuss valuations and performance and the second section discusses the databases. diff --git a/website/content/terminal/guides/intros/etf.md b/website/content/terminal/guides/intros/etf.md index fac61abb4ad..1eb14ebdbd4 100644 --- a/website/content/terminal/guides/intros/etf.md +++ b/website/content/terminal/guides/intros/etf.md @@ -10,7 +10,7 @@ The ETF menu enables you to lookup any ETF and obtain an +image You now have the ability to look up any ETF. With the example below, the `load` command is used to load an ETF. diff --git a/website/content/terminal/guides/intros/forex.md b/website/content/terminal/guides/intros/forex.md index 091b55df57e..8445a6f6f3f 100644 --- a/website/content/terminal/guides/intros/forex.md +++ b/website/content/terminal/guides/intros/forex.md @@ -10,7 +10,7 @@ The Forex menu enables you to +image For example, you are able to show the quote of the currency pair by using the quote command: diff --git a/website/content/terminal/guides/intros/futures.md b/website/content/terminal/guides/intros/futures.md index 56b8ced24f2..3953adb4f70 100644 --- a/website/content/terminal/guides/intros/futures.md +++ b/website/content/terminal/guides/intros/futures.md @@ -6,7 +6,7 @@ description: The Futures menu provides historical prices and the current term st The Futures menu provides historical prices and the current term structure for an asset. This menu is accessible from the Main menu by typing `futures` and pressing the `enter` key. -image +image ## How to Use diff --git a/website/content/terminal/guides/intros/portfolio/index.md b/website/content/terminal/guides/intros/portfolio/index.md index aaab76e5535..26d8f2bbf1d 100644 --- a/website/content/terminal/guides/intros/portfolio/index.md +++ b/website/content/terminal/guides/intros/portfolio/index.md @@ -11,7 +11,7 @@ and +image The first step in using this menu is loading a portfolio with load. Within this guide, we provide an example file when running `load --example` which will be used to explain the functionality through the guide. diff --git a/website/content/terminal/guides/intros/portfolio/po.md b/website/content/terminal/guides/intros/portfolio/po.md index f5f31ccebc6..92771ed0bc8 100644 --- a/website/content/terminal/guides/intros/portfolio/po.md +++ b/website/content/terminal/guides/intros/portfolio/po.md @@ -10,7 +10,7 @@ The Portfolio Optimization menu allows the user to apply advanced optimization t The portfolio optimization menu can be reached by visiting the `portfolio` menu and typing `po` (or alternatively, typing `/portfolio/po` from any location). This opens the following menu: -image +image The first step in using this menu is loading a portfolio with load. Within this guide, we provide an example file when running `load --example` which will be used to explain the functionality through the guide. diff --git a/website/content/terminal/guides/intros/stocks/comparison.md b/website/content/terminal/guides/intros/stocks/comparison.md index 220205dcde9..3b2376bc3ea 100644 --- a/website/content/terminal/guides/intros/stocks/comparison.md +++ b/website/content/terminal/guides/intros/stocks/comparison.md @@ -5,7 +5,7 @@ description: The Comparison Analysis menu provides the user with tools for compa --- The Comparison Analysis menu provides the user with tools for comparison (similar) stocks. It is not necessary to load a ticker from the Stocks menu to use these features. Enter the Comparison Analysis submenu by typing `ca` and pressing `ENTER` (⏎). -image +image ### How to use 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 24f4ec64a17..35b9e3b5bea 100644 --- a/website/content/terminal/guides/intros/stocks/dark-pool-shorts.md +++ b/website/content/terminal/guides/intros/stocks/dark-pool-shorts.md @@ -6,7 +6,7 @@ description: The Introduction to Dark Pools & Short Data, within the Stocks menu The purpose of this menu is to provide the user with tools for gauging the level of short interest, FTD rate, and off-exchange volume in a NMS security. There are also commands for looking at market as a whole. Enter the submenu from the Stocks menu by typing, `dps`, and hitting `ENTER` (⏎). -image +image To use every feature in the Dark Pools menu, an API key for Quandl must be obtained (for free) and authorized on the local installation. See the Setting API Keys Guide 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. diff --git a/website/content/terminal/guides/intros/stocks/disc.md b/website/content/terminal/guides/intros/stocks/disc.md index 18a067f7b60..07a58ad26d9 100644 --- a/website/content/terminal/guides/intros/stocks/disc.md +++ b/website/content/terminal/guides/intros/stocks/disc.md @@ -5,7 +5,7 @@ description: Introducing the Discovery menu, within the Stocks menu. This guide --- The set of features within the Stocks Discovery submenu provides tools for discovering trade setups, for following trends, and for staying up with current events. Enter the menu from the Stocks menu by typing, `disc`, and pressing, `ENTER` (⏎). Absolute path jumping is possible from anywhere, to anywhere. For example, jumping from the Portfolio Optimization submenu to the Stocks Discovery submenu: -image +image ### How to use diff --git a/website/content/terminal/guides/intros/stocks/fa.md b/website/content/terminal/guides/intros/stocks/fa.md index b1efd2a6380..8590756718e 100644 --- a/website/content/terminal/guides/intros/stocks/fa.md +++ b/website/content/terminal/guides/intros/stocks/fa.md @@ -10,7 +10,7 @@ The Fundamental Analysis menu is a set of tools for measuring a company's intrin Enter the submenu from the Stocks menu, with a ticker loaded. -image +image Some commands offer interpretations of the data, but, the majority are statements reported to the SEC. The `overview` command is a table of basic statistics, including price. ```` diff --git a/website/content/terminal/guides/intros/stocks/gov.md b/website/content/terminal/guides/intros/stocks/gov.md index 8aed21683be..3f647b13500 100644 --- a/website/content/terminal/guides/intros/stocks/gov.md +++ b/website/content/terminal/guides/intros/stocks/gov.md @@ -6,7 +6,7 @@ description: This guide introduces the Government submenu, within the Stocks men 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 QuiverQuant. A ticker is not required to enter the menu; navigate there from anywhere in the terminal with absolute path jumping: `/stocks/gov` -image +image ### How to use diff --git a/website/content/terminal/guides/intros/stocks/index.md b/website/content/terminal/guides/intros/stocks/index.md index 4c5fa8f75e1..30d85a95c16 100644 --- a/website/content/terminal/guides/intros/stocks/index.md +++ b/website/content/terminal/guides/intros/stocks/index.md @@ -63,7 +63,7 @@ For more information and examples, use 'about news' to access the related guide. The first step in many workflows will be to load a stock symbol with historical data. The amount, granularity, and market coverage will vary by source. Users can elect to subscribe to any of the data sources accordingly. While no API keys are required to get started using the Terminal, acquiring these credentials at the free level will enhance the user experience with additional functionality. Refer to the [API keys guide](https://docs.openbb.co/terminal/guides/advanced/api-keys) for links to obtain each. -image +image Attaching the source argument to a command enables users to select their preferred source. The default sources can be changed from the [`/sources` menu](https://docs.openbb.co/terminal/guides/advanced/changing-sources). To select the `source` as `NewsApi`, use the block below. diff --git a/website/content/terminal/guides/intros/stocks/ins.md b/website/content/terminal/guides/intros/stocks/ins.md index a5a30b317b9..cabf7ab6510 100644 --- a/website/content/terminal/guides/intros/stocks/ins.md +++ b/website/content/terminal/guides/intros/stocks/ins.md @@ -6,7 +6,7 @@ description: This guide introduces the Insider Trading submenu, within the Stock The Insider Trading menu gives stock screener for SEC Form 4 filings and researching individual companies for executive and director transactions. Navigate to the Insider Trading submenu from the `stocks` menu by typing `ins` and pressing `enter`. The features in this menu function only for companies registered with the SEC, that also trade in public markets. -image +image ### How to use diff --git a/website/content/terminal/guides/intros/stocks/options/hedge.md b/website/content/terminal/guides/intros/stocks/options/hedge.md index ef78668cc95..bba497b189c 100644 --- a/website/content/terminal/guides/intros/stocks/options/hedge.md +++ b/website/content/terminal/guides/intros/stocks/options/hedge.md @@ -5,7 +5,7 @@ excerpt: This guide introduces the Hedge submenu, within the Options menu, provi --- The Hedge menu is designed to help the user calculate positions within the selected expiration chain to be directionally neutral. Enter the submenu after choosing the desired expiration date by using the command, `hedge`, from the Options menu. -image +image ### How to use diff --git a/website/content/terminal/guides/intros/stocks/options/index.md b/website/content/terminal/guides/intros/stocks/options/index.md index 48118ad881b..c7b2726a2f0 100644 --- a/website/content/terminal/guides/intros/stocks/options/index.md +++ b/website/content/terminal/guides/intros/stocks/options/index.md @@ -9,7 +9,7 @@ The Options menu provides the user with a comprehensive set of tools for analyzi Navigate to the menu by typing `options`, from the `Stocks` menu, and then pressing enter. Alternatively, absolute path navigation can jump straight there, from anywhere. `/stocks/options` -image +image By default, the Terminal loads a ticker using Tradier as the source. Sign up for a free developer account and then enter that token using the `Keys menu`. 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. diff --git a/website/content/terminal/guides/intros/stocks/options/pricing.md b/website/content/terminal/guides/intros/stocks/options/pricing.md index 5e2efc1470b..27a6939666e 100644 --- a/website/content/terminal/guides/intros/stocks/options/pricing.md +++ b/website/content/terminal/guides/intros/stocks/options/pricing.md @@ -8,7 +8,7 @@ This set of features is for composing hypothetical outcomes through user-defined The Pricing submenu is accessible after selecting anexpiration date for the options chain. Type, `pricing`, and press enter for access. -image +image ## How to use diff --git a/website/content/terminal/guides/intros/stocks/options/screener.md b/website/content/terminal/guides/intros/stocks/options/screener.md index 4670b12089c..df37430ccb4 100644 --- a/website/content/terminal/guides/intros/stocks/options/screener.md +++ b/website/content/terminal/guides/intros/stocks/options/screener.md @@ -5,7 +5,7 @@ description: This guide introduces the user to the Options Screener, located wit --- The OpenBB options screener is a versatile discovery tool for an options trader. -image +image The screener makes use of presets (.ini files) that are stored locally within `~/OpenBBUserData/presets/stocks/options/` diff --git a/website/content/terminal/guides/intros/stocks/screener.md b/website/content/terminal/guides/intros/stocks/screener.md index 47ebc461b38..4790e9b1d51 100644 --- a/website/content/terminal/guides/intros/stocks/screener.md +++ b/website/content/terminal/guides/intros/stocks/screener.md @@ -5,7 +5,7 @@ description: This guide introduces the Stock Screener, within the Stocks menu, b --- The Stock sScreener menu is a diverse tool for stock discovery. There are categories of statistics to use as metrics to sort the criteria defined in the preset file. The preset files are `.ini` files stored locally in the application folder: `~/OpenBBUserData/presets/stocks/screener` and they can be modified in any text editor. Get to the Stock Screener from the `Stocks` menu by typing `scr` and then pressing `enter`. -image +image ### How to use @@ -58,7 +58,7 @@ The columns can be sorted with the optional argument `-s`, and autocomplete will To see a description of each preset, use `view`, and autocomplete will allow the user to scroll presets with the arrow keys to `set` the choice. -image +image ### Examples diff --git a/website/content/terminal/guides/intros/stocks/sia.md b/website/content/terminal/guides/intros/stocks/sia.md index 2d3b1d7c8e7..e456192029c 100644 --- a/website/content/terminal/guides/intros/stocks/sia.md +++ b/website/content/terminal/guides/intros/stocks/sia.md @@ -11,7 +11,7 @@ The most promising sectors are chosen first under the top-down strategy, and the When you have loaded in a ticker, the menu automatically finds the corresponding industry, sector, country and market cap. -image +image Based on this information, you can get insights in a variety of datapoints, for example with `cps` you are able to see the companies based per sector and market cap: diff --git a/website/content/terminal/guides/intros/stocks/tradinghours.md b/website/content/terminal/guides/intros/stocks/tradinghours.md index c40a3bf9bd5..75d499341a7 100644 --- a/website/content/terminal/guides/intros/stocks/tradinghours.md +++ b/website/content/terminal/guides/intros/stocks/tradinghours.md @@ -5,7 +5,7 @@ description: An Introduction to the Trading Hours menu, within the Stocks menu. --- This set of features is for checking the operating status of markets globally. To access the Trading Hours features, enter `th` from the Stocks menu. Alternatively, a user can access the submenu with absolute path navigation from anywhere in the Terminal: `/stocks/th` -image +image ## How to use