mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-27 04:31:13 +00:00
Doc updates and fixes (#3609)
* fixing a url * moving around menus * Grammar Update * many fixes to links and some added pics to install * Add improvements * fix: tabs * Move support/feedback window to FAQ * Forgot to save * MVC moved around * change installation Source -> Python * fix: tabs * guides to basics * Add new README LINKS * Change links * Change forecasting to forecast * fix: details * more fixes * Change markdown file so it is ready for pypi Co-authored-by: Chavithra <chavithra@gmail.com> Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com> Co-authored-by: Jeroen Bouma <jeroenbouma@Jeroens-MacBook-Pro.local> Co-authored-by: jose-donato <zmcdonato@gmail.com>
This commit is contained in:
9
README.md
vendored
9
README.md
vendored
@@ -98,14 +98,15 @@ If you wish to install the OpenBB Terminal or the OpenBB SDK, please use one of
|
|||||||
|
|
||||||
|**OpenBB Terminal**|**Usage**|
|
|**OpenBB Terminal**|**Usage**|
|
||||||
|:-|:-|
|
|:-|:-|
|
||||||
|[Installer](https://docs.openbb.co/terminal/quickstart/installation)|Recommended way if you just want to use the OpenBB Terminal|
|
|[Windows Installer](https://docs.openbb.co/terminal/quickstart/installation?tab=windows)|Recommended way for Windows if you just want to use the OpenBB Terminal|
|
||||||
|[Docker](https://docs.openbb.co/terminal/quickstart/installation)|An alternative way if you just want to use the OpenBB Terminal|
|
|[MacOS Installer](https://docs.openbb.co/terminal/quickstart/installation?tab=mac)|Recommended way for MacOS if you just want to use the OpenBB Terminal|
|
||||||
|[Python](https://docs.openbb.co/terminal/quickstart/installation)|If you wish to contribute to the development of the OpenBB Terminal|
|
|[Docker](https://docs.openbb.co/terminal/quickstart/installation?tab=docker)|An alternative way if you just want to use the OpenBB Terminal|
|
||||||
|
|[Python](https://docs.openbb.co/terminal/quickstart/installation?tab=python)|If you wish to contribute to the development of the OpenBB Terminal|
|
||||||
|
|
||||||
|**OpenBB SDK** |**Usage**|
|
|**OpenBB SDK** |**Usage**|
|
||||||
|:-|:-|
|
|:-|:-|
|
||||||
|[PyPi](https://docs.openbb.co/sdk/quickstart/installation)|Recommended way if you just want to use the OpenBB SDK|
|
|[PyPi](https://docs.openbb.co/sdk/quickstart/installation)|Recommended way if you just want to use the OpenBB SDK|
|
||||||
|[Python](https://docs.openbb.co/sdk/quickstart/installation)|If you wish to contribute to the development of the OpenBB SDK |
|
|[Python](https://docs.openbb.co/terminal/quickstart/installation?tab=python)|If you wish to contribute to the development of the OpenBB SDK |
|
||||||
|
|
||||||
## 3. Contributing
|
## 3. Contributing
|
||||||
|
|
||||||
|
|||||||
@@ -126,16 +126,16 @@ def open_openbb_documentation(
|
|||||||
path = "/"
|
path = "/"
|
||||||
command = ""
|
command = ""
|
||||||
elif "keys" in path:
|
elif "keys" in path:
|
||||||
path = "/guides/basics/keys"
|
path = "/guides/advanced/api-keys"
|
||||||
command = ""
|
command = ""
|
||||||
elif "settings" in path:
|
elif "settings" in path:
|
||||||
path = "/guides/basics/customizing_the_terminal"
|
path = "/guides/advanced/customizing-the-terminal"
|
||||||
command = ""
|
command = ""
|
||||||
elif "featflags" in path:
|
elif "featflags" in path:
|
||||||
path = "/guides/basics/customizing_the_terminal"
|
path = "/guides/advanced/customizing-the-terminal"
|
||||||
command = ""
|
command = ""
|
||||||
elif "sources" in path:
|
elif "sources" in path:
|
||||||
path = "/guides/advanced/changing_sources"
|
path = "/guides/advanced/changing-sources"
|
||||||
command = ""
|
command = ""
|
||||||
else:
|
else:
|
||||||
if arg_type == "command": # user passed a command name
|
if arg_type == "command": # user passed a command name
|
||||||
@@ -158,22 +158,16 @@ def open_openbb_documentation(
|
|||||||
|
|
||||||
if command:
|
if command:
|
||||||
if "keys" == command:
|
if "keys" == command:
|
||||||
path = "/guides/basics/keys"
|
path = "/guides/advanced/api-keys"
|
||||||
command = ""
|
command = ""
|
||||||
elif "settings" in path:
|
elif "settings" in path or "featflags" in path:
|
||||||
path = "/guides/basics/customizing_the_terminal"
|
path = "/guides/advanced/customizing-the-terminal"
|
||||||
command = ""
|
|
||||||
elif "featflags" in path:
|
|
||||||
path = "/guides/basics/customizing_the_terminal"
|
|
||||||
command = ""
|
command = ""
|
||||||
elif "sources" in path:
|
elif "sources" in path:
|
||||||
path = "/guides/advanced/changing_sources"
|
path = "/guides/advanced/changing-sources"
|
||||||
command = ""
|
command = ""
|
||||||
elif "exe" == command:
|
elif "exe" == command:
|
||||||
path = "/quickstart/scripts"
|
path = "/guides/advanced/scripts-and-routines"
|
||||||
command = ""
|
|
||||||
elif command in ["settings", "featflags", "sources"]:
|
|
||||||
path = ""
|
|
||||||
command = ""
|
command = ""
|
||||||
elif command in ["ta", "ba", "qa"]:
|
elif command in ["ta", "ba", "qa"]:
|
||||||
path = f"/guides/intros/common/{command}"
|
path = f"/guides/intros/common/{command}"
|
||||||
|
|||||||
6
package-lock.json
generated
vendored
Normal file
6
package-lock.json
generated
vendored
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
{
|
||||||
|
"name": "OpenBB Terminal",
|
||||||
|
"lockfileVersion": 2,
|
||||||
|
"requires": true,
|
||||||
|
"packages": {}
|
||||||
|
}
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Set API Keys
|
title: Set API Keys
|
||||||
sidebar_position: 3
|
sidebar_position: 1
|
||||||
---
|
---
|
||||||
|
|
||||||
API keys can be managed directly from the SDK environment. If there is already a Terminal installation configured with API keys, they will be recognized by the SDK. Their status can be verified with the line of code below.
|
API keys can be managed directly from the SDK environment. If there is already a Terminal installation configured with API keys, they will be recognized by the SDK. Their status can be verified with the line of code below.
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Changing Sources
|
title: Changing Sources
|
||||||
sidebar_position: 1
|
sidebar_position: 2
|
||||||
---
|
---
|
||||||
|
|
||||||
Some functions have the built-in capability of requesting data from multiple sources. `obb.stocks.load` is one example of this type feature:
|
Some functions have the built-in capability of requesting data from multiple sources. `obb.stocks.load` is one example of this type feature:
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Adjusting Chart Style
|
title: Adjusting Chart Style
|
||||||
sidebar_position: 2
|
sidebar_position: 4
|
||||||
---
|
---
|
||||||
|
|
||||||
Within the OpenBB SDK, you can customize your chart style. You can switch between `dark` and `light` easily using this block of code:
|
Within the OpenBB SDK, you can customize your chart style. You can switch between `dark` and `light` easily using this block of code:
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Importing and Exporting Data
|
title: Importing and Exporting Data
|
||||||
sidebar_position: 4
|
sidebar_position: 3
|
||||||
---
|
---
|
||||||
|
|
||||||
The OpenBB SDK shares the `OpenBBUserData` folder with the Terminal, even with multiple versions installed on the same machine. Portfolio files, screener presets, and Matplotlib style sheets are all shared resources. This folder will be created after the first installation and it is read by subsequent installations. The default location for it is in the root of the operating system user account folder.
|
The OpenBB SDK shares the `OpenBBUserData` folder with the Terminal, even with multiple versions installed on the same machine. Portfolio files, screener presets, and Matplotlib style sheets are all shared resources. This folder will be created after the first installation and it is read by subsequent installations. The default location for it is in the root of the operating system user account folder.
|
||||||
@@ -13,4 +13,4 @@ Within the folder you can find files that you have exported as well as files tha
|
|||||||
|
|
||||||
<img width="1231" alt="Screen Shot 2022-10-13 at 6 45 01 PM" src="https://user-images.githubusercontent.com/85772166/195742985-19f0e420-d8f7-4fea-a145-a0243b8f2ddc.png"></img>
|
<img width="1231" alt="Screen Shot 2022-10-13 at 6 45 01 PM" src="https://user-images.githubusercontent.com/85772166/195742985-19f0e420-d8f7-4fea-a145-a0243b8f2ddc.png"></img>
|
||||||
|
|
||||||
This folder contains all things user-created which are, among other things screener presets, portfolio files, files exported directly from the code, styles and themes, preferred data sources and API keys.
|
This folder contains all things user-created which are, among other things screener presets, portfolio files, files exported directly from the code, styles and themes, preferred data sources and API keys.
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
{
|
{
|
||||||
"label": "Basics",
|
"label": "Basics",
|
||||||
"position": 2
|
"position": 1
|
||||||
}
|
}
|
||||||
@@ -1,15 +1,61 @@
|
|||||||
---
|
---
|
||||||
title: Using the SDK
|
title: Basics
|
||||||
sidebar_position: 2
|
sidebar_position: 1
|
||||||
---
|
---
|
||||||
|
### Importing the SDK
|
||||||
|
|
||||||
After you have imported the OpenBB SDK you are able to run many of the commands presents within the extensive list found [here]](/sdk/reference).
|
Now that you have the SDK installed, the first step is to import the OpenBB SDK in your preferred code editor. Nearly everything required to interact with any function from the OpenBB Terminal gets imported in one line. Begin a Python script or Notebook file with:
|
||||||
|
|
||||||
```python
|
```python
|
||||||
from openbb_terminal.sdk import openbb
|
from openbb_terminal.sdk import openbb
|
||||||
```
|
```
|
||||||
|
|
||||||
For example, you are able to show Economic events by running the following command. Note that the results from data functions are not stored to memory unless explicitly instructed to. Most functions that return data are presented as a Pandas DataFrame.
|
Example snippets used in the remainder of this guide will assume the code block above is used.
|
||||||
|
|
||||||
|
### Navigation
|
||||||
|
|
||||||
|
In the same way as operating the OpenBB Terminal, functions are divided into menus which are scrollable after importing into a jupyter notebook. Entering a period, `.`, after `openbb`, will display the Sub-menus available.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
An alternate way to view the contents of a menu is to use Python's built-in help.
|
||||||
|
|
||||||
|
```python
|
||||||
|
help(openbb.stocks.dd)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Docstrings
|
||||||
|
|
||||||
|
In addition to Python's built-in help, docstrings are also displayed in the Contextual Help window, within a Jupyter environment or by running `help(openbb.economy.events)` in your code editor.
|
||||||
|
|
||||||
|
```python
|
||||||
|
help(openbb.economy.events)
|
||||||
|
|
||||||
|
Help on Operation in module openbb_terminal.core.library.operation:
|
||||||
|
|
||||||
|
<openbb_terminal.core.library.operation.Operation object>
|
||||||
|
Get economic calendar for countries between specified dates
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
countries : [List[str],str]
|
||||||
|
List of countries to include in calendar. Empty returns all
|
||||||
|
start_date : str
|
||||||
|
Start date for calendar
|
||||||
|
end_date : str
|
||||||
|
End date for calendar
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
pd.DataFrame
|
||||||
|
Economic calendar
|
||||||
|
```
|
||||||
|
|
||||||
|
## How to use the SDK
|
||||||
|
|
||||||
|
### Your First Function
|
||||||
|
|
||||||
|
To get started using the OpenBB SDK you can try the below code for your first function.
|
||||||
|
|
||||||
```python
|
```python
|
||||||
openbb.economy.events()
|
openbb.economy.events()
|
||||||
@@ -23,7 +69,16 @@ openbb.economy.events()
|
|||||||
| 3 | 02:00 | United Kingdom | Claimant Count Change | 3.3K | 17.3K | 3.9K | 2022-11-15 |
|
| 3 | 02:00 | United Kingdom | Claimant Count Change | 3.3K | 17.3K | 3.9K | 2022-11-15 |
|
||||||
| 4 | 02:00 | United Kingdom | Employment Change 3M/3M | -52K | -25K | -109K | 2022-11-15 |
|
| 4 | 02:00 | United Kingdom | Employment Change 3M/3M | -52K | -25K | -109K | 2022-11-15 |
|
||||||
|
|
||||||
As most data is stored as a Pandas DataFrame, it is possible to adjust or filter the data directly through the use of the built-in functionalities of [Pandas](https://pandas.pydata.org/). For example, the code block below will filter the results of the events function to display only events scheduled at a specific time.
|
:::note - The results from data functions are not stored to memory unless explicitly instructed to. Most functions returning data are presented as a Pandas DataFrame.
|
||||||
|
:::
|
||||||
|
|
||||||
|
Modify the syntax slightly to deliver the output into a DataFrame:
|
||||||
|
|
||||||
|
```python
|
||||||
|
economic_calendar = openbb.economy.events()
|
||||||
|
```
|
||||||
|
|
||||||
|
Defined as a variable, interacting with the results becomes a matter of manipulating tables. For example, the code block below will filter the results of the events function to display only events scheduled at a specific time.
|
||||||
|
|
||||||
```python
|
```python
|
||||||
economic_calendar = openbb.economy.events()
|
economic_calendar = openbb.economy.events()
|
||||||
@@ -41,7 +96,13 @@ events
|
|||||||
|
|
||||||
### Passing Results to Another Function
|
### Passing Results to Another Function
|
||||||
|
|
||||||
It may be desirable to derive a list of tickers from a different function. This can be useful for screening tickers, or analyzing particular industries or sectors. The Comparison Analysis sub-module, within Stocks, has one set of functions that can benefit from this kind of workflow. As an example, holdings with the highest allocation of the [Dow Jones Industrial Average ETF](https://www.ssga.com/us/en/intermediary/etfs/funds/spdr-dow-jones-industrial-average-etf-trust-dia) are used.
|
Let's take a look at another example where the input to a function is a list. It may be desirable to derive that list from a different function. This can be useful for screening tickers, or analyzing particular industries or sectors. The Comparison Analysis sub-module, within Stocks, is one set of functions that can benefit from this kind of workflow. Instead of something like:
|
||||||
|
|
||||||
|
```python
|
||||||
|
openbb.stocks.ca.screener(similar = ['AAPL', 'NFLX', 'META', 'AMZN', 'MSFT', 'GOOGL', 'DIS', 'TSLA'], data_type = 'valuation')
|
||||||
|
```
|
||||||
|
|
||||||
|
Try, `openbb.etf.holdings`, to populate a list dynamically:
|
||||||
|
|
||||||
```python
|
```python
|
||||||
symbols = openbb.etf.holdings('DIA')
|
symbols = openbb.etf.holdings('DIA')
|
||||||
@@ -60,9 +121,10 @@ dia_valuation.head(5)
|
|||||||
| 1 | AMGN | 1.5543e+11 | 22.86 | 15.4 | 3.38 | 5.9 | 41.77 | 13.54 | 32.04 | -0.165 | 0.0486 | 0.001 | 0.0677 | 0.025 | 283.6 | -0.006 | 2761083 |
|
| 1 | AMGN | 1.5543e+11 | 22.86 | 15.4 | 3.38 | 5.9 | 41.77 | 13.54 | 32.04 | -0.165 | 0.0486 | 0.001 | 0.0677 | 0.025 | 283.6 | -0.006 | 2761083 |
|
||||||
| 18 | MCD | 2.0272e+11 | 34.3 | 26.01 | 5.14 | 8.71 | N/A | 71.67 | 118.65 | 0.591 | 0.0522 | 0.13 | 0.0667 | -0.012 | 267.84 | -0.0163 | 5421817 |
|
| 18 | MCD | 2.0272e+11 | 34.3 | 26.01 | 5.14 | 8.71 | N/A | 71.67 | 118.65 | 0.591 | 0.0522 | 0.13 | 0.0667 | -0.012 | 267.84 | -0.0163 | 5421817 |
|
||||||
|
|
||||||
|
|
||||||
### Displaying Charts
|
### Displaying Charts
|
||||||
|
|
||||||
The OpenBB SDK has built-in charting libraries for Matplotlib, for any chart available from the Terminal. User style sheets can be added to the folder (more on this in [Importing and Exporting Data](/sdk/guides/basics/data)), `~/OpenBBUserData/styles/user`. Styles are shared properties between the OpenBB Terminal and the SDK.
|
The OpenBB SDK has built-in charting libraries for Matplotlib, for any chart available from the Terminal. User style sheets can be added to the folder (more on this in [Importing and Exporting Data](/sdk/guides/advanced/data)), `~/OpenBBUserData/styles/user`. Styles are shared properties between the OpenBB Terminal and the SDK.
|
||||||
|
|
||||||
:::note Displaying charts in Jupyter Notebooks requires an additional line of code. You can either render a static image with `%matplotlib inline` or add in pan/zoom functionality with `%matplotlib widget`.
|
:::note Displaying charts in Jupyter Notebooks requires an additional line of code. You can either render a static image with `%matplotlib inline` or add in pan/zoom functionality with `%matplotlib widget`.
|
||||||
:::
|
:::
|
||||||
@@ -127,4 +189,4 @@ openbb.futures.curve_chart('GE')
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
The intros section for each module explore further functionality and provide sample code snippets.
|
The intros section for each module explore further functionality and provide sample code snippets. For example, an introduction to Stocks can be found [here](/sdk/guides/intros/stocks).
|
||||||
53
website/content/sdk/guides/basics/structure.md
vendored
53
website/content/sdk/guides/basics/structure.md
vendored
@@ -1,53 +0,0 @@
|
|||||||
---
|
|
||||||
title: Structure of the SDK
|
|
||||||
sidebar_position: 1
|
|
||||||
---
|
|
||||||
|
|
||||||
## Importing the SDK
|
|
||||||
|
|
||||||
Once you have the OpenBB SDK installed, the first step is to import the OpenBB SDK in your preferred code editor. Nearly everything required to interact with any function from the OpenBB Terminal gets imported in one line. Begin a Python script or Notebook file with:
|
|
||||||
|
|
||||||
```python
|
|
||||||
from openbb_terminal.sdk import openbb
|
|
||||||
```
|
|
||||||
|
|
||||||
Note that most snippets used in the guides will assume the code block above is used, and that the `Python kernel` selected is the environment created during the [installation process](/sdk/quickstart/installation).
|
|
||||||
|
|
||||||
## Navigation
|
|
||||||
|
|
||||||
In the same way how the OpenBB Terminal is operated, functions are divided into menus which can be navigated after code completion is activated. Entering a period, `.`, after `openbb`, will display the Sub-menus available.
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
An alternate way to view the contents of a menu is to use Python's built-in help.
|
|
||||||
|
|
||||||
```python
|
|
||||||
help(openbb.stocks.dd)
|
|
||||||
```
|
|
||||||
|
|
||||||
### Docstrings
|
|
||||||
|
|
||||||
In addition to Python's built-in help, docstrings are also displayed in the Contextual Help window, within a Jupyter environment; type hints are included.
|
|
||||||
|
|
||||||
```python
|
|
||||||
help(openbb.economy.events)
|
|
||||||
|
|
||||||
Help on Operation in module openbb_terminal.core.library.operation:
|
|
||||||
|
|
||||||
<openbb_terminal.core.library.operation.Operation object>
|
|
||||||
Get economic calendar for countries between specified dates
|
|
||||||
|
|
||||||
Parameters
|
|
||||||
----------
|
|
||||||
countries : [List[str],str]
|
|
||||||
List of countries to include in calendar. Empty returns all
|
|
||||||
start_date : str
|
|
||||||
Start date for calendar
|
|
||||||
end_date : str
|
|
||||||
End date for calendar
|
|
||||||
|
|
||||||
Returns
|
|
||||||
-------
|
|
||||||
pd.DataFrame
|
|
||||||
Economic calendar
|
|
||||||
```
|
|
||||||
@@ -14,7 +14,7 @@ keywords:
|
|||||||
excerpt: "The Introduction to Econometrics explains how to use the menu"
|
excerpt: "The Introduction to Econometrics explains how to use the menu"
|
||||||
---
|
---
|
||||||
|
|
||||||
The capabilities of the [Econometrics menu](/terminal/guides/econometrics) from the OpenBB Terminal are wrapped into a powerful SDK, enabling users to work with the data in a flexible environment that can be fully customized to meet the needs of any user. The Econometrics menu's purpose is to provide the user the ability to perform statistical research on custom datasets. The menu allows the user to load in his/her own dataset(s), modify the data by adding columns or setting indices, apply statistical tests (e.g. <a href="https://en.wikipedia.org/wiki/Breusch%E2%80%93Godfrey_test" target="_blank" rel="noreferrer noopener">Breusch-Godfrey autocorrelation tests</a>) as well as OLS regressions and Panel regressions (e.g. <a href="https://en.wikipedia.org/wiki/Random_effects_model" target="_blank" rel="noreferrer noopener">Random Effects</a> and <a href="https://en.wikipedia.org/wiki/Fixed_effects_model" target="_blank" rel="noreferrer noopener">Fixed Effects</a>)
|
The capabilities of the [Econometrics menu](/terminal/guides/intros/econometrics) from the OpenBB Terminal are wrapped into a powerful SDK, enabling users to work with the data in a flexible environment that can be fully customized to meet the needs of any user. The Econometrics menu's purpose is to provide the user the ability to perform statistical research on custom datasets. The menu allows the user to load in his/her own dataset(s), modify the data by adding columns or setting indices, apply statistical tests (e.g. <a href="https://en.wikipedia.org/wiki/Breusch%E2%80%93Godfrey_test" target="_blank" rel="noreferrer noopener">Breusch-Godfrey autocorrelation tests</a>) as well as OLS regressions and Panel regressions (e.g. <a href="https://en.wikipedia.org/wiki/Random_effects_model" target="_blank" rel="noreferrer noopener">Random Effects</a> and <a href="https://en.wikipedia.org/wiki/Fixed_effects_model" target="_blank" rel="noreferrer noopener">Fixed Effects</a>)
|
||||||
|
|
||||||
## How to use
|
## How to use
|
||||||
|
|
||||||
|
|||||||
34
website/content/sdk/guides/intros/forecast.md
vendored
34
website/content/sdk/guides/intros/forecast.md
vendored
@@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
title: Forecast SDK
|
title: Forecast
|
||||||
---
|
---
|
||||||
|
|
||||||
The Forecast module provides programmatic access to the same commands found in the OpenBB Terminal Forecast menu. The extensive library of models, built on top of the [u8darts](https://unit8co.github.io/darts/) library, are easily tuned with hyper-parameters.
|
The Forecast module provides programmatic access to the same commands found in the OpenBB Terminal Forecast menu. The extensive library of models, built on top of the [u8darts](https://unit8co.github.io/darts/) library, are easily tuned with hyper-parameters.
|
||||||
@@ -134,7 +134,7 @@ openbb.forecast.theta_chart(data = spy, target_column = 'Adj Close')
|
|||||||
The default number of days to predict for all models is five. If the interval of the time-series is not daily, days equates to the interval of the index.
|
The default number of days to predict for all models is five. If the interval of the time-series is not daily, days equates to the interval of the index.
|
||||||
|
|
||||||
```console
|
```console
|
||||||
Theta Model obtains MAPE: 1.91%
|
Theta Model obtains MAPE: 1.91%
|
||||||
```
|
```
|
||||||
|
|
||||||

|

|
||||||
@@ -163,7 +163,7 @@ A moving average provides an indication of the trend of the price movement by cu
|
|||||||
|
|
||||||
```console
|
```console
|
||||||
help(openbb.forecast.ema)
|
help(openbb.forecast.ema)
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
dataset : pd.DataFrame
|
dataset : pd.DataFrame
|
||||||
@@ -172,7 +172,7 @@ help(openbb.forecast.ema)
|
|||||||
The column you wish to add the EMA to
|
The column you wish to add the EMA to
|
||||||
period : int
|
period : int
|
||||||
Time Span
|
Time Span
|
||||||
|
|
||||||
Returns
|
Returns
|
||||||
-------
|
-------
|
||||||
pd.DataFrame
|
pd.DataFrame
|
||||||
@@ -252,7 +252,7 @@ Stochastic Oscillator %K and %D : A stochastic oscillator is a momentum indicato
|
|||||||
|
|
||||||
Requires Low/High/Close columns.
|
Requires Low/High/Close columns.
|
||||||
Note: This will drop first rows equal to period due to how this metric is calculated.
|
Note: This will drop first rows equal to period due to how this metric is calculated.
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
close_column: str
|
close_column: str
|
||||||
@@ -276,10 +276,10 @@ The results of these calculations appends the dataset with two additional column
|
|||||||
|
|
||||||
```python
|
```python
|
||||||
spy = openbb.forecast.sto(
|
spy = openbb.forecast.sto(
|
||||||
dataset = spy,
|
dataset = spy,
|
||||||
high_column='High',
|
high_column='High',
|
||||||
low_column = 'Low',
|
low_column = 'Low',
|
||||||
close_column = 'Adj Close',
|
close_column = 'Adj Close',
|
||||||
period = 20
|
period = 20
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -380,7 +380,7 @@ openbb.forecast.regr_chart(spy, target_column = 'Close')
|
|||||||
```console
|
```console
|
||||||
Predicting Regression for 5 days
|
Predicting Regression for 5 days
|
||||||
|
|
||||||
Regression model obtains MAPE: 1.90%
|
Regression model obtains MAPE: 1.90%
|
||||||
```
|
```
|
||||||
|
|
||||||

|

|
||||||
@@ -482,7 +482,7 @@ Covariate #2: XOM
|
|||||||
|
|
||||||
Predicting Regression for 5 days
|
Predicting Regression for 5 days
|
||||||
|
|
||||||
Regression model obtains MAPE: 1.80%
|
Regression model obtains MAPE: 1.80%
|
||||||
```
|
```
|
||||||
|
|
||||||
|Datetime |Prediction |
|
|Datetime |Prediction |
|
||||||
@@ -515,10 +515,10 @@ spy = openbb.forecast.rsi(spy, target_column = 'Adj Close', period = 10)
|
|||||||
spy = openbb.forecast.rsi(spy, target_column = 'Adj Close', period = 60)
|
spy = openbb.forecast.rsi(spy, target_column = 'Adj Close', period = 60)
|
||||||
|
|
||||||
spy = openbb.forecast.sto(
|
spy = openbb.forecast.sto(
|
||||||
dataset = spy,
|
dataset = spy,
|
||||||
high_column='High',
|
high_column='High',
|
||||||
low_column = 'Low',
|
low_column = 'Low',
|
||||||
close_column = 'Adj Close',
|
close_column = 'Adj Close',
|
||||||
period = 20
|
period = 20
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -549,7 +549,7 @@ Help on Operation in module openbb_terminal.core.library.operation:
|
|||||||
|
|
||||||
<openbb_terminal.core.library.operation.Operation object>
|
<openbb_terminal.core.library.operation.Operation object>
|
||||||
Display Regression Forecasting
|
Display Regression Forecasting
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
data: Union[pd.Series, pd.DataFrame]
|
data: Union[pd.Series, pd.DataFrame]
|
||||||
@@ -585,4 +585,4 @@ Help on Operation in module openbb_terminal.core.library.operation:
|
|||||||
as the previous day's closing price. Defaults to False.
|
as the previous day's closing price. Defaults to False.
|
||||||
external_axes: Optional[List[plt.axes]]
|
external_axes: Optional[List[plt.axes]]
|
||||||
External axes to plot on
|
External axes to plot on
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ optimization techniques and provides a brief description of its sub-menus"
|
|||||||
---
|
---
|
||||||
The Portfolio Optimization menu allows the user to apply advanced optimization techniques to a portfolio of any type and of any size. It does so by introducing a multitude of optimization techniques ranging from <a href="https://www.investopedia.com/terms/m/meanvariance-analysis.asp" target="_blank" rel="noreferrer noopener">mean-variance optimization</a> to <a href="https://www.investopedia.com/terms/r/risk-parity.asp" target="_blank" rel="noreferrer noopener">risk parity models</a> and <a href="https://www.investopedia.com/terms/c/cluster_analysis.asp" target="_blank" rel="noreferrer noopener">hierarchical clustering models</a>. By providing Excel templates, the user can make sense of the vast array of parameters that each command has. E.g. think of the historic period you wish to use or which of the more than 10 risk measures and covariance methods should be used? These are questions the templates make easier to answer.
|
The Portfolio Optimization menu allows the user to apply advanced optimization techniques to a portfolio of any type and of any size. It does so by introducing a multitude of optimization techniques ranging from <a href="https://www.investopedia.com/terms/m/meanvariance-analysis.asp" target="_blank" rel="noreferrer noopener">mean-variance optimization</a> to <a href="https://www.investopedia.com/terms/r/risk-parity.asp" target="_blank" rel="noreferrer noopener">risk parity models</a> and <a href="https://www.investopedia.com/terms/c/cluster_analysis.asp" target="_blank" rel="noreferrer noopener">hierarchical clustering models</a>. By providing Excel templates, the user can make sense of the vast array of parameters that each command has. E.g. think of the historic period you wish to use or which of the more than 10 risk measures and covariance methods should be used? These are questions the templates make easier to answer.
|
||||||
|
|
||||||
The capabilities of the [Portfolio Optiminzation menu](/terminal/guides/portfolio/po) from the OpenBB Terminal are wrapped into a powerful SDK, enabling users to work with the data in a flexible environment that can be fully customized to meet the needs of any user. These functionalities allow the user to apply advanced optimization techniques to a portfolio of any type and of any size. It does so by introducing a multitude of optimization techniques ranging from <a href="https://www.investopedia.com/terms/m/meanvariance-analysis.asp" target="_blank" rel="noreferrer noopener">mean-variance optimization</a> to <a href="https://www.investopedia.com/terms/r/risk-parity.asp" target="_blank" rel="noreferrer noopener">risk parity models</a> and <a href="https://www.investopedia.com terms/c/cluster_analysis.asp" target="_blank" rel="noreferrer noopener">hierarchical clustering models</a>. By providing Excel templates, the user can make sense of the vast array of parameters that each command has. E.g. think of the historic period you wish to use or which of the more than 10 risk measures and covariance methods should be used? These are questions the templates make easier to answer.
|
The capabilities of the [Portfolio Optiminzation menu](/terminal/guides/intros/portfolio/po) from the OpenBB Terminal are wrapped into a powerful SDK, enabling users to work with the data in a flexible environment that can be fully customized to meet the needs of any user. These functionalities allow the user to apply advanced optimization techniques to a portfolio of any type and of any size. It does so by introducing a multitude of optimization techniques ranging from <a href="https://www.investopedia.com/terms/m/meanvariance-analysis.asp" target="_blank" rel="noreferrer noopener">mean-variance optimization</a> to <a href="https://www.investopedia.com/terms/r/risk-parity.asp" target="_blank" rel="noreferrer noopener">risk parity models</a> and <a href="https://www.investopedia.com terms/c/cluster_analysis.asp" target="_blank" rel="noreferrer noopener">hierarchical clustering models</a>. By providing Excel templates, the user can make sense of the vast array of parameters that each command has. E.g. think of the historic period you wish to use or which of the more than 10 risk measures and covariance methods should be used? These are questions the templates make easier to answer.
|
||||||
|
|
||||||
## How to use
|
## How to use
|
||||||
Start a Python script or Notebook file by importing the module:
|
Start a Python script or Notebook file by importing the module:
|
||||||
@@ -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.
|
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/basics/data).
|
:::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).
|
||||||
:::
|
:::
|
||||||
|
|
||||||
### OpenBB Parameters Template
|
### OpenBB Parameters Template
|
||||||
|
|||||||
@@ -72,11 +72,6 @@ sp500_df
|
|||||||
|
|
||||||
| Date | S&P Inflation-Adjusted Value | S&P 500 % Change | P/E Ratio | P/E % Change |
|
| Date | S&P Inflation-Adjusted Value | S&P 500 % Change | P/E Ratio | P/E % Change |
|
||||||
|:--------------------|-------------------------------:|-------------------:|------------:|---------------:|
|
|:--------------------|-------------------------------:|-------------------:|------------:|---------------:|
|
||||||
| 1871-01-31 00:00:00 | 105.76 | nan | nan | nan |
|
|
||||||
| 1871-02-28 00:00:00 | 104.02 | -0.0164523 | 10.92 | nan |
|
|
||||||
| 1871-03-31 00:00:00 | 105.01 | 0.0095174 | 11.19 | 0.0247253 |
|
|
||||||
| 1871-04-30 00:00:00 | 112.01 | 0.0666603 | 12.05 | 0.0768543 |
|
|
||||||
...continued...
|
|
||||||
| 2022-08-31 00:00:00 | 3955 | 0.0092504 | 29.64 | 0.022069 |
|
| 2022-08-31 00:00:00 | 3955 | 0.0092504 | 29.64 | 0.022069 |
|
||||||
| 2022-09-30 00:00:00 | 3585.62 | -0.0933957 | 26.84 | -0.0944669 |
|
| 2022-09-30 00:00:00 | 3585.62 | -0.0933957 | 26.84 | -0.0944669 |
|
||||||
| 2022-10-31 00:00:00 | 3871.98 | 0.0798635 | 28.53 | 0.0629657 |
|
| 2022-10-31 00:00:00 | 3871.98 | 0.0798635 | 28.53 | 0.0629657 |
|
||||||
|
|||||||
@@ -49,7 +49,6 @@ ctb_df
|
|||||||
| 2 | KITT | 574.4353% | 100 |
|
| 2 | KITT | 574.4353% | 100 |
|
||||||
| 3 | EFSH | 439.7636% | 2000 |
|
| 3 | EFSH | 439.7636% | 2000 |
|
||||||
| 4 | EVTL | 434.336% | 9000 |
|
| 4 | EVTL | 434.336% | 9000 |
|
||||||
...continued...
|
|
||||||
| 17655 | DSAIF | 0.0% | 1000 |
|
| 17655 | DSAIF | 0.0% | 1000 |
|
||||||
| 17656 | DRREF | 0.0% | 25000 |
|
| 17656 | DRREF | 0.0% | 25000 |
|
||||||
| 17657 | DOSEF | 0.0% | 100 |
|
| 17657 | DOSEF | 0.0% | 100 |
|
||||||
@@ -89,7 +88,6 @@ pos_df
|
|||||||
| 2022-11-25 | NVDA | 6264211 | 0.62147 | 2448753 | 3.98412e+08 | 61850799 | 1.00604e+10 |
|
| 2022-11-25 | NVDA | 6264211 | 0.62147 | 2448753 | 3.98412e+08 | 61850799 | 1.00604e+10 |
|
||||||
| 2022-11-25 | IWM | 3932703 | 0.541717 | 605706 | 1.12407e+08 | 34431260 | 6.31318e+09 |
|
| 2022-11-25 | IWM | 3932703 | 0.541717 | 605706 | 1.12407e+08 | 34431260 | 6.31318e+09 |
|
||||||
| 2022-11-25 | HYG | 1170511 | 0.523497 | 105076 | 7.88175e+06 | 75184813 | 5.53232e+09 |
|
| 2022-11-25 | HYG | 1170511 | 0.523497 | 105076 | 7.88175e+06 | 75184813 | 5.53232e+09 |
|
||||||
...continued...
|
|
||||||
| 2022-11-25 | META | 1652587 | 0.359614 | -1290276 | -1.4375e+08 | -88892626 | -8.17035e+09 |
|
| 2022-11-25 | META | 1652587 | 0.359614 | -1290276 | -1.4375e+08 | -88892626 | -8.17035e+09 |
|
||||||
| 2022-11-25 | SQQQ | 6198104 | 0.358094 | -4912392 | -2.20223e+08 | -160324410 | -8.81487e+09 |
|
| 2022-11-25 | SQQQ | 6198104 | 0.358094 | -4912392 | -2.20223e+08 | -160324410 | -8.81487e+09 |
|
||||||
| 2022-11-25 | MSFT | 1246644 | 0.356497 | -1003640 | -2.48391e+08 | -60211625 | -1.41156e+10 |
|
| 2022-11-25 | MSFT | 1246644 | 0.356497 | -1003640 | -2.48391e+08 | -60211625 | -1.41156e+10 |
|
||||||
@@ -136,7 +134,6 @@ spy_pos
|
|||||||
| 2022-11-22 00:00:00 | 10.0279 | 53.85 | 52.335 | 18.6233 | 572.874 | 42444.8 |
|
| 2022-11-22 00:00:00 | 10.0279 | 53.85 | 52.335 | 18.6233 | 572.874 | 42444.8 |
|
||||||
| 2022-11-21 00:00:00 | 9.42557 | 57.6 | 61.242 | 16.3632 | 981.734 | 42187.3 |
|
| 2022-11-21 00:00:00 | 9.42557 | 57.6 | 61.242 | 16.3632 | 981.734 | 42187.3 |
|
||||||
| 2022-11-18 00:00:00 | 18.445 | 60.68 | 112.603 | 30.3973 | 2571.31 | 42352.3 |
|
| 2022-11-18 00:00:00 | 18.445 | 60.68 | 112.603 | 30.3973 | 2571.31 | 42352.3 |
|
||||||
...continued...
|
|
||||||
| 2022-02-16 00:00:00 | 11.0333 | 52.77 | 7.958 | 20.909 | 516.966 | 19836.2 |
|
| 2022-02-16 00:00:00 | 11.0333 | 52.77 | 7.958 | 20.909 | 516.966 | 19836.2 |
|
||||||
| 2022-02-15 00:00:00 | 11.8138 | 57.01 | 36.259 | 20.7236 | 1295.52 | 21808.3 |
|
| 2022-02-15 00:00:00 | 11.8138 | 57.01 | 36.259 | 20.7236 | 1295.52 | 21808.3 |
|
||||||
| 2022-02-14 00:00:00 | 12.744 | 53.08 | 50.473 | 24.0105 | 648.705 | 19105.9 |
|
| 2022-02-14 00:00:00 | 12.744 | 53.08 | 50.473 | 24.0105 | 648.705 | 19105.9 |
|
||||||
@@ -188,7 +185,6 @@ nyse_psi.join(nasdaq_psi, lsuffix = ' (NYSE)', rsuffix = ' (NQ)')
|
|||||||
| 2013-04-03 00:00:00 | 2.43128e+06 | 0 | 3.23342e+06 | 1.89638e+07 | 13418 | 2.83739e+07 |
|
| 2013-04-03 00:00:00 | 2.43128e+06 | 0 | 3.23342e+06 | 1.89638e+07 | 13418 | 2.83739e+07 |
|
||||||
| 2013-04-04 00:00:00 | 1.55106e+06 | 800 | 2.28563e+06 | 1.29551e+07 | 7586 | 1.99661e+07 |
|
| 2013-04-04 00:00:00 | 1.55106e+06 | 800 | 2.28563e+06 | 1.29551e+07 | 7586 | 1.99661e+07 |
|
||||||
| 2013-04-05 00:00:00 | 1.94417e+06 | 300 | 2.93733e+06 | 1.43612e+07 | 0 | 2.81504e+07 |
|
| 2013-04-05 00:00:00 | 1.94417e+06 | 300 | 2.93733e+06 | 1.43612e+07 | 0 | 2.81504e+07 |
|
||||||
...continued...
|
|
||||||
| 2022-11-21 00:00:00 | 838081 | 171 | 2.05784e+06 | 8.47984e+06 | 61071 | 1.41414e+07 |
|
| 2022-11-21 00:00:00 | 838081 | 171 | 2.05784e+06 | 8.47984e+06 | 61071 | 1.41414e+07 |
|
||||||
| 2022-11-22 00:00:00 | 1.24058e+06 | 273 | 2.45227e+06 | 8.70804e+06 | 52062 | 1.60467e+07 |
|
| 2022-11-22 00:00:00 | 1.24058e+06 | 273 | 2.45227e+06 | 8.70804e+06 | 52062 | 1.60467e+07 |
|
||||||
| 2022-11-23 00:00:00 | 1.82258e+06 | 524 | 3.35511e+06 | 1.17129e+07 | 91028 | 1.90024e+07 |
|
| 2022-11-23 00:00:00 | 1.82258e+06 | 524 | 3.35511e+06 | 1.17129e+07 | 91028 | 1.90024e+07 |
|
||||||
@@ -209,7 +205,6 @@ openbb.stocks.dps.hsi()
|
|||||||
| 2 | CVNA | Carvana Co | NYSE | 44.24% | 93.40M | 105.95M | Retail (Specialty Non-Apparel) |
|
| 2 | CVNA | Carvana Co | NYSE | 44.24% | 93.40M | 105.95M | Retail (Specialty Non-Apparel) |
|
||||||
| 3 | BYND | Beyond Meat Inc | Nasdaq | 42.75% | 57.25M | 63.74M | Food Processing |
|
| 3 | BYND | Beyond Meat Inc | Nasdaq | 42.75% | 57.25M | 63.74M | Food Processing |
|
||||||
| 4 | MSTR | MicroStrategy Inc | Nasdaq | 40.51% | 9.34M | 9.35M | Software & Programming |
|
| 4 | MSTR | MicroStrategy Inc | Nasdaq | 40.51% | 9.34M | 9.35M | Software & Programming |
|
||||||
...continued...
|
|
||||||
| 31 | SPCE | Virgin Galactic Holdings Inc | NYSE | 20.98% | 208.85M | 274.56M | Aerospace & Defense |
|
| 31 | SPCE | Virgin Galactic Holdings Inc | NYSE | 20.98% | 208.85M | 274.56M | Aerospace & Defense |
|
||||||
| 32 | PETS | Petmed Express Inc | Nasdaq | 20.83% | 19.74M | 21.08M | Retail (Drugs) |
|
| 32 | PETS | Petmed Express Inc | Nasdaq | 20.83% | 19.74M | 21.08M | Retail (Drugs) |
|
||||||
| 33 | RIDE | Lordstown Motors Corp | Nasdaq | 20.69% | 162.40M | 216.98M | Auto & Truck Manufacturers |
|
| 33 | RIDE | Lordstown Motors Corp | Nasdaq | 20.69% | 162.40M | 216.98M | Auto & Truck Manufacturers |
|
||||||
|
|||||||
@@ -63,7 +63,7 @@ gtlb_customers
|
|||||||
|
|
||||||
### Supplier
|
### Supplier
|
||||||
|
|
||||||
`openbb.stocks.dd.supplier` is the supply side to the `customer` function. It returns revenue, net income, net margin, and cash flow, for the companies that the feed the ticker's supply chain.
|
`openbb.stocks.dd.supplier` is the supply side to the `customer` function. It returns revenue, net income, net margin, and cash flow, for the companies feeding the ticker's supply chain.
|
||||||
|
|
||||||
```python
|
```python
|
||||||
gtlb_suppliers = openbb.stocks.dd.supplier('GTLB')
|
gtlb_suppliers = openbb.stocks.dd.supplier('GTLB')
|
||||||
|
|||||||
@@ -1,8 +1,82 @@
|
|||||||
---
|
---
|
||||||
title: Options
|
title: Options
|
||||||
keywords:
|
keywords: ["stocks", "options", "calls", "puts", "gamma", "delta", "iv", "theta", "rho", "greeks", "charm", "vanna", "vomma", "derivatives", "contracts", "^SPX", "^VIX", "^NDX", "chains", "oi", "vol", "volume", "open", "interest", "expiration", "dte", "volatility", "underlying"]
|
||||||
[
|
excerpt: "This guide introduces the Stock Options module, within the context of the OpenBB SDK"
|
||||||
"stocks", "stock", "options", "option", "call", "put"
|
geekdocCollapseSection: true
|
||||||
]
|
|
||||||
excerpt: "This guide introduces the Stocks menu in the context of the OpenBB SDK."
|
|
||||||
---
|
---
|
||||||
|
The Stock Options module of the OpenBB SDK wraps the functions of the Options sub-menu within the [OpenBB Terminal](/terminal/guides/intros/stocks/options). This allows the user greater flexibility when researching and anlayzing options data. Start a Python script of Notebook file by importing the dependencies:
|
||||||
|
|
||||||
|
```python
|
||||||
|
from openbb_terminal.sdk import openbb
|
||||||
|
|
||||||
|
import pandas as pd
|
||||||
|
import numpy as np
|
||||||
|
|
||||||
|
import matplotlib.pyplot as plt
|
||||||
|
|
||||||
|
%matplotlib widget
|
||||||
|
```
|
||||||
|
|
||||||
|
## How to Use
|
||||||
|
|
||||||
|
All functions within the Options module are printed with: `openbb.stocks.options`
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
The [Unusual Options function](/sdk/reference/stocks/options/unu/) returns a Tuple containing the DataFrame and a timestamp from when the list was last updated.
|
||||||
|
|
||||||
|
```python
|
||||||
|
unusual_options,timestamp = openbb.stocks.options.unu()
|
||||||
|
unusual_options
|
||||||
|
```
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Get up to ten years of historical put/call ratios (US equity options only), with the `PCR` function:
|
||||||
|
|
||||||
|
```python
|
||||||
|
pcr_spy = openbb.stocks.options.pcr(symbol = 'SPY', start_date = '2012-11-03')
|
||||||
|
pcr_spy.rename(columns = {'PCR': 'Put/Call Ratio'})
|
||||||
|
```
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
The list of expiration dates is generated with:
|
||||||
|
|
||||||
|
```python
|
||||||
|
openbb.stocks.options.option_expirations('SPY')
|
||||||
|
```
|
||||||
|
|
||||||
|
Get the raw DataFrame for an options chain from yFinance by using:
|
||||||
|
|
||||||
|
```python
|
||||||
|
SPY221111 = openbb.stocks.options.chains_yf(symbol = 'SPY', expiry = '2022-11-11')
|
||||||
|
|
||||||
|
SPY221111
|
||||||
|
```
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Getting all option chains for the underlying symbol as a single Pandas DataFrame requires a little bit of scripting prior to analysis. This will query Tradier as the data source:
|
||||||
|
|
||||||
|
```python
|
||||||
|
from openbb_terminal.sdk import openbb
|
||||||
|
import pandas as pd
|
||||||
|
import numpy as np
|
||||||
|
|
||||||
|
expirations = openbb.stocks.options.option_expirations(symbol = 'SPY')
|
||||||
|
options_df: pd.DataFrame = []
|
||||||
|
|
||||||
|
for expirations in expirations:
|
||||||
|
options_df.append(openbb.stocks.options.chains(symbol = 'SPY', expiry = expirations))
|
||||||
|
|
||||||
|
options_df = pd.concat(options_df)
|
||||||
|
|
||||||
|
options_df.set_index(keys = 'symbol', inplace = True)
|
||||||
|
|
||||||
|
options_df
|
||||||
|
```
|
||||||
|
|
||||||
|
Depending on the depth of options available, compiling the data may take upwards of thirty seconds.
|
||||||
|
|
||||||
|

|
||||||
|
|||||||
2
website/content/sdk/index.md
vendored
2
website/content/sdk/index.md
vendored
@@ -38,7 +38,7 @@ To know more about OpenBB SDK, you can start by reading the [Installation Guide]
|
|||||||
|
|
||||||
To learn how to use OpenBB SDK, you can start by reading the [Structure of the SDK](/sdk/guides/basics/structure) and [Using the SDK](/sdk/guides/basics/using) guides.
|
To learn how to use OpenBB SDK, you can start by reading the [Structure of the SDK](/sdk/guides/basics/structure) and [Using the SDK](/sdk/guides/basics/using) guides.
|
||||||
|
|
||||||
### SDK Functions
|
### SDK Reference
|
||||||
|
|
||||||
SDK Reference is a complete list of all functions available in OpenBB SDK. It is automatically generated and updated every time a new version of OpenBB SDK is released. It can be found [here](/sdk/reference).
|
SDK Reference is a complete list of all functions available in OpenBB SDK. It is automatically generated and updated every time a new version of OpenBB SDK is released. It can be found [here](/sdk/reference).
|
||||||
|
|
||||||
|
|||||||
53
website/content/sdk/quickstart/faq.md
vendored
53
website/content/sdk/quickstart/faq.md
vendored
@@ -56,7 +56,7 @@ An installation will use approximately 4GB of space.
|
|||||||
<details><summary>How do I launch Jupyter Lab or Jupyter Notebook for use with the OpenBB SDK?</summary>
|
<details><summary>How do I launch Jupyter Lab or Jupyter Notebook for use with the OpenBB SDK?</summary>
|
||||||
<p>
|
<p>
|
||||||
|
|
||||||
Once the installation is finished via `pip` and you have activated the conda environment, as explained in the [installation guide](/sdk/quickstart/installation) you are able to activate a Jupyter Notebook by running `jupyter notebook` or Jupyter Lab with `jupyter lab`. Then, you should be able to use the OpenBB SDK by following along with the [Structure of the SDK](/sdk/guides/basics/structure) and [Using the SDK](/sdk/guides/basics/using) guides.
|
Once the installation is finished via `pip` and you have activated the conda environment, as explained in the [installation guide](/sdk/quickstart/installation) you are able to activate a Jupyter Notebook by running `jupyter notebook` or Jupyter Lab with `jupyter lab`. Then, you should be able to use the OpenBB SDK by following along with the [How to use the SDK](/sdk/guides/basics#how-to-use-the-sdk) guide.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</details>
|
</details>
|
||||||
@@ -104,13 +104,62 @@ You can get help with OpenBB SDK by joining our [Discord server](https://openbb.
|
|||||||
</p>
|
</p>
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
<details><summary>How can I give feedback about the OpenBB SDK?</summary>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
Being an open source platform that wishes to tailor to the needs of any type of investor, we highly encourage anyone to share with us their experience and/or how we can further improve the OpenBB Terminal. This can be anything from a very small bug, a new feature, or the implementation of a highly advanced Machine Learning model.
|
||||||
|
|
||||||
|
You can contact us via the following routes:
|
||||||
|
|
||||||
|
- If you notice that a feature is missing inside the terminal, please fill in the <a href="https://openbb.co/request-a-feature" target="_blank" rel="noreferrer noopener">Request a Feature form</a>.
|
||||||
|
- If you wish to report a bug, have a question/suggestion or anything else, please fill in the <a href="https://openbb.co/support" target="_blank" rel="noreferrer noopener">Support form</a>.
|
||||||
|
- If you wish to speak to us directly, please contact us via <a href="https://openbb.co/discord" target="_blank" rel="noreferrer noopener">Discord</a>.
|
||||||
|
|
||||||
|
</p>
|
||||||
|
</details>
|
||||||
|
|
||||||
|
|
||||||
## Functionality
|
## Functionality
|
||||||
|
|
||||||
|
<details><summary>What kind of architectural pattern does the OpenBB SDK use?</summary>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
Throughout the entire OpenBB Platform, the [Model-view-controller](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller) architectural pattern is used for creating functionality in the terminal.
|
||||||
|
|
||||||
|
This is visible in the OpenBB SDK with the addition of `_chart` within functions relating to the `view` portfion of the pattern.
|
||||||
|
|
||||||
|
For example the model is displayed with:
|
||||||
|
|
||||||
|
```
|
||||||
|
openbb.economy.ycrv()
|
||||||
|
```
|
||||||
|
|
||||||
|
| | Maturity | Rate |
|
||||||
|
| --: | --------: | ---: |
|
||||||
|
| 0 | 0.0833333 | 3.93 |
|
||||||
|
| 1 | 0.25 | 4.34 |
|
||||||
|
| 2 | 0.5 | 4.61 |
|
||||||
|
| ... | ... | ... |
|
||||||
|
| 8 | 10 | 3.82 |
|
||||||
|
| 9 | 20 | 4.13 |
|
||||||
|
| 10 | 30 | 3.92 |
|
||||||
|
|
||||||
|
And the view with:
|
||||||
|
|
||||||
|
```
|
||||||
|
openbb.economy.ycrv_chart()
|
||||||
|
```
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
</p>
|
||||||
|
</details>
|
||||||
|
|
||||||
|
|
||||||
<details><summary>Why is data from today missing when I use the load function?</summary>
|
<details><summary>Why is data from today missing when I use the load function?</summary>
|
||||||
<p>
|
<p>
|
||||||
|
|
||||||
By default, the load function requests end-of-day daily data and is not included until the EOD summary has been published. The current day's data is considered intraday and is loaded when the `interval` argument is present.
|
By default, the load function requests end-of-day daily data and is not included until the EOD summary has been published. The current day's data is considered intraday and is loaded when the `interval` argument is present.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</details>
|
</details>
|
||||||
|
|||||||
@@ -1,7 +1,4 @@
|
|||||||
---
|
# Installation
|
||||||
title: Installation
|
|
||||||
sidebar_position: 2
|
|
||||||
---
|
|
||||||
|
|
||||||
We provide a simple installation method in order to utilize the OpenBB SDK. You must first create an environment, which allows you to isolate the SDK from the rest of your system. It is our recommendation that you utilize a `conda` environment because there are optional features, such as `forecast`, that utilize libraries that are specifically sourced from `conda-forge`. Due to this, if you do not use a conda environment, you will not be able to use some of these features. As such, the installation steps will be written under the assumption that you are using conda.
|
We provide a simple installation method in order to utilize the OpenBB SDK. You must first create an environment, which allows you to isolate the SDK from the rest of your system. It is our recommendation that you utilize a `conda` environment because there are optional features, such as `forecast`, that utilize libraries that are specifically sourced from `conda-forge`. Due to this, if you do not use a conda environment, you will not be able to use some of these features. As such, the installation steps will be written under the assumption that you are using conda.
|
||||||
|
|
||||||
@@ -81,4 +78,5 @@ Congratulations! You have successfully installed `openbb` on an environment and
|
|||||||
conda activate obb
|
conda activate obb
|
||||||
```
|
```
|
||||||
|
|
||||||
The OpenBB SDK can be imported to a Jupyter Notebook or any code editor with, `from openbb_terminal.sdk import openbb` as explained in the [Structure of the SDK](/sdk/guides/basics/structure) and [Using the SDK](/sdk/guides/basics/using) guides. By following the above process, the [OpenBB Terminal](/terminal) is automatically included as well which can be ran by typing `openbb`.
|
The OpenBB SDK can be imported to a Jupyter Notebook or any code editor with, `from openbb_terminal.sdk import openbb` as explained in the [How to use the SDK](https://docs.openbb.co/sdk/guides/basics) guides. By following the above process, the [OpenBB Terminal](https://docs.openbb.co/terminal) is automatically included as well which can be ran by typing `openbb`.
|
||||||
|
|
||||||
|
|||||||
36
website/content/sdk/quickstart/requirements.md
vendored
36
website/content/sdk/quickstart/requirements.md
vendored
@@ -52,9 +52,7 @@ Note that installation of the SDK with all the toolkits would require downloadin
|
|||||||
</Tabs>
|
</Tabs>
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## Python
|
## Virtual Environments
|
||||||
|
|
||||||
### Virtual Environments
|
|
||||||
|
|
||||||
- [Miniconda3](https://docs.conda.io/en/latest/miniconda.html)
|
- [Miniconda3](https://docs.conda.io/en/latest/miniconda.html)
|
||||||
- [Installing Python Packages](https://packaging.python.org/en/latest/tutorials/installing-packages/)
|
- [Installing Python Packages](https://packaging.python.org/en/latest/tutorials/installing-packages/)
|
||||||
@@ -67,36 +65,8 @@ Virtual Python environments are containers for Python applications, and allows t
|
|||||||
|
|
||||||
It is not recommended to install in a Global environment, such as Homebrew or `usr/local/bin/python3`. Create and activate a new environment before installing the OpenBB SDK.
|
It is not recommended to install in a Global environment, such as Homebrew or `usr/local/bin/python3`. Create and activate a new environment before installing the OpenBB SDK.
|
||||||
|
|
||||||
### GitHub
|
## GitHub
|
||||||
|
|
||||||
[GitHub](https://github.com/OpenBB-finance/OpenBBTerminal) is where the OpenBB source code is maintained. Cloning the [repository](https://github.com/OpenBB-finance/OpenBBTerminal.git) is recommended for those wishing to develop functions, inspect the source code, or be on the bleeding-edge of development. Syncing the local folder - `git pull` - to the main branch of the repository will keep the installation up-to-date, and `git checkout` provides a way to test development or contributor branches. GitHub can also be used as a personal storage vault and take advantage of automated actions. It's a great place to build, store, and maintain small databases for free.
|
[GitHub](https://github.com/OpenBB-finance/OpenBBTerminal) is where the OpenBB source code is maintained. Cloning the [repository](https://github.com/OpenBB-finance/OpenBBTerminal.git) is recommended for those wishing to develop functions, inspect the source code, or be on the bleeding-edge of development. Syncing the local folder - `git pull` - to the main branch of the repository will keep the installation up-to-date, and `git checkout` provides a way to test development or contributor branches. GitHub can also be used as a personal storage vault and take advantage of automated actions. It's a great place to build, store, and maintain small databases for free.
|
||||||
|
|
||||||
Users encountering bugs are encouraged to report them [here](https://github.com/OpenBB-finance/OpenBBTerminal/issues/new/choose) by creating a new issue, if no open issue for the bug already exists.
|
Users encountering bugs are encouraged to report them [here](https://github.com/OpenBB-finance/OpenBBTerminal/issues/new/choose) by creating a new issue, if no open issue for the bug already exists.
|
||||||
|
|
||||||
### View-Model-Control
|
|
||||||
|
|
||||||
OpenBB uses a [View-Model-Control](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller) format for creating functionality in the terminal.
|
|
||||||
|
|
||||||
For example:
|
|
||||||
|
|
||||||
```
|
|
||||||
openbb.economy.ycrv()
|
|
||||||
```
|
|
||||||
|
|
||||||
| | Maturity | Rate |
|
|
||||||
| --: | --------: | ---: |
|
|
||||||
| 0 | 0.0833333 | 3.93 |
|
|
||||||
| 1 | 0.25 | 4.34 |
|
|
||||||
| 2 | 0.5 | 4.61 |
|
|
||||||
| ... | ... | ... |
|
|
||||||
| 8 | 10 | 3.82 |
|
|
||||||
| 9 | 20 | 4.13 |
|
|
||||||
| 10 | 30 | 3.92 |
|
|
||||||
|
|
||||||
Then the view:
|
|
||||||
|
|
||||||
```
|
|
||||||
openbb.economy.ycrv_chart()
|
|
||||||
```
|
|
||||||
|
|
||||||

|
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Set API keys
|
title: Set API keys
|
||||||
sidebar_position: 3
|
sidebar_position: 1
|
||||||
---
|
---
|
||||||
Within the `keys` menu you can define your, often free, API key from various platforms like Alpha Vantage, FRED, IEX, Twitter, DeGiro, Binance and Coinglass. API keys are in essence a set of random characters that is unique to you.
|
Within the `keys` menu you can define your, often free, API key from various platforms like Alpha Vantage, FRED, IEX, Twitter, DeGiro, Binance and Coinglass. API keys are in essence a set of random characters that is unique to you.
|
||||||
|
|
||||||
@@ -44,4 +44,4 @@ To figure out where you can obtain the API key, you can enter the command (e.g.
|
|||||||
| eodhd | EODHD | https://eodhistoricaldata.com/ |
|
| eodhd | EODHD | https://eodhistoricaldata.com/ |
|
||||||
| santiment | Santiment | https://app.santiment.net/ |
|
| santiment | Santiment | https://app.santiment.net/ |
|
||||||
| shroom | ShroomDK | https://sdk.flipsidecrypto.xyz/shroomdk |
|
| shroom | ShroomDK | https://sdk.flipsidecrypto.xyz/shroomdk |
|
||||||
| tokenterminal | Token Terminal | https://tokenterminal.com/ |
|
| tokenterminal | Token Terminal | https://tokenterminal.com/ |
|
||||||
@@ -1,12 +1,12 @@
|
|||||||
---
|
---
|
||||||
sidebar_position: 1
|
sidebar_position: 2
|
||||||
title: Changing Sources
|
title: Changing Sources
|
||||||
---
|
---
|
||||||
|
|
||||||
Many commands have multiple datasources attached to it. A great example is `/stocka/fa/income` that allows you to select `YahooFinance, Polygon, AlphaVantage, FinancialModelingPrep or EODHD`. Many have a default source, for example for `income` this is Yahoo Finance but you can change the default sources of each command via the `sources` menu.
|
Many commands have multiple datasources attached to it. A great example is `/stocka/fa/income` that allows you to select `YahooFinance, Polygon, AlphaVantage, FinancialModelingPrep or EODHD`. Many have a default source, for example for `income` this is Yahoo Finance but you can change the default sources of each command via the `sources` menu.
|
||||||
|
|
||||||
```
|
```
|
||||||
2022 Nov 23, 06:09 (🦋) / $ sources
|
2022 Nov 23, 06:09 (🦋) / $ sources
|
||||||
|
|
||||||
╭─────────────────────────────────────────────────────────────────────────────────────────────────── Data Sources ───────────────────────────────────────────────────────────────────────────────────────────────────╮
|
╭─────────────────────────────────────────────────────────────────────────────────────────────────── Data Sources ───────────────────────────────────────────────────────────────────────────────────────────────────╮
|
||||||
│ │
|
│ │
|
||||||
@@ -43,4 +43,4 @@ The data source was specified successfully.
|
|||||||
Default : Polygon
|
Default : Polygon
|
||||||
Available : Polygon, YahooFinance, AlphaVantage, FinancialModelingPrep, EODHD
|
Available : Polygon, YahooFinance, AlphaVantage, FinancialModelingPrep, EODHD
|
||||||
|
|
||||||
```
|
```
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
sidebar_position: 2
|
sidebar_position: 4
|
||||||
title: Customizing the Terminal
|
title: Customizing the Terminal
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -38,4 +38,4 @@ includes the following:
|
|||||||
- `ion` whether to enable interactive mode of MATPLOTLIB (default is yes).
|
- `ion` whether to enable interactive mode of MATPLOTLIB (default is yes).
|
||||||
- `watermark` whether to include the watermark of OpenBB Terminal in figures (default is yes).
|
- `watermark` whether to include the watermark of OpenBB Terminal in figures (default is yes).
|
||||||
- `cmdloc` whether the location of the command is displayed in figures (default is yes).
|
- `cmdloc` whether the location of the command is displayed in figures (default is yes).
|
||||||
- `tbhint` whether usage hints are displayed in the bottom toolbar (default is yes).
|
- `tbhint` whether usage hints are displayed in the bottom toolbar (default is yes).
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Importing and Exporting Data
|
title: Importing and Exporting Data
|
||||||
sidebar_position: 4
|
sidebar_position: 3
|
||||||
---
|
---
|
||||||
The `OpenBBUserData` folder's default location is the home of the system user account. By default this will be the following paths:
|
The `OpenBBUserData` folder's default location is the home of the system user account. By default this will be the following paths:
|
||||||
- macOS: `Macintosh HD/Users/<YOUR_USERNAME>/OpenBBUserData`
|
- macOS: `Macintosh HD/Users/<YOUR_USERNAME>/OpenBBUserData`
|
||||||
@@ -19,6 +19,6 @@ This folder contains all things user-created. For example:
|
|||||||
- Styles and themes
|
- Styles and themes
|
||||||
- Preferred data sources
|
- Preferred data sources
|
||||||
|
|
||||||
The location of this folder can be set by the user from the `/settings` menu.
|
The location of this folder can be set by the user from the `/settings` menu.
|
||||||
|
|
||||||
<img width="1117" alt="The settings menu" src="https://user-images.githubusercontent.com/85772166/195736718-a1b821da-5977-437a-bd18-b44add2a29a2.png"></img>
|
<img width="1117" alt="The settings menu" src="https://user-images.githubusercontent.com/85772166/195736718-a1b821da-5977-437a-bd18-b44add2a29a2.png"></img>
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
sidebar_position: 3
|
sidebar_position: 5
|
||||||
title: Scripts & Routines
|
title: Scripts & Routines
|
||||||
---
|
---
|
||||||
The `.openbb` scripts offer the ability to automatically run a set of commands in the form of a **routine**. Furthermore, the scripts can be adapted, and documented, at any moment giving the user full control over the type of analysis you wish to do (and repeat). This can fundamental research, understanding market movements, finding hidden gems and even doing advanced statistical/econometric research.
|
The `.openbb` scripts offer the ability to automatically run a set of commands in the form of a **routine**. Furthermore, the scripts can be adapted, and documented, at any moment giving the user full control over the type of analysis you wish to do (and repeat). This can fundamental research, understanding market movements, finding hidden gems and even doing advanced statistical/econometric research.
|
||||||
@@ -11,7 +11,7 @@ The script file below is titled _stocks_demo.openbb_. This file follows the foll
|
|||||||
- <b>Comments</b>: any text after a `#` is referred to as a comment. This is used to explain what is happening within the script and is not taking into account when running terminal commands.
|
- <b>Comments</b>: any text after a `#` is referred to as a comment. This is used to explain what is happening within the script and is not taking into account when running terminal commands.
|
||||||
- <b>Commands</b>: any text **without** a `#` is being ran inside the OpenBB Terminal. E.g. on the second line it says `stocks` thus within the OpenBB Terminal the script will enter `stocks` and run this for you.
|
- <b>Commands</b>: any text **without** a `#` is being ran inside the OpenBB Terminal. E.g. on the second line it says `stocks` thus within the OpenBB Terminal the script will enter `stocks` and run this for you.
|
||||||
|
|
||||||
These scripts have a 1-to-1 relationship with how you would normally use the terminal. To get a better understanding of how the terminal is used, please see <a href="https://docs.openbb.co/guides/basics/structure" target="_blank" rel="noreferrer noopener">Structure of the OpenBB Terminal</a>.
|
These scripts have a 1-to-1 relationship with how you would normally use the terminal. To get a better understanding of how the terminal is used, please see <a href="https://docs.openbb.co/terminal/guides/basics/structure" target="_blank" rel="noreferrer noopener">Structure of the OpenBB Terminal</a>.
|
||||||
|
|
||||||
```
|
```
|
||||||
# Go into the stocks context
|
# Go into the stocks context
|
||||||
@@ -54,7 +54,7 @@ sentiment
|
|||||||
|
|
||||||
### Executing a script
|
### Executing a script
|
||||||
|
|
||||||
By going to the main menu as depicted below (accessible with `home`), the <a href="exe" target="_blank" rel="noreferrer noopener">exe</a> command can be used. With this command you can run any `.openbb` script. These scripts are located where the application is located inside the routines folder.
|
By going to the main menu as depicted below (accessible with `home`), the `exe` command can be used. With this command you can run any `.openbb` script. These scripts are located where the application is located inside the routines folder.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
@@ -107,4 +107,4 @@ Scripts and routines reside in the `routines` folder and are automatically shown
|
|||||||
|
|
||||||
Within this template, some examples are given, and you are free to change the contents and rename the file. As long as the file remains in the same folder, you will be able to find your file automatically as shown below:
|
Within this template, some examples are given, and you are free to change the contents and rename the file. As long as the file remains in the same folder, you will be able to find your file automatically as shown below:
|
||||||
|
|
||||||

|

|
||||||
@@ -1,23 +1,34 @@
|
|||||||
---
|
---
|
||||||
sidebar_position: 2
|
title: Basics
|
||||||
title: Menus & Commands
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
The OpenBB Terminal is based off the <a href="https://en.wikipedia.org/wiki/Command-line_interface" target="_blank" rel="noreferrer noopener">Command Line Interface (CLI)</a>
|
||||||
|
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"/>
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
Throughout the entire terminal, the same set of colors are used which all share the same representation. This is structured as follows:
|
||||||
|
|
||||||
|
- <b><span style={{color:"#00AAFF"}}>Light Blue</span></b>: represents commands.
|
||||||
|
- <b><span style={{color:"#005CA9"}}>Dark Blue</span></b>: represents menus, also recognizable by the `>` in front.
|
||||||
|
- <b><span style={{color:"#EF7D00"}}>Orange</span></b>: represents titles and headers.
|
||||||
|
- <b><span style={{color:"#FCED00"}}>Yellow</span></b>: represents descriptions of a parameter or variable.
|
||||||
|
- <b>White</b>: represents text, usually in combination with a description that is in Yellow.
|
||||||
|
|
||||||
|
|
||||||
### Explanation of Menus
|
### Explanation of Menus
|
||||||
|
|
||||||
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.
|
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>
|
<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>
|
||||||
|
|
||||||
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 <a href="terminal/stocks" target="_blank" rel="noreferrer noopener">Introduction to Stocks</a> for more information.
|
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).
|
||||||
|
|
||||||
---
|
:::note **Pro tip:** you can quickly jump between menus by using a forward slash (`/`). For example, if I want to access the options menu, You can type `/stocks/options` to instantly arrive at this menu. You can do this from any location within theOpenBB Terminal!
|
||||||
|
:::
|
||||||
**Pro tip:** you can quickly jump between menus by using a forward slash (`/`). For example, if I want to access the options
|
|
||||||
menu, I can type `/stocks/options` to instantly arrive at this menu. You can do this from any location within the
|
|
||||||
OpenBB Terminal!
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Explanation of Commands
|
### Explanation of Commands
|
||||||
|
|
||||||
@@ -118,4 +129,13 @@ We can check that this period has changed by looking into the <a href="https://w
|
|||||||
|
|
||||||
<a target="_blank" href="https://user-images.githubusercontent.com/46355364/169503345-a9409637-dc7a-4193-9c87-38b1b6ee1a08.png"><img src="https://user-images.githubusercontent.com/46355364/169503345-a9409637-dc7a-4193-9c87-38b1b6ee1a08.png" alt="Amazon Candle Chart" width="800"/></a>
|
<a target="_blank" href="https://user-images.githubusercontent.com/46355364/169503345-a9409637-dc7a-4193-9c87-38b1b6ee1a08.png"><img src="https://user-images.githubusercontent.com/46355364/169503345-a9409637-dc7a-4193-9c87-38b1b6ee1a08.png" alt="Amazon Candle Chart" width="800"/></a>
|
||||||
|
|
||||||
As mentioned in the <a href="#explanation-of-menus">Explanation of Menus</a>, some information also transfers over to other menus and this includes the loaded market data from <a href="terminal/stocks/load" target="_blank" rel="noreferrer noopener">load</a>. So, if you would visit the `ta` menu (which stands for <a href="https://www.investopedia.com/terms/t/technicalanalysis.asp" target="_blank" rel="noreferrer noopener">Technical Analysis</a>) you will see that, by running any command, the selected period above is depicted again. Return to the Stocks menu again by using `q` and use it again to return to the home screen which can be shown with `?`.
|
As mentioned in the <a href="#explanation-of-menus">Explanation of Menus</a>, some information also transfers over to other menus and this includes the loaded market data from <a href="terminal/stocks/load" target="_blank" rel="noreferrer noopener">load</a>. So, if you would visit the `ta` menu (which stands for <a href="https://www.investopedia.com/terms/t/technicalanalysis.asp" target="_blank" rel="noreferrer noopener">Technical Analysis</a>) you will see that, by running any command, the selected period above is depicted again. Return to the Stocks menu again by using `q` and use it again to return to the home screen which can be shown with `?`.
|
||||||
|
|
||||||
|
|
||||||
|
### Defining your own source of data
|
||||||
|
|
||||||
|
The OpenBB Terminal is built on a lot of different data sources. The example above for example collects data from Yahoo Finance. This could be undesirable and therefore we allow for a variety of different data sources. Think of Polygon, IEX Cloud, Alpha Vantage and Binance to name a few.
|
||||||
|
|
||||||
|
Some of these sources require you to set an API Key to connect with their data. You can find more information about setting these keys in the terminal [here](/terminal/guides/advanced/keys).
|
||||||
|
|
||||||
|
It is also possible to use your own datastreams. It could be that you have a dataset in Microsoft Excel or similar that you would like to import for usage within any of our functionalities. In that case, have a look [here](/terminal/guides/advanced/data).
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_position: 1
|
|
||||||
title: Structure of the Terminal
|
|
||||||
---
|
|
||||||
The OpenBB Terminal is based off the <a href="https://en.wikipedia.org/wiki/Command-line_interface" target="_blank" rel="noreferrer noopener">Command Line Interface (CLI)</a>
|
|
||||||
which is installed by default on every computer. By opening the application you have installed via "Accessing the OpenBB Terminal",
|
|
||||||
you are greeted with the following interface:
|
|
||||||
|
|
||||||
<img src="https://user-images.githubusercontent.com/85772166/194683764-ae1c6c0a-8d50-4533-b930-ec4b601017b8.png" width="800"/>
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
Throughout the entire terminal, the same set of colors are used which all share the same representation. This is structured as follows:
|
|
||||||
|
|
||||||
- <b><span style={{color:"#00AAFF"}}>Light Blue</span></b>: represents commands.
|
|
||||||
- <b><span style={{color:"#005CA9"}}>Dark Blue</span></b>: represents menus, also recognizable by the `>` in front.
|
|
||||||
- <b><span style={{color:"#EF7D00"}}>Orange</span></b>: represents titles and headers.
|
|
||||||
- <b><span style={{color:"#FCED00"}}>Yellow</span></b>: represents descriptions of a parameter or variable.
|
|
||||||
- <b>White</b>: represents text, usually in combination with a description that is in Yellow.
|
|
||||||
@@ -47,7 +47,7 @@ The Behavioural Analysis menu offers the user tools for gauging the overall publ
|
|||||||
|
|
||||||
### How to use
|
### How to use
|
||||||
|
|
||||||
The commands with text, representing <a href="https://openbb-finance.github.io/OpenBBTerminal/#structure-of-the-openbb-terminal" target="_blank" rel="noreferrer noopener">commands</a>, do not require a ticker, faded commands will turn light blue when there is a ticker loaded.
|
The commands with text, representing <a href="https://docs.openbb.co/terminal/guides/basics/structure" 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
|
(🦋) /stocks/ba/ $ load gme
|
||||||
@@ -73,11 +73,11 @@ Some data sources will require a valid API key, which can be obtained for free a
|
|||||||
- <a href="https://sentimentinvestor.com/" target="_blank" rel="noreferrer noopener">Sentiment
|
- <a href="https://sentimentinvestor.com/" target="_blank" rel="noreferrer noopener">Sentiment
|
||||||
Investor</a><br/>
|
Investor</a><br/>
|
||||||
|
|
||||||
See the <a href="/terminal/quickstart/keys" target="_blank" rel="noreferrer noopener">Getting Started Guide</a> for help setting API keys in the Terminal.
|
See the <a href="/terminal/guides/advanced/keys" target="_blank" rel="noreferrer noopener">Set API keys</a> for help with API keys in the Terminal.
|
||||||
|
|
||||||
### Examples
|
### Examples
|
||||||
|
|
||||||
As with every command, using the `-h` argument displays the help dialogue. Running the <a href="/terminal/reference/stocks/behavioural%20analysis/headlines/" target="_blank" rel="noreferrer noopener">headlines</a> command returns the following:
|
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
|
(🦋) /stocks/ba/ $ headlines
|
||||||
@@ -85,7 +85,7 @@ As with every command, using the `-h` argument displays the help dialogue. Runni
|
|||||||
|
|
||||||
<img alt="headlines" src="https://user-images.githubusercontent.com/46355364/170244924-ffe6cd15-8d17-4690-bf44-d2b496dbc310.png"></img>
|
<img alt="headlines" src="https://user-images.githubusercontent.com/46355364/170244924-ffe6cd15-8d17-4690-bf44-d2b496dbc310.png"></img>
|
||||||
|
|
||||||
Alternatively, running the <a href="/terminal/reference/stocks/behavioural%20analysis/snews/" target="_blank" rel="noreferrer noopener">snews</a> command returns the following:
|
Alternatively, running the <a href="/terminal/reference/stocks/ba/snews/" target="_blank" rel="noreferrer noopener">snews</a> command returns the following:
|
||||||
|
|
||||||
```
|
```
|
||||||
(🦋) /stocks/ba/ $ snews
|
(🦋) /stocks/ba/ $ snews
|
||||||
@@ -125,7 +125,7 @@ Reddit Submission
|
|||||||
| | | | | | 1 Sne |
|
| | | | | | 1 Sne |
|
||||||
```
|
```
|
||||||
|
|
||||||
The Behavioural Analysis menu also has the ability to scan for sentiment on multiple platforms including Twitter and Google with <a href="/terminal/reference/stocks/behavioural%20analysis/sentiment/" target="_blank" rel="noreferrer noopener">sentiment</a>, <a href="/terminal/reference/stocks/behavioural%20analysis/infer/" target="_blank" rel="noreferrer noopener">infer</a> and <a href="/terminal/reference/stocks/behavioural%20analysis/queries/" target="_blank" rel="noreferrer noopener">queries</a>.
|
The Behavioural Analysis menu also has the ability to scan for sentiment on multiple platforms including Twitter and Google with <a href="/terminal/reference/stocks/ba/sentiment/" target="_blank" rel="noreferrer noopener">sentiment</a>, <a href="/terminal/reference/stocks/ba/infer/" target="_blank" rel="noreferrer noopener">infer</a> and <a href="/terminal/reference/stocks/ba/queries/" target="_blank" rel="noreferrer noopener">queries</a>.
|
||||||
|
|
||||||
```
|
```
|
||||||
(🦋) /stocks/ba/ $ sentiment -c
|
(🦋) /stocks/ba/ $ sentiment -c
|
||||||
@@ -165,14 +165,14 @@ Of the last 100 tweets, 19.00 % had a higher negative sentiment
|
|||||||
| bb | 5% |
|
| bb | 5% |
|
||||||
```
|
```
|
||||||
|
|
||||||
The <a href="/terminal/reference/stocks/behavioural%20analysis/sentiment/" target="_blank" rel="noreferrer noopener">sentiment</a> command returns the following:
|
The <a href="/terminal/reference/stocks/ba/sentiment/" target="_blank" rel="noreferrer noopener">sentiment</a> command returns the following:
|
||||||
|
|
||||||
<img alt="sentiment" src="https://user-images.githubusercontent.com/46355364/170243539-1ea3fc6a-d7ec-4991-a6bb-ed5879753328.png"></img>
|
<img alt="sentiment" src="https://user-images.githubusercontent.com/46355364/170243539-1ea3fc6a-d7ec-4991-a6bb-ed5879753328.png"></img>
|
||||||
|
|
||||||
More advanced techniques can also be applied by using tools from <a href="https://sentimentinvestor.com" target="_blank" rel="noreferrer noopener">Sentiment Investor</a> that analyzes millions of messages to show the most talked about stocks by hour. This has the ability to show the most trending tickers with <a href="/terminal/reference/stocks/behavioural%20analysis/trend/" target="_blank" rel="noreferrer noopener">trend</a> and historical sentiment data with <a href="/terminal/reference/stocks/behavioural%20analysis/hist/" target="_blank" rel="noreferrer noopener">hist</a>.
|
More advanced techniques can also be applied by using tools from <a href="https://sentimentinvestor.com" target="_blank" rel="noreferrer noopener">Sentiment Investor</a> that analyzes millions of messages to show the most talked about stocks by hour. This has the ability to show the most trending tickers with <a href="/terminal/reference/stocks/ba/trending/" target="_blank" rel="noreferrer noopener">trending</a> and historical sentiment data with <a href="/terminal/reference/stocks/ba/hist/" target="_blank" rel="noreferrer noopener">hist</a>.
|
||||||
|
|
||||||
```
|
```
|
||||||
(🦋) /stocks/ba/ $ trend
|
(🦋) /stocks/ba/ $ trending
|
||||||
|
|
||||||
Most trending stocks at 2022-05-23 00:00
|
Most trending stocks at 2022-05-23 00:00
|
||||||
|
|
||||||
|
|||||||
@@ -53,9 +53,9 @@ excerpt: "This guide introduces the Quantitative Analysis menu, which is common
|
|||||||
|
|
||||||
The Quantitative Analysis menu is a common menu to three asset classes:
|
The Quantitative Analysis menu is a common menu to three asset classes:
|
||||||
|
|
||||||
- <a href = "terminal/guides/intros/crypto/" target="_blank" rel="noreferrer noopener">Crypto</a>
|
- <a href = "/terminal/guides/intros/crypto/" target="_blank" rel="noreferrer noopener">Crypto</a>
|
||||||
- <a href = "terminal/guides/intros/forex/" target= "_blank">Forex</a>
|
- <a href = "/terminal/guides/intros/forex/" target= "_blank" rel="noreferrer noopener">Forex</a>
|
||||||
- <a href = "terminal/guides/intros/stocks/" target = "_blank">Stocks</a>
|
- <a href = "/terminal/guides/intros/stocks/" target = "_blank" rel="noreferrer noopener">Stocks</a>
|
||||||
|
|
||||||
<img width="1110" alt="The Quantitative Analysis menu" src="https://user-images.githubusercontent.com/85772166/183483507-a4bef3e8-6603-46fb-a022-424f18af32d6.png"></img>
|
<img width="1110" alt="The Quantitative Analysis menu" src="https://user-images.githubusercontent.com/85772166/183483507-a4bef3e8-6603-46fb-a022-424f18af32d6.png"></img>
|
||||||
|
|
||||||
|
|||||||
@@ -41,10 +41,10 @@ excerpt: "This guide introduces the Technical Analysis menu, which is common acr
|
|||||||
|
|
||||||
The Technical Analysis menu offers the user a suite of tools for analyzing the technical components of an asset's trading history. The menu can be found in most wings of the Terminal:
|
The Technical Analysis menu offers the user a suite of tools for analyzing the technical components of an asset's trading history. The menu can be found in most wings of the Terminal:
|
||||||
|
|
||||||
- <a href="/terminal/guides/intros/cryptocurrency/" target="_blank" rel="noreferrer noopener">Crypto</a>
|
- <a href="/terminal/guides/intros/crypto/" target="_blank" rel="noreferrer noopener">Crypto</a>
|
||||||
- <a href="/terminal/guides/intros/stocks/" target="_blank" rel="noreferrer noopener">Stocks</a>
|
- <a href="/terminal/guides/intros/stocks/" target="_blank" rel="noreferrer noopener">Stocks</a>
|
||||||
- <a href="/terminal/guides/intros/etf/" target="_blank" rel="noreferrer noopener">ETF</a>
|
- <a href="/terminal/guides/intros/etf/" target="_blank" rel="noreferrer noopener">ETF</a>
|
||||||
- <a href ="terminal/guides/intros/forex/" target="blank">ForEx</a>
|
- <a href="/terminal/guides/intros/forex/" target="blank">Forex</a>
|
||||||
|
|
||||||
The commands are divided by categories that define their purpose for general-use:
|
The commands are divided by categories that define their purpose for general-use:
|
||||||
|
|
||||||
|
|||||||
@@ -6,8 +6,8 @@ with a brief overview of the features."
|
|||||||
geekdocCollapseSection: true
|
geekdocCollapseSection: true
|
||||||
---
|
---
|
||||||
|
|
||||||
The Cryptocurrency Due Diligence menu gives the user the ability to delve deeper into the coin of choice. To be able to do this, the menu offers basic information about the loaded coin (<a href="/terminal/reference/cryptocurrency/dd/info" target="_blank" rel="noreferrer noopener">info</a> and <a href="/terminal/reference/cryptocurrency/dd/basic" target="_blank" rel="noreferrer noopener">basic</a>), information about the project, technology details, audits etcetera (<a href="/terminal/reference/cryptocurrency/dd/pi" target="_blank" rel="noreferrer noopener">pi</a>), insights into the coin balance and order book (<a href="/terminal/reference/cryptocurrency/dd/balance" target="_blank" rel="noreferrer noopener">balance</a> and <a href="/terminal/reference/cryptocurrency/dd/cbbook" target="_blank" rel="noreferrer noopener">cbbook</a>), the tokenomics and fundraising details
|
The Cryptocurrency Due Diligence menu gives the user the ability to delve deeper into the coin of choice. To be able to do this, the menu offers basic information about the loaded coin (<a href="/terminal/reference/crypto/dd/info" target="_blank" rel="noreferrer noopener">info</a> and <a href="/terminal/reference/crypto/dd/basic" target="_blank" rel="noreferrer noopener">basic</a>), information about the project, technology details, audits etcetera (<a href="/terminal/reference/crypto/dd/pi" target="_blank" rel="noreferrer noopener">pi</a>), insights into the coin balance and order book (<a href="/terminal/reference/crypto/dd/balance" target="_blank" rel="noreferrer noopener">balance</a> and <a href="/terminal/reference/crypto/dd/cbbook" target="_blank" rel="noreferrer noopener">cbbook</a>), the tokenomics and fundraising details
|
||||||
(<a href="/terminal/reference/cryptocurrency/dd/tk" target="_blank" rel="noreferrer noopener">tk</a> and <a href="/terminal/reference/cryptocurrency/dd/fr" target="_blank" rel="noreferrer noopener">fr</a>) and lastly, social media activity (<a href="/terminal/reference/cryptocurrency/dd/mt" target="_blank" rel="noreferrer noopener">mt</a>, <a href="/terminal/reference/cryptocurrency/dd/twitter" target="_blank" rel="noreferrer noopener">twitter</a> and <a href="/terminal/reference/cryptocurrency/dd/dev" target="_blank" rel="noreferrer noopener">dev</a>).
|
(<a href="/terminal/reference/crypto/dd/tk" target="_blank" rel="noreferrer noopener">tk</a> and <a href="/terminal/reference/crypto/dd/fr" target="_blank" rel="noreferrer noopener">fr</a>) and lastly, social media activity (<a href="/terminal/reference/crypto/dd/mt" target="_blank" rel="noreferrer noopener">mt</a>, <a href="/terminal/reference/crypto/dd/twitter" target="_blank" rel="noreferrer noopener">twitter</a> and <a href="/terminal/reference/crypto/dd/dev" target="_blank" rel="noreferrer noopener">dev</a>).
|
||||||
|
|
||||||
### How to use
|
### How to use
|
||||||
|
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ with a brief overview of the features."
|
|||||||
geekdocCollapseSection: true
|
geekdocCollapseSection: true
|
||||||
---
|
---
|
||||||
|
|
||||||
The Cryptocurrency Decentralized Finance (DeFi) menu gives the user the ability to delve deeper into Uniswap statistics (<a href="/terminal/reference/cryptocurrency/defi/tokens" target="_blank" rel="noreferrer noopener">tokens</a>, <a href="/terminal/reference/cryptocurrency/defi/stats" target="_blank" rel="noreferrer noopener">stats</a> and <a href="/terminal/reference/cryptocurrency/defi/pairs" target="_blank" rel="noreferrer noopener">pairs</a>), information about dApps (<a href="/terminal/reference/cryptocurrency/defi/gdapps" target="_blank" rel="noreferrer noopener">gdapps</a> and <a href="/terminal/reference/cryptocurrency/defi/stvl" target="_blank" rel="noreferrer noopener">stvl</a>) as well as information about terra blockchain (<a href="/terminal/reference/cryptocurrency/defi/sreturn" target="_blank" rel="noreferrer noopener">sreturn</a>) and luna (<a href="/terminal/reference/cryptocurrency/defi/lcsc" target="_blank" rel="noreferrer noopener">lcsc</a>).
|
The Cryptocurrency Decentralized Finance (DeFi) menu gives the user the ability to delve deeper into Uniswap statistics (<a href="/terminal/reference/crypto/defi/tokens" target="_blank" rel="noreferrer noopener">tokens</a>, <a href="/terminal/reference/crypto/defi/stats" target="_blank" rel="noreferrer noopener">stats</a> and <a href="/terminal/reference/crypto/defi/pairs" target="_blank" rel="noreferrer noopener">pairs</a>), information about dApps (<a href="/terminal/reference/crypto/defi/gdapps" target="_blank" rel="noreferrer noopener">gdapps</a> and <a href="/terminal/reference/crypto/defi/stvl" target="_blank" rel="noreferrer noopener">stvl</a>) as well as information about terra blockchain (<a href="/terminal/reference/crypto/defi/sreturn" target="_blank" rel="noreferrer noopener">sreturn</a>) and luna (<a href="/terminal/reference/crypto/defi/lcsc" target="_blank" rel="noreferrer noopener">lcsc</a>).
|
||||||
|
|
||||||
### How to use
|
### How to use
|
||||||
|
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ with a brief overview of the features."
|
|||||||
geekdocCollapseSection: true
|
geekdocCollapseSection: true
|
||||||
---
|
---
|
||||||
|
|
||||||
The Cryptocurrency Discovery menu provides the option to look into a wide selection of trending coins (<a href="/terminal/reference/cryptocurrency/disc/trending" target="_blank" rel="noreferrer noopener">trending</a>), gainers and losers (<a href="/terminal/reference/cryptocurrency/disc/gainers" target="_blank" rel="noreferrer noopener">gainers</a> and <a href="/terminal/reference/cryptocurrency/disc/losers" target="_blank" rel="noreferrer noopener">losers</a>) as well as NFTs (<a href="/terminal/reference/cryptocurrency/disc/nft" target="_blank" rel="noreferrer noopener">nft</a>) and decentralized apps (<a href="/terminal/reference/cryptocurrency/disc/dex" target="_blank" rel="noreferrer noopener">dex</a>).
|
The Cryptocurrency Discovery menu provides the option to look into a wide selection of trending coins (<a href="/terminal/reference/crypto/disc/trending" target="_blank" rel="noreferrer noopener">trending</a>), gainers and losers (<a href="/terminal/reference/crypto/disc/gainers" target="_blank" rel="noreferrer noopener">gainers</a> and <a href="/terminal/reference/crypto/disc/losers" target="_blank" rel="noreferrer noopener">losers</a>) as well as NFTs (<a href="/terminal/reference/crypto/disc/nft" target="_blank" rel="noreferrer noopener">nft</a>) and decentralized apps (<a href="/terminal/reference/crypto/disc/dex" target="_blank" rel="noreferrer noopener">dex</a>).
|
||||||
|
|
||||||
### How to use
|
### How to use
|
||||||
|
|
||||||
|
|||||||
@@ -4,9 +4,9 @@ keywords: ["crypto", "web3", "nft", "blockchain", "cryptocurrency"]
|
|||||||
excerpt: "The Introduction to Cryptocurrency explains how to use the Cryptocurrency and provides a brief description of its sub-menus"
|
excerpt: "The Introduction to Cryptocurrency explains how to use the Cryptocurrency and provides a brief description of its sub-menus"
|
||||||
---
|
---
|
||||||
|
|
||||||
The Cryptocurrency menu allows you to discover trending cryptocurrency (<a href="/terminal/reference/cryptocurrency/disc/" target="_blank" rel="noreferrer noopener">disc</a>). Additionally, you can also perform research of a specific coin (<a href="/terminal/reference/cryptocurrency/dd" target="_blank" rel="noreferrer noopener">dd</a>),
|
The Cryptocurrency menu allows you to discover trending cryptocurrency (<a href="/terminal/guides/intros/crypto/disc/" target="_blank" rel="noreferrer noopener">disc</a>). Additionally, you can also perform research of a specific coin (<a href="/terminal/guides/intros/crypto/dd" target="_blank" rel="noreferrer noopener">dd</a>),
|
||||||
NFT (<a href="/terminal/reference/cryptocurrency/nft" target="_blank" rel="noreferrer noopener">nft</a>) or most lucrative Defi project
|
NFT (<a href="/terminal/guides/intros/crypto/nft" target="_blank" rel="noreferrer noopener">nft</a>) or most lucrative Defi project
|
||||||
(<a href="/terminal/reference/cryptocurrency/defi" target="_blank" rel="noreferrer noopener">defi</a>). It does so by handing you tools to (among other things) perform technical analysis (<a href="/terminal/guides/intros/common/ta/" target="_blank" rel="noreferrer noopener">ta</a>), quantitative analysis (<a href="/terminal/guides/intros/common/qa" target="_blank" rel="noreferrer noopener">qa</a>), and give you access to onchain information (<a href="/terminal/reference/cryptocurrency/onchain/" target="_blank" rel="noreferrer noopener">onchain</a>).
|
(<a href="/terminal//guides/intros/crypto/defi" target="_blank" rel="noreferrer noopener">defi</a>). It does so by handing you tools to (among other things) perform technical analysis (<a href="/terminal/guides/intros/common/ta/" target="_blank" rel="noreferrer noopener">ta</a>), quantitative analysis (<a href="/terminal/guides/intros/common/qa" target="_blank" rel="noreferrer noopener">qa</a>), and give you access to onchain information (<a href="/terminal/guides/intros/crypto/onchain/" target="_blank" rel="noreferrer noopener">onchain</a>).
|
||||||
|
|
||||||
### How to use
|
### How to use
|
||||||
|
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ with a brief overview of the features."
|
|||||||
geekdocCollapseSection: true
|
geekdocCollapseSection: true
|
||||||
---
|
---
|
||||||
|
|
||||||
The Non Fungible Token (NFT) menu gives the user the ability to dive into certain NFTs (<a href="/terminal/reference/cryptocurrency/nft/stats/" target="_blank" rel="noreferrer noopener">stats</a>).
|
The Non Fungible Token (NFT) menu gives the user the ability to dive into certain NFTs (<a href="/terminal/reference/crypto/nft/stats/" target="_blank" rel="noreferrer noopener">stats</a>).
|
||||||
|
|
||||||
### How to use
|
### How to use
|
||||||
|
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ with a brief overview of the features."
|
|||||||
geekdocCollapseSection: true
|
geekdocCollapseSection: true
|
||||||
---
|
---
|
||||||
|
|
||||||
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 (<a href="/terminal/reference/cryptocurrency/onchain/hr/" target="_blank" rel="noreferrer noopener">hr</a>), confirmed transactions (<a href="/terminal/reference/cryptocurrency/onchain/btcct/" target="_blank" rel="noreferrer noopener">btcct</a>) and top traded crypto pairs (<a href="/terminal/reference/cryptocurrency/onchain/ttcp/" target="_blank" rel="noreferrer noopener">ttcp</a>).
|
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 (<a href="/terminal/reference/crypto/onchain/hr/" target="_blank" rel="noreferrer noopener">hr</a>), confirmed transactions (<a href="/terminal/reference/crypto/onchain/btcct/" target="_blank" rel="noreferrer noopener">btcct</a>) and top traded crypto pairs (<a href="/terminal/reference/crypto/onchain/ttcp/" target="_blank" rel="noreferrer noopener">ttcp</a>).
|
||||||
|
|
||||||
### How to use
|
### How to use
|
||||||
|
|
||||||
@@ -47,13 +47,13 @@ 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 <a href="/terminal/reference/cryptocurrency/onchain/address/" target="_blank" rel="noreferrer noopener">address</a> command as follows:
|
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 <a href="/terminal/reference/crypto/onchain/address/" target="_blank" rel="noreferrer noopener">address</a> command as follows:
|
||||||
|
|
||||||
```
|
```
|
||||||
2022 Jul 12, 08:48 (🦋) /crypto/onchain/ $ address 0x71C7656EC7ab88b098defB751B7401B5f6d8976F
|
2022 Jul 12, 08:48 (🦋) /crypto/onchain/ $ address 0x71C7656EC7ab88b098defB751B7401B5f6d8976F
|
||||||
```
|
```
|
||||||
|
|
||||||
Which allows you to see the <a href="/terminal/reference/cryptocurrency/onchain/balance/" target="_blank" rel="noreferrer noopener">balance</a> and <a href="/terminal/reference/cryptocurrency/onchain/hist/" target="_blank" rel="noreferrer noopener">hist</a> which returns the following for `balance`:
|
Which allows you to see the <a href="/terminal/reference/crypto/onchain/balance/" target="_blank" rel="noreferrer noopener">balance</a> and <a href="/terminal/reference/crypto/onchain/hist/" target="_blank" rel="noreferrer noopener">hist</a> which returns the following for `balance`:
|
||||||
|
|
||||||
```
|
```
|
||||||
2022 Jul 12, 08:53 (🦋) /crypto/onchain/ $ balance
|
2022 Jul 12, 08:53 (🦋) /crypto/onchain/ $ balance
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ with a brief overview of the features."
|
|||||||
geekdocCollapseSection: true
|
geekdocCollapseSection: true
|
||||||
---
|
---
|
||||||
|
|
||||||
The Cryptocurrency Overview menu provides, among other things, the option to obtain a complete overview of the Cryptocurrency market (<a href="/terminal/reference/cryptocurrency/ov/global" target="_blank" rel="noreferrer noopener">global</a>), find cryptocurrency indices and derivatives (<a href="/terminal/reference/cryptocurrency/ov/indices" target="_blank" rel="noreferrer noopener">indices</a> and <a href="/terminal/reference/cryptocurrency/ov/derivatives" target="_blank" rel="noreferrer noopener">derivatives</a>), news feeds (<a href="/terminal/reference/cryptocurrency/ov/news" target="_blank" rel="noreferrer noopener">news</a>) and fees (<a href="/terminal/reference/cryptocurrency/ov/wf" target="_blank" rel="noreferrer noopener">wf</a> and <a href="/terminal/reference/cryptocurrency/ov/ewf" target="_blank" rel="noreferrer noopener">ewf</a>)
|
The Cryptocurrency Overview menu provides, among other things, the option to obtain a complete overview of the Cryptocurrency market (<a href="/terminal/reference/crypto/ov/global" target="_blank" rel="noreferrer noopener">global</a>), find cryptocurrency indexes and derivatives (<a href="/terminal/reference/crypto/ov/indexes" target="_blank" rel="noreferrer noopener">indexes</a> and <a href="/terminal/reference/crypto/ov/derivatives" target="_blank" rel="noreferrer noopener">derivatives</a>), news feeds (<a href="/terminal/reference/crypto/ov/news" target="_blank" rel="noreferrer noopener">news</a>) and fees (<a href="/terminal/reference/crypto/ov/wf" target="_blank" rel="noreferrer noopener">wf</a> and <a href="/terminal/reference/crypto/ov/ewf" target="_blank" rel="noreferrer noopener">ewf</a>)
|
||||||
|
|
||||||
### How to use
|
### How to use
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
title: Economy
|
title: Economy
|
||||||
keywords: ['economy', 'macro', 'index', 'treasury', 'fred', 'market']
|
keywords: ['economy', 'macro', 'index', 'treasury', 'fred', 'market']
|
||||||
excerpt: "The Introduction to Economy explains how to use the
|
excerpt: "The Introduction to Economy explains how to use the
|
||||||
menu and provides a brief description of its sub-menus"
|
menu and provides a brief description of its sub-menus"
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -175,7 +175,7 @@ This returns the following graph:
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
The FRED database similarly has a lot of macroeconomic data, do note that you need an API key to do this which is explained in more detail in the <a href="/terminal/quickstart/keys" target="_blank" rel="noreferrer noopener">Accessing other sources of data via API keys</a> section.
|
The FRED database similarly has a lot of macroeconomic data, do note that you need an API key to do this which is explained in more detail in the <a href="/terminal/guides/advanced/changing-sources" target="_blank" rel="noreferrer noopener">Accessing other sources of data via API keys</a> section.
|
||||||
|
|
||||||
You have the ability to query the entire FRED database with the `-q` argument. For example, down below we look for datasets that are centered around inflation. The `-l` argument is set to show a maximum of 10 datasets:
|
You have the ability to query the entire FRED database with the `-q` argument. For example, down below we look for datasets that are centered around inflation. The `-l` argument is set to show a maximum of 10 datasets:
|
||||||
|
|
||||||
@@ -376,4 +376,4 @@ Now, combine these two graphs with the `plot` command. This helps in visually de
|
|||||||
2022 Jun 30, 08:00 (🦋) /economy/ $ plot --y1 Germany_CONF --y2 OVXCLS
|
2022 Jun 30, 08:00 (🦋) /economy/ $ plot --y1 Germany_CONF --y2 OVXCLS
|
||||||
```
|
```
|
||||||
|
|
||||||

|

|
||||||
|
|||||||
85
website/content/terminal/guides/intros/etf.md
vendored
85
website/content/terminal/guides/intros/etf.md
vendored
@@ -1,74 +1,67 @@
|
|||||||
---
|
---
|
||||||
title: ETF
|
title: ETF
|
||||||
keywords: ['etfs', 'exchange traded funds', 'fund', 'basket', 'retail', 'stocks']
|
keywords: ['etfs', 'exchange traded funds', 'fund', 'basket', 'retail', 'stocks']
|
||||||
excerpt: "The Introduction to ETFs explains how to use the
|
excerpt: "The Introduction to ETFs explains how to use the
|
||||||
menu and provides a brief description of its sub-menus"
|
menu and provides a brief description of its sub-menus"
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
The ETF menu enables you to lookup any ETF (<a href="/terminal/reference/etf/ln" target="_blank" rel="noreferrer noopener">ln</a> and <a href="/terminal/reference/etf/ld" target="_blank" rel="noreferrer noopener">ld</a>) and obtain an <a href="/terminal/reference/etf/overview" target="_blank" rel="noreferrer noopener">overview</a>, <a href="/terminal/reference/etf/holdings" target="_blank" rel="noreferrer noopener">holdings</a>, <a href="/terminal/reference/etf/weights" target="_blank" rel="noreferrer noopener">weights</a> and <a href="/terminal/reference/etf/news" target="_blank" rel="noreferrer noopener">news</a> about the chosen ETF. Furthermore, sub-menus reside in this menu that can be used to <a href="/terminal/guides/intros/stocks/ca" target="_blank" rel="noreferrer noopener">compare companies</a> within the ETF, discover gainers and losers within <a href="/terminal/reference/etf/disc" target="_blank" rel="noreferrer noopener">discovery</a> and apply advanced <a href="/terminal/guides/intros/common/ta" target="_blank" rel="noreferrer noopener">technical indicators</a> and <a href="/terminal/guides/intros/forecast" target="_blank" rel="noreferrer noopener">Forecasting menu</a>. Lastly, it also has the option to export multiple ETFs to Excel with <a href="/terminal/reference/etf/pir" target="_blank" rel="noreferrer noopener">pir</a>.
|
The ETF menu enables you to lookup any ETFand obtain an <a href="/terminal/reference/etf/overview" target="_blank" rel="noreferrer noopener">overview</a>, <a href="/terminal/reference/etf/holdings" target="_blank" rel="noreferrer noopener">holdings</a>, <a href="/terminal/reference/etf/weights" target="_blank" rel="noreferrer noopener">weights</a> and <a href="/terminal/reference/etf/news" target="_blank" rel="noreferrer noopener">news</a> about the chosen ETF. Furthermore, sub-menus reside in this menu that can be used to <a href="/terminal/guides/intros/stocks/ca" target="_blank" rel="noreferrer noopener">compare companies</a> within the ETF, discover gainers and losers within <a href="/terminal/reference/etf/disc" target="_blank" rel="noreferrer noopener">discovery</a> and apply advanced <a href="/terminal/guides/intros/common/ta" target="_blank" rel="noreferrer noopener">technical indicators</a> and <a href="/terminal/guides/intros/forecast" target="_blank" rel="noreferrer noopener">Forecasting menu</a>. Lastly, it also has the option to export multiple ETFs to Excel with <a href="/terminal/reference/etf/pir" target="_blank" rel="noreferrer noopener">pir</a>.
|
||||||
|
|
||||||
### How to use
|
### How to use
|
||||||
|
|
||||||
The ETF menu is called upon by typing `etf` which opens the following menu:
|
The ETF menu is called upon by typing `etf` which opens the following menu:
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
You have the ability to look up any ETF (<a href="/terminal/reference/etf/ln" target="_blank" rel="noreferrer noopener">ln</a> and <a href="/terminal/reference/etf/ld" target="_blank" rel="noreferrer noopener">ld</a>). With the example below, the `ld` command is used that searches the description of the ETFs. Then the search query is entered with is `500`. Lastly, the `-l` argument is included which refers to `limit` and is maxed to `15` ETFs.
|
You now have the ability to look up any ETF. With the example below, the `load` command is used to load an ETF.
|
||||||
|
|
||||||
```
|
|
||||||
2022 Jun 21, 09:14 (🦋) /etf/ $ ld 500 -l 15
|
|
||||||
|
|
||||||
ETFs by Total Assets
|
|
||||||
┏━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┓
|
|
||||||
┃ ┃ Name ┃ Family ┃ Category ┃ Total Assets [M] ┃
|
|
||||||
┡━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━┩
|
|
||||||
│ VOO │ Vanguard S&P 500 ETF │ Vanguard │ Large Blend │ 705316.98 │
|
|
||||||
├──────┼──────────────────────────────────────────────┼───────────────────────────────────┼──────────────────────────┼──────────────────┤
|
|
||||||
│ SPY │ SPDR S&P 500 ETF Trust │ SPDR State Street Global Advisors │ Large Blend │ 363964.50 │
|
|
||||||
├──────┼──────────────────────────────────────────────┼───────────────────────────────────┼──────────────────────────┼──────────────────┤
|
|
||||||
│ IVV │ iShares Core S&P 500 ETF │ iShares │ Large Blend │ 248764.65 │
|
|
||||||
├──────┼──────────────────────────────────────────────┼───────────────────────────────────┼──────────────────────────┼──────────────────┤
|
|
||||||
│ ITOT │ iShares Core S&P Total U.S. Stock Market ETF │ iShares │ Large Blend │ 38539.13 │
|
|
||||||
├──────┼──────────────────────────────────────────────┼───────────────────────────────────┼──────────────────────────┼──────────────────┤
|
|
||||||
│ IVW │ iShares S&P 500 Growth ETF │ iShares │ Large Growth │ 30874.18 │
|
|
||||||
├──────┼──────────────────────────────────────────────┼───────────────────────────────────┼──────────────────────────┼──────────────────┤
|
|
||||||
│ RSP │ Invesco S&P 500 Equal Weight ETF │ Invesco │ Large Blend │ 26551.87 │
|
|
||||||
├──────┼──────────────────────────────────────────────┼───────────────────────────────────┼──────────────────────────┼──────────────────┤
|
|
||||||
│ SCHB │ Schwab U.S. Broad Market ETF │ Schwab ETFs │ Large Blend │ 20675.03 │
|
|
||||||
├──────┼──────────────────────────────────────────────┼───────────────────────────────────┼──────────────────────────┼──────────────────┤
|
|
||||||
│ IVE │ iShares S&P 500 Value ETF │ iShares │ Large Value │ 19373.45 │
|
|
||||||
├──────┼──────────────────────────────────────────────┼───────────────────────────────────┼──────────────────────────┼──────────────────┤
|
|
||||||
│ SDY │ SPDR S&P Dividend ETF │ SPDR State Street Global Advisors │ Large Value │ 17140.94 │
|
|
||||||
├──────┼──────────────────────────────────────────────┼───────────────────────────────────┼──────────────────────────┼──────────────────┤
|
|
||||||
│ SCHP │ Schwab U.S. TIPS ETF │ Schwab ETFs │ Inflation-Protected Bond │ 16553.40 │
|
|
||||||
├──────┼──────────────────────────────────────────────┼───────────────────────────────────┼──────────────────────────┼──────────────────┤
|
|
||||||
│ SCHA │ Schwab U.S. Small-Cap ETF │ Schwab ETFs │ Small Blend │ 15301.01 │
|
|
||||||
├──────┼──────────────────────────────────────────────┼───────────────────────────────────┼──────────────────────────┼──────────────────┤
|
|
||||||
│ SPYV │ SPDR Portfolio S&P 500 Value ETF │ SPDR State Street Global Advisors │ Large Value │ 11590.81 │
|
|
||||||
├──────┼──────────────────────────────────────────────┼───────────────────────────────────┼──────────────────────────┼──────────────────┤
|
|
||||||
│ SPYG │ SPDR Portfolio S&P 500 Growth ETF │ SPDR State Street Global Advisors │ Large Growth │ 10514.91 │
|
|
||||||
├──────┼──────────────────────────────────────────────┼───────────────────────────────────┼──────────────────────────┼──────────────────┤
|
|
||||||
│ SPLG │ SPDR Portfolio S&P 500 ETF │ SPDR State Street Global Advisors │ Large Blend │ 9850.30 │
|
|
||||||
├──────┼──────────────────────────────────────────────┼───────────────────────────────────┼──────────────────────────┼──────────────────┤
|
|
||||||
│ SPLV │ Invesco S&P 500 Low Volatility ETF │ Invesco │ Large Blend │ 7922.23 │
|
|
||||||
└──────┴──────────────────────────────────────────────┴───────────────────────────────────┴──────────────────────────┴──────────────────┘
|
|
||||||
```
|
|
||||||
|
|
||||||
This results in a selection of <a href="https://www.investopedia.com/ask/answers/12/what-is-a-stock-ticker.asp" target="_blank" rel="noreferrer noopener">tickers</a>, name, family, category and total assets (estimation). With this information, you can load in one of the tickers into the menu. This can be done with <a href="/terminal/reference/etf/load" target="_blank" rel="noreferrer noopener">load</a>. See the following example:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
2022 Jun 21, 09:22 (🦋) /etf/ $ load VOO
|
2022 Jun 21, 09:22 (🦋) /etf/ $ load VOO
|
||||||
Top company holdings found: AAPL, MSFT, AMZN, GOOGL, TSLA
|
Top company holdings found: AAPL, MSFT, AMZN, GOOGL, TSLA
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Now we can use `holdings` to see the makeup of VOO
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
2022 Jun 21, 09:14 (🦋) /etf/ holdings
|
||||||
|
|
||||||
|
ETF Holdings
|
||||||
|
┌───────┬─────────────────────────────────┬──────────┬───────────┐
|
||||||
|
│ │ Name │ % Of Etf │ Shares │
|
||||||
|
├───────┼─────────────────────────────────┼──────────┼───────────┤
|
||||||
|
│ AAPL │ Apple Inc. │ 7.08% │ 345662285 │
|
||||||
|
├───────┼─────────────────────────────────┼──────────┼───────────┤
|
||||||
|
│ MSFT │ Microsoft Corporation │ 5.29% │ 170648491 │
|
||||||
|
├───────┼─────────────────────────────────┼──────────┼───────────┤
|
||||||
|
│ AMZN │ Amazon.com, Inc. │ 2.77% │ 202804167 │
|
||||||
|
├───────┼─────────────────────────────────┼──────────┼───────────┤
|
||||||
|
│ TSLA │ Tesla, Inc. │ 1.85% │ 60944555 │
|
||||||
|
├───────┼─────────────────────────────────┼──────────┼───────────┤
|
||||||
|
│ GOOGL │ Alphabet, Inc. │ 1.73% │ 137178918 │
|
||||||
|
├───────┼─────────────────────────────────┼──────────┼───────────┤
|
||||||
|
│ BRK.B │ Berkshire Hathaway Inc. │ 1.63% │ 41297378 │
|
||||||
|
├───────┼─────────────────────────────────┼──────────┼───────────┤
|
||||||
|
│ UNH │ UnitedHealth Group Incorporated │ 1.59% │ 21403214 │
|
||||||
|
├───────┼─────────────────────────────────┼──────────┼───────────┤
|
||||||
|
│ GOOG │ Alphabet, Inc. │ 1.55% │ 122705978 │
|
||||||
|
├───────┼─────────────────────────────────┼──────────┼───────────┤
|
||||||
|
│ XOM │ Exxon Mobil Corporation │ 1.41% │ 95363206 │
|
||||||
|
├───────┼─────────────────────────────────┼──────────┼───────────┤
|
||||||
|
│ JNJ │ Johnson & Johnson │ 1.40% │ 60159633 │
|
||||||
|
└───────┴─────────────────────────────────┴──────────┴───────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
To then view the stock chart, you can call <a href="/terminal/reference/etf/candle" target="_blank" rel="noreferrer noopener">candle</a> which shows a candle chart for the defined period (by default set to a year by `load`):
|
To then view the stock chart, you can call <a href="/terminal/reference/etf/candle" target="_blank" rel="noreferrer noopener">candle</a> which shows a candle chart for the defined period (by default set to a year by `load`):
|
||||||
|
|
||||||

|

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

|

|
||||||
|
|
||||||
For example, the ETF's weights can now be depicted with the following:
|
For example, the ETF's weights can now be depicted with the following:
|
||||||
|
|
||||||
@@ -85,8 +78,6 @@ Which shows the following graph:
|
|||||||
The ETF menu has a few sub-menus available to delve further into a specific ETF or screen multiple ETFs at the same time. To find more information about each menu, click on one of the following:
|
The ETF menu has a few sub-menus available to delve further into a specific ETF or screen multiple ETFs at the same time. To find more information about each menu, click on one of the following:
|
||||||
|
|
||||||
- <a href="/terminal/guides/intros/stocks/ca/" target="_blank" rel="noreferrer noopener">Introduction to Comparison Analysis</a>: have the ability to compare companies within the ETF based on, among other things, correlation, financial statements, sentiment, valuations and performance.
|
- <a href="/terminal/guides/intros/stocks/ca/" target="_blank" rel="noreferrer noopener">Introduction to Comparison Analysis</a>: have the ability to compare companies within the ETF based on, among other things, correlation, financial statements, sentiment, valuations and performance.
|
||||||
- <a href="disc" target="_blank" rel="noreferrer noopener">Introduction to ETF Discovery</a>: discover trending ETF based on their returns (gainers and decliners) as well as activity.
|
|
||||||
- <a href="scr" target="_blank" rel="noreferrer noopener">Introduction to ETF Screener</a>: provides the ability to screen companies within the ETF based on a preset as well as the ability to screen by category.
|
|
||||||
- <a href="/terminal/guides/intros/common/ta" target="_blank" rel="noreferrer noopener">Introduction to Technical Analysis</a>: analysis the chosen ETF's historical data extensively with moving averages and momentum, trend, volatility and volume indicators.
|
- <a href="/terminal/guides/intros/common/ta" target="_blank" rel="noreferrer noopener">Introduction to Technical Analysis</a>: analysis the chosen ETF's historical data extensively with moving averages and momentum, trend, volatility and volume indicators.
|
||||||
- <a href="/terminal/guides/intros/forecast/" target="_blank" rel="noreferrer noopener">Introduction to Forecasting menu</a>: apply advanced AI and Machine Learning models to form prediction of future ETF prices including Recurrent Neural Network (RNN), Autoregressive Integrated Moving Average (ARIMA) and Monte Carlo forecasting.
|
- <a href="/terminal/guides/intros/forecast/" target="_blank" rel="noreferrer noopener">Introduction to Forecasting menu</a>: apply advanced AI and Machine Learning models to form prediction of future ETF prices including Recurrent Neural Network (RNN), Autoregressive Integrated Moving Average (ARIMA) and Monte Carlo forecasting.
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
title: Forecasting
|
title: Forecast
|
||||||
keywords:
|
keywords:
|
||||||
[
|
[
|
||||||
"machine learning",
|
"machine learning",
|
||||||
@@ -15,7 +15,7 @@ excerpt: "The introduction to Forecasting explains how to use the menu"
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
The forecasting menu is a machine learning toolkit that provides practitioners with high-level components that can quickly provide state-of-the-art results, be it with with classical or deep learning models, while also providing researchers with low-level components that can be mixed, matched and fine tuned to build new approaches and custom tuned models. Bring in multiple datasets and train machine learning models with unlimited external factors to see how underlying data may change future forecasting predictions and accuracy.
|
The Forecast menu is a machine learning toolkit that provides practitioners with high-level components that can quickly provide state-of-the-art results, be it with with classical or deep learning models, while also providing researchers with low-level components that can be mixed, matched and fine tuned to build new approaches and custom tuned models. Bring in multiple datasets and train machine learning models with unlimited external factors to see how underlying data may change future forecasting predictions and accuracy.
|
||||||
|
|
||||||
### Accessing the Forecast menu
|
### Accessing the Forecast menu
|
||||||
|
|
||||||
@@ -5,7 +5,7 @@ excerpt: "The Introduction to Forex explains how to use the
|
|||||||
menu and provides a brief description of its sub-menus"
|
menu and provides a brief description of its sub-menus"
|
||||||
---
|
---
|
||||||
|
|
||||||
The Forex menu enables you to <a href="/terminal/reference/forex/load" target="_blank" rel="noreferrer noopener">load</a> any combination of currencies (e.g. USDEUR or JPYGBP), show current <a href="/terminal/reference/forex/quote" target="_blank" rel="noreferrer noopener">quote</a> and historical data (<a href="/terminal/reference/forex/candle" target="_blank" rel="noreferrer noopener">candle</a>) as well as forward rates (<a href="/terminal/reference/forex/fwd" target="_blank" rel="noreferrer noopener">fwd</a>). Furthermore, the menu has the ability to also apply <a href="/terminal/guides/intros/common/ta" target="_blank" rel="noreferrer noopener">Technical Analysis</a> and <a href="/terminal/guides/intros/forecast" target="_blank" rel="noreferrer noopener">Forecasting menu</a> while also having an integration with <a href="/terminal/reference/forex/oanda" target="_blank" rel="noreferrer noopener">Oanda</a>.
|
The Forex menu enables you to <a href="/terminal/reference/forex/load" target="_blank" rel="noreferrer noopener">load</a> any combination of currencies (e.g. USDEUR or JPYGBP), show current <a href="/terminal/reference/forex/quote" target="_blank" rel="noreferrer noopener">quote</a> and historical data (<a href="/terminal/reference/forex/candle" target="_blank" rel="noreferrer noopener">candle</a>) as well as forward rates (<a href="/terminal/reference/forex/fwd" target="_blank" rel="noreferrer noopener">fwd</a>). Furthermore, the menu has the ability to also apply <a href="/terminal/guides/intros/common/ta" target="_blank" rel="noreferrer noopener">Technical Analysis</a> and <a href="/terminal/guides/intros/forecast" target="_blank" rel="noreferrer noopener">Forecasting menu</a> while also having an integration with <a href="/terminal/reference#oanda" target="_blank" rel="noreferrer noopener">Oanda</a>.
|
||||||
|
|
||||||
### How to use
|
### How to use
|
||||||
|
|
||||||
|
|||||||
@@ -6,8 +6,8 @@ menu and provides a brief description of its sub-menus"
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
The Stocks menu enables you to perform an evaluation of a particular company, a sector or a market as whole by performing various techniques including fundamental, technical and behavioural analysis. It does so by handing you tools to (among other things) evaluate company news (<a href="/terminal/reference/stocks/news/" target="_blank" rel="noreferrer noopener">news</a>), display historic quarterly results (<a href="/terminal/reference/stocks/fundamental_analysis/income/" target="_blank" rel="noreferrer noopener">income</a>), determine future cash flows (<a href="/terminal/reference/stocks/fundamental_analysis/dcf/" target="_blank" rel="noreferrer noopener">dcf</a>),
|
The Stocks menu enables you to perform an evaluation of a particular company, a sector or a market as whole by performing various techniques including fundamental, technical and behavioural analysis. It does so by handing you tools to (among other things) evaluate company news (<a href="/terminal/reference/stocks/news/" target="_blank" rel="noreferrer noopener">news</a>), display historic quarterly results (<a href="/terminal/reference/stocks/fa/income/" target="_blank" rel="noreferrer noopener">income</a>), determine future cash flows (<a href="/terminal/reference/stocks/fa/dcf/" target="_blank" rel="noreferrer noopener">dcf</a>),
|
||||||
show analyst recommendations (<a href="/terminal/reference/stocks/due_diligence/pt/" target="_blank" rel="noreferrer noopener">pt</a>), evaluate an entire sector or industry (<a href="/terminal/reference/stocks/sia/" target="_blank" rel="noreferrer noopener">sia</a>), and show the historical prices, correlations and sentiment between similar companies (<a href="/terminal/reference/stocks/comparison_analysis/hcorr/" target="_blank" rel="noreferrer noopener">correlation</a>).
|
show analyst recommendations (<a href="/terminal/reference/stocks/dd/pt/" target="_blank" rel="noreferrer noopener">pt</a>), evaluate an entire sector or industry (<a href="/terminal/reference#sia" target="_blank" rel="noreferrer noopener">sia</a>), and show the historical prices, correlations and sentiment between similar companies (<a href="/terminal/reference/stocks/ca/hcorr/" target="_blank" rel="noreferrer noopener">correlation</a>).
|
||||||
|
|
||||||
### How to use
|
### How to use
|
||||||
|
|
||||||
@@ -84,22 +84,22 @@ By calling `?` or `help` the stocks menu re-appears. Here you can see that multi
|
|||||||
|
|
||||||
The Stock menu has an extensive list of available sub-menus ranging from fundamental analysis to sector analysis to advanced prediction techniques. To find more information about each menu, click on one of the following:
|
The Stock menu has an extensive list of available sub-menus ranging from fundamental analysis to sector analysis to advanced prediction techniques. To find more information about each menu, click on one of the following:
|
||||||
|
|
||||||
- <a href="th" target="_blank" rel="noreferrer noopener">Introduction to Trading Hours</a>: discover exchanges that are currently open or closed for a specified ticker. Also find relevant information about each exchange.
|
- <a href="/terminal/guides/intros/stocks/tradinghours" target="_blank" rel="noreferrer noopener">Introduction to Trading Hours</a>: discover exchanges that are currently open or closed for a specified ticker. Also find relevant information about each exchange.
|
||||||
- <a href="options" target="_blank" rel="noreferrer noopener">Introduction to Options</a>: look into available options, option spreads, open interest and binomial valuation models.
|
- <a href="/terminal/guides/intros/stocks/options" target="_blank" rel="noreferrer noopener">Introduction to Options</a>: look into available options, option spreads, open interest and binomial valuation models.
|
||||||
- <a href="disc" target="_blank" rel="noreferrer noopener">Introduction to Stock Discovery</a>: discover trending stocks based on return metrics, revenue and earnings growth, penny stocks and based on upcoming earnings release dates.
|
- <a href="/terminal/guides/intros/stocks/disc" target="_blank" rel="noreferrer noopener">Introduction to Stock Discovery</a>: discover trending stocks based on return metrics, revenue and earnings growth, penny stocks and based on upcoming earnings release dates.
|
||||||
- <a href="sia" target="_blank" rel="noreferrer noopener">Introduction to Sector & Industry Analysis</a>: analyse companies that reside in the same industry, sector and/or country and share a similar market cap to determine potential under- and out performance of each company.
|
- <a href="/terminal/guides/intros/stocks/sia" target="_blank" rel="noreferrer noopener">Introduction to Sector & Industry Analysis</a>: analyse companies that reside in the same industry, sector and/or country and share a similar market cap to determine potential under- and out performance of each company.
|
||||||
- <a href="dps" target="_blank" rel="noreferrer noopener">Introduction to Dark Pools</a>: discover companies that have enormous shorting pressure, obtain information about dark pool positions and find out about shares that failed to deliver.
|
- <a href="/terminal/guides/intros/stocks/dark-pool-shorts" target="_blank" rel="noreferrer noopener">Introduction to Dark Pools</a>: discover companies that have enormous shorting pressure, obtain information about dark pool positions and find out about shares that failed to deliver.
|
||||||
- <a href="scr" target="_blank" rel="noreferrer noopener">Introduction to Stock Screener</a>: provides the ability to screen companies that share a similar characteristic, for example unusual volumes, overbought or that include analyst upgrades, and be able to compare valuations and performance.
|
- <a href="/terminal/guides/intros/stocks/screener" target="_blank" rel="noreferrer noopener">Introduction to Stock Screener</a>: provides the ability to screen companies that share a similar characteristic, for example unusual volumes, overbought or that include analyst upgrades, and be able to compare valuations and performance.
|
||||||
- <a href="ins" target="_blank" rel="noreferrer noopener">Introduction to Insider Trading</a>: explains what large insiders, e.g. a CEO of a company, is buying the chosen company and insider trading activity for the chosen company.
|
- <a href="/terminal/guides/intros/stocks/ins" target="_blank" rel="noreferrer noopener">Introduction to Insider Trading</a>: explains what large insiders, e.g. a CEO of a company, is buying the chosen company and insider trading activity for the chosen company.
|
||||||
- <a href="gov" target="_blank" rel="noreferrer noopener">Introduction to Government</a>: gives insights in what the House of Congress is trading and the corporate lobbying that is performed.
|
- <a href="/terminal/guides/intros/stocks/gov" target="_blank" rel="noreferrer noopener">Introduction to Government</a>: gives insights in what the House of Congress is trading and the corporate lobbying that is performed.
|
||||||
- <a href="/OpenBBTerminal/terminal/common/ba" target="_blank" rel="noreferrer noopener">Introduction to Behavioural Analysis</a>: gives the abilities to discover how different social media platforms view the chosen company and what is written about them.
|
- <a href="/terminal/guides/intros/common/ba" target="_blank" rel="noreferrer noopener">Introduction to Behavioural Analysis</a>: gives the abilities to discover how different social media platforms view the chosen company and what is written about them.
|
||||||
- <a href="ca" target="_blank" rel="noreferrer noopener">Introduction to Comparison Analysis</a>: have the ability to compare companies based on, among other things, correlation, financial statements, sentiment, valuations and performance.
|
- <a href="/terminal/guides/intros/stocks/comparison" target="_blank" rel="noreferrer noopener">Introduction to Comparison Analysis</a>: have the ability to compare companies based on, among other things, correlation, financial statements, sentiment, valuations and performance.
|
||||||
- <a href="fa" target="_blank" rel="noreferrer noopener">Introduction to Fundamental Analysis</a>: look into the fundamentals of a chosen company including financial statements, SEC filings, investing scores, discounted cash flow analysis (DCF), sustainability scores and key ratios.
|
- <a href="/terminal/guides/intros/stocks/fa" target="_blank" rel="noreferrer noopener">Introduction to Fundamental Analysis</a>: look into the fundamentals of a chosen company including financial statements, SEC filings, investing scores, discounted cash flow analysis (DCF), sustainability scores and key ratios.
|
||||||
- <a href="dd" target="_blank" rel="noreferrer noopener">Introduction to Due Diligence</a>: explore analyst recommendations, ratings over time, price targets and quarterly and yearly earnings estimates.
|
- <a href="/terminal/guides/intros/stocks/dd" target="_blank" rel="noreferrer noopener">Introduction to Due Diligence</a>: explore analyst recommendations, ratings over time, price targets and quarterly and yearly earnings estimates.
|
||||||
- <a href="bt" target="_blank" rel="noreferrer noopener">Introduction to Strategy Backtesting</a>: explore back testing strategies based on technical indicators.
|
- <a href="/terminal/guides/intros/stocks/bt" target="_blank" rel="noreferrer noopener">Introduction to Strategy Backtesting</a>: explore back testing strategies based on technical indicators.
|
||||||
- <a href="/OpenBBTerminal/terminal/common/ta" target="_blank" rel="noreferrer noopener">Introduction to Technical Analysis</a>: analysis the chosen company's historical data extensively with moving averages and momentum, trend, volatility and volume indicators.
|
- <a href="/terminal/guides/intros/common/ta" target="_blank" rel="noreferrer noopener">Introduction to Technical Analysis</a>: analysis the chosen company's historical data extensively with moving averages and momentum, trend, volatility and volume indicators.
|
||||||
- <a href="/OpenBBTerminal/terminal/common/qa" target="_blank" rel="noreferrer noopener">Introduction to Quantitative Analysis</a>: delve deeper in the historical data with quantitative methods including cumulative distribution function (CDF), (conditional) Value at Risk and rolling ratios.
|
- <a href="/terminal/guides/intros/common/qa" target="_blank" rel="noreferrer noopener">Introduction to Quantitative Analysis</a>: delve deeper in the historical data with quantitative methods including cumulative distribution function (CDF), (conditional) Value at Risk and rolling ratios.
|
||||||
- <a href="/OpenBBTerminal/terminal/forecast/" target="_blank" rel="noreferrer noopener">Introduction to Forecasting menu</a>: apply advanced AI and Machine Learning models to form prediction of future stock prices including Recurrent Neural Network (RNN), Autoregressive Integrated Moving Average (ARIMA) and Monte Carlo forecasting.
|
- <a href="/terminal/guides/intros/forecast/" target="_blank" rel="noreferrer noopener">Introduction to Forecasting menu</a>: apply advanced AI and Machine Learning models to form prediction of future stock prices including Recurrent Neural Network (RNN), Autoregressive Integrated Moving Average (ARIMA) and Monte Carlo forecasting.
|
||||||
|
|
||||||
### Examples
|
### Examples
|
||||||
|
|
||||||
|
|||||||
9
website/content/terminal/guides/intros/stocks/sia.md
vendored
Normal file
9
website/content/terminal/guides/intros/stocks/sia.md
vendored
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
---
|
||||||
|
title: Sector & Industry Analysis (SIA)
|
||||||
|
geekdocCollapseSection: true
|
||||||
|
---
|
||||||
|
A sector analysis is a study of the economic and financial state and prospects of a certain economic sector. An investor can use sector analysis to make a prediction about how well companies in the sector will perform. Investors that specialize in a specific sector or who utilize a top-down or sector rotation approach to investing generally use sector analysis.
|
||||||
|
|
||||||
|
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).
|
||||||
|
|
||||||
|
<img src="https://openbb-web-assets.s3.amazonaws.com/docs/sia.png" alt="SIA Menu" width="800"/>
|
||||||
22
website/content/terminal/index.md
vendored
22
website/content/terminal/index.md
vendored
@@ -11,6 +11,8 @@ import Card from "@site/src/components/General/Card";
|
|||||||
|
|
||||||
OpenBB is a leading open source investment research software platform for accessing and analyzing financial market data. We represent millions of investors who want to leverage state-of-the-art data science and machine learning technologies to make sense of raw unrefined data. Our mission is to make investment research effective, powerful and accessible to everyone.
|
OpenBB is a leading open source investment research software platform for accessing and analyzing financial market data. We represent millions of investors who want to leverage state-of-the-art data science and machine learning technologies to make sense of raw unrefined data. Our mission is to make investment research effective, powerful and accessible to everyone.
|
||||||
|
|
||||||
|
Want to contribute? Check out our [CONTRIBUTING GUIDELINES](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/CONTRIBUTING.md).
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**The OpenBB Terminal is Free and Open-Source (FOSS)**
|
**The OpenBB Terminal is Free and Open-Source (FOSS)**
|
||||||
@@ -58,25 +60,11 @@ OpenBB is a leading open source investment research software platform for access
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Obtaining support and giving feedback
|
|
||||||
|
|
||||||
Being an open source platform that wishes to tailor to the needs of any type of investor, we highly encourage anyone to share with us their experience and/or how we can further improve the OpenBB Terminal. This can be anything from a very small bug to a new feature to the implementation of a highly advanced Machine Learning model.
|
|
||||||
|
|
||||||
You are able to directly send us information about a bug or question/suggestion from inside the terminal by using the `support` command which is available everywhere in the terminal. Here you can select which command you want to report a bug, ask a question or make a suggestion on. When you press `ENTER` (⏎), you are taken to the Support form which is automatically filled with your input. You are only required to include the type (e.g. bug, suggestion or question) and message in the form although this can also be set directly from inside the terminal (see `support -h`).
|
|
||||||
|
|
||||||
<a target="_blank" href="https://user-images.githubusercontent.com/46355364/169503483-c93c83fa-e9e9-4345-b816-8fcfe02b6785.png"><img src="https://user-images.githubusercontent.com/46355364/169503483-c93c83fa-e9e9-4345-b816-8fcfe02b6785.png" alt="Support Command" width="800"/></a>
|
|
||||||
|
|
||||||
Alternatively, you can contact us via the following routes:
|
|
||||||
|
|
||||||
- If you notice that a feature is missing inside the terminal, please fill in the <a href="https://openbb.co/request-a-feature" target="_blank" rel="noreferrer noopener">Request a Feature form</a>.
|
|
||||||
- If you wish to report a bug, have a question/suggestion or anything else, please fill in the <a href="https://openbb.co/support" target="_blank" rel="noreferrer noopener">Support form</a>.
|
|
||||||
- If you wish to speak to us directly, please contact us via <a href="https://openbb.co/discord" target="_blank" rel="noreferrer noopener">Discord</a>.
|
|
||||||
|
|
||||||
Want to learn how to install the OpenBB Terminal? Check out our [Installation](/quickstart/installation) guide.
|
Want to learn how to install the OpenBB Terminal? Check out our [Installation](/quickstart/installation) guide.
|
||||||
|
|
||||||
Want to know how to import and export data? Check out our [Data Import/Export](/guides/basics/data)
|
Want to know how to import and export data? Check out our [Data Import/Export](/guides/advanced/data)
|
||||||
|
|
||||||
Looking for personalized routines? Check out our [User Routines](/guides/advanced/scripts)
|
Looking for personalized routines? Check out our [User Routines](/guides/advanced/scripts-and-routines)
|
||||||
|
|
||||||
[contributors-shield]: https://img.shields.io/github/contributors/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge
|
[contributors-shield]: https://img.shields.io/github/contributors/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge
|
||||||
[contributors-url]: https://github.com/OpenBB-finance/OpenBBTerminal/graphs/contributors
|
[contributors-url]: https://github.com/OpenBB-finance/OpenBBTerminal/graphs/contributors
|
||||||
@@ -93,4 +81,4 @@ Looking for personalized routines? Check out our [User Routines](/guides/advance
|
|||||||
[license-shield]: https://img.shields.io/github/license/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge
|
[license-shield]: https://img.shields.io/github/license/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge
|
||||||
[license-url]: https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/LICENSE
|
[license-url]: https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/LICENSE
|
||||||
[twitter-shield]: https://img.shields.io/twitter/follow/openbb_finance?style=for-the-badge&color=blue
|
[twitter-shield]: https://img.shields.io/twitter/follow/openbb_finance?style=for-the-badge&color=blue
|
||||||
[twitter-url]: https://twitter.com/openbb_finance
|
[twitter-url]: https://twitter.com/openbb_finance
|
||||||
|
|||||||
47
website/content/terminal/quickstart/faq.md
vendored
47
website/content/terminal/quickstart/faq.md
vendored
@@ -53,7 +53,7 @@ From the Windows Security menu, click on the Firewall & Network Protection tab,
|
|||||||
<details><summary>On what Operating Systems can I run the OpenBB Terminal?</summary>
|
<details><summary>On what Operating Systems can I run the OpenBB Terminal?</summary>
|
||||||
<p>
|
<p>
|
||||||
|
|
||||||
The OpenBB Terminal is compatible with Windows, Mac Os and Linux. Check the
|
The OpenBB Terminal is compatible with Windows, MacOS and Linux. Check the
|
||||||
[installation guide](/terminal/quickstart/installation) and [requirements outline](/terminal/quickstart/requirements) for more details.
|
[installation guide](/terminal/quickstart/installation) and [requirements outline](/terminal/quickstart/requirements) for more details.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
@@ -70,7 +70,7 @@ An installation will use approximately 2GB of space.
|
|||||||
<details><summary>How can I contribute to the OpenBB Terminal</summary>
|
<details><summary>How can I contribute to the OpenBB Terminal</summary>
|
||||||
<p>
|
<p>
|
||||||
|
|
||||||
There are three main ways of contributing to this project.
|
There are two main ways of contributing to this project.
|
||||||
|
|
||||||
**BECOME A CONTRIBUTOR**
|
**BECOME A CONTRIBUTOR**
|
||||||
|
|
||||||
@@ -105,7 +105,25 @@ First, search the open issues for another report. If one already exists, attach
|
|||||||
<details><summary>How can I get help with OpenBB Terminal?</summary>
|
<details><summary>How can I get help with OpenBB Terminal?</summary>
|
||||||
<p>
|
<p>
|
||||||
|
|
||||||
You can get help with OpenBB SDK by joining our [Discord server](https://openbb.co/discord) or contact us in our support form [here](https://openbb.co/support).
|
You can get help with OpenBB Terminal by joining our [Discord server](https://openbb.co/discord) or contact us in our support form [here](https://openbb.co/support).
|
||||||
|
|
||||||
|
</p>
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details><summary>How can I give feedback about the OpenBB Terminal?</summary>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
Being an open source platform that wishes to tailor to the needs of any type of investor, we highly encourage anyone to share with us their experience and/or how we can further improve the OpenBB Terminal. This can be anything from a very small bug, a new feature, or the implementation of a highly advanced Machine Learning model.
|
||||||
|
|
||||||
|
You are able to directly send us information about a bug or a question/suggestion from inside the terminal by using the `support` command which is available everywhere in the terminal. Here you can select which command you want to report a bug on, ask a question or make a suggestion. After entering `support`, when you press `ENTER` (⏎), you are taken to the Support form which is automatically filled with your input. You are only required to include the type (e.g. bug, suggestion or question) and message in the form, although this can also be set directly from inside the terminal (see `support -h`).
|
||||||
|
|
||||||
|
<a target="_blank" href="https://user-images.githubusercontent.com/46355364/169503483-c93c83fa-e9e9-4345-b816-8fcfe02b6785.png"><img src="https://user-images.githubusercontent.com/46355364/169503483-c93c83fa-e9e9-4345-b816-8fcfe02b6785.png" alt="Support Command" width="800"/></a>
|
||||||
|
|
||||||
|
Alternatively, you can contact us via the following routes:
|
||||||
|
|
||||||
|
- If you notice that a feature is missing inside the terminal, please fill in the <a href="https://openbb.co/request-a-feature" target="_blank" rel="noreferrer noopener">Request a Feature form</a>.
|
||||||
|
- If you wish to report a bug, have a question/suggestion or anything else, please fill in the <a href="https://openbb.co/support" target="_blank" rel="noreferrer noopener">Support form</a>.
|
||||||
|
- If you wish to speak to us directly, please contact us via <a href="https://openbb.co/discord" target="_blank" rel="noreferrer noopener">Discord</a>.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</details>
|
</details>
|
||||||
@@ -123,7 +141,7 @@ By default, the load function requests end-of-day daily data and is not included
|
|||||||
<details><summary>Why does a specific menu or command not exist?</summary>
|
<details><summary>Why does a specific menu or command not exist?</summary>
|
||||||
<p>
|
<p>
|
||||||
|
|
||||||
It could be that you are running an outdated version in which the menu or command is not yet available. Please check use the [installation guide](https://docs.openbb.co/terminal/quickstart/installation) to download the most recent release.
|
It could be that you are running an outdated version in which the menu or command is not yet available. Please check the [installation guide](https://docs.openbb.co/terminal/quickstart/installation) to download the most recent release.
|
||||||
|
|
||||||
Do note that it is also possible that the menu or command is removed. If this is undesirable, please reach out to us [here](https://openbb.co/support).
|
Do note that it is also possible that the menu or command is removed. If this is undesirable, please reach out to us [here](https://openbb.co/support).
|
||||||
|
|
||||||
@@ -175,6 +193,17 @@ before you call `openbb` again.
|
|||||||
</p>
|
</p>
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
<details><summary>What kind of architectural pattern does the OpenBB SDK use?</summary>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
Throughout the entire OpenBB Platform, the [Model-view-controller](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller) architectural pattern is used for creating functionality in the OpenBB Terminal.
|
||||||
|
|
||||||
|
The `model` relates to any calculations or data collection done. The `view` is meant for showing tables or graphs and the `controller` makes it possible to execute a command with a set of arguments directly in the OpenBB Terminal. Learn more about this in our [CONTRIBUTING GUIDELINES](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/CONTRIBUTING.md).
|
||||||
|
|
||||||
|
</p>
|
||||||
|
</details>
|
||||||
|
|
||||||
|
|
||||||
<details><summary>Why do I get too many red error lines on Windows?</summary>
|
<details><summary>Why do I get too many red error lines on Windows?</summary>
|
||||||
<p>
|
<p>
|
||||||
|
|
||||||
@@ -251,10 +280,12 @@ poetry config experimental.new-installer false
|
|||||||
<details><summary>Why do a receive a ModuleNotFoundError?</summary>
|
<details><summary>Why do a receive a ModuleNotFoundError?</summary>
|
||||||
<p>
|
<p>
|
||||||
|
|
||||||
In the case when you run into an error of the form `ModuleNotFoundError: No module named '_______'` before you start installing these modules that have not been found please check that you have most followed the recommended installation instructions.
|
IF you receive an error like `ModuleNotFoundError: No module named '_______'`
|
||||||
These errors often can occur when you have not activated the virtual environment where you have installed the terminal, or you have not used the `poetry install` command to install the dependencies.
|
|
||||||
|
|
||||||
In case you wish to proceed with an alternative way to install the terminal feel free to install the missing packages via pip. For example if you get the error that `yfinance` is not found, you would run `pip install yfinance`
|
<p>Before you start begin troubleshooting please verify that you have followed the recommended installation instructions.
|
||||||
|
These errors often can occur when you have not activated the virtual environment where you have installed the terminal, or you have not used the `poetry install` command to install the dependencies.</p>
|
||||||
|
|
||||||
|
If you are still having issues install the missing packages via pip. For example if you get the error that `yfinance` is not found, you would run `pip install yfinance`
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</details>
|
</details>
|
||||||
@@ -303,7 +334,7 @@ git reset --hard
|
|||||||
</p>
|
</p>
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details><summary>Why can't I run openbb via the VS Code integrated terminal?</summary>
|
<details><summary>Why can't I run OpenBB via the VS Code integrated terminal?</summary>
|
||||||
<p>
|
<p>
|
||||||
|
|
||||||
This occurs when VS Code terminal python version/path is different from the terminal version.
|
This occurs when VS Code terminal python version/path is different from the terminal version.
|
||||||
|
|||||||
@@ -13,42 +13,41 @@ OpenBB Terminal is available in all major platforms. With MacOS/Windows you can
|
|||||||
:::info Installation Instructions
|
:::info Installation Instructions
|
||||||
|
|
||||||
<Tabs>
|
<Tabs>
|
||||||
<TabItem value="Windows" label="Windows">Install on Windows
|
<TabItem value="windows" label="Windows">Install on Windows
|
||||||
<div class="gdoc-page">
|
<div class="gdoc-page">
|
||||||
|
|
||||||
</div><p>Download the installer from the <a href="https://github.com/OpenBB-finance/OpenBBTerminal/releases/download/v1.9.0/Windows10.OpenBB.Terminal.v1.9.0.exe">here</a>.</p>
|
</div><p>Download the installer from the website <a href="https://github.com/OpenBB-finance/OpenBBTerminal/releases/download/v1.9.0/Windows10.OpenBB.Terminal.v1.9.0.exe">here</a>.</p>
|
||||||
|
|
||||||
<p>When the file is downloaded, use the following steps to run the OpenBB Terminal:</p>
|
<p>When the file is downloaded, use the following steps to run the OpenBB Terminal:</p>
|
||||||
<div class="gdoc-columns">
|
<div class="gdoc-columns">
|
||||||
|
|
||||||
<div class="gdoc-columns__content gdoc-markdown--nested">
|
<div class="gdoc-columns__content gdoc-markdown--nested">
|
||||||
<p><strong>Step 1: Double-click the <code>.exe</code> file that got downloaded to your <code>Downloads</code> folder</strong></p>
|
<p><strong>Step 1: Double-click the <code>.exe</code> file that got downloaded to your <code>Downloads</code> folder</strong></p>
|
||||||
<p>You will most likely receive the error below stating “Windows protected your PC”. This is because the installer is
|
<p align="center"><a target="_blank" href="https://openbb-web-assets.s3.amazonaws.com/docs/installation/install_step_1.png"><img width="500" alt="windows_protected_your_pc" src="https://openbb-web-assets.s3.amazonaws.com/docs/installation/install_step_1.png"></img></a></p>
|
||||||
still in beta phase, and the team has not yet requested verification from Windows.</p>
|
|
||||||
<p align="center"><a target="_blank" href="https://user-images.githubusercontent.com/46355364/169502271-69ad8075-165f-4b1a-8ab8-254d643a5dae.png"><img width="500" alt="windows_protected_your_pc" src="https://user-images.githubusercontent.com/46355364/169502271-69ad8075-165f-4b1a-8ab8-254d643a5dae.png"></img></a></p>
|
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="gdoc-columns__content gdoc-markdown--nested">
|
<div class="gdoc-columns__content gdoc-markdown--nested">
|
||||||
<p><strong>Step 2: Click on <code>More info</code> and select <code>Run anyway</code> to start the installation process</strong></p>
|
<p><strong>Step 2: Follow the prompts clicking <code>Next ></code> where needed to complete the installation process</strong></p>
|
||||||
<p>Proceed by following the steps. Do note that if you wish to install the application to “Program Files” that you will have to run the resulting application as Administrator.</p>
|
|
||||||
<p align="center"><a target="_blank" href="https://user-images.githubusercontent.com/46355364/169502143-ba88de53-7757-48f2-9ec4-748d4917044b.png"><img width="500" alt="run_anyway" src="https://user-images.githubusercontent.com/46355364/169502143-ba88de53-7757-48f2-9ec4-748d4917044b.png"></img></a></p>
|
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<div class="gdoc-columns__content gdoc-markdown--nested">
|
<div class="gdoc-columns__content gdoc-markdown--nested">
|
||||||
<p><strong>Step 3: Double-click on the application that appeared on your Desktop, you are now able to run the OpenBB Terminal</strong></p>
|
<p><strong>Step 3: Double-click on the application that appeared on your Desktop, you are now able to run the OpenBB Terminal</strong></p>
|
||||||
<p>The first time this takes a bit longer to load, this can take up to a few minutes.</p>
|
<p align="center"><a target="_blank" href="https://openbb-web-assets.s3.amazonaws.com/docs/installation/icon.png"><img width="100" alt="run_the_terminal" src="https://openbb-web-assets.s3.amazonaws.com/docs/installation/icon.png"></img></a></p>
|
||||||
<p align="center"><a target="_blank" href="https://user-images.githubusercontent.com/46355364/169502187-f4e42333-a947-464b-9320-a8f63c7ce089.png"><img width="500" alt="run_the_terminal" src="https://user-images.githubusercontent.com/46355364/169502187-f4e42333-a947-464b-9320-a8f63c7ce089.png"></img></a></p>
|
<p>The first time this takes a bit longer to load, this can take up to a few minutes. If everything was successful you should see a screen like the one below : </p>
|
||||||
|
<p align="center"><img width="500" alt="run_the_terminal" src="https://openbb-web-assets.s3.amazonaws.com/docs/installation/final_install.png"></img></p>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
</TabItem>
|
</TabItem>
|
||||||
|
|
||||||
<TabItem value="macOS" label="MacOS">Install on macOS 🍎
|
<TabItem value="mac" label="MacOS">Install on macOS 🍎
|
||||||
|
|
||||||
For mac there are two installers available, one for Intel and one for Apple Silicon (M1). Please download the correct one for your machine.
|
For Mac there are two installers available, one for Intel and one for Apple Silicon (M1). Please download the correct one for your machine.
|
||||||
<ul>
|
<ul>
|
||||||
<li>If you are using Mac Intel click <a href="https://github.com/OpenBB-finance/OpenBBTerminal/releases/download/v1.9.0/x86_64.MacOS.OpenBB.Terminal.v1.9.0.dmg">here</a> to download the installer.</li>
|
<li>If you are using Mac Intel click <a href="https://github.com/OpenBB-finance/OpenBBTerminal/releases/download/v1.9.0/x86_64.MacOS.OpenBB.Terminal.v1.9.0.dmg">here</a> to download the installer.</li>
|
||||||
<li>If you are using Mac Apple Silicon (M1) click <a href="https://github.com/OpenBB-finance/OpenBBTerminal/releases/download/v1.9.0/ARM64.MacOS.OpenBB.Terminal.v1.9.0.dmg">here</a> to download the installer.</li>
|
<li>If you are using Mac Apple Silicon (M1) click <a href="https://github.com/OpenBB-finance/OpenBBTerminal/releases/download/v1.9.0/ARM64.MacOS.OpenBB.Terminal.v1.9.0.dmg">here</a> to download the installer.</li>
|
||||||
@@ -58,10 +57,10 @@ For mac there are two installers available, one for Intel and one for Apple Sili
|
|||||||
<div class="gdoc-columns">
|
<div class="gdoc-columns">
|
||||||
|
|
||||||
<div class="gdoc-columns__content gdoc-markdown--nested">
|
<div class="gdoc-columns__content gdoc-markdown--nested">
|
||||||
<p><strong>Step 1: Open the downloaded <code>OpenBB Terminal.dmg</code> and copy <code>OpenBB Terminal</code> folder into your <code>Applications</code></strong></p>
|
<p><strong>Step 1: Open the downloaded <code>OpenBB Terminal.dmg</code> and drag the <code>OpenBB Terminal</code> folder into your <code>Applications</code></strong></p>
|
||||||
<p>Open the <code>OpenBB Terminal.dmg</code> file that got saved to your “Downloads” folder and drag the “OpenBB Terminal” folder into “Applications” folder. A link to the <code>Applications</code> folder is presented on the screen.
|
<p>A link to the <code>Applications</code> folder is presented on the screen.
|
||||||
Note that this should take some time as it is extracting the files from the .dmg file.</p>
|
Note that this should take some time as it is extracting the files from the .dmg file.</p>
|
||||||
<p align="center"><img width="100%" alt="image" src="https://user-images.githubusercontent.com/11668535/173027899-9b25ae4f-1eef-462c-9dc9-86086e9cf197.png"></img></p>
|
<p align="center"><img width="70%" alt="image" src="https://user-images.githubusercontent.com/11668535/173027899-9b25ae4f-1eef-462c-9dc9-86086e9cf197.png"></img></p>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@@ -69,13 +68,14 @@ Note that this should take some time as it is extracting the files from the .dmg
|
|||||||
<p><strong>Step 2: Open the <code>OpenBB Terminal</code> app in the folder that you have just copied to your <code>Applications</code>.</strong></p>
|
<p><strong>Step 2: Open the <code>OpenBB Terminal</code> app in the folder that you have just copied to your <code>Applications</code>.</strong></p>
|
||||||
<p>During first launch if you get a message saying that the application can’t be launched, do the following:
|
<p>During first launch if you get a message saying that the application can’t be launched, do the following:
|
||||||
Right-Click the app and select <code>Open</code>. You will see a message saying that macOS was not able to check whether the application contains malicious software. Click <code>Open</code> to proceed.</p>
|
Right-Click the app and select <code>Open</code>. You will see a message saying that macOS was not able to check whether the application contains malicious software. Click <code>Open</code> to proceed.</p>
|
||||||
<p align="center"><img width="100%" alt="image" src="https://user-images.githubusercontent.com/11668535/173027798-b4d25a20-d932-4ed9-a8ce-f911c4ee4342.png"></img></p>
|
<p align="center"><img width="70%" alt="image" src="https://user-images.githubusercontent.com/11668535/173027798-b4d25a20-d932-4ed9-a8ce-f911c4ee4342.png"></img></p>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem value="docker" label="Docker">Install with Docker
|
<TabItem value="docker" label="Docker">
|
||||||
|
<p>Install with Docker</p>
|
||||||
Here are the steps to get OpenBBTerminal using the Docker containers that we provide:
|
Here are the steps to get OpenBBTerminal using the Docker containers that we provide:
|
||||||
|
|
||||||
1. Installing `Docker` and `Docker Compose`
|
1. Installing `Docker` and `Docker Compose`
|
||||||
@@ -166,7 +166,7 @@ Be sure to replace `X.Y.Z` with the version you want to pull and run.
|
|||||||
Note for windows:
|
Note for windows:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
Ignore this message if you are using Powershell or a more evolved interpreters.
|
Ignore this message if you are using Powershell or a more evolved interpreters.
|
||||||
If you are using the builtin Windows interpreter.
|
If you are using the builtin Windows interpreter.
|
||||||
Replace `~` by `%USERPROFILE%` in the command above.
|
Replace `~` by `%USERPROFILE%` in the command above.
|
||||||
```
|
```
|
||||||
@@ -253,10 +253,10 @@ If you're using remote docker host, you can connect with "ssh -X <FQDN/IP>".
|
|||||||
Then run the previous docker command.
|
Then run the previous docker command.
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem value="Source" label="Source">
|
<TabItem value="python" label="Python">
|
||||||
This installation type supports both Windows and Unix systems (Linux + MacOS).
|
This installation type supports both Windows and Unix systems (Linux + MacOS).
|
||||||
|
|
||||||
**NOTE for Windows users:** Some _not all_ Windows users would prefer to use an environment similar to what Linux and macOS users use. In this case it is easier to use Windows Subsystem for Linux (WSL). WSL emulates a Linux machine inside your Windows system. If this is the case - jump to the <a href="#installing-wsl-only-for-windows-users">Installing WSL (Only for Windows users)</a> section before proceeding.
|
**NOTE for Windows users:** For Windows users who prefer to use an environment similar to what Linux and macOS users use, we recommend Windows Subsystem for Linux (WSL). WSL emulates a Linux machine inside your Windows system. If this is the case - jump to the <a href="#installing-wsl-only-for-windows-users">Installing WSL (Only for Windows users)</a> section before proceeding.
|
||||||
|
|
||||||
### Installing the terminal
|
### Installing the terminal
|
||||||
|
|
||||||
@@ -275,11 +275,11 @@ issues.
|
|||||||
Miniconda is a python environment and package manager. It is required if you want to
|
Miniconda is a python environment and package manager. It is required if you want to
|
||||||
have the dependencies working straight away.
|
have the dependencies working straight away.
|
||||||
|
|
||||||
- Follow the [link to the page with the latest installers for all platforms](https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-installer-links) or click direct links to installer packages based on your operating system:
|
- Go [here](https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-installer-links) to find the download for your operating system or use the links below:
|
||||||
- If you are using macOS click [Miniconda for MacOS](https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh)
|
- If you are using macOS [Miniconda for MacOS](https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh)
|
||||||
- If you are using WSL or Linux click [Miniconda for Linux](https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh)
|
- If you are using WSL or Linux [Miniconda for Linux](https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh)
|
||||||
- If you are using a Raspberry PI click [Miniconda for Raspberry PI](https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-aarch64.sh)
|
- If you are using a Raspberry PI [Miniconda for Raspberry PI](https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-aarch64.sh)
|
||||||
- If you are using Windows click [Miniconda for Windows](https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe).
|
- If you are using Windows [Miniconda for Windows](https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe).
|
||||||
|
|
||||||
**ONLY REQUIRED ON WINDOWS IF NOT USING WSL**, Install/update Microsoft C++ Build Tools from here: <https://visualstudio.microsoft.com/visual-cpp-build-tools/>
|
**ONLY REQUIRED ON WINDOWS IF NOT USING WSL**, Install/update Microsoft C++ Build Tools from here: <https://visualstudio.microsoft.com/visual-cpp-build-tools/>
|
||||||
|
|
||||||
@@ -392,11 +392,13 @@ poetry install -E all
|
|||||||
|
|
||||||
#### 9. You're ready to use the terminal!
|
#### 9. You're ready to use the terminal!
|
||||||
|
|
||||||
|
Start the terminal by running:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
openbb
|
openbb
|
||||||
```
|
```
|
||||||
|
|
||||||
Or if you are old-fashioned run:
|
Or the old-fashioned way:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
python terminal.py
|
python terminal.py
|
||||||
@@ -404,11 +406,11 @@ python terminal.py
|
|||||||
|
|
||||||
**NOTE:** When you close the terminal and re-open it, the only command you need to re-call is `conda activate obb` before you call `openbb` again.
|
**NOTE:** When you close the terminal and re-open it, the only command you need to re-call is `conda activate obb` before you call `openbb` again.
|
||||||
|
|
||||||
**TROUBLESHOOT:** If you are having troubles to install, check out the [troubleshoot page](/terminal/quickstart/troubleshooting). You can also reach for help on our [discord](https://discord.gg/Up2QGbMKHY).
|
**TROUBLESHOOT:** If you are having troubles with installation, check out the [FAQ page](/terminal/quickstart/faq). You can also reach for help on our [discord](https://discord.gg/Up2QGbMKHY).
|
||||||
|
|
||||||
## Advanced User Install - Custom installation procedures
|
## Advanced User Install - Custom installation procedures
|
||||||
|
|
||||||
By default we advice using `conda` and `poetry` for environment setup and dependency management. Conda ships binaries for packages like `numpy` so these dependencies are not built from source locally by `pip`. Poetry solves the dependency tree in a way that the dependencies of dependencies of dependencies use versions that are compatible with each other.
|
By default we advise using `conda` and `poetry` for environment setup and dependency management. Conda ships binaries for packages like `numpy` so these dependencies are not built from source locally by `pip`. Poetry solves the dependency tree in a way that the dependencies of dependencies of dependencies use versions that are compatible with each other.
|
||||||
|
|
||||||
If you are using a conda environment the `build/conda` folder contains multiple `.yaml` configuration files that you can choose from.
|
If you are using a conda environment the `build/conda` folder contains multiple `.yaml` configuration files that you can choose from.
|
||||||
|
|
||||||
@@ -451,4 +453,4 @@ After this, `VcXsrv` should be running successfully and we can proceed to termin
|
|||||||
</TabItem>
|
</TabItem>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|||||||
@@ -6,10 +6,10 @@ sidebar_position: 1
|
|||||||
import Tabs from '@theme/Tabs';
|
import Tabs from '@theme/Tabs';
|
||||||
import TabItem from '@theme/TabItem';
|
import TabItem from '@theme/TabItem';
|
||||||
|
|
||||||
Installation of the OpenbB Terminal requires downloading around 500mb of data. Querying data (by running commands) does not require a lot of bandwidth but you will certainly have a more pleasant experience if you will be on a fast internet line. 4G networks provide a good enough experience so if you're traveling your personal hot-spot will do. While it's technically possible to use a subset of the functionality in off-line mode, you will not be able to use any data that is queried from the APIs of data providers and services.
|
Installation of the OpenBB Terminal requires downloading around 2GB of data. Querying data (by running commands) does not require a lot of bandwidth but you will certainly have a more pleasant experience if you are on a fast internet connection. 4G networks provide a good enough experience so if you're traveling your personal hot-spot will do. While it's technically possible to use a subset of the functionality in off-line mode, you will not be able to use any data that is queried from the APIs of data providers and services.
|
||||||
|
|
||||||
### Minimum System Requirements
|
### Minimum System Requirements
|
||||||
|
|
||||||
- 4GB RAM or more
|
- 4GB RAM or more
|
||||||
- 5GB free storage
|
- 2GB free storage
|
||||||
- Internet connection
|
- Internet connection
|
||||||
|
|||||||
2
website/src/css/custom.css
vendored
2
website/src/css/custom.css
vendored
@@ -327,7 +327,7 @@ pre[class*="language-"] {
|
|||||||
color: #2dba06 !important;
|
color: #2dba06 !important;
|
||||||
}
|
}
|
||||||
|
|
||||||
.theme-admonition-info [data-theme="dark"] {
|
[data-theme="dark"] .theme-admonition-info {
|
||||||
border-color: #004466 !important;
|
border-color: #004466 !important;
|
||||||
background-color: #2a2a2a !important;
|
background-color: #2a2a2a !important;
|
||||||
}
|
}
|
||||||
|
|||||||
15
website/src/theme/Details/index.js
vendored
Normal file
15
website/src/theme/Details/index.js
vendored
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
import React from 'react';
|
||||||
|
import clsx from 'clsx';
|
||||||
|
import {Details as DetailsGeneric} from '@docusaurus/theme-common/Details';
|
||||||
|
import styles from './styles.module.css';
|
||||||
|
// Should we have a custom details/summary comp in Infima instead of reusing
|
||||||
|
// alert classes?
|
||||||
|
const InfimaClasses = 'alert alert--info';
|
||||||
|
export default function Details({...props}) {
|
||||||
|
return (
|
||||||
|
<DetailsGeneric
|
||||||
|
{...props}
|
||||||
|
className={clsx(InfimaClasses, styles.details, props.className)}
|
||||||
|
/>
|
||||||
|
);
|
||||||
|
}
|
||||||
19
website/src/theme/Details/styles.module.css
vendored
Normal file
19
website/src/theme/Details/styles.module.css
vendored
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
.details {
|
||||||
|
--docusaurus-details-decoration-color: #5a5a5aff;
|
||||||
|
--docusaurus-details-transition: transform var(--ifm-transition-fast) ease;
|
||||||
|
margin: 0 0 var(--ifm-spacing-vertical);
|
||||||
|
border: 1px solid var(--ifm-alert-border-color);
|
||||||
|
background-color: transparent !important;
|
||||||
|
border-color: transparent !important;
|
||||||
|
--tw-shadow: 0 1px 3px 0 rgb(0 0 0 / 0.1), 0 1px 2px -1px rgb(0 0 0 / 0.1) !important;
|
||||||
|
--tw-shadow-colored: 0 1px 3px 0 var(--tw-shadow-color), 0 1px 2px -1px var(--tw-shadow-color) !important;
|
||||||
|
box-shadow: var(--tw-ring-offset-shadow, 0 0 #0000), var(--tw-ring-shadow, 0 0 #0000), var(--tw-shadow) !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.details code {
|
||||||
|
background-color: transparent !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
[data-theme="dark"] .details {
|
||||||
|
border-color: #5a5a5aff !important;
|
||||||
|
}
|
||||||
16
website/src/theme/MDXComponents/Details.js
vendored
Normal file
16
website/src/theme/MDXComponents/Details.js
vendored
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
import React from 'react';
|
||||||
|
import Details from '@theme/Details';
|
||||||
|
export default function MDXDetails(props) {
|
||||||
|
const items = React.Children.toArray(props.children);
|
||||||
|
// Split summary item from the rest to pass it as a separate prop to the
|
||||||
|
// Details theme component
|
||||||
|
const summary = items.find(
|
||||||
|
(item) => React.isValidElement(item) && item.props?.mdxType === 'summary',
|
||||||
|
);
|
||||||
|
const children = <>{items.filter((item) => item !== summary)}</>;
|
||||||
|
return (
|
||||||
|
<Details {...props} summary={summary}>
|
||||||
|
{children}
|
||||||
|
</Details>
|
||||||
|
);
|
||||||
|
}
|
||||||
29
website/src/theme/Tabs/index.js
vendored
29
website/src/theme/Tabs/index.js
vendored
@@ -8,6 +8,20 @@ import {
|
|||||||
} from '@docusaurus/theme-common/internal';
|
} from '@docusaurus/theme-common/internal';
|
||||||
import styles from './styles.module.css';
|
import styles from './styles.module.css';
|
||||||
import { useLocation } from '@docusaurus/router';
|
import { useLocation } from '@docusaurus/router';
|
||||||
|
|
||||||
|
function getQueryVariable(query, variable) {
|
||||||
|
// substring query
|
||||||
|
const vars = query.substring(1).split('&');
|
||||||
|
for (let i = 0; i < vars.length; i++) {
|
||||||
|
let pair = vars[i].split('=');
|
||||||
|
console.log(decodeURIComponent(pair[0]), variable)
|
||||||
|
if (decodeURIComponent(pair[0]) == variable) {
|
||||||
|
return decodeURIComponent(pair[1]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
// A very rough duck type, but good enough to guard against mistakes while
|
// A very rough duck type, but good enough to guard against mistakes while
|
||||||
// allowing customization
|
// allowing customization
|
||||||
function isTabItem(comp) {
|
function isTabItem(comp) {
|
||||||
@@ -68,7 +82,10 @@ function TabsComponent(props) {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
const { tabGroupChoices, setTabGroupChoices } = useTabGroupChoice();
|
const { tabGroupChoices, setTabGroupChoices } = useTabGroupChoice();
|
||||||
const [selectedValue, setSelectedValue] = useState(defaultValue);
|
|
||||||
|
const { pathname, search } = useLocation()
|
||||||
|
const value = getQueryVariable(search, 'tab')
|
||||||
|
const [selectedValue, setSelectedValue] = useState(value ? value : defaultValue);
|
||||||
const tabRefs = [];
|
const tabRefs = [];
|
||||||
const { blockElementScrollPositionUntilNextRender } =
|
const { blockElementScrollPositionUntilNextRender } =
|
||||||
useScrollPositionBlocker();
|
useScrollPositionBlocker();
|
||||||
@@ -117,7 +134,6 @@ function TabsComponent(props) {
|
|||||||
focusElement?.focus();
|
focusElement?.focus();
|
||||||
};
|
};
|
||||||
|
|
||||||
const { pathname } = useLocation()
|
|
||||||
return (
|
return (
|
||||||
<div>
|
<div>
|
||||||
<ul
|
<ul
|
||||||
@@ -137,22 +153,21 @@ function TabsComponent(props) {
|
|||||||
onClick={handleTabChange}
|
onClick={handleTabChange}
|
||||||
{...attributes}
|
{...attributes}
|
||||||
className={clsx(
|
className={clsx(
|
||||||
'font-bold tracking-widest w-fit px-3 inline-flex py-1 uppercase text-sm border-b',
|
'font-bold tracking-widest w-fit px-3 inline-flex py-1 uppercase border-b text-lg cursor-pointer',
|
||||||
styles.tabItem,
|
styles.tabItem,
|
||||||
attributes?.className,
|
attributes?.className,
|
||||||
{
|
{
|
||||||
'border-b-2 pointer-events-none': selectedValue === value,
|
'border-b-2 pointer-events-none': selectedValue === value,
|
||||||
'cursor-pointer': selectedValue !== value,
|
|
||||||
'border-b-2 text-[#669dcb] border-[#669dcb]': selectedValue === value && pathname.startsWith("/terminal"),
|
'border-b-2 text-[#669dcb] border-[#669dcb]': selectedValue === value && pathname.startsWith("/terminal"),
|
||||||
'border-b-2 text-[#FB923C] border-[#FB923C]': selectedValue === value && pathname.startsWith("/sdk"),
|
'border-b-2 text-[#FB923C] border-[#FB923C]': selectedValue === value && pathname.startsWith("/sdk"),
|
||||||
'border-grey-600 text-grey-600 hover:text-[#ffd4b1] hover:border-[#ffd4b1]': selectedValue !== value && pathname.startsWith("/sdk"),
|
'border-grey-400 text-grey-400 hover:text-[#ffd4b1] hover:border-[#ffd4b1]': selectedValue !== value && pathname.startsWith("/sdk"),
|
||||||
'border-grey-600 text-grey-600 hover:text-[#abd2f1] hover:border-[#abd2f1]': selectedValue !== value && pathname.startsWith("/terminal"),
|
'border-grey-400 text-grey-400 hover:text-[#abd2f1] hover:border-[#abd2f1]': selectedValue !== value && pathname.startsWith("/terminal"),
|
||||||
},
|
},
|
||||||
)}>
|
)}>
|
||||||
{label ?? value}
|
{label ?? value}
|
||||||
</li>
|
</li>
|
||||||
))}
|
))}
|
||||||
<li className='w-full border-b border-grey-600 pointer-events-none py-1 mb-[9.5px]'></li>
|
<li className='w-full border-b border-grey-400 pointer-events-none py-1 mb-[12px]'></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
{lazy ? (
|
{lazy ? (
|
||||||
|
|||||||
10832
website/yarn.lock
vendored
10832
website/yarn.lock
vendored
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user