Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/doc updates #4253

Merged
merged 47 commits into from
Feb 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
ddc013f
fix: wordwrap
jose-donato Dec 15, 2022
6225475
Merge branch 'main' of https://github.com/OpenBB-finance/OpenBBTerminal
jose-donato Dec 15, 2022
b4989ed
Merge branch 'main' of https://github.com/OpenBB-finance/OpenBBTerminal
jose-donato Dec 21, 2022
77a2663
Merge branch 'main' of https://github.com/OpenBB-finance/OpenBBTerminal
jose-donato Jan 11, 2023
76acf34
Merge branch 'main' of https://github.com/OpenBB-finance/OpenBBTerminal
jose-donato Jan 23, 2023
9dea17f
Merge pull request #4237 from OpenBB-finance/release/2.4.0
jmaslek Feb 14, 2023
bbf5dd1
Merge branch 'main' of https://github.com/OpenBB-finance/OpenBBTerminal
jose-donato Feb 14, 2023
6b35c4e
fix: algolia
jose-donato Feb 14, 2023
6451deb
Merge pull request #4244 from OpenBB-finance/hotfix/algolia-smth
jmaslek Feb 14, 2023
dac5b59
New images in Basics
JerBouma Feb 15, 2023
841f0bf
Update
JerBouma Feb 15, 2023
3e8585d
Update qa.md
JerBouma Feb 15, 2023
640259f
Update ta.md
JerBouma Feb 15, 2023
f3a6489
Update comparison.md
JerBouma Feb 15, 2023
81431ce
Update dark-pool-shorts.md
JerBouma Feb 15, 2023
5d39673
Update disc.md
JerBouma Feb 15, 2023
dc65ed3
Update fa.md
JerBouma Feb 15, 2023
6ccc468
Update gov.md
JerBouma Feb 15, 2023
3f3e6dc
Update index since for some silly reason it used SPY
JerBouma Feb 15, 2023
187a970
Update ins.md
JerBouma Feb 15, 2023
ff81210
Update screener.md
JerBouma Feb 15, 2023
f841a2a
Update sia.md
JerBouma Feb 15, 2023
2fb7e02
Update tradinghours.md
JerBouma Feb 15, 2023
4367e73
Update index.md
JerBouma Feb 15, 2023
84f946d
Update hedge.md
JerBouma Feb 15, 2023
508ed53
Update pricing.md
JerBouma Feb 15, 2023
4ead1c0
Update screener.md
JerBouma Feb 15, 2023
9fb2f78
Update econometrics.md
JerBouma Feb 15, 2023
f3fccf3
Update economy.md
JerBouma Feb 15, 2023
6586c09
Update economy.md
JerBouma Feb 15, 2023
0489eea
Update etf.md
JerBouma Feb 15, 2023
e610f70
Update forex.md
JerBouma Feb 15, 2023
0bfc287
Update futures.md
JerBouma Feb 15, 2023
459fc2d
Update dd.md
JerBouma Feb 15, 2023
979728d
Update defi.md
JerBouma Feb 15, 2023
0ff9f68
Update disc.md
JerBouma Feb 15, 2023
73ec82b
Update index.md
JerBouma Feb 15, 2023
5b9b5a9
Update nft.md
JerBouma Feb 15, 2023
402c3a7
Update onchain.md
JerBouma Feb 15, 2023
ae69b88
Update ov.md
JerBouma Feb 15, 2023
253842b
Update index.md
JerBouma Feb 15, 2023
a970013
Update po.md
JerBouma Feb 15, 2023
8016bde
forgot one
JerBouma Feb 15, 2023
6b50411
Merge branch 'main' into feature/doc-updates
jmaslek Feb 15, 2023
6d271fb
Merge pull request #4251 from OpenBB-finance/feature/doc-updates
jmaslek Feb 15, 2023
eae5f30
Fix the stuff
JerBouma Feb 15, 2023
8890d83
Merge branch 'main' into feature/doc-updates
jmaslek Feb 15, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion website/content/terminal/guides/advanced/api-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

<img width="800" alt="image" src="https://user-images.githubusercontent.com/85772166/194684312-f12b7f26-8a04-4efe-bc94-fa516b7186d3.png"></img>
<img width="800" alt="image" src="https://user-images.githubusercontent.com/46355364/219021978-41caff4c-65e2-4169-983f-3e66fdce4563.png"></img>

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`.

Expand Down
32 changes: 18 additions & 14 deletions website/content/terminal/guides/basics/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The OpenBB Terminal is based off the <a href="https://en.wikipedia.org/wiki/Comm
which is installed by default on every computer. By opening the application you have installed from the [Installation Page](/terminal/quickstart/installation),
you are greeted with the following interface:

<img src="https://user-images.githubusercontent.com/85772166/194683764-ae1c6c0a-8d50-4533-b930-ec4b601017b8.png" width="800"/>
<img width="800" alt="image" src="https://user-images.githubusercontent.com/46355364/218973939-deb992e3-52cc-400f-a00f-4d9addbcedd4.png"></img>

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.

Expand All @@ -24,7 +24,7 @@ Throughout the entire terminal, the same set of colors are used which all share

Menus, depicted in <b><span style={{color:"#005CA9"}}>Dark Blue</span></b>, 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.

<a target="_blank" href="https://user-images.githubusercontent.com/85772166/194683870-7888ad2f-5d38-4484-96a5-cbe95bf52d5b.png"><img src="https://user-images.githubusercontent.com/85772166/194683870-7888ad2f-5d38-4484-96a5-cbe95bf52d5b.png" alt="Stocks Menu" width="800"/></a>
<img width="800" alt="image" src="https://user-images.githubusercontent.com/46355364/218974442-563cb216-623f-4f98-b2e1-9f1bb0e1a199.png"></img>

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).

Expand All @@ -48,18 +48,18 @@ the commands that you are able to use from any menu in the terminal (see <a href
Continuing with the example mentioned at `quit`, revisit the `stocks` menu and look at the commands. At the top you will see a command named <a href="/terminal/reference/stocks/load" target="_blank" rel="noreferrer noopener">load</a>. To understand what this command can do, you can use `load -h` followed by `ENTER` (⏎). The `-h` stands for `help` and every command will have this feature. This will return the following:

```
2022 May 19, 05:27 (🦋) /stocks/ $ load -h
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)
Expand All @@ -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.
Expand All @@ -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 <a href="https://www.investopedia.com/ask/answers/12/what-is-a-stock-ticker.asp" target="_blank" rel="noreferrer noopener">stock ticker</a> 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.
Expand All @@ -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 <a href="https://www.investopedia.com/trading/candlestick-charting-what-is-it/" target="_blank" rel="noreferrer noopener">candle chart</a> 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
```

<a target="_blank" href="https://user-images.githubusercontent.com/46355364/169503345-a9409637-dc7a-4193-9c87-38b1b6ee1a08.png"><img src="https://user-images.githubusercontent.com/46355364/169503345-a9409637-dc7a-4193-9c87-38b1b6ee1a08.png" alt="Amazon Candle Chart" width="800"/></a>
![Candlestick Chart Amazon](https://user-images.githubusercontent.com/46355364/218974887-f7d6bc81-4d25-4ef2-9854-0a6bebc351d1.png)

As mentioned in the <a href="#explanation-of-menus">Explanation of Menus</a>, some information also transfers over to other menus and this includes the loaded market data from <a href="/terminal/reference/stocks/load" target="_blank" rel="noreferrer noopener">load</a>. So, if you would visit the `ta` menu (which stands for <a href="https://www.investopedia.com/terms/t/technicalanalysis.asp" target="_blank" rel="noreferrer noopener">Technical Analysis</a>) you will see that, by running any command, the selected period above is depicted again. Return to the Stocks menu again by using `q` and use it again to return to the home screen which can be shown with `?`.

Expand Down
34 changes: 2 additions & 32 deletions website/content/terminal/guides/intros/common/ba.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="/terminal/guides/intros/stocks/" target="_blank" rel="noreferrer noopener">Stocks</a> menu by entering, `ba`; or, using absolute paths from anywhere in the Terminal: `/stocks/ba`

<img alt="The Behavioural Analysis submenu" src="https://user-images.githubusercontent.com/46355364/170242317-ae66ed0b-f2e8-4304-9231-ea833d01e0e2.png"></img>
<img width="800" alt="image" src="https://user-images.githubusercontent.com/46355364/218975466-a52343f6-9f43-4ecc-88ac-f47afbd7f128.png"></img>

### How to use

The commands with text, representing <a href="https://docs.openbb.co/terminal/guides/basics" target="_blank" rel="noreferrer noopener">commands</a>, 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/ $ ?
```

<img alt="The Behavioural Analysis Menu with a loaded ticker" src="https://user-images.githubusercontent.com/46355364/170242757-3e29f690-7d29-4fe2-9e14-889c43e3142e.png"></img>

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:

- <a href="https://finnhub.io/" target="_blank" rel="noreferrer noopener">Finnhub</a><br/>
- <a href="https://developer.twitter.com/" target="_blank" rel="noreferrer noopener">Twitter</a><br/>
- <a href="https://old.reddit.com/prefs/apps/" target="_blank" rel="noreferrer noopener">Reddit</a><br/>
- <a href="https://sentimentinvestor.com/" target="_blank" rel="noreferrer noopener">Sentiment
Investor</a><br/>

See the <a href="/terminal/guides/advanced/api-keys" target="_blank" rel="noreferrer noopener">Set API keys</a> for help with API keys in the Terminal.

### Examples

As with every command, using the `-h` argument displays the help dialogue. Running the <a href="/terminal/reference/stocks/ba/headlines/" target="_blank" rel="noreferrer noopener">headlines</a> 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 <a href="/terminal/reference/stocks/ba/headlines/" target="_blank" rel="noreferrer noopener">headlines</a> command returns the following:

```
(🦋) /stocks/ba/ $ headlines
Expand Down
Loading