diff options
author | github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> | 2023-03-28 22:53:48 +0000 |
---|---|---|
committer | github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> | 2023-03-28 22:53:48 +0000 |
commit | 8752030e44c0c71559fb7ed7f463467c96f60188 (patch) | |
tree | ed5492ba674a1181d63be3dcab804fb691f58a7c /sdk/reference/economy.html | |
parent | d656d43c8f5aad5e4a439b2c7e38edab2a495cf5 (diff) |
Diffstat (limited to 'sdk/reference/economy.html')
-rw-r--r-- | sdk/reference/economy.html | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/sdk/reference/economy.html b/sdk/reference/economy.html index b2a6318b33e..b0d95af6fc6 100644 --- a/sdk/reference/economy.html +++ b/sdk/reference/economy.html @@ -4,13 +4,13 @@ <meta charset="UTF-8"> <meta name="generator" content="Docusaurus v2.3.1"> <title data-rh="true">economy | OpenBB Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://docs.openbb.co/img/banner.png"><meta data-rh="true" name="twitter:image" content="https://docs.openbb.co/img/banner.png"><meta data-rh="true" property="og:url" content="https://docs.openbb.co/sdk/reference/economy"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="economy | OpenBB Docs"><meta data-rh="true" name="description" content="<ReferenceCard"><meta data-rh="true" property="og:description" content="<ReferenceCard"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openbb.co/sdk/reference/economy"><link data-rh="true" rel="alternate" href="https://docs.openbb.co/sdk/reference/economy" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openbb.co/sdk/reference/economy" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://7D1HQ0IXAS-dsn.algolia.net" crossorigin="anonymous"><script data-rh="true" defer="true" src="https://static.cloudflareinsights.com/beacon.min.js" data-cf-beacon="{"token": "100eb319cb954b9ea86aa757652c0958"}"></script><link rel="search" type="application/opensearchdescription+xml" title="OpenBB Docs" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.20b54d7b.css"> -<link rel="preload" href="/assets/js/runtime~main.7ab72918.js" as="script"> +<link rel="preload" href="/assets/js/runtime~main.c2528a47.js" as="script"> <link rel="preload" href="/assets/js/main.693ad262.js" as="script"> </head> <body class="navigation-with-keyboard"> <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"dark")}()</script><div id="__docusaurus"> <div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav class="border-b border-grey-600 lg:px-12 header_docs_sdk navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><div class="flex items-center gap-x-[56px]"><a class="mb-1 md:mb-0 md:ml-0" href="/"><svg viewBox="0 0 254 19" width="254" height="19" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M216.41 11.412h7.73v-1.254h-8.86v5.55h7.575v1.97h-7.573V19h8.857v-4.436h-7.729v-3.152Z" fill="#fff"></path><path fill-rule="evenodd" clip-rule="evenodd" d="M229.9 10.158v8.773h6.803l1.969-2.149v-4.475l-1.969-2.149H229.9Zm1.074 7.699v-6.624h5.013l1.432 1.556v3.635l-1.432 1.433h-5.013Z" fill="#fff"></path><path d="M245.506 10.158h-1.074v8.773h1.074v-4.476l6.087 4.476h1.611l-6.624-5.013 4.476-3.76h-1.432l-4.118 3.297v-3.297ZM123.007.99V14.33l-1.114-1.11-1.112-1.113-1.114-1.11-1.112-1.114-1.115-1.11-1.114-1.113-1.112-1.11-1.114-1.114-1.112-1.113-1.115-1.11-1.111-1.11L109.647.99h-2.226v17.787h2.226V4.323l1.115 1.113 1.111 1.113 1.115 1.11 1.112 1.114 1.114 1.11 1.112 1.113 1.114 1.11 1.115 1.114 1.112 1.11 1.114 1.113 1.112 1.113 1.114 1.11 1.112 1.111h1.114V.99h-2.226ZM158.849 7.66h-2.226V.99h-13.357v17.79h17.815V7.65h-2.226l-.006.01ZM145.492 6.54V3.213h8.905V7.66h-8.905V6.54Zm13.357 4.447v5.566h-13.357V9.886h13.357v1.102ZM195.79 7.66h-3.338V.99h-13.36v17.79h17.81V7.65l-1.112.01ZM181.318 6.54V3.213h8.908V7.66h-8.908V6.54Zm13.36 4.447v5.566h-13.36V9.886h13.36v1.102ZM87.313.99H71.727v17.787H89.534v-2.22H73.956V12.106h13.352V9.883H73.956V3.213H89.534V.99h-2.221ZM15.6.99H.018v17.79H17.83V.99H15.6Zm0 3.336v12.23H2.24V3.213H15.6v1.113ZM51.478.99H35.894v17.79h2.226v-6.673h15.584V.977h-2.226V.99Zm0 3.336v5.565H38.12V3.213h13.358v1.113Z" fill="#fff"></path></svg></a></div></div><div class="navbar__items navbar__items--right hidden sm:block"><div class="flex items-center"><div class="flex gap-4 mr-12 md:mr-0 ml-4"><button type="button" aria-haspopup="dialog" aria-expanded="false" aria-controls="" data-state="closed" class="bg-grey-900 radix-state-open:text-white hover:border-grey-200 hover:text-grey-200 radix-state-open:border-white border -mt-[0.6px] h-[34px] w-[34px] text-grey-400 border-grey-400 rounded flex items-center justify-center"><svg viewBox="0 0 24 24" width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="w-4 h-4"><path d="M21 12.79A9 9 0 1 1 11.21 3 7 7 0 0 0 21 12.79Z" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path></svg></button></div><div class="searchBox_ZlJk"><div class="flex gap-2"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button><a href="https://my.openbb.co/" class="_btn-dark text-xs">Visit hub</a></div></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav class="menu thin-scrollbar !px-10 text-sm !pb-10 mt-[40px] menu_Y1UP"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/terminal">OpenBB Terminal</a><button aria-label="Toggle the collapsible sidebar category 'OpenBB Terminal'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" aria-expanded="true" href="/sdk">OpenBB SDK</a><button aria-label="Toggle the collapsible sidebar category 'OpenBB SDK'" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/installation">Installation</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/sdk/usage/basics">Guides</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/sdk/faqs/installation_updates">FAQs</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" aria-expanded="true" tabindex="0" href="/sdk/reference">SDK Reference</a><button aria-label="Toggle the collapsible sidebar category 'SDK Reference'" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/sdk/reference/alt">alt</a><button aria-label="Toggle the collapsible sidebar category 'alt'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/sdk/reference/crypto">crypto</a><button aria-label="Toggle the collapsible sidebar category 'crypto'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/sdk/reference/econometrics">econometrics</a><button aria-label="Toggle the collapsible sidebar category 'econometrics'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item"><div class="menu__list-item-collapsible menu__list-item-collapsible--active"><a class="menu__link menu__link--sublist menu__link--active" aria-current="page" aria-expanded="true" tabindex="0" href="/sdk/reference/economy">economy</a><button aria-label="Toggle the collapsible sidebar category 'economy'" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/available_indices">available_indices</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/balance">balance</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/bigmac">bigmac</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/ccpi">ccpi</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/country_codes">country_codes</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/cpi">cpi</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/currencies">currencies</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/debt">debt</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/events">events</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/fgdp">fgdp</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/fred">fred</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/fred_notes">fred_notes</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/future">future</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/futures">futures</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/gdp">gdp</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/get_groups">get_groups</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/glbonds">glbonds</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/index_cmd">index</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/indices">indices</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/macro">macro</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/macro_countries">macro_countries</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/macro_parameters">macro_parameters</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/overview">overview</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/perfmap">perfmap</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/performance">performance</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/revenue">revenue</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/rgdp">rgdp</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/rtps">rtps</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/search_index">search_index</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/spectrum">spectrum</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/spending">spending</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/treasury">treasury</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/treasury_maturities">treasury_maturities</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/trust">trust</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/usbonds">usbonds</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/economy/valuation">valuation</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/sdk/reference/etf">etf</a><button aria-label="Toggle the collapsible sidebar category 'etf'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/sdk/reference/fixedincome">fixedincome</a><button aria-label="Toggle the collapsible sidebar category 'fixedincome'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/sdk/reference/forecast">forecast</a><button aria-label="Toggle the collapsible sidebar category 'forecast'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/sdk/reference/forex">forex</a><button aria-label="Toggle the collapsible sidebar category 'forex'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/sdk/reference/futures">futures</a><button aria-label="Toggle the collapsible sidebar category 'futures'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/sdk/reference/keys">keys</a><button aria-label="Toggle the collapsible sidebar category 'keys'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/login">login</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/logout">logout</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/news">news</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/sdk/reference/portfolio">portfolio</a><button aria-label="Toggle the collapsible sidebar category 'portfolio'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/sdk/reference/qa">qa</a><button aria-label="Toggle the collapsible sidebar category 'qa'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/sdk/reference/stocks">stocks</a><button aria-label="Toggle the collapsible sidebar category 'stocks'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/sdk/reference/ta">ta</a><button aria-label="Toggle the collapsible sidebar category 'ta'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/reference/whoami">whoami</a></li></ul></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/sdk/showcase">Showcase</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/bot">OpenBB Bot</a><button aria-label="Toggle the collapsible sidebar category 'OpenBB Bot'" type="button" class="clean-btn menu__caret"></button></div></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/sdk"><span itemprop="name">OpenBB SDK</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/sdk/reference"><span itemprop="name">SDK Reference</span></a><meta itemprop="position" content="2"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">economy</span><meta itemprop="position" content="3"></li></ul></nav><div class="theme-doc-markdown markdown"><h1>economy</h1><ul class="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6"><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/available_indices"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">available_indices</p><p class="text-grey-200 text-xs mt-2 mb-0">Get available indices</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/balance"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">balance</p><p class="text-grey-200 text-xs mt-2 mb-0">General government deficit is defined as the balance of income and expenditure of government,</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/bigmac"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">bigmac</p><p class="text-grey-200 text-xs mt-2 mb-0">Display Big Mac Index for given countries</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/ccpi"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">ccpi</p><p class="text-grey-200 text-xs mt-2 mb-0">Inflation measured by consumer price index (CPI) is defined as the change in the prices</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/country_codes"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">country_codes</p><p class="text-grey-200 text-xs mt-2 mb-0">Get available country codes for Bigmac index</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/cpi"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">cpi</p><p class="text-grey-200 text-xs mt-2 mb-0">Obtain CPI data from FRED. [Source: FRED]</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/currencies"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">currencies</p><p class="text-grey-200 text-xs mt-2 mb-0">Scrape data for global currencies</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/debt"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">debt</p><p class="text-grey-200 text-xs mt-2 mb-0">General government debt-to-GDP ratio measures the gross debt of the general</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/events"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">events</p><p class="text-grey-200 text-xs mt-2 mb-0">Get economic calendar for countries between specified dates</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/fgdp"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">fgdp</p><p class="text-grey-200 text-xs mt-2 mb-0">Real gross domestic product (GDP) is GDP given in constant prices and</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/fred"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">fred</p><p class="text-grey-200 text-xs mt-2 mb-0">Get Series data. [Source: FRED]</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/fred_notes"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">fred_notes</p><p class="text-grey-200 text-xs mt-2 mb-0">Get series notes. [Source: FRED]</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/future"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">future</p><p class="text-grey-200 text-xs mt-2 mb-0">Get futures data. [Source: Finviz]</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/futures"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">futures</p><p class="text-grey-200 text-xs mt-2 mb-0">Get futures data.</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/gdp"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">gdp</p><p class="text-grey-200 text-xs mt-2 mb-0">Gross domestic product (GDP) is the standard measure of the value added created</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/get_groups"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">get_groups</p><p class="text-grey-200 text-xs mt-2 mb-0">Get group available</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/glbonds"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">glbonds</p><p class="text-grey-200 text-xs mt-2 mb-0">Scrape data for global bonds</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/index_cmd"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">index_cmd</p><p class="text-grey-200 text-xs mt-2 mb-0">Get data on selected indices over time [Source: Yahoo Finance]</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/indices"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">indices</p><p class="text-grey-200 text-xs mt-2 mb-0">Get the top US indices</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/macro"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">macro</p><p class="text-grey-200 text-xs mt-2 mb-0">This functions groups the data queried from the EconDB database [Source: EconDB]</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/macro_countries"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">macro_countries</p><p class="text-grey-200 text-xs mt-2 mb-0">This function returns the available countries and respective currencies.</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/macro_parameters"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">macro_parameters</p><p class="text-grey-200 text-xs mt-2 mb-0">This function returns the available macro parameters with detail.</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/overview"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">overview</p><p class="text-grey-200 text-xs mt-2 mb-0">Scrape data for market overview</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/perfmap"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">perfmap</p><p class="text-grey-200 text-xs mt-2 mb-0">Opens Finviz map website in a browser. [Source: Finviz]</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/performance"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">performance</p><p class="text-grey-200 text-xs mt-2 mb-0">Get group (sectors, industry or country) performance data. [Source: Finviz]</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/revenue"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">revenue</p><p class="text-grey-200 text-xs mt-2 mb-0">Governments collect revenues mainly for two purposes: to finance the goods</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/rgdp"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">rgdp</p><p class="text-grey-200 text-xs mt-2 mb-0">Gross domestic product (GDP) is the standard measure of the value added</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/rtps"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">rtps</p><p class="text-grey-200 text-xs mt-2 mb-0">Get real-time performance sector data</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/search_index"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"></div><p class="py-2 font-bold text-lg my-0">search_index</p><p class="text-grey-200 text-xs mt-2 mb-0">Search indices by keyword. [Source: FinanceDatabase]</p></a><a class="rounded border-2 !no-underline border-grey-600 p-6 cursor-pointer relative overflow-hidden hover:shadow-2xl hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-2xl bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]" href="/sdk/reference/economy/spectrum"><div class="absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent">& |