Hub Synchronization

This guide will walk you through the process of integrating the OpenBB Terminal with the OpenBB Hub to achieve optimal performance.

Registration

To get started, you'll need to create an account on the OpenBB Hub by visiting https://my.openbb.co

By registering with the OpenBB Hub, you can easily access our products on multiple devices and maintain consistent settings for an improved user experience. This also enables you to receive updates for the terminal as soon as they become available.

Login

Once you're successfully registered on the OpenBB Hub, you can log in to access all the benefits it has to offer.

The login credentials you use on the OpenBB Hub will be the same ones you will use to access the OpenBB Terminal.

When OpenBB Terminal 3.0.0 (or greater) is launched, there will be a new welcome message. On packaged applications, you will be greeted with the following:

The "Remember me" feature saves your session locally, eliminating the need to log in for 30 days.

If you haven't registered, simply press <ENTER> to access the terminal as a guest without using this feature.

Once you have successfully logged in, your username (e.g. [didier.lopes]) along with a 🦋 flair will be displayed on the terminal. However, if you're in guest mode, only the 🐛 flair will be visible.

Note: If you wish to log in or out of your account while inside the terminal, simply access the /account menu.

API Keys

As you may already know, the OpenBB Terminal acts as a mediator between users and data providers and does not store any data. This enables us to focus on providing a superior product experience for users, while data vendors can integrate their data sources to create a new revenue channel. However, this does mean that each user must manage their own API keys for each data provider they wish to access.

OpenBB Hub

If you were an OpenBB user prior to the release of OpenBB Terminal 3.0, you may already have an .env file containing all your API keys. If this is the case, simply drag and drop the file onto this page to automatically save your keys.

If you are a new user, you'll need to follow the instructions provided by hovering over the ℹ️ icon for each data source you're interested in. The icon will direct you to the data vendor's website to obtain the necessary API key, which can then be saved on the Hub for future use.

OpenBB Terminal

Upon logging in, the OpenBB Terminal will automatically retrieve the API keys associated with your account.

If you have not saved them on the OpenBB Hub, they will be loaded from your local environment by default. However, if an API key is saved on the OpenBB Hub, it will take precedence over the local environment key.

Important: Note that setting a key in the keys menu will NOT upload it to the OpenBB Hub. This option is only intended for managing local environment variables. For a superior user experience, OpenBB highly recommends using the OpenBB Hub to manage your API keys.

If an API key is updated in the Hub while the OpenBB Terminal is running, you will need to restart the terminal for the changes to take effect.

To delete your saved API keys from the OpenBB Hub, use the /account/clear command. However, please note that this action CANNOT BE UNDONE and will prompt a confirmation prompt.

Default Data Sources

In many cases, there are multiple data vendors offering access to the same data for a given command. At OpenBB, we believe in empowering our users to choose their preferred data source, or the one with whom they already have a commercial relationship. Therefore, we offer the ability for users to select their default data sources for each command.

OpenBB Hub

In the OpenBB Hub, you can access this page which allows you to select the default data sources for all commands.

OpenBB Terminal

Upon login, the OpenBB Terminal will pull the default data sources associated with your account.

If a user wants to adjust any data source directly from the terminal, this is possible by utilizing the /sources menu. For instance,

That change will be reflected on the OpenBB Hub when refreshing the page.

Note that any changes on the OpenBB Hub will require a restart of the terminal to take effect.

Theme Styles

Theme styles correspond to the ability to change your terminal "skin" (i.e. colouring of the menu, commands, data source, parameters, information and help), the charts and tables style.

OpenBB Hub

In the OpenBB Hub, you have the ability to change your preferred themes for the terminal on this page,

and charts and tables on this page,

OpenBB Terminal

When you log in to the OpenBB Terminal, the platform automatically applies the theme style associated with your account.

To further customize your experience, you can manage these styles using the /settings/theme and /settings/colors commands. While managing the theme is straightforward, managing colors can be more complex as it requires moving a special file around. For a smoother experience, we highly recommend managing colors through the improved interface on the OpenBB Hub.

It's important to note that changes to charts and tables take effect immediately, while changes to the terminal theme require a reset to take effect.

Script Routines

These are text files with an .openbb extension that allow users to create workflows of sequence of commands. And allows to create parameters that can be modified outside the terminal. An example would be the file, "example.openbb" looking like:

stocks
load $ARGV[0]
# depict candle chart
candle

and then run on the terminal utilizing:

/exe example.openbb -i MSFT

OpenBB Hub

The OpenBB Hub allows users to manage their own script routines to be run in the OpenBB Terminal. They can do so on this page.

In addition, a few script routines will be distributed by the OpenBB Team on this page. These come primarily from academic content that the team is releasing, but can serve as an example of what you can do.

Note that the "Download" button allows you to download the example file and share with co-workers / colleagues.

OpenBB Terminal

Once you've logged in to your OpenBB Terminal account, your routines will automatically sync and become available for use.

To see the available routines from the Hub, use the /account/list command. This command will display both the default OpenBB routines and your personal routines, as shown in the image below:

To run a routine, select exe --file from the main menu and the available routines will pop up as auto-completions. For example:

If you'd like to download a specific routine or upload a locally created .openbb file file, you can use the account/upload and account/download commands.

You can also delete your locally stored routines, which will then be synced with the OpenBB Hub.

Personal Access Tokens

Setting up API keys on the OpenBB Hub has an additional benefit: it allows you to generate a personal access token (PAT) that can be used with the OpenBB SDK. With this token, you can programmatically access the data that powers the OpenBB Terminal, without the need to add individual API keys for each user.

OpenBB Hub

If you go to the bottom of this page you can find your OpenBB PAT. This is the API Keys that will be used on the OpenBB SDK and this is the same as the ones set in the OpenBB Terminal.

The bottom of that page also allows to regenerate the PAT.

In addition you can copy-paste the following section

from openbb_terminal.sdk import openbb
openbb.login(token = "<YOUR TOKEN HERE>")

OpenBB Terminal

Although the PAT is not meant to be used in the OpenBB Terminal, you can still manage it in the /account menu through the generate command. This will delete any previously issued tokens.

Once you have generated a token, an SDK session can be initiated anywhere utilizing:

from openbb_terminal.sdk import openbb
openbb.login(token = "<YOUR TOKEN HERE>")

Note that you can also access your account utilizing your credentials, e.g.

openbb.login(email = 'didier.lopes@openbb.finance', password = '****')

in addition, if you want to store that information locally you can do so by setting this additional flag.

keep_session = True