GETTING STARTED WITH

THE OPENBB TERMINAL

 INDEX

Installation of the OpenBB Terminal 01

Structure of the OpenBB Terminal 02

Obtaining and Setting API Keys 03

Exporting Data to Excel Files 04

Working with Scripts & Routines 05

INSTALLATION OF THE
OPENBB TERMINAL
 Installation of the OpenBB Terminal 4

INSTALLING THE OPENBB TERMINAL

Before installation, it is important to verify the software can
be installed. The OpenBB Terminal is available on Windows
(Windows 10 or higher) and MacOS (Monterey or higher).

The installation process can be started by using one of the below

buttons. The website will guide you through the installation
process.

openbb.co/install-windows openbb.co/install-mac

We offer a solution for Linux users as well through the usage of Python as found at openbb.co/install-source
STRUCTURE OF THE
OPENBB TERMINAL
 Structure of the OpenBB Terminal 6

LAUNCHING THE OPENBB TERMINAL FOR THE FIRST TIME

After launching the OpenBB

Terminal you will see a
similar screen as seen on
the right side.

Through typing, you can

access asset classes and
tools like stocks, economy
and portfolio to delve
deeper into the topic.
 Structure of the OpenBB Terminal 7

COLOUR CODING OF THE OPENBB TERMINAL

Light Blue: represents

commands like news.

Dark Blue: represents

menus like stocks.

Orange: represents
titles and headers.

Yellow & White:

represents descriptions
of a parameter or
variable.
 Structure of the OpenBB Terminal 8

WORKING WITH MENUS

Menus, depicted in
Dark Blue, display a
new set of options.

For example, stocks

gives access to a new
menu that includes the
data and tools to do
company research. From
here on, you can visit
other menus like fa or
options as well.
Structure of the OpenBB Terminal 9

WORKING WITH COMMANDS

Commands, depicted
in Light Blue, execute
an action or task
(e.g. a table or
chart)

For example, search

allows searching for
tickers based on a
keyword and once the
ticker (MSFT) is
found, load MSFT
obtains market data
for any given period.
Structure of the OpenBB Terminal 1
0

WORKING WITH COMMANDS (2)

Each command has a help
menu through –h, for
example candle –h

With this information, it

is possible to extend the
chart with additional
arguments as seen in the
example.
Structure of the OpenBB Terminal 1
1

USING UNIVERSAL COMMANDS FOR NAVIGATION AND DOCUMENTATION

Commands that can be
accessed from any
location are:
• q (or quit or ..)
which allows
navigation between
menus.
• ? (or h or help)
which displays the
menu you are on.
• about which goes to
the documentation
page located at
docs.openbb.co
OBTAINING AND SETTING
API KEYS
Obtaining and Setting API Keys 1
3

WORKING WITH API KEYS

The OpenBB platform connects to
nearly a hundred different data
providers. Some of these data
providers require an API key.
This is a unique token that is
generated just for you.

Most API keys have a free tier

that is extensive enough to
cover most use-cases. For
example, 30+ years of
fundamental data, like income,
balance and cash flow
statements, can be obtained for
free.
Obtaining and Setting API Keys 1
4

IDENTIFYING THE NEED FOR AN API KEY

All text marked in

red, refers to the
different sources the
command can retrieve
information for.

For example, for

income this can be
five different sources
with the first source
being the default
option.
Obtaining and Setting API Keys 1
5

SELECTING DIFFERENT SOURCES OF DATA

For a command with

multiple sources,
using the --source
argument allows you to
switch between each
source.

Based on the source,

an API key could be
required. By running
the command you will
be informed about this
if you have not set
one yet.
Obtaining and Setting API Keys 1
6

USING THE OPENBB HUB

The OpenBB Hub is the

platform that connects
all products, data
sources and settings.
With this you can
register API keys,
access presentations
and customize the
OpenBB Terminal as you
wish.

To set your API keys

go to the OpenBB
Terminal product page
after registration.
Obtaining and Setting API Keys 1
7

ACCESSING YOUR API KEYS

From the OpenBB

Terminal page, go to
API Keys to define
your keys.

By clicking on the
information icon
You can get more
information how to
obtain each key. Once
obtained, fill the
field and save.
Obtaining and Setting API Keys 1
8

LOGIN INTO THE OPENBB TERMINAL

When you wish to use the

API keys, you need to
log-in with your OpenBB
Hub account.

This prompt is shown

automatically when you
boot up the OpenBB
Terminal for the first
time. Alternatively,
access the accounts menu
inside the home menu and
login.
Obtaining and Setting API Keys 1
9

VERIFY YOUR API KEYS

Once logged in, use

keys to access the
keys menu to verify
your keys.

If the test fails, it

is important to check
inside the OpenBB Hub
whether the keys are
correctly defined.
Obtaining and Setting API Keys 2
0

USING YOUR API KEYS TO ACCESS DATA

After setting API

keys, for example
that of Financial
Modeling Prep, you
will be able to
access commands
like ratios within
the fa menu as
found within the
stocks menu.
EXPORTING DATA TO
EXCEL FILES
Exporting Data to Excel Files 2
2

EXPORTING DATA TO EXCEL

Almost all commands

offer the ability to
export to Excel.

This can be done by

including the argument
--export NAME.xlsx to
the command.

Furthermore, you can

also specify the sheet
name with the argument
--sheet-name NAME
Exporting Data to Excel Files 2
3

ACCESSING THE EXCEL FILE VIA THE OPENBB USERDATA FOLDER

All exports are

located inside the
OpenBBUserData folder.

This folder is
automatically created
when you install the
OpenBB Terminal and
resides in your User
folder.

Read more about this

on the OpenBB Hub.
WORKING WITH ROUTINE
SCRIPTS
Working with Routine Scripts 2
5

DEFINITION OF ROUTINE SCRIPTS

The .openbb routine scripts are

simple scripts that automate
tasks and enable replication of
financial analysis for multiple
companies and variables.

The methodology shares the same

structure as seen in programs
like R Studio, STATA and SPSS.
Whereas these programs are
primarily used for doing
statistical analysis, the
OpenBB scripts extends this
further into the area of
financial analysis. Routine Scripts
Working with Routine Scripts 2
6

UNDERSTANDING THE BASICS OF A ROUTINE SCRIPT

Executing scripts can
be done via the
command exe –file
SCRIPT.openbb that can
be about any topic.

With exe --example

some example commands
are ran which gives a
basic understanding of
how routines work.

Read more about this

on inside the OpenBB
Hub.
Working with Routine Scripts 2
7

CREATING YOUR OWN ROUTINE SCRIPT

A routine script can

be created with the
routine editor as
found on the OpenBB
Hub.

Routine scripts follow

the same logic as the
OpenBB Terminal itself
as seen in the script
on the right. Note the
# which indicate
comments.
Working with Routine Scripts 2
8

EXECUTING A SCRIPT

Executing the routine

script creates an
Excel file with an
abundance of data
about the company
Microsoft.

This includes 30 years

of fundamental data
and market data. With
this information,
additional analysis
can be performed
directly in Excel.
Working with Routine Scripts 2
9

WORKING WITH CUSTOM ARGUMENTS

By using $ARGV[0],
$ARGV[1], $ARGV[2] and
so on, custom arguments
can be entered.

This allows scripts to

be dynamic and the same
methodology can be used
for multiple variables.

The script on the right

allows the previous
script to be ran for
any company.
Working with Routine Scripts 3
0

EXECUTING A SCRIPT WITH CUSTOM ARGUMENTS

Executing the routine

script with custom
arguments is the same
as a regular script
except you add –i NAME

In this case this

should be a company
ticker and thus AAPL
(Apple Inc.) was
added. This again
returns an Excel file
with the same type of
data as for the
company Microsoft.
Working with Routine Scripts 3
1

RECORDING YOUR OWN ROUTINE SCRIPT

Next to creating your
script, it is also
possible to use the
record and stop
commands. This shares
similarities with that
of Excel’s VBA Macro
Recorder.

By typing record,
running commands and
then typing stop, you
can automatically
create an .openbb
routine script.
Learn more at
openbb.co