diff --git a/website/config.toml b/website/config.toml index 6f0be43e0cf..7f215176c49 100644 --- a/website/config.toml +++ b/website/config.toml @@ -1,5 +1,5 @@ baseURL = "https://openbb-finance.github.io/OpenBBTerminal" -title = "OpenBB Terminal" +title = "OpenBB Documentation" theme = "hugo-geekdoc" # Required to get well formatted code blocks diff --git a/website/content/_index.md b/website/content/_index.md index 739c5cf921d..5c100fbcad4 100644 --- a/website/content/_index.md +++ b/website/content/_index.md @@ -1,13 +1,16 @@ --- -title: OpenBB Terminal -description: A modern investment research tool for Everyone. -geekdocNav: true -geekdocAnchor: false -resources: - - name: GST - src: "/gst_logo_lockup_rGreen_with_letters.png" - title: +title: Getting Started +keywords: "getting started, openbb, bots, api, beginner guide, how to use openbb, openbb keys, openbb terminal, openbb" +excerpt: "This page guides you how to use the OpenBB terminal, developed by OpenBB." +geekdocCollapseSection: true +aliases: + - /terminal/_index.md --- +## Introduction + +OpenBB is a leading open source investment analysis company. 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. **All our products are Free and Open-Source (FOSS).** @@ -18,32 +21,45 @@ resources: [![Forks][forks-shield]][forks-url] [![Contributors][contributors-shield]][contributors-url] [![MIT License][license-shield]][license-url] - -[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/openbb_finance.svg?style=social&label=Follow%20%40openbb_finance)](https://twitter.com/openbb_finance) +[![Twitter][twitter-shield]][twitter-url] --- +
If you are interested in the OpenBB Terminal, +please continue reading this page and the related pages on each menu (e.g. Stocks +or Economy)
-## OpenBB Terminal +
If you are interested in one of our other products, +please refer to the OpenBB Python API or the +OpenBB Bots pages.
+ +--- + +{{< toc >}} {{< columns >}} -### Python +### Why Python? -Fully written in python which is one of the most used programming languages due to its simplified syntax and shallow learning curve. It is the first time in history that users - regardless of their background - can so easily add features to an investment research platform. +Python is one of the most used programming languages due to its simplified syntax and shallow learning curve. +On top of this, it is highly used in data science and academia world (particularly on finance, economics +or business related degrees). This is very important, as it is the first time in history that users - regardless +of their background - can so easily add features to an investment research platform. <---> -### Open Source and Transparency +### Why Open Source? -The MIT Open Source license allows any user to fork the project to either add features to the broader community or create their own customized terminal version. +An open source product allows for higher quality, greater reproducibility, lower costs, more transparency, +and faster go-to-market due to the strong community created. In addition, users can adapt the platform to their +needs or even build proprietary features on top of our infrastructure - which ultimately can result in a marketplace. <---> ### Importing and Exporting data -The terminal allows for users to import their own proprietary datasets to use on our econometric menu. In addition, users are allowed to export any type of data to any type of format whether that is raw data in Excel or an image in PNG. This is ideal for finance content creation. +The terminal allows for users to import their own proprietary datasets to use on our econometrics menu. In addition, users are allowed to export any type of data to any type of format whether that is raw data in Excel or an image in PNG. This is also ideal for finance content creation. {{< /columns >}} @@ -51,55 +67,289 @@ The terminal allows for users to import their own proprietary datasets to use on ### Automatic notebook reports -Create notebook templates (through papermill) which can be run on different tickers. This level of automation allows to speed up the development of your investment thesis and reduce human error. +Create notebook templates (through papermill) which can be run on different tickers. This level of automation allows speeding up the development of your investment thesis and reduce human error. <---> -### GST API and Customizable notebook reports +### OpenBB API and Customizable notebook reports -Use our OpenBB Terminal environment to access raw data through a Jupyter notebook and play with it accordingly. Or just create customizable notebook reports for your colleagues and friends doing research on a particular asset or a macro economic event impact on said asset. The possibilities are endless. +Use our OpenBB Terminal environment to access raw data through a Jupyter Notebook and play with it accordingly. Or just create customizable notebook reports for your colleagues and friends doing research on a particular asset or a macroeconomic event impact on said asset. The possibilities are endless. <---> ### Advanced user and routines -Navigate through 500+ terminal features using fast shortcuts and leverage auto-complete functionality. Jump from looking into your portfolio to compare the financials of those companies in a few seconds. Leverage our routines implementation to run analysis while you drink your coffee/tea. +Navigate through 750+ terminal features using fast shortcuts and leverage auto-complete functionality. Jump from looking into your portfolio to comparing the financials of those companies in a few seconds. Leverage our routines implementation to run analysis while you drink your coffee or tea. {{< /columns >}} ---- +## Accessing the OpenBB Terminal ---- +The OpenBB Terminal can be directly installed on your computer via our installation program. Within this section, you +are guided through the installation process and how to launch the program. If you are a developer, please have a +look here. If you struggle with the +installation process, please don't hesitate to reach us on Discord +or visit our contact page. -## Financial Chatting Bot +### Installation for Windows -{{< columns >}} +The process starts off by downloading the installer, see below for how to download the most recent release: -### Discord, Telegram, Slack and GroupMe integration +1. Go to the following link +2. Click on the 'Latest' release and scroll down +3. Click on the ".exe" file, this downloads the installation program -The only cross-platform financial chatting bot to accommodate for your already existing groups/chats/servers. +When the file is downloaded, you can follow the following steps: -<---> +| Installation instructions | Illustration | +|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Double click the .exe file that got downloaded to your "Downloads" folder. You will most likely receive the error on the right stating "Windows protected your PC". This is because the installer is still in beta phase, and the team has not yet requested verification from Windows.

Click on "More info" and select "Run anyway" to start the installation process. 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.

By clicking on the application that appeared on your Desktop, you are able to run the Terminal. The first time this takes a bit longer to load. |

windows_protected_your_pc

run_anyway

run_the_terminal

| -### Investment data should be OS agnostic +### Installation for macOS -This bot will allow to access the terminal features using any type of device. From mobile phone to tablet and computer. +The process starts off by downloading the installer, see below for how to download the most recent release: -{{< /columns >}} +1. Go to the following link +2. Click on the 'Latest' release and scroll down +3. Click on the ".dmg" file, this downloads the installation program -{{< columns >}} +Installation instructions: -### Use bot for your own investment research +1. Open the .dmg file that got downloaded to your "Downloads" folder. +2. Drag the folder into your "Applications" folder. This should take some time as it is extracting the + files from the .dmg file. +3. Open the folder and click on the "OpenBB Terminal" file, this should run the application. -If you don't want to engage with the bot in an open-server setting, you can message the bot directly and interact with data on a more private setting. +mac_os_installation -<---> +| Note about "Cannot check it for malicious software" warning | Illustration | +|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Run the file. You will most likely receive a message that macOS was not able to check whether the application contains malicious software. This is because the installer is still in beta phase, and the team has not yet requested verification from Apple. See below how to correct for this.

Go to `System Preferences > Security & Privacy > General`. You should see a message at the bottom that says that the file "was blocked from use because it is not from an identified developer". Click on “Allow anyway” or "Open anyway".

You should now be able to launch the application. |

malicious_software_warning

warning_fix

| -### Customize the bot to your needs +## Structure of the OpenBB Terminal -The bot also benefits from an MIT Open Source license, which means that you can customize it according to your needs and include proprietary features. +The OpenBB Terminal is based off the Command Line Interface (CLI) +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: -{{< /columns >}} +Main Menu + +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: +- Light Blue: represents commands. +- Dark Blue: represents menus, also recognizable by the `>` in front. +- Orange: represents titles and headers. +- Yellow: represents descriptions of a parameter or variable. +- White: represents text, usually in combination with a description that is in Yellow. + +### Explanation of Menus + +Menus, depicted in Dark Blue, take you to a new section of the terminal referred +to as a menu. For example, if you wish to view information about stocks, you can do so by typing `stocks` and pressing `ENTER` (⏎). +This opens a new menu as depicted below. + +Stocks Menu + +Depending on the menu you are in, you are presented with a new set of commands (see "Explanation 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 for more information. + +### Explanation of Commands + +Commands, depicted in Light Blue, execute an action or task. For example, +the commands that you are able to use from any menu in the terminal (see "Explanation of Menus") are as follows: + +- `cls`: clears the screen, by executing this command you are left with an empty screen. +- `help`, `h` or `?`: displays the menu that you are currently on. +- `quit`, `q` or `..`: allows for navigation through the menu. E.g. if you type `stocks` press `ENTER` (⏎) and then +use `q` and press `ENTER` (⏎) you return to where you started. Validate this by typing `?` and pressing `ENTER` (⏎). +- `support`: allows you to submit bugs, questions and suggestions. + +Continuing with the example mentioned at `quit`, revisit the `stocks` menu and look at the commands. At the top you +will see a command named load. To understand what this command can do, you can use `load -h` followed by `ENTER` (⏎). The `-h` stands for `help` and every command will have this feature. This will return the following: + +``` +2022 May 19, 05:27 (🦋) /stocks/ $ load -h +usage: load [-t TICKER] [-s START] [-e END] [-i {1,5,15,30,60}] [--source {yf,av,iex,polygon}] [-p] [-f FILEPATH] [-m] [-w] [-r {ytd,1y,2y,5y,6m}] [-h] + +Load stock ticker to perform analysis on. When the data source is yf (Yahoo Finance), an Indian ticker can be loaded by using '.NS'at the end, e.g. 'SBIN.NS'. See available market in https://help.yahoo.com/kb/exchanges-data-providers-yahoo-finance-sln2310.html. + +optional arguments: + -t TICKER, --ticker TICKER + Stock ticker (default: None) + -s START, --start START + The starting date (format YYYY-MM-DD) of the stock (default: 2019-05-15) + -e END, --end END The ending date (format YYYY-MM-DD) of the stock (default: 2022-05-19) + -i {1,5,15,30,60}, --interval {1,5,15,30,60} + Intraday stock minutes (default: 1440) + --source {yf,av,iex,polygon} + Source of historical data. (default: yf) + -p, --prepost Pre/After market hours. Only works for 'yf' source, and intraday data (default: False) + -f FILEPATH, --file FILEPATH + Path to load custom file. (default: None) + -m, --monthly Load monthly data (default: False) + -w, --weekly Load weekly data (default: False) + -r {ytd,1y,2y,5y,6m}, --iexrange {ytd,1y,2y,5y,6m} + Range for using the iexcloud api. Note that longer range requires more tokens in account (default: ytd) + -h, --help show this help message (default: False) +``` + +This shows you all **arguments** the command has. These are additional options you can provide to the command. Each +default value is also displayed which is used when you do not select this option. For example, if I would use the stock ticker +of Amazon (AMZN, which can also be found with `search amazon`), I can use `load AMZN` which will return the following: + +``` +2022 May 19, 05:27 (🦋) /stocks/ $ load AMZN + +Loading Daily AMZN stock with starting period 2019-05-15 for analysis. + +Datetime: 2022 May 19 05:33 +Timezone: America/New_York +Currency: USD +Market: OPEN +Company: Amazon.com, Inc. + + AMZN Performance +┏━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ 1 Day ┃ 1 Week ┃ 1 Month ┃ 1 Year ┃ YTD ┃ Volatility (1Y) ┃ Volume (10D avg) ┃ Last Price ┃ +┡━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ -3.34 % │ 1.65 % │ -32.26 % │ -33.71 % │ -37.14 % │ 31.36 % │ 5.51 M │ 2142.25 │ +└─────────┴────────┴──────────┴──────────┴──────────┴─────────────────┴──────────────────┴────────────┘ +``` + +The default values you see within `load -h` have been inputted here. E.g. the starting period is 2019-05-15. I can +decide to change these default values by calling the argument and inputting a different value. Let's change the starting +and ending period of the data that is being loaded in by doing the following: + +``` +2022 May 19, 05:38 (🦋) /stocks/ $ load AMZN -s 2005-01-01 -e 2010-01-01 + +Loading Daily AMZN stock with starting period 2005-01-01 for analysis. + +Datetime: 2022 May 19 05:43 +Timezone: America/New_York +Currency: USD +Market: OPEN +Company: Amazon.com, Inc. + + AMZN Performance +┏━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ 1 Day ┃ 1 Week ┃ 1 Month ┃ 1 Year ┃ Period ┃ Volatility (1Y) ┃ Volume (10D avg) ┃ Last Price ┃ +┡━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ -3.51 % │ -3.18 % │ -2.87 % │ 162.32 % │ 203.73 % │ 49.78 % │ 8.53 M │ 134.52 │ +└─────────┴─────────┴─────────┴──────────┴──────────┴─────────────────┴──────────────────┴────────────┘ +``` + +We can check that this period has changed by looking into the candle chart with `candle`. This, again shares the same `-h` argument. This results in the following which indeed depicts our +selected period. + +``` +2022 May 19, 05:44 (🦋) /stocks/ $ candle +``` +Amazon Candle Chart + +As mentioned in the "Explanation of Menus", some information also transfers over to other menus and this includes the +loaded market data from load. +So, if you would visit the `ta` menu (which stands for Technical Analysis) you will see that, by running any command, the selected period above is depicted again. Return to the Stocks menu again by using `q` and use it again to return to the home screen which can be shown with `?`. + +## Accessing other sources of data via API keys + +Within this 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. + +You can access this menu from the homepage with `keys` which will open the menu as shown below: + + + +Within this menu you are able to set your API keys to access the commands that require that key. You can do so by typing the command followed by the API key, for example: `fred a215egade08a8d47cfd49c849658a2be`. When you press `ENTER` (⏎) the terminal will test whether this API key works. If it does, you receive the message `defined, test passed` and if it does not, you receive the message `defined, test failed`. + +To figure out where you can obtain the API key, you can enter the command (e.g. `av`) and press `ENTER` (⏎) or use the table below. **We recommend that you gradually obtain and set keys whenever you wish to use features that require an API key. For example, if you are interested in viewing recent news about a company, you should set the API key from the 'News API'.** + +| Command | Name | URL | +|:-----------|:-----------------------------------------|:-----------------------------------------------------------------------------------| +| av | AlphaVantage | https://www.alphavantage.co/support/#api-key | +| fmp | Financial Modelling Prep | https://site.financialmodelingprep.com/developer/docs/ | +| quandl | Quandl | https://www.quandl.com | +| polygon | Polygon | https://polygon.io | +| fred | Federal Reserve Economic Database (FRED) | https://fred.stlouisfed.org | +| news | News API | https://newsapi.org/ | +| tradier | Tradier | https://developer.tradier.com | +| cmc | CoinMarketCap | https://coinmarketcap.com/ | +| finnhub | Finnhub | https://finnhub.io/ | +| iex | IEX Cloud | https://iexcloud.io/ | +| reddit | Reddit | https://www.reddit.com/wiki/api | +| twitter | Twitter | https://developer.twitter.com | +| rh | Robinhood | https://robinhood.com/us/en/ | +| degiro | DeGiro | https://www.degiro.com/ | +| oanda | Oanda | https://developer.oanda.com | +| binance | Binance | https://binance.com | +| bitquery | Bitquery | https://bitquery.io/ | +| si | Sentiment Investor | https://sentimentinvestor.com | +| cb | Coinbase | https://help.coinbase.com/en/exchange/managing-my-account/how-to-create-an-api-key | +| walert | Whale Alert | https://docs.whale-alert.io/ | +| glassnode | Glassnode | https://docs.glassnode.com/basic-api/api-key#how-to-get-an-api-key/ | +| coinglass | Coinglass | https://coinglass.github.io/API-Reference/#api-key | +| ethplorer | Ethplorer | https://github.com/EverexIO/Ethplorer/wiki/Ethplorer-API | +| smartstake | Smartstake | https://www.smartstake.io | +| github | GitHub | https://docs.github.com/en/rest/guides/getting-started-with-the-rest-api | + +## Available menus + +There is a large collection of (sub) menus available. Here, the asset class and other menus are described. To find a detailed description and explanation of its usage for each menu, click on the corresponding link to visit the introduction page. + +The asset class menus are as follows: + +- Introduction to Stocks: access historical pricing data, options, sector and +industry analysis, and overall due diligence. +- Introduction to Crypto: dive into onchain data, tokenomics, circulation supply, +nfts and more. +- Introduction to ETF: explore exchange traded funds, historical pricing, holdings +and screeners. +- Introduction to Forex: see foreign exchanges, quotes, forward rates for currency +pairs and Oanda integration. +- Introduction to Funds: discover mutual funds, general overviews, holdings and +sector weights. + +The other menus are as follows: + +- Introduction to Economy: explore global macroeconomic data including +interest and inflation rates, GDP and its components, futures, yield curves and treasury rates. +- Introduction to Alternative: explore alternative datasets such as COVID and +open source metrics. +- Introduction to Econometrics: perform (advanced) regression techniques and +statistical tests on custom datasets to understand relationships for both time series and panel data. +- Introduction to Portfolio: understand how your portfolio evolved over time, what +assets contributed the most to this performance, compare this to a benchmark and make adjustments via various portfolio +optimization techniques. +- Introduction to Dashboards: see interactive dashboards using voila and +jupyter notebooks. +- Introduction to Reports: create customizable research reports through +jupyter notebooks. + +To adjust the lay-out and settings of the OpenBB Terminal you can access the `settings` menu. This menu allows you to +tweak how the terminal behaves. For example, you are able to define the coloring, interactive graphs and whether to use +pretty tables. + +## Obtaining support and/or 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`). + +Support Command + +Alternatively, you can contact us via the following routes: + +- If you notice that a feature is missing inside the terminal, please fill in the Request a Feature form. +- If you wish to report a bug, have a question/suggestion or anything else, please fill in the Support form. +- If you wish to speak to us directly, please contact us via Discord. [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 @@ -115,3 +365,5 @@ The bot also benefits from an MIT Open Source license, which means that you can [bugs-closed-url]: https://github.com/OpenBB-finance/OpenBBTerminal/issues?q=is%3Aissue+label%3Abug+is%3Aclosed [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.txt +[twitter-shield]: https://img.shields.io/twitter/follow/openbb_finance?style=for-the-badge&color=blue +[twitter-url]: https://twitter.com/openbb_finance \ No newline at end of file diff --git a/website/content/api/_index.md b/website/content/api/_index.md index 3772f781996..0c4e67b7e72 100644 --- a/website/content/api/_index.md +++ b/website/content/api/_index.md @@ -1,27 +1,18 @@ --- +title: OpenBB Python API geekdocCollapseSection: true --- -{{< toc-tree >}} - -image - - -- [GST python API](#gst-python-api) -- [Python environment setup](#python-environment-setup) -- [Understanding the API functions](#understanding-the-api-functions) -- [Usage examples](#usage-examples) -- [External matplotlib axes support](#external-matplotlib-axes-support) - -## GST python API - -The GST python API was created to enable usage of the terminal functionality in python -scripts and IPython Notebooks (Jupyter). -The API wraps the functionality of the terminal in a way that the python commands follow -the same convention as the terminal. +The OpenBB Python API was created to enable usage of the terminal functionality in python +scripts and IPython Notebooks (Jupyter). The API wraps the functionality of the terminal in a way that the Python +commands follow the same convention as the terminal. For example `stocks/load aapl` becomes `openbb.stocks.load("aapl")`. +image + +{{< toc >}} + --- ## Python environment setup diff --git a/website/content/bots/_index.md b/website/content/bots/_index.md index c5fea7209bd..e02a4431af4 100644 --- a/website/content/bots/_index.md +++ b/website/content/bots/_index.md @@ -1,19 +1,41 @@ --- +title: OpenBB Bots geekdocCollapseSection: true --- +The purpose of the Financial Chatting bots are to remove the need of you and your group of friends /colleagues +migrating to any chatting tool to use the terminal capabilities. Instead, our OpenBB Terminal Bot will seamlessly +integrate with your already existing conversations/chats/servers. -[Our personal bet on financial bots and how they will render other finance chatting tools useless.](https://twitter.com/openbb_finance/status/1501380282884268037) +Platforms: +{{< toc-tree >}} -TL;DR: We remove the need of you and your group of friends/colleagues migrating to any chatting tool to use the the terminal capabilities. Instead, our OpenBB Terminal Bot will seamlessly integrate with your already existing conversations/chats/servers. +{{< columns >}} -## Discord Bot +### Discord, Telegram, Slack and GroupMe integration +The only cross-platform financial chatting bot to accommodate for your already existing groups/chats/servers. We will go in detail regarding the commands within [Discord Bot](/OpenBBTerminal/bots/discord/). +However, for the other chatting platforms, we will just list the main differences as +the commands are expected to be invoked in the same manner. -However, for the other chatting platforms, we will just list the main differences as the commands are expected to be invoked in the same manner. +<---> -**Supported bots:** +### Investment data should be OS agnostic -- [Telegram](/OpenBBTerminal/bots/telegram/) -- [Slack](/OpenBBTerminal/bots/slack/) -- [GroupMe](/OpenBBTerminal/bots/groupme/) +This bot will allow to access the terminal features using any type of device. From mobile phone to tablet and computer. + +{{< /columns >}} + +{{< columns >}} + +### Use bot for your own investment research + +If you don't want to engage with the bot in an open-server setting, you can message the bot directly and interact with data on a more private setting. + +<---> + +### Customize the bot to your needs + +The bot also benefits from an MIT Open Source license, which means that you can customize it according to your needs and include proprietary features. + +{{< /columns >}} \ No newline at end of file diff --git a/website/content/bots/discord/_index.md b/website/content/bots/discord/_index.md index 700b98f0ac3..ff29973b61d 100644 --- a/website/content/bots/discord/_index.md +++ b/website/content/bots/discord/_index.md @@ -1,20 +1,7 @@ --- geekdocCollapseSection: true --- - - -
-

Table of Contents

 -
    -
  1. Introduction
    2. -
  2. Getting Started
    3. -
  3. Commands Groups
    4. -
  4. Support
    5. -
-
- ## Introduction - Discord Bot is an easy-to-use and interactive bot for querying stock, options, futures, indices, crypto and more. The confusion in knowing the exact command structure for each feature is no longer a problem because autocomplete guides you through it, which lets you concentrate on the things that really matter - the data. Getting started is as easy as entering the slash key in a server where the bot is hosted, or in a DM to **GameStonksBot#4609**. It takes only minutes to learn how to use, but with a little curiosity, you can get lost for hours exploring all of the possibilities, finding boundless inspiration for new trade ideas. Browse or search the documentation for more detailed information about each feature. A text list containing the variable options unique to that feature is accessible by using: `/cmds`. @@ -22,34 +9,22 @@ Getting started is as easy as entering the slash key in a server where the bot i More information: - [Here is a short demonstration of the bot in action](https://youtu.be/WxTJHUfLi1U). -- [Join our Discord to try the bot for free](https://discord.com/invite/Up2QGbMKHY) +- [Join our Discord to try the bot for free](https://openbb.co/discord) + +{{< toc >}} ## Getting Started There are several ways to get started with the bot. -_1_. Join our Discord [here](https://discord.com/invite/Up2QGbMKHY) and start interacting with the bot. This is recommended because you will be in touch with our community and will benefit from tips and tricks to get faster up-to-speed. - -_2_. Interact directly with the Discord bot by messaging `GameStonksBot#4609`. - -_3_. Server owners and admins can add the Discord Bot to any server by using [this invite link](https://discord.com/oauth2/authorize?client_id=927232119346962513&permissions=510500797553&scope=bot%20applications.commands). - -_4_. Alternatively, one can fork the Discord bot [here](https://github.com/OpenBB-finance/OpenBBTerminal). The user is then able to modify the bot at their own discretion, and the bot can be either run locally or on a privately-hosted server. Instructions for installation through Heroku can be found [here](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/bots/README.md). +1. Join our Discord [here](https://openbb.co/discord) and start interacting with the bot. This is recommended because you will be in touch with our community and will benefit from tips and tricks to get faster up-to-speed. +2. Interact directly with the Discord bot by messaging `GameStonksBot#4609`. +3. Server owners and admins can add the Discord Bot to any server by using [this invite link](https://discord.com/oauth2/authorize?client_id=927232119346962513&permissions=510500797553&scope=bot%20applications.commands). +4. Alternatively, one can fork the Discord bot [here](https://github.com/OpenBB-finance/OpenBBTerminal). The user is then able to modify the bot at their own discretion, and the bot can be either run locally or on a privately-hosted server. Instructions for installation through Heroku can be found [here](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/bots/README.md). ## Commands Groups -- [Price](/OpenBBTerminal/bots/discord/price/) -- [Options](/OpenBBTerminal/bots/discord/options/) -- [Technical Analysis](/OpenBBTerminal/bots/discord/ta) -- [Stocks Screener](/OpenBBTerminal/bots/discord/screener/) -- [Due Diligence](/OpenBBTerminal/bots/discord/dd) -- [Dark Pool & Shorts](/OpenBBTerminal/bots/discord/dps/) -- [Government Contracts](/OpenBBTerminal/bots/discord/gov/) -- [Economy](/OpenBBTerminal/bots/discord/economy/) -- [Sector & Industry Analysis](/OpenBBTerminal/bots/discord/sia) -- [Sector & Industry Analysis](/OpenBBTerminal/bots/discord/sia) -- [Stocks Discovery](/OpenBBTerminal/bots/discord/disc) -- [Miscellaneous](/OpenBBTerminal/bots/discord/misc) +{{< toc-tree >}} ## Support @@ -57,4 +32,4 @@ Server owners and administrators are able to generate a support request ticket, -Otherwise, join [our Discord](https://discord.com/invite/Up2QGbMKHY) and someone from the community will help you! +Otherwise, join [our Discord](https://openbb.co/discord) and someone from the community will help you! diff --git a/website/content/terminal/_index.md b/website/content/terminal/_index.md index 13b0bf9942d..039c4173e35 100644 --- a/website/content/terminal/_index.md +++ b/website/content/terminal/_index.md @@ -1,24 +1,24 @@ --- -title: Getting started with the OpenBB Terminal -keywords: "getting started, beginner guide, how to use openbb, openbb keys, openbb terminal, openbb" -excerpt: "This page guides you how to use the OpenBB terminal, developed by OpenBB." -geekdocCollapseSection: true +title: OpenBB Terminal --- -## Introduction - OpenBB is a leading open source investment analysis company. 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. ---- -
If you are new to the terminal, please continue reading this -Getting Started page -that explains how the terminal works. To get an understanding -of each menu (e.g. stocks -or economy) -visit the related introduction page.
+**All our products are Free and Open-Source (FOSS).** ---- + + + +[![Stargazers][stars-shield]][stars-url] +[![Forks][forks-shield]][forks-url] +[![Contributors][contributors-shield]][contributors-url] +[![MIT License][license-shield]][license-url] +[![Twitter][twitter-shield]][twitter-url] + + + +{{< columns >}} ### Why Python? @@ -27,11 +27,7 @@ On top of this, it is highly used in data science and academia world (particular or business related degrees). This is very important, as it is the first time in history that users - regardless of their background - can so easily add features to an investment research platform. -The OpenBB Terminal provides a modern Python-based integrated environment for investment research, that allows an -average joe retail trader to leverage state-of-the-art Data Science and Machine Learning technologies. As a modern -Python-based environment, the OpenBB Terminal opens access to numerous Python data libraries in Data Science (Pandas, -Numpy, Scipy, Jupyter), Machine Learning (Pytorch, Tensorflow, Sklearn, Flair), and Data Acquisition (Beautiful Soup, -and numerous third-party APIs). +<---> ### Why Open Source? @@ -39,276 +35,47 @@ An open source product allows for higher quality, greater reproducibility, lower and faster go-to-market due to the strong community created. In addition, users can adapt the platform to their needs or even build proprietary features on top of our infrastructure - which ultimately can result in a marketplace. -The OpenBB Terminal empowers individuals, regardless of whether they want to invest on the stock market in Japan, -invest real estate in Portugal or invest in the cryptomarket, to contribute and share their passion, dreams and desires -about the OpenBB Terminal. This brings together contributors that are not only software engineers but also financial -advisors, data scientists, machine learning researchers, analysts, day traders, mathematicians, academics, physicists -and portfolio managers. +<---> -## Accessing the OpenBB Terminal +### Importing and Exporting data -The OpenBB Terminal can be directly installed on your computer via our installation program. Within this section, you -are guided through the installation process and how to launch the program. If you are a developer, please have a -look here. If you struggle with the -installation process, please don't hesitate to reach us on Discord -or visit our contact page. +The terminal allows for users to import their own proprietary datasets to use on our econometrics menu. In addition, users are allowed to export any type of data to any type of format whether that is raw data in Excel or an image in PNG. This is also ideal for finance content creation. -### Installation for Windows +{{< /columns >}} -The process starts off by downloading the installer, see below for how to download the most recent release: +{{< columns >}} -1. Go to the following link -2. Click on the 'Latest' release and scroll down -3. Click on the ".exe" file, this downloads the installation program +### Automatic notebook reports -When the file is downloaded, you can follow the following steps: +Create notebook templates (through papermill) which can be run on different tickers. This level of automation allows speeding up the development of your investment thesis and reduce human error. -| Installation instructions | Illustration | -|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Double click the .exe file that got downloaded to your "Downloads" folder. You will most likely receive the error on the right stating "Windows protected your PC". This is because the installer is still in beta phase, and the team has not yet requested verification from Windows.

Click on "More info" and select "Run anyway" to start the installation process. 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.

By clicking on the application that appeared on your Desktop, you are able to run the Terminal. The first time this takes a bit longer to load. |

windows_protected_your_pc

run_anyway

run_the_terminal

| +<---> -### Installation for macOS +### OpenBB API and Customizable notebook reports -The process starts off by downloading the installer, see below for how to download the most recent release: +Use our OpenBB Terminal environment to access raw data through a Jupyter Notebook and play with it accordingly. Or just create customizable notebook reports for your colleagues and friends doing research on a particular asset or a macroeconomic event impact on said asset. The possibilities are endless. -1. Go to the following link -2. Click on the 'Latest' release and scroll down -3. Click on the ".dmg" file, this downloads the installation program +<---> -Installation instructions: +### Advanced user and routines -1. Open the .dmg file that got downloaded to your "Downloads" folder. -2. Drag the folder into your "Applications" folder. This should take some time as it is extracting the - files from the .dmg file. -3. Open the folder and click on the "OpenBB Terminal" file, this should run the application. +Navigate through 750+ terminal features using fast shortcuts and leverage auto-complete functionality. Jump from looking into your portfolio to comparing the financials of those companies in a few seconds. Leverage our routines implementation to run analysis while you drink your coffee or tea. -mac_os_installation +{{< /columns >}} -| Note about "Cannot check it for malicious software" warning | Illustration | -|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Run the file. You will most likely receive a message that macOS was not able to check whether the application contains malicious software. This is because the installer is still in beta phase, and the team has not yet requested verification from Apple. See below how to correct for this.

Go to `System Preferences > Security & Privacy > General`. You should see a message at the bottom that says that the file "was blocked from use because it is not from an identified developer". Click on “Allow anyway” or "Open anyway".

You should now be able to launch the application. |

malicious_software_warning

warning_fix

| - -## Structure of the OpenBB Terminal - -The OpenBB Terminal is based off the Command Line Interface (CLI) -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: - -Main Menu - -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: -- Light Blue: represents commands. -- Dark Blue: represents menus, also recognizable by the `>` in front. -- Orange: represents titles and headers. -- Yellow: represents descriptions of a parameter or variable. -- White: represents text, usually in combination with a description that is in Yellow. - -### Explanation of Menus - -Menus, depicted in Dark Blue, take you to a new section of the terminal referred -to as a menu. For example, if you wish to view information about stocks, you can do so by typing `stocks` and pressing `ENTER` (⏎). -This opens a new menu as depicted below. - -Stocks Menu - -Depending on the menu you are in, you are presented with a new set of commands (see "Explanation 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 for more information. - -### Explanation of Commands - -Commands, depicted in Light Blue, execute an action or task. For example, -the commands that you are able to use from any menu in the terminal (see "Explanation of Menus") are as follows: - -- `cls`: clears the screen, by executing this command you are left with an empty screen. -- `help`, `h` or `?`: displays the menu that you are currently on. -- `quit`, `q` or `..`: allows for navigation through the menu. E.g. if you type `stocks` press `ENTER` (⏎) and then -use `q` and press `ENTER` (⏎) you return to where you started. Validate this by typing `?` and pressing `ENTER` (⏎). -- `support`: allows you to submit bugs, questions and suggestions. - -Continuing with the example mentioned at `quit`, revisit the `stocks` menu and look at the commands. At the top you -will see a command named load. To understand what this command can do, you can use `load -h` followed by `ENTER` (⏎). The `-h` stands for `help` and every command will have this feature. This will return the following: - -``` -2022 May 19, 05:27 (🦋) /stocks/ $ load -h -usage: load [-t TICKER] [-s START] [-e END] [-i {1,5,15,30,60}] [--source {yf,av,iex,polygon}] [-p] [-f FILEPATH] [-m] [-w] [-r {ytd,1y,2y,5y,6m}] [-h] - -Load stock ticker to perform analysis on. When the data source is yf (Yahoo Finance), an Indian ticker can be loaded by using '.NS'at the end, e.g. 'SBIN.NS'. See available market in https://help.yahoo.com/kb/exchanges-data-providers-yahoo-finance-sln2310.html. - -optional arguments: - -t TICKER, --ticker TICKER - Stock ticker (default: None) - -s START, --start START - The starting date (format YYYY-MM-DD) of the stock (default: 2019-05-15) - -e END, --end END The ending date (format YYYY-MM-DD) of the stock (default: 2022-05-19) - -i {1,5,15,30,60}, --interval {1,5,15,30,60} - Intraday stock minutes (default: 1440) - --source {yf,av,iex,polygon} - Source of historical data. (default: yf) - -p, --prepost Pre/After market hours. Only works for 'yf' source, and intraday data (default: False) - -f FILEPATH, --file FILEPATH - Path to load custom file. (default: None) - -m, --monthly Load monthly data (default: False) - -w, --weekly Load weekly data (default: False) - -r {ytd,1y,2y,5y,6m}, --iexrange {ytd,1y,2y,5y,6m} - Range for using the iexcloud api. Note that longer range requires more tokens in account (default: ytd) - -h, --help show this help message (default: False) -``` - -This shows you all **arguments** the command has. These are additional options you can provide to the command. Each -default value is also displayed which is used when you do not select this option. For example, if I would use the stock ticker -of Amazon (AMZN, which can also be found with `search amazon`), I can use `load AMZN` which will return the following: - -``` -2022 May 19, 05:27 (🦋) /stocks/ $ load AMZN - -Loading Daily AMZN stock with starting period 2019-05-15 for analysis. - -Datetime: 2022 May 19 05:33 -Timezone: America/New_York -Currency: USD -Market: OPEN -Company: Amazon.com, Inc. - - AMZN Performance -┏━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓ -┃ 1 Day ┃ 1 Week ┃ 1 Month ┃ 1 Year ┃ YTD ┃ Volatility (1Y) ┃ Volume (10D avg) ┃ Last Price ┃ -┡━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━┩ -│ -3.34 % │ 1.65 % │ -32.26 % │ -33.71 % │ -37.14 % │ 31.36 % │ 5.51 M │ 2142.25 │ -└─────────┴────────┴──────────┴──────────┴──────────┴─────────────────┴──────────────────┴────────────┘ -``` - -The default values you see within `load -h` have been inputted here. E.g. the starting period is 2019-05-15. I can -decide to change these default values by calling the argument and inputting a different value. Let's change the starting -and ending period of the data that is being loaded in by doing the following: - -``` -2022 May 19, 05:38 (🦋) /stocks/ $ load AMZN -s 2005-01-01 -e 2010-01-01 - -Loading Daily AMZN stock with starting period 2005-01-01 for analysis. - -Datetime: 2022 May 19 05:43 -Timezone: America/New_York -Currency: USD -Market: OPEN -Company: Amazon.com, Inc. - - AMZN Performance -┏━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓ -┃ 1 Day ┃ 1 Week ┃ 1 Month ┃ 1 Year ┃ Period ┃ Volatility (1Y) ┃ Volume (10D avg) ┃ Last Price ┃ -┡━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━┩ -│ -3.51 % │ -3.18 % │ -2.87 % │ 162.32 % │ 203.73 % │ 49.78 % │ 8.53 M │ 134.52 │ -└─────────┴─────────┴─────────┴──────────┴──────────┴─────────────────┴──────────────────┴────────────┘ -``` - -We can check that this period has changed by looking into the candle chart with `candle`. This, again shares the same `-h` argument. This results in the following which indeed depicts our -selected period. - -``` -2022 May 19, 05:44 (🦋) /stocks/ $ candle -``` -Amazon Candle Chart - -As mentioned in the "Explanation of Menus", some information also transfers over to other menus and this includes the -loaded market data from load. -So, if you would visit the `ta` menu (which stands for Technical Analysis) you will see that, by running any command, the selected period above is depicted again. Return to the Stocks menu again by using `q` and use it again to return to the home screen which can be shown with `?`. - -## Accessing other sources of data via API keys - -Within this 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. - -You can access this menu from the homepage with `keys` which will open the menu as shown below: - - - -Within this menu you are able to set your API keys to access the commands that require that key. You can do so by typing the command followed by the API key, for example: `fred a215egade08a8d47cfd49c849658a2be`. When you press `ENTER` (⏎) the terminal will test whether this API key works. If it does, you receive the message `defined, test passed` and if it does not, you receive the message `defined, test failed`. - -To figure out where you can obtain the API key, you can enter the command (e.g. `av`) and press `ENTER` (⏎) or use the table below. **We recommend that you gradually obtain and set keys whenever you wish to use features that require an API key. For example, if you are interested in viewing recent news about a company, you should set the API key from the 'News API'.** - -| Command | Name | URL | -|:-----------|:-----------------------------------------|:-----------------------------------------------------------------------------------| -| av | AlphaVantage | https://www.alphavantage.co/support/#api-key | -| fmp | Financial Modelling Prep | https://site.financialmodelingprep.com/developer/docs/ | -| quandl | Quandl | https://www.quandl.com | -| polygon | Polygon | https://polygon.io | -| fred | Federal Reserve Economic Database (FRED) | https://fred.stlouisfed.org | -| news | News API | https://newsapi.org/ | -| tradier | Tradier | https://developer.tradier.com | -| cmc | CoinMarketCap | https://coinmarketcap.com/ | -| finnhub | Finnhub | https://finnhub.io/ | -| iex | IEX Cloud | https://iexcloud.io/ | -| reddit | Reddit | https://www.reddit.com/wiki/api | -| twitter | Twitter | https://developer.twitter.com | -| rh | Robinhood | https://robinhood.com/us/en/ | -| degiro | DeGiro | https://www.degiro.com/ | -| oanda | Oanda | https://developer.oanda.com | -| binance | Binance | https://binance.com | -| bitquery | Bitquery | https://bitquery.io/ | -| si | Sentiment Investor | https://sentimentinvestor.com | -| cb | Coinbase | https://help.coinbase.com/en/exchange/managing-my-account/how-to-create-an-api-key | -| walert | Whale Alert | https://docs.whale-alert.io/ | -| glassnode | Glassnode | https://docs.glassnode.com/basic-api/api-key#how-to-get-an-api-key/ | -| coinglass | Coinglass | https://coinglass.github.io/API-Reference/#api-key | -| ethplorer | Ethplorer | https://github.com/EverexIO/Ethplorer/wiki/Ethplorer-API | -| smartstake | Smartstake | https://www.smartstake.io | -| github | GitHub | https://docs.github.com/en/rest/guides/getting-started-with-the-rest-api | - -## Available menus - -There is a large collection of (sub) menus available. Here, the asset class and other menus are described. To find a detailed description and explanation of its usage for each menu, click on the corresponding link to visit the introduction page. - -The asset class menus are as follows: - -- Introduction to Stocks: access historical pricing data, options, sector and -industry analysis, and overall due diligence. -- Introduction to Crypto: dive into onchain data, tokenomics, circulation supply, -nfts and more. -- Introduction to ETF: explore exchange traded funds, historical pricing, holdings -and screeners. -- Introduction to Forex: see foreign exchanges, quotes, forward rates for currency -pairs and Oanda integration. -- Introduction to Funds: discover mutual funds, general overviews, holdings and -sector weights. - -The other menus are as follows: - -- Introduction to Economy: explore global macroeconomic data including -interest and inflation rates, GDP and its components, futures, yield curves and treasury rates. -- Introduction to Alternative: explore alternative datasets such as COVID and -open source metrics. -- Introduction to Econometrics: perform (advanced) regression techniques and -statistical tests on custom datasets to understand relationships for both time series and panel data. -- Introduction to Portfolio: understand how your portfolio evolved over time, what -assets contributed the most to this performance, compare this to a benchmark and make adjustments via various portfolio -optimization techniques. -- Introduction to Dashboards: see interactive dashboards using voila and -jupyter notebooks. -- Introduction to Reports: create customizable research reports through -jupyter notebooks. - -To adjust the lay-out and settings of the OpenBB Terminal you can access the `settings` menu. This menu allows you to -tweak how the terminal behaves. For example, you are able to define the coloring, interactive graphs and whether to use -pretty tables. - -## Obtaining support and/or 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`). - -Support Command - -Alternatively, you can contact us via the following routes: - -- If you notice that a feature is missing inside the terminal, please fill in the Request a Feature form. -- If you wish to report a bug, have a question/suggestion or anything else, please fill in the Support form. -- If you wish to speak to us directly, please contact us via Discord. +[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 +[forks-shield]: https://img.shields.io/github/forks/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge +[forks-url]: https://github.com/OpenBB-finance/OpenBBTerminal/network/members +[stars-shield]: https://img.shields.io/github/stars/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge +[stars-url]: https://github.com/OpenBB-finance/OpenBBTerminal/stargazers +[issues-shield]: https://img.shields.io/github/issues/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge&color=blue +[issues-url]: https://github.com/OpenBB-finance/OpenBBTerminal/issues +[bugs-open-shield]: https://img.shields.io/github/issues/OpenBB-finance/OpenBBTerminal/bug.svg?style=for-the-badge&color=yellow +[bugs-open-url]: https://github.com/OpenBB-finance/OpenBBTerminal/issues?q=is%3Aissue+label%3Abug+is%3Aopen +[bugs-closed-shield]: https://img.shields.io/github/issues-closed/OpenBB-finance/OpenBBTerminal/bug.svg?style=for-the-badge&color=success +[bugs-closed-url]: https://github.com/OpenBB-finance/OpenBBTerminal/issues?q=is%3Aissue+label%3Abug+is%3Aclosed +[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.txt +[twitter-shield]: https://img.shields.io/twitter/follow/openbb_finance?style=for-the-badge&color=blue +[twitter-url]: https://twitter.com/openbb_finance \ No newline at end of file diff --git a/website/content/terminal/stocks/_index.md b/website/content/terminal/stocks/_index.md index 124b9fcf269..98761472650 100644 --- a/website/content/terminal/stocks/_index.md +++ b/website/content/terminal/stocks/_index.md @@ -93,29 +93,29 @@ a stock ticker, these menus can now be used in combination with the chosen stock 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: -- Introduction to Trading Hours: discover exchanges that are currently open or +- Introduction to Trading Hours: discover exchanges that are currently open or closed for a specified ticker. Also find relevant information about each exchange. - Introduction to Options: look into available options, option spreads, open interest and binomial valuation models. -- Introduction to Stock Discovery: discover trending stocks based on return metrics, revenue and earnings growth, +- Introduction to Stock Discovery: discover trending stocks based on return metrics, revenue and earnings growth, penny stocks and based on upcoming earnings release dates. -- Introduction to Sector & Industry Analysis: analyse companies that reside in the same industry, sector and/or country and +- Introduction to Sector & Industry Analysis: 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. -- Introduction to Dark Pools: discover companies that have enormous shorting pressure, obtain information about dark pool positions and +- Introduction to Dark Pools: discover companies that have enormous shorting pressure, obtain information about dark pool positions and find out about shares that failed to deliver. -- Introduction to Stock Screener: provides the ability to screen companies that share a similar characteristic, +- Introduction to Stock Screener: 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. -- Introduction to Insider Trading: explains what large insiders, e.g. a CEO of a company, is buying the chosen company and insider trading activity for the chosen company. +- Introduction to Insider Trading: explains what large insiders, e.g. a CEO of a company, is buying the chosen company and insider trading activity for the chosen company. - Introduction to Government: gives insights in what the House of Congress is trading and the corporate lobbying that is performed. -- Introduction to Behavioural Analysis: gives the abilities to discover how different social media platforms view the chosen company and what is written about them. +- Introduction to Behavioural Analysis: gives the abilities to discover how different social media platforms view the chosen company and what is written about them. - Introduction to Comparison Analysis: have the ability to compare companies based on, among other things, correlation, financial statements, sentiment, valuations and performance. - Introduction to Fundamental Analysis: 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. - Introduction to Due Diligence: explore analyst recommendations, ratings over time, price targets and quarterly and yearly earnings estimates. -- Introduction to Strategy Backtesting: explore back testing strategies based on technical indicators. -- Introduction to Technical Analysis: analysis the chosen company's historical data extensively with moving averages and momentum, trend, volatility and volume indicators. -- Introduction to Quantitative Analysis: delve deeper in the historical data with quantitative methods including cumulative distribution function (CDF), (conditional) Value at Risk and rolling ratios. -- Introduction to Prediction Techniques: apply advanced AI and Machine Learning models to form prediction of future stock prices including Recurrent Neural Network (RNN), +- Introduction to Strategy Backtesting: explore back testing strategies based on technical indicators. +- Introduction to Technical Analysis: analysis the chosen company's historical data extensively with moving averages and momentum, trend, volatility and volume indicators. +- Introduction to Quantitative Analysis: delve deeper in the historical data with quantitative methods including cumulative distribution function (CDF), (conditional) Value at Risk and rolling ratios. +- Introduction to Prediction Techniques: 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 diff --git a/website/content/terminal/stocks/prediction_techniques/_index.md b/website/content/terminal/stocks/prediction_techniques/_index.md deleted file mode 100755 index 093e02e215d..00000000000 --- a/website/content/terminal/stocks/prediction_techniques/_index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -geekdocCollapseSection: true ---- - -{{< toc-tree >}} diff --git a/website/content/terminal/stocks/quantitative_analysis/_index.md b/website/content/terminal/stocks/quantitative_analysis/_index.md deleted file mode 100755 index 093e02e215d..00000000000 --- a/website/content/terminal/stocks/quantitative_analysis/_index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -geekdocCollapseSection: true ---- - -{{< toc-tree >}} diff --git a/website/data/menu/main.yml b/website/data/menu/main.yml index e69c2f12824..1dec0099204 100755 --- a/website/data/menu/main.yml +++ b/website/data/menu/main.yml @@ -1,7 +1,7 @@ --- main: - - name: terminal - ref: "/terminal" + - name: OpenBB Terminal + ref: "/" sub: - name: stocks ref: "/terminal/stocks" @@ -1082,7 +1082,7 @@ main: ref: "/terminal/common/quantitative_analysis/line" - name: raw ref: "/terminal/common/quantitative_analysis/raw" - - name: etf + - name: ETFs ref: "/terminal/etf" sub: - name: ln @@ -1415,9 +1415,9 @@ main: ref: "/terminal/jupyter/dashboards/shortdata" - name: "reports" ref: "/terminal/jupyter/reports" - - name: "GST python API" + - name: "OpenBB Python API" ref: "/api" - - name: "bots" + - name: "OpenBB Bots" ref: "/bots" sub: - name: "Discord" diff --git a/website/themes/hugo-geekdoc/layouts/shortcodes/toc.html b/website/themes/hugo-geekdoc/layouts/shortcodes/toc.html index 771478f6559..5d98459329d 100644 --- a/website/themes/hugo-geekdoc/layouts/shortcodes/toc.html +++ b/website/themes/hugo-geekdoc/layouts/shortcodes/toc.html @@ -1,5 +1,6 @@ {{ $tocLevels := default (default 6 .Site.Params.GeekdocToC) .Page.Params.GeekdocToC }} {{ if and $tocLevels .Page.TableOfContents }} +

Table of Contents

{{ .Page.TableOfContents }}
{{ end }}