Skip to main content

Economy

The /economy menu provides methods for querying macroeconomic data sets from sources like FRED, OECD, and EconDB. To get the most out of this menu, sign up for a free API key from the Federal Reserve of St. Louis, and enter it into the OpenBB Terminal from the /keys menu.

The Economy Menu

The menu is divided into four general sections:

  • Broad market: General headline statistics from the markets today.
  • Country performance: Country-specific data published by the OECD.
  • Databases: Query time series.
  • Stored datasets: Compare and chart multiple time series together.

Each command is listed below, with a short description.

Broad Market

Function KeyDescription
overviewMarket overview of either indices, bonds or currencies.
futuresFutures and commodities overview.
mapS&P 500 heat map.
bigmacThe Economist's Big Mac Index.
eventsThe economic calendar.
edebtExternal debt statitistics for various countries.
valuationValuation of sectors, industries, and countries for US-listed stocks.
performancePerformance of sectors, industry, and countries for US-listed stocks.
usdliUSD Liquidity Index

Country Performance

Function KeyDescription
gdpNominal Gross Domestic Product (GDP).
rgdpReal Gross Domestic Product (GDP).
fgdpForecasts of nominal and real Gross Domestic Product (GDP).
debtGovernment debt-to-GDP ratios.
cpiHarmonized CPI.
ccpiCPI Components.
balanceGovernment tax revenues.
spendingGovernment spending.
trustConfidence in government surveys.

Databases

Function KeyDescription
macroTime series data by country and indicator.
treasuryHistorical US Treasury rates.
fredQuery the FRED.
indexHistorical daily time series for most major global indices.

Stored Datasets

Function KeyDescription
evalA method for performing basic eval operations on a time series.
plotPlot multiple time series together.

Examples

This section will demonstrate some basic operations within the menu.

events

A morning ritual might begin with checking the economic calendar for the day's - or week's - events. The events command can browse the calendar by country and date. By default, the current day for all countries will display in a table.

/economy/events

Economic Calendar

To select a specific country, attach --countries to the command, then press the space bar. Use the up or down arrow keys to browse the choices.

Economic Calendar Countries

overview

The overview fetches the headline levels and rates from the Wall Street Journal. Choose from of the categories by attaching the -t argument to the command.

/economy/overview -t usbonds

Overview

Rate (%)Yld (%)Yld Chg (%)
30-Year Bond3.6253.686-0.028
10-Year Note3.53.343-0.085
7-Year Note3.53.323-0.122
5-Year Note3.53.305-0.162
3-Year Note3.753.513-0.18
2-Year Note3.8753.838-0.144
1-Year Bill04.665-0.09
6-Month Bill04.980.005
3-Month Bill05.2120.064
1-Month Bill04.4520.114

debt

Compare debt-to-GDP ratios between groups of countries by entering them as a comma-separated list.

/economy/debt -c australia,norway,united_states,italy,japan

Debt-to-GDP

usdli

Compare the US Dollar Liquidity Index against a selection of indices published to FRED.

/economy/usdli -o WILLSMLCAP

USD Liquidity Index

The indices available to overlay are displayed in a table by adding, --show, to the command.

/economy/usdli --show

valuation

Get valuations of industries and sectors for the US equity universe. Select the focus by using the, -g (--group), parameter.

Valuation By Industry

valuation --group consumer_cyclical

Consumer Cyclical Valuations

index

Major global indices are curated under the index command. Adding --show to the command will display a table with the list.

index --show

Curated Index List

The cumulative returns of an index is displayed instead of the levels by attaching -r to the command. Multiple indices can be queried simultaneously.

index sp500,sp400,sp600 --start 2023-01-01 -r

Indices

fred

To lookup FRED series by keywords attach, -q, to the fred command.

fred -q PCE

Fred Series

plot

After requesting a time series, it gets populated under Stored datasets. Plot them together, on a shared or separate y-axis, by using the plot command.

Multi-Axis Plots

plot --y1 PCE --y2 sp500

Plot Multiple Time Series