summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChavithra PARANA <chavithra@gmail.com>2022-11-29 02:15:02 +0100
committerChavithra PARANA <chavithra@gmail.com>2022-11-29 02:15:02 +0100
commitcb08bf096958af4131357a9fa8d7ce546671709a (patch)
treec3b6b90064aafbd3630baf79cbd9be3e9f90cc29
parent80aa4768c6e1c00c02aba9bbb8168e401fc32c9f (diff)
parente042116fab56c797ef313e3bd03418eb1a29c875 (diff)
Merge branch 'main' of github.com:OpenBB-finance/OpenBBTerminal
-rw-r--r--website/content/sdk/guides/intros/alternative.md2
-rw-r--r--website/content/sdk/guides/intros/crypto.md10
-rw-r--r--website/content/sdk/guides/intros/econometrics.md2
-rw-r--r--website/content/sdk/guides/intros/economy.md32
-rw-r--r--website/content/sdk/guides/intros/etf.md4
-rw-r--r--website/content/sdk/guides/intros/forecast.md4
-rw-r--r--website/content/sdk/guides/intros/futures.md3
-rw-r--r--website/content/sdk/guides/intros/portfolio/index.md30
-rw-r--r--website/content/sdk/guides/intros/portfolio/po.md72
-rw-r--r--website/content/sdk/guides/intros/stocks/behavioral-analysis.md44
-rw-r--r--website/content/sdk/guides/intros/stocks/discovery.md36
-rw-r--r--website/content/sdk/guides/intros/stocks/fundamental-analysis.md56
-rw-r--r--website/content/sdk/guides/intros/stocks/sia.md24
-rw-r--r--website/content/terminal/guides/advanced/scripts-and-routines.md2
-rw-r--r--website/content/terminal/guides/basics/index.md10
-rw-r--r--website/content/terminal/guides/intros/common/ba.md2
-rw-r--r--website/content/terminal/quickstart/installation.md4
17 files changed, 158 insertions, 179 deletions
diff --git a/website/content/sdk/guides/intros/alternative.md b/website/content/sdk/guides/intros/alternative.md
index 3d4b2665934..095f5f572af 100644
--- a/website/content/sdk/guides/intros/alternative.md
+++ b/website/content/sdk/guides/intros/alternative.md
@@ -39,7 +39,7 @@ A brief description below highlights the main Functions and Modules available in
|openbb.alt.covid.ov |Function | overview historical cases and deaths by country |
-Alteratively you can print the contents of the ETF SDK with:
+Alteratively you can print the contents of the Alternative SDK with:
```python
help(openbb.alt.covid)
diff --git a/website/content/sdk/guides/intros/crypto.md b/website/content/sdk/guides/intros/crypto.md
index 74c44dd3c05..80b7a9d0e5b 100644
--- a/website/content/sdk/guides/intros/crypto.md
+++ b/website/content/sdk/guides/intros/crypto.md
@@ -11,7 +11,7 @@ The list below are all the SDK functions at the `openbb.crypto` level:
| Path | Type | Description |
| :-------------------- | :--------: | --------------------: |
-| openbb.crypto.candles | Function | OHLC+V chart |
+| openbb.crypto.candle | Function | OHLC+V chart |
| openbb.crypto.dd | Sub-Module | Due Diligence |
| openbb.crypto.defi | Sub-Module | DeFi |
| openbb.crypto.disc | Sub-Module | Discovery |
@@ -244,10 +244,10 @@ eth_df.tail(3)
A loaded DataFrame is used as the input for the `candles` function:
```python
-openbb.crypto.candles(eth_df)
+openbb.crypto.candle(eth_df)
```
-![openbb.crypto.candles](https://user-images.githubusercontent.com/85772166/202791587-d69c7568-69ff-46b3-b41f-146ed8796f7e.png "openbb.crypto.candles")
+![openbb.crypto.candle](https://user-images.githubusercontent.com/85772166/202791587-d69c7568-69ff-46b3-b41f-146ed8796f7e.png "openbb.crypto.candle")
Notice that the chart has no title. It can be added using the `title` argument.
@@ -255,14 +255,14 @@ Notice that the chart has no title. It can be added using the `title` argument.
openbb.crypto.candles(eth_df, title = 'ETH/USDT (Monthly)')
```
-![openbb.crypto.candles](https://user-images.githubusercontent.com/85772166/202791726-b4a775d9-5a00-4d92-8fbc-bd26aeff62d2.png "openbb.crypto.candles")
+![openbb.crypto.candle](https://user-images.githubusercontent.com/85772166/202791726-b4a775d9-5a00-4d92-8fbc-bd26aeff62d2.png "openbb.crypto.candle")
### Find
Find similar coins by name, symbol, or ID.
```python
-results = openbb.crypto.search(
+results = openbb.crypto.find(
query = 'Genesis',
source = 'CoinPaprika',
key = 'name',
diff --git a/website/content/sdk/guides/intros/econometrics.md b/website/content/sdk/guides/intros/econometrics.md
index ed4a19e09c5..2b4bf9eecc9 100644
--- a/website/content/sdk/guides/intros/econometrics.md
+++ b/website/content/sdk/guides/intros/econometrics.md
@@ -67,7 +67,7 @@ help(openbb.econometrics)
### Loading a dataset
The first step in using this menu is loading a dataset. This can be either an example dataset, see the list below, or any locally stored Excel file. To demonstrate the usage of the menu, the <a href="https://www.statsmodels.org/dev/datasets/generated/longley.html" target="_blank" rel="noreferrer noopener">longley</a>
-dataset is loaded in. This can be done with the following
+ dataset is loaded in. This can be done with the following
```python
example_load = openbb.econometrics.load("anes96")
diff --git a/website/content/sdk/guides/intros/economy.md b/website/content/sdk/guides/intros/economy.md
index e9700ba44a5..790f2498bcd 100644
--- a/website/content/sdk/guides/intros/economy.md
+++ b/website/content/sdk/guides/intros/economy.md
@@ -12,9 +12,9 @@ Define the keys for the OpenBB installation with:
```python
-obb.keys.fred(key = 'REPLACE_ME', persist = True)
-obb.keys.quandl(key = 'REPLACE_ME', persist = True)
-obb.keys.av(key = 'REPLACE_ME', persist = True)
+openbb.keys.fred(key = 'REPLACE_ME', persist = True)
+openbb.keys.quandl(key = 'REPLACE_ME', persist = True)
+openbb.keys.av(key = 'REPLACE_ME', persist = True)
```
## How to Use
@@ -33,8 +33,6 @@ Below is brief description of each function within the Economy module:
| openbb.economy.events | Function | Economic Calendar |
| openbb.economy.fred_ids | Function | Search for a FRED series ID by keyword |
| openbb.economy.fred_notes | Function | Search by Keyword for Series Information |
-| openbb.economy.fred_series | Function | Get Data for a FRED Series ID(s) |
-| openbb.economy.fred_series_chart | Function | Chart for `fred_series` |
| openbb.economy.futures | Function | Current Prices of Commodities |
| openbb.economy.gdpc | Function | US GDP per Capita from AlphaVantage |
| openbb.economy.gdpc_chart | Function | Chart for `gdpc` |
@@ -267,30 +265,6 @@ series_ids.head(5)
| A33DNO | Manufacturers' New Orders: Mining, Oil, and Gas Field Machinery Manufacturing |
| PCU21112111 | Producer Price Index by Industry: Oil and Gas Extraction |
-Request the data for a series ID, or a list of IDs:
-
-```python
-data,titles = openbb.economy.fred_series(series_ids=['A33DNO', 'PCU21112111'])
-
-data.tail(5)
-```
-
-| | A33DNO | PCU21112111 |
-| :------------------ | -----: | ----------: |
-| 2022-05-01 00:00:00 | 1509 | 339.024 |
-| 2022-06-01 00:00:00 | 1534 | 374.936 |
-| 2022-07-01 00:00:00 | 1516 | 315.785 |
-| 2022-08-01 00:00:00 | 1661 | 350.329 |
-| 2022-09-01 00:00:00 | 1551 | 339.109 |
-
-Series can also be plotted together:
-
-```python
-openbb.economy.fred_series_chart(series_ids=['A33DNO', 'PCU21112111'])
-```
-
-![openbb.economy.fred_series_chart](https://user-images.githubusercontent.com/85772166/202557759-322a05ed-2740-4abf-8055-82a4abe0cc0d.png)
-
### Macro
The `macro` function will return a Tuple. See refer to the docstring below to see the input arguments:
diff --git a/website/content/sdk/guides/intros/etf.md b/website/content/sdk/guides/intros/etf.md
index 76faf8ba394..2b14f9e9d3a 100644
--- a/website/content/sdk/guides/intros/etf.md
+++ b/website/content/sdk/guides/intros/etf.md
@@ -58,7 +58,7 @@ ETFs are categorized into different buckets. Use the code block below as a way t
etf_list = pd.DataFrame.from_dict(openbb.etf.etf_by_category('')).transpose()
categories = list(etf_list['category'].drop_duplicates())
categories = pd.DataFrame(categories[1::], columns = ['Type'])
-​
+
categories.head(6)
```
@@ -77,7 +77,7 @@ categories.head(6)
```python
etf_category = pd.DataFrame.from_dict(openbb.etf.etf_by_category('Foreign Large Blend')).transpose()
etf_category = etf_category.sort_values(by=['total_assets'], ascending = False)
-​
+
etf_category.head(2)
```
diff --git a/website/content/sdk/guides/intros/forecast.md b/website/content/sdk/guides/intros/forecast.md
index 6872d91873b..29ff3ce858b 100644
--- a/website/content/sdk/guides/intros/forecast.md
+++ b/website/content/sdk/guides/intros/forecast.md
@@ -338,7 +338,7 @@ openbb.forecast.delete(spy, 'Close')
Then, let's rename, 'Adj Close', as, 'Close', and verify the results:
```python
-openbb.forecast.rename(spy, 'Adj Close', 'Close')
+spy = openbb.forecast.rename(spy, 'Adj Close', 'Close')
spy.tail(1)
```
@@ -440,7 +440,7 @@ Let's add another potential past-covariate to the dataset by taking the adjusted
```python
xom = openbb.stocks.load("XOM", start_date = '1993-01-29')
-openbb.forecast.combine(df1 = spy, df2 = xom, column = 'Adj Close', dataset = 'XOM' )
+spy = openbb.forecast.combine(df1 = spy, df2 = xom, column = 'Adj Close', dataset = 'XOM' )
spy.rename(columns = {'XOM_Adj Close': 'XOM'}, inplace = True)
```
diff --git a/website/content/sdk/guides/intros/futures.md b/website/content/sdk/guides/intros/futures.md
index 9663ae8051e..a247160ae4a 100644
--- a/website/content/sdk/guides/intros/futures.md
+++ b/website/content/sdk/guides/intros/futures.md
@@ -34,7 +34,7 @@ import pandas as pd
Futures can be searched by description, exchange, or category.
```python
-obb.futures.search(description = 'Eurodollar')
+openbb.futures.search(description = 'Eurodollar')
```
| | Ticker | Description | Exchange | Category |
@@ -60,7 +60,6 @@ eurodollar = openbb.futures.curve('GE')
| 2023-01-01 00:00:00 | 94.985 |
| 2023-02-01 00:00:00 | 94.9 |
| 2023-03-01 00:00:00 | 94.825 |
-...continued
To display a chart of the data, use `curve_chart`:
diff --git a/website/content/sdk/guides/intros/portfolio/index.md b/website/content/sdk/guides/intros/portfolio/index.md
index e987fe657d0..3e694fee917 100644
--- a/website/content/sdk/guides/intros/portfolio/index.md
+++ b/website/content/sdk/guides/intros/portfolio/index.md
@@ -88,8 +88,8 @@ help(openbb.portfolio.load)
```
```console
- Get PortfolioEngine object
-
+ Get PortfolioEngine object
+
Parameters
----------
transactions_file_path : str
@@ -101,11 +101,16 @@ help(openbb.portfolio.load)
quantity to the nearest number
risk_free_rate : float
Risk free rate in float format
-
+
Returns
-------
PortfolioEngine
PortfolioEngine class instance, this will hold transactions and perform calculations
+
+ Examples
+ --------
+ >>> from openbb_terminal.sdk import openbb
+ >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv")
```
The syntax should resemble something like the sample below; don't forget to modify the path to match the local path.
@@ -132,7 +137,7 @@ A Portfolio Object is assigned to the variable, `P`. The created object, or part
```python
P.set_benchmark(symbol = 'SPY')
-
+
Loading benchmark: 50%|█████ | 2/4 [00:00<00:00, 5.69it/s]
print(P.benchmark_ticker)
@@ -248,18 +253,17 @@ print(rs.tail(5))
rv = openbb.portfolio.rvol(P, window = '3m')
rv.rename(columns={'portfolio': 'Portfolio Volatility', 'benchmark': 'Benchmark Volatility'}, inplace = True)
rv.index = rv.index.strftime(date_format='%Y-%m-%d')
-rolling_metrics = dd.join(rv,rs)
-print(rolling_metrics.tail(5))
+print(rv.tail(5))
```
-| Date | Portfolio % Drawdown | Portfolio Value | Portfolio Volatility | Benchmark Volatility | Portfolio Sharpe | Benchmark Sharpe |
-|:-----------|-----------------------:|---------------------:|-----------------------:|-----------------------:|-------------------:|-------------------:|
-| 2022-11-21 | -0.58 | 109442 | 0.02 | 0.01 | -0.15 | 0.02 |
-| 2022-11-22 | -0.57 | 111257 | 0.02 | 0.01 | -0.13 | 0.05 |
-| 2022-11-23 | -0.56 | 114017 | 0.02 | 0.01 | -0.10 | 0.07 |
-| 2022-11-24 | -0.56 | 114027 | 0.02 | 0.01 | -0.10 | 0.08 |
-| 2022-11-25 | -0.56 | 113302 | 0.02 | 0.01 | -0.91 | 0.11 |
+| Date | Portfolio Volatility | Benchmark Volatility |
+|:-----------|-----------------------:|---------------------:|
+|2022-11-23 | 0.021727 | 0.014490|
+|2022-11-24 | 0.021715 | 0.014439|
+|2022-11-25 | 0.021596 | 0.014256|
+|2022-11-26 | 0.021591 | 0.014256|
+|2022-11-27 | 0.021592 | 0.014256|
### DRet
diff --git a/website/content/sdk/guides/intros/portfolio/po.md b/website/content/sdk/guides/intros/portfolio/po.md
index 1cc8f977028..875496df27c 100644
--- a/website/content/sdk/guides/intros/portfolio/po.md
+++ b/website/content/sdk/guides/intros/portfolio/po.md
@@ -18,7 +18,7 @@ from openbb_terminal.sdk import openbb
This menu requires the usage of the Excel templates to work properly. As there is a lot of complexity involved around these techniques, these templates allow the user to understand what values for each parameter are actually used and allow for an easy way to define the allocation.
-:::note For this there are two templates that need to be set, the **OpenBB Parameters Template** and the **OpenBB Portfolio Template**. These files can be found in [here](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/miscellaneous/portfolio_examples). Select a file and press "Download" on the right, then place it into the OpenBBUserData folder. You can find more about this folder [here](/sdk/advanced/data).
+:::note For this there are two templates that need to be set, the **OpenBB Parameters Template** and the **60_40_Portfolio.xlsx**. These files can be found in [here](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/miscellaneous/portfolio_examples). One is in the `allocation` folder and the other is in `optimization`. the Select a file and press "Download" on the right, then place it into the OpenBBUserData folder. You can find more about this folder [here](/sdk/advanced/data).
:::
### OpenBB Parameters Template
@@ -28,22 +28,6 @@ The OpenBB Terminal does, however, allow the user to run any model despite the `
<a target="_blank" href="https://user-images.githubusercontent.com/46355364/171144692-dd812efd-1e95-4a71-a93f-7ae8a480fe5d.png"><img alt="OpenBB Parameters Template" src="https://user-images.githubusercontent.com/46355364/171144692-dd812efd-1e95-4a71-a93f-7ae8a480fe5d.png"></img></a>
-Once you have defined the parameters, save the template and load it inside the terminal by using the the following:
-
-```python
-# Define your orderbook path here
-order_book_path = "PATH_TO_ORDERBOOK_FILE"
-
-# Read in the file
-order_book = pd.read_excel(order_book_path)
-
-# Adjust the columns accordingly
-order_book_cols = ['Ticker', 'Asset Class', 'Sector', 'Industry', 'Country',
- 'Current Invested Amount', 'Currency']
-
-order_book = order_book[order_book_cols]
-```
-
### OpenBB Portfolio Template
This template hands the user a format to work with it to define the portfolio. Here, categorization is applied based on asset class, sector, industry, country and currency. By using the dropdown menus within this Excel, you are able to apply the proper categorization. This is based on the same methodology as found in other areas of the terminal.
@@ -55,7 +39,7 @@ You can load in the portfolio template with the following code:
import pandas as pd
# Define your own orderbook path here, current value won't work
-order_book_path = "PATH_TO_ORDERBOOK_FILE"
+order_book_path = "60_40_Portfolio.xlsx"
# Read in the file
order_book = pd.read_excel(order_book_path)
@@ -67,7 +51,8 @@ order_book_cols = ['Ticker', 'Asset Class', 'Sector', 'Industry', 'Country',
order_book = order_book[order_book_cols]
# Load in the portfolio
-tickers, categories = openbb.portfolio.po.load(order_book_path)
+p = openbb.portfolio.po.load(symbols_file_path=order_book_path)
+weights, performance = openbb.portfolio.po.equal(portfolio_engine=p)
```
### Performing optimization
@@ -75,10 +60,9 @@ Based on the parameters and allocation the user has set, the optimization proces
```python
# Perform calculations
-weights_riskparity, data_returns_riskparity = openbb.portfolio.po.riskparity(tickers)
+weights_riskparity, data_returns_riskparity = openbb.portfolio.po.riskparity(p)
-# Convert to a DataFrame
-pd.DataFrame.from_dict(weights_riskparity, orient='index', columns=["Risk Parity"])
+weights_riskparity
```
Which returns:
@@ -100,7 +84,10 @@ Which returns:
It is possible to use the commands without loading in the parameters template or by using the parameters template but changing some arguments directly into the terminal. For example, using the same method as described above, the risk measure is changed to <a href="https://www.investopedia.com/terms/c/conditional_value_at_risk.asp" target="_blank" rel="noreferrer noopener">Conditional Value at Risk (CVaR)</a> and the used historic period is increased to 10 years (keeping all other parameters unchanged):
```python
-weights_riskparity, data_returns_riskparity = openbb.portfolio.po.riskparity(tickers, interval="10y", risk_measure="CVaR")
+# Perform calculations
+weights_riskparity, data_returns_riskparity = openbb.portfolio.po.riskparity(p, interval="10y", risk_measure="CVaR")
+
+weights_riskparity
```
Which returns:
@@ -127,7 +114,7 @@ To demonstrate the capabilities of the Portfolio Optimization menu, the entire <
import pandas as pd
# Define your own orderbook path here, current value won't work
-order_book_path = "PATH_TO_ORDERBOOK_FILE"
+order_book_path = "pathto/SP_500_Portfolio.xlsx"
# Read in the file
order_book = pd.read_excel(order_book_path)
@@ -139,20 +126,35 @@ order_book_cols = ['Ticker', 'Asset Class', 'Sector', 'Industry', 'Country',
order_book = order_book[order_book_cols]
# Load in the portfolio
-tickers, categories = openbb.portfolio.po.load(order_book_path)
+tickers, categories = openbb.portfolio.po.load(symbols_file_path=order_book_path)
```
Then, the <a href="https://jpm.pm-research.com/content/42/4/59.short" target="_blank" rel="noreferrer noopener">Hierarchical Risk Parity</a> technique is applied by using the following:
```python
-weights_hrp, data_returns_hrp = openbb.portfolio.po.hrp(
- tickers,
- interval="5y",
- risk_measure="cVaR",
- risk_aversion=0.8
-)
-
-pd.DataFrame.from_dict(weights_hrp, orient='index', columns=["Hierarchical Risk Parity"])
+order_book_path = "pathto/SP_500_Portfolio.xlsx"
+
+order_book = pd.read_excel(order_book_path)
+# Adjust the columns accordingly
+order_book_cols = [
+ 'Ticker',
+ 'Asset Class',
+ 'Sector',
+ 'Industry',
+ 'Country',
+ 'Current Invested Amount',
+ 'Currency',
+]
+
+order_book = order_book[order_book_cols]
+
+p = openbb.portfolio.po.load(symbols_file_path=order_book_path)
+riskparity, data_returns_riskparity = openbb.portfolio.po.hrp(p, interval="5y",
+ risk_measure='SLPM',
+ risk_aversion=0.8)
+
+print(riskparity)
+print(data_returns_riskparity)
```
This results in the following (the result is edited, as it would show 500 tickers, to prevent flooding this page):
@@ -174,13 +176,13 @@ This results in the following (the result is edited, as it would show 500 ticker
It is possible to delve further into these findings with the `plot` functionality for example done by looking at the portfolio's returns <a href="https://www.investopedia.com/terms/h/histogram.asp" target="_blank" rel="noreferrer noopener">histogram</a> which also includes a variety of risk measures as well as the portfolio's drawdowns.
````
-openbb.portfolio.po.plot(data=data_returns_hrp, weights=weights_hrp, risk_measure='cVaR', hist=True)
+openbb.portfolio.po.plot(p, category='SECTOR', chart_type="hist")
````
<a target="_blank" href="https://user-images.githubusercontent.com/46355364/171145848-5a3f5333-6b7f-4d7a-a96e-0859adb1ce78.png"><img alt="Portfokio Returns Histogram" src="https://user-images.githubusercontent.com/46355364/171145848-5a3f5333-6b7f-4d7a-a96e-0859adb1ce78.png"></img></a>
````
-openbb.portfolio.po.plot(data=data_returns_hrp, weights=weights_hrp, risk_measure='cVaR', dd=True)
+openbb.portfolio.po.plot(p, category='SECTOR', chart_type="dd")
````
<a target="_blank" href="https://user-images.githubusercontent.com/46355364/171145983-2d2c1c2e-67d2-4839-b43a-51bd22332de8.png"><img alt="Portfolio Drawdowns" src="https://user-images.githubusercontent.com/46355364/171145983-2d2c1c2e-67d2-4839-b43a-51bd22332de8.png"></img></a>
diff --git a/website/content/sdk/guides/intros/stocks/behavioral-analysis.md b/website/content/sdk/guides/intros/stocks/behavioral-analysis.md
index beb5aa2dc59..badfe9555e1 100644
--- a/website/content/sdk/guides/intros/stocks/behavioral-analysis.md
+++ b/website/content/sdk/guides/intros/stocks/behavioral-analysis.md
@@ -25,31 +25,31 @@ A brief description below highlights the main Functions and Modules available in
| Path | Type | Description |
| :------------------------- | :--------: | -------------------------------------------: |
-| openbb.ba.bullbear | Function | Estimate Quick Sentiment |
-| openbb.ba.headlines | Function | Sentiment from 15+ News Headlines |
-| openbb.ba.spacc | Function | Shows SPAC announcements from SPAC subreddit |
-| openbb.ba.watchlist | Function | Show Other User's Watchlists |
-| openbb.ba.messages | Function | Output last 30 messages on the board |
-| openbb.ba.mentions | Function | Interest Over Time Based on Mentions |
-| openbb.ba.hist | Function | Plot Historical RHI and AHI |
-| openbb.ba.snews | Function | Stock Price Plotted Over Sentiment |
-| openbb.ba.redditsent | Function | Search for Tickers and Find Sentiment |
-| openbb.ba.popular | Function | Show Popular Tickers |
-| openbb.ba.spac | Function | Shows Other User's SPAC Announcements |
-| openbb.ba.getdd | Function | Get Due Diligence |
-| openbb.ba.regions | Function | Regions Showing the Highest Interest |
-| openbb.ba.trending | Function | Trending Stocks |
-| openbb.ba.wsb | Function | Highlights from WSB Subreddit |
-| openbb.ba.queries | Function | Top Related Queries |
-| openbb.ba.sentiment | Function | Stock Sentiment Prediction from Last Tweets |
-| openbb.ba.infer | Function | Stock Sentiment from Last Tweets |
-| openbb.ba.stalker | Function | Stocktwit's last messages |
-| openbb.ba.rise | Function | Top Rising Related Queries |
+| openbb.stocks.ba.bullbear | Function | Estimate Quick Sentiment |
+| openbb.stocks.ba.headlines | Function | Sentiment from 15+ News Headlines |
+| openbb.stocks.ba.spacc | Function | Shows SPAC announcements from SPAC subreddit |
+| openbb.stocks.ba.watchlist | Function | Show Other User's Watchlists |
+| openbb.stocks.ba.messages | Function | Output last 30 messages on the board |
+| openbb.stocks.ba.mentions | Function | Interest Over Time Based on Mentions |
+| openbb.stocks.ba.hist | Function | Plot Historical RHI and AHI |
+| openbb.stocks.ba.snews | Function | Stock Price Plotted Over Sentiment |
+| openbb.stocks.ba.redditsent | Function | Search for Tickers and Find Sentiment |
+| openbb.stocks.ba.popular | Function | Show Popular Tickers |
+| openbb.stocks.ba.spac | Function | Shows Other User's SPAC Announcements |
+| openbb.stocks.ba.getdd | Function | Get Due Diligence |
+| openbb.stocks.ba.regions | Function | Regions Showing the Highest Interest |
+| openbb.stocks.ba.trending | Function | Trending Stocks |
+| openbb.stocks.ba.wsb | Function | Highlights from WSB Subreddit |
+| openbb.stocks.ba.queries | Function | Top Related Queries |
+| openbb.stocks.ba.sentiment | Function | Stock Sentiment Prediction from Last Tweets |
+| openbb.stocks.ba.infer | Function | Stock Sentiment from Last Tweets |
+| openbb.stocks.ba.stalker | Function | Stocktwit's last messages |
+| openbb.stocks.ba.rise | Function | Top Rising Related Queries |
Alteratively you can print the contents of the BA SDK with:
```python
-help(openbb.ba)
+help(openbb.stocks.ba)
```
## Examples
@@ -140,4 +140,4 @@ openbb.stocks.ba.rise("AAPL")
| 6 | bynd | 44850 |
| 7 | pltr | 41000 |
| 8 | spce | 37350 |
-| 9 | zm | 31650 | \ No newline at end of file
+| 9 | zm | 31650 |
diff --git a/website/content/sdk/guides/intros/stocks/discovery.md b/website/content/sdk/guides/intros/stocks/discovery.md
index 557ea71e979..efb00a2ddce 100644
--- a/website/content/sdk/guides/intros/stocks/discovery.md
+++ b/website/content/sdk/guides/intros/stocks/discovery.md
@@ -25,27 +25,27 @@ A brief description below highlights the main Functions and Modules available in
| Path | Type | Description |
| :------------------------- | :--------: | -------------------------------------------: |
-| openbb.disc.pipo | Function | Past IPO Dates |
-| openbb.disc.active | Function | Stocks with Highest Trade Volumes |
-| openbb.disc.gainers | Function | Latest Top Gainers |
-| openbb.disc.asc | Function | Small Caps with Earnings Growth Above 25% |
-| openbb.disc.lowfloat | Function | Stocks with Under 10M Shares Float |
-| openbb.disc.fipo | Function | Future IPO Dates |
-| openbb.disc.upcoming | Function | Upcoming Earnings Release Dates |
-| openbb.disc.trending | Function | Trending News |
-| openbb.disc.ulc | Function | Potentially Undervalued Large Cap Stocks |
-| openbb.disc.arkord | Function | Orders of ARK Investment Management LLC |
-| openbb.disc.hotpenny | Function | Hot Penny Stocks |
-| openbb.disc.gtech | Function | Tech Stocks with Earnings Growth Over 25% |
-| openbb.disc.losers | Function | Show Top Losers |
-| openbb.disc.ugs | Function | Undervalueds with Earnings Growt