mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-21 00:31:53 +00:00
1 line
61 KiB
JavaScript
1 line
61 KiB
JavaScript
"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[50168],{3905:(t,e,a)=>{a.d(e,{Zo:()=>d,kt:()=>N});var r=a(67294);function n(t,e,a){return e in t?Object.defineProperty(t,e,{value:a,enumerable:!0,configurable:!0,writable:!0}):t[e]=a,t}function i(t,e){var a=Object.keys(t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(t);e&&(r=r.filter((function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable}))),a.push.apply(a,r)}return a}function l(t){for(var e=1;e<arguments.length;e++){var a=null!=arguments[e]?arguments[e]:{};e%2?i(Object(a),!0).forEach((function(e){n(t,e,a[e])})):Object.getOwnPropertyDescriptors?Object.defineProperties(t,Object.getOwnPropertyDescriptors(a)):i(Object(a)).forEach((function(e){Object.defineProperty(t,e,Object.getOwnPropertyDescriptor(a,e))}))}return t}function p(t,e){if(null==t)return{};var a,r,n=function(t,e){if(null==t)return{};var a,r,n={},i=Object.keys(t);for(r=0;r<i.length;r++)a=i[r],e.indexOf(a)>=0||(n[a]=t[a]);return n}(t,e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(t);for(r=0;r<i.length;r++)a=i[r],e.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(t,a)&&(n[a]=t[a])}return n}var g=r.createContext({}),m=function(t){var e=r.useContext(g),a=e;return t&&(a="function"==typeof t?t(e):l(l({},e),t)),a},d=function(t){var e=m(t.components);return r.createElement(g.Provider,{value:e},t.children)},o={inlineCode:"code",wrapper:function(t){var e=t.children;return r.createElement(r.Fragment,{},e)}},k=r.forwardRef((function(t,e){var a=t.components,n=t.mdxType,i=t.originalType,g=t.parentName,d=p(t,["components","mdxType","originalType","parentName"]),k=m(a),N=n,h=k["".concat(g,".").concat(N)]||k[N]||o[N]||i;return a?r.createElement(h,l(l({ref:e},d),{},{components:a})):r.createElement(h,l({ref:e},d))}));function N(t,e){var a=arguments,n=e&&e.mdxType;if("string"==typeof t||n){var i=a.length,l=new Array(i);l[0]=k;var p={};for(var g in e)hasOwnProperty.call(e,g)&&(p[g]=e[g]);p.originalType=t,p.mdxType="string"==typeof t?t:n,l[1]=p;for(var m=2;m<i;m++)l[m]=a[m];return r.createElement.apply(null,l)}return r.createElement.apply(null,a)}k.displayName="MDXCreateElement"},66061:(t,e,a)=>{a.r(e),a.d(e,{assets:()=>g,contentTitle:()=>l,default:()=>o,frontMatter:()=>i,metadata:()=>p,toc:()=>m});var r=a(87462),n=(a(67294),a(3905));const i={title:"Economy"},l=void 0,p={unversionedId:"guides/intros/economy",id:"guides/intros/economy",title:"Economy",description:"The Economy module wraps the functions from the Economy menu of the OpenBB Terminal, and provides the user with more control over their workflow. In a Jupyter Notebook environment, it is quick and easy to get going. To get the most out of these functions, it is highly recommended to acquire API keys for:",source:"@site/content/sdk/guides/intros/economy.md",sourceDirName:"guides/intros",slug:"/guides/intros/economy",permalink:"/sdk/guides/intros/economy",draft:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/sdk/guides/intros/economy.md",tags:[],version:"current",frontMatter:{title:"Economy"},sidebar:"tutorialSidebar",previous:{title:"Econometrics",permalink:"/sdk/guides/intros/econometrics"},next:{title:"ETF",permalink:"/sdk/guides/intros/etf"}},g={},m=[{value:"How to Use",id:"how-to-use",level:2},{value:"Examples",id:"examples",level:2},{value:"Import Statements",id:"import-statements",level:3},{value:"Index",id:"index",level:3},{value:"Performance",id:"performance",level:3},{value:"Events",id:"events",level:3},{value:"FRED",id:"fred",level:3},{value:"Macro",id:"macro",level:3}],d={toc:m};function o(t){let{components:e,...a}=t;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:e,mdxType:"MDXLayout"}),(0,n.kt)("p",null,"The Economy module wraps the functions from the Economy menu of the OpenBB Terminal, and provides the user with more control over their workflow. In a Jupyter Notebook environment, it is quick and easy to get going. To get the most out of these functions, it is highly recommended to acquire API keys for:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"https://fred.stlouisfed.org"},"FRED")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"https://data.nasdaq.com"},"Quandl/Nasdaq Data Link")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"https://www.alphavantage.co/"},"AlphaVantage"))),(0,n.kt)("p",null,"Define the keys for the OpenBB installation with:"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-python"},"\nopenbb.keys.fred(key = 'REPLACE_ME', persist = True)\nopenbb.keys.quandl(key = 'REPLACE_ME', persist = True)\nopenbb.keys.av(key = 'REPLACE_ME', persist = True)\n")),(0,n.kt)("h2",{id:"how-to-use"},"How to Use"),(0,n.kt)("p",null,"Below is brief description of each function within the Economy module:"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Path"),(0,n.kt)("th",{parentName:"tr",align:"center"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"right"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.available_indices"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Dictionary"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Curated List of Global Indices")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.bigmac"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"The Big Mac Index")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.bigmac_chart"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Chart for ",(0,n.kt)("inlineCode",{parentName:"td"},"bigmac"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.country_codes"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"List of Three-Letter ISO Country Codes")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.cpi"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Monthly US CPI from AlphaVantage")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.cpi_chart"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Chart for ",(0,n.kt)("inlineCode",{parentName:"td"},"cpi"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.currencies"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Currencies from WSJ")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.events"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Economic Calendar")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.fred_ids"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Search for a FRED series ID by keyword")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.fred_notes"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Search by Keyword for Series Information")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.futures"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Current Prices of Commodities")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.gdpc"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"US GDP per Capita from AlphaVantage")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.gdpc_chart"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Chart for ",(0,n.kt)("inlineCode",{parentName:"td"},"gdpc"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.get_events_countries"),(0,n.kt)("td",{parentName:"tr",align:"center"},"List"),(0,n.kt)("td",{parentName:"tr",align:"right"},"List of Countries for Events Function")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.get_groups"),(0,n.kt)("td",{parentName:"tr",align:"center"},"List"),(0,n.kt)("td",{parentName:"tr",align:"right"},"List of Groups for Performance and Valuation Functions")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.glbonds"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Table of Select 10 Year Sovereign Bonds from WSJ")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.indices"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Top US Indices from WSJ")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.index"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Historical Daily Data for Indices from YahooFinance")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.index_chart"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Chart for ",(0,n.kt)("inlineCode",{parentName:"td"},"index"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.inf"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"US Inflation Prints from AlphaVantage")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.inf_chart"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Chart for ",(0,n.kt)("inlineCode",{parentName:"td"},"inf"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.macro"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Gets Series Data from EconDB")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.macro_chart"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Chart for ",(0,n.kt)("inlineCode",{parentName:"td"},"macro"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.macro_countries"),(0,n.kt)("td",{parentName:"tr",align:"center"},"List"),(0,n.kt)("td",{parentName:"tr",align:"right"},"List of Countries Accepted by Macro Function")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.macro_parameters"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Dictionary"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Dictionary of Parameters & Descriptions for Macro Function")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.overview"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"General Market Overview from WSJ")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.perfmap"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Opens a Browser to Performance Map from Finviz")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.performance"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Performance Data (get_groups)")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.rtps"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Real-Time Performance by Sector (US Markets) from AlphaVantage")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.rtps_chart"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Chart of ",(0,n.kt)("inlineCode",{parentName:"td"},"rtps"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.search_index"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Search for a Global Index by Name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.treasury"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"US Treasuries Data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.treasury_chart"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Chart for ",(0,n.kt)("inlineCode",{parentName:"td"},"treasury"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.treasury_maturities"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Table of Accepted Values for Maturities Argument in ",(0,n.kt)("inlineCode",{parentName:"td"},"treasury"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.tyld"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Historical Treasury Yields from AlphaVantage")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.tyld_chart"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Chart of ",(0,n.kt)("inlineCode",{parentName:"td"},"tyld"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.unemp"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Historical US Unemployment Data from AlphaVantage")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.unemp_chart"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Chart of ",(0,n.kt)("inlineCode",{parentName:"td"},"unemp"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.usbonds"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Table of Current Rate, Yield, and Yield Change")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.valuation"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Valuation for Group from (get_gropus)")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.ycrv"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Current and Historical US Yield Curve Data from FRED")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"openbb.economy.ycrv_chart"),(0,n.kt)("td",{parentName:"tr",align:"center"},"Function"),(0,n.kt)("td",{parentName:"tr",align:"right"},"Chart for ",(0,n.kt)("inlineCode",{parentName:"td"},"ycrv"))))),(0,n.kt)("p",null,"Alternatively, the contents of the economy, or function docstrings, is printed with:"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-python"},"help(openbb.economy)\n")),(0,n.kt)("h2",{id:"examples"},"Examples"),(0,n.kt)("h3",{id:"import-statements"},"Import Statements"),(0,n.kt)("p",null,"The examples will assume that this code block is included with the import statements:"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-python"},"from openbb_terminal.sdk import openbb\nimport pandas as pd\n%matplotlib inline\n")),(0,n.kt)("h3",{id:"index"},"Index"),(0,n.kt)("p",null,"The ",(0,n.kt)("inlineCode",{parentName:"p"},"index")," function can request data using a couple of methods. There is a curated list of global indexes which can be entered by symbol or values from the left column of the table below."),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-python"},"indexes = pd.DataFrame.from_dict(openbb.economy.available_indices()).transpose()\n\nindexes\n")),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"}),(0,n.kt)("th",{parentName:"tr",align:"left"},"name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"ticker"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"sp500"),(0,n.kt)("td",{parentName:"tr",align:"left"},"S&P 500 Index"),(0,n.kt)("td",{parentName:"tr",align:"left"},"^GSPC")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"sp400"),(0,n.kt)("td",{parentName:"tr",align:"left"},"S&P 400 Mid Cap Index"),(0,n.kt)("td",{parentName:"tr",align:"left"},"^SP400")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"sp600"),(0,n.kt)("td",{parentName:"tr",align:"left"},"S&P 600 Small Cap Index"),(0,n.kt)("td",{parentName:"tr",align:"left"},"^SP600")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"sp500tr"),(0,n.kt)("td",{parentName:"tr",align:"left"},"S&P 500 TR Index"),(0,n.kt)("td",{parentName:"tr",align:"left"},"^SP500TR")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"sp_xsp"),(0,n.kt)("td",{parentName:"tr",align:"left"},"S&P 500 Mini SPX Options Index"),(0,n.kt)("td",{parentName:"tr",align:"left"},"^XSP")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"cboe_tyx"),(0,n.kt)("td",{parentName:"tr",align:"left"},"CBOE 30 year Treasury Yields"),(0,n.kt)("td",{parentName:"tr",align:"left"},"^TYX")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"cboe_irx"),(0,n.kt)("td",{parentName:"tr",align:"left"},"CBOE 13 Week Treasury Bill"),(0,n.kt)("td",{parentName:"tr",align:"left"},"^IRX")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"move"),(0,n.kt)("td",{parentName:"tr",align:"left"},"ICE BofAML Move Index"),(0,n.kt)("td",{parentName:"tr",align:"left"},"^MOVE")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"dxy"),(0,n.kt)("td",{parentName:"tr",align:"left"},"US Dollar Index"),(0,n.kt)("td",{parentName:"tr",align:"left"},"DX-Y.NYB")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"crypto200"),(0,n.kt)("td",{parentName:"tr",align:"left"},"CMC Crypto 200 Index by Solacti"),(0,n.kt)("td",{parentName:"tr",align:"left"},"^CMC200")))),(0,n.kt)("p",null,"This list can be filtered:"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-python"},"indexes.filter(like = 'sp_', axis = 0)\n")),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"}),(0,n.kt)("th",{parentName:"tr",align:"left"},"name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"ticker"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"sp_xsp"),(0,n.kt)("td",{parentName:"tr",align:"left"},"S&P 500 Mini SPX Options Index"),(0,n.kt)("td",{parentName:"tr",align:"left"},"^XSP")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"sp_energy_ig"),(0,n.kt)("td",{parentName:"tr",align:"left"},"S&P 500 Energy (Industry Group) Index"),(0,n.kt)("td",{parentName:"tr",align:"left"},"^SP500-1010")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"sp_energy_equipment"),(0,n.kt)("td",{parentName:"tr",align:"left"},"S&P 500 Energy Equipment & Services Industry Index"),(0,n.kt)("td",{parentName:"tr",align:"left"},"^SP500-101010")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"sp_energy_oil"),(0,n.kt)("td",{parentName:"tr",align:"left"},"S&P 500 Oil, Gas & Consumable Fuels Industry Index"),(0,n.kt)("td",{parentName:"tr",align:"left"},"^SP500-101020")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"sp_materials_sector"),(0,n.kt)("td",{parentName:"tr",align:"left"},"S&P 500 Materials Sector Index"),(0,n.kt)("td",{parentName:"tr",align:"left"},"^SP500-15")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"sp_utilities_sector"),(0,n.kt)("td",{parentName:"tr",align:"left"},"S&P 500 Utilities Sector Index"),(0,n.kt)("td",{parentName:"tr",align:"left"},"^SP500-55")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"sp_utilities_electricity"),(0,n.kt)("td",{parentName:"tr",align:"left"},"S&P 500 Electric Utilities Index"),(0,n.kt)("td",{parentName:"tr",align:"left"},"^SP500-551010")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"sp_utilities_multis"),(0,n.kt)("td",{parentName:"tr",align:"left"},"S&P 500 Multi-Utilities Industry Index"),(0,n.kt)("td",{parentName:"tr",align:"left"},"^SP500-551030")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"sp_re_sector"),(0,n.kt)("td",{parentName:"tr",align:"left"},"S&P 500 Real Estate Sector Index"),(0,n.kt)("td",{parentName:"tr",align:"left"},"^SP500-60")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"sp_re_ig"),(0,n.kt)("td",{parentName:"tr",align:"left"},"S&P 500 Real Estate (Industry Group) Index"),(0,n.kt)("td",{parentName:"tr",align:"left"},"^SP500-6010")))),(0,n.kt)("p",null,"One index, or multiple, can be requested as a single DataFrame:"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-python"},"df = openbb.economy.index(indices = ['sp_energy_oil', 'sp_energy_equipment', 'sp_energy_ig'])\n\ndf.tail(3)\n")),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Date"),(0,n.kt)("th",{parentName:"tr",align:"right"},"sp_energy_oil"),(0,n.kt)("th",{parentName:"tr",align:"right"},"sp_energy_equipment"),(0,n.kt)("th",{parentName:"tr",align:"right"},"sp_energy_ig"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-11-14 00:00:00"),(0,n.kt)("td",{parentName:"tr",align:"right"},"800.76"),(0,n.kt)("td",{parentName:"tr",align:"right"},"330.53"),(0,n.kt)("td",{parentName:"tr",align:"right"},"712.28")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-11-15 00:00:00"),(0,n.kt)("td",{parentName:"tr",align:"right"},"809.27"),(0,n.kt)("td",{parentName:"tr",align:"right"},"335.84"),(0,n.kt)("td",{parentName:"tr",align:"right"},"720.16")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-11-16 00:00:00"),(0,n.kt)("td",{parentName:"tr",align:"right"},"792.32"),(0,n.kt)("td",{parentName:"tr",align:"right"},"326.49"),(0,n.kt)("td",{parentName:"tr",align:"right"},"704.68")))),(0,n.kt)("p",null,"This can also be displayed as a chart:"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-python"},"openbb.economy.index_chart(indices = ['sp_energy_oil', 'sp_energy_equipment', 'sp_energy_ig'])\n")),(0,n.kt)("p",null,(0,n.kt)("img",{parentName:"p",src:"https://user-images.githubusercontent.com/85772166/202557572-b67f35e1-a17a-4724-83b3-1b1175e0445d.png",alt:"openbb.economy.index_chart",title:"openbb.economy.index_chart"})),(0,n.kt)("h3",{id:"performance"},"Performance"),(0,n.kt)("p",null,"Performance metrics for sectors, industries, and regions (US listed) are printed with:"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-python"},"openbb.economy.performance(group = 'energy')\n")),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"right"}),(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"right"},"Week"),(0,n.kt)("th",{parentName:"tr",align:"right"},"Month"),(0,n.kt)("th",{parentName:"tr",align:"right"},"3Month"),(0,n.kt)("th",{parentName:"tr",align:"right"},"6Month"),(0,n.kt)("th",{parentName:"tr",align:"right"},"1Year"),(0,n.kt)("th",{parentName:"tr",align:"right"},"YTD"),(0,n.kt)("th",{parentName:"tr",align:"right"},"Recom"),(0,n.kt)("th",{parentName:"tr",align:"right"},"AvgVolume ","[1M]"),(0,n.kt)("th",{parentName:"tr",align:"right"},"RelVolume"),(0,n.kt)("th",{parentName:"tr",align:"right"},"Change"),(0,n.kt)("th",{parentName:"tr",align:"right"},"Volume ","[1M]"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"0"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Oil & Gas Drilling"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0106"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.2154"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.2501"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.1534"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.711"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.8991"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1.92"),(0,n.kt)("td",{parentName:"tr",align:"right"},"33.58"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.71"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.013"),(0,n.kt)("td",{parentName:"tr",align:"right"},"16.93")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"1"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Oil & Gas E&P"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0019"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0618"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.1188"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.15"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.6602"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.6922"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.18"),(0,n.kt)("td",{parentName:"tr",align:"right"},"287.09"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.66"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0059"),(0,n.kt)("td",{parentName:"tr",align:"right"},"136.36")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"2"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Oil & Gas Equipment & Services"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0063"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.1613"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.305"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.1219"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.493"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.5702"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.1"),(0,n.kt)("td",{parentName:"tr",align:"right"},"74.1"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.52"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0125"),(0,n.kt)("td",{parentName:"tr",align:"right"},"27.79")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"3"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Oil & Gas Integrated"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0166"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0557"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0885"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0462"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.4014"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.4114"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.23"),(0,n.kt)("td",{parentName:"tr",align:"right"},"122.44"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.71"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0079"),(0,n.kt)("td",{parentName:"tr",align:"right"},"62.12")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"4"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Oil & Gas Midstream"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0113"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.038"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.019"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0045"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.1551"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.2027"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.3"),(0,n.kt)("td",{parentName:"tr",align:"right"},"105.55"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.65"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0115"),(0,n.kt)("td",{parentName:"tr",align:"right"},"48.8")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"5"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Oil & Gas Refining & Marketing"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0147"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0929"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.1562"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.1585"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.6038"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.6084"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.13"),(0,n.kt)("td",{parentName:"tr",align:"right"},"30.59"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.61"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0006"),(0,n.kt)("td",{parentName:"tr",align:"right"},"13.32")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"6"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Thermal Coal"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0096"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0291"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0494"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.1289"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1.2305"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1.0504"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1.97"),(0,n.kt)("td",{parentName:"tr",align:"right"},"8.74"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.69"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0207"),(0,n.kt)("td",{parentName:"tr",align:"right"},"4.28")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"7"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Uranium"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0176"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0416"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0856"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0426"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.1746"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0267"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1.61"),(0,n.kt)("td",{parentName:"tr",align:"right"},"32.44"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.54"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0125"),(0,n.kt)("td",{parentName:"tr",align:"right"},"12.58")))),(0,n.kt)("p",null,"Performance by sector:"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-python"},"openbb.economy.performance(group = 'sector')\n")),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"right"}),(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"right"},"Week"),(0,n.kt)("th",{parentName:"tr",align:"right"},"Month"),(0,n.kt)("th",{parentName:"tr",align:"right"},"3Month"),(0,n.kt)("th",{parentName:"tr",align:"right"},"6Month"),(0,n.kt)("th",{parentName:"tr",align:"right"},"1Year"),(0,n.kt)("th",{parentName:"tr",align:"right"},"YTD"),(0,n.kt)("th",{parentName:"tr",align:"right"},"Recom"),(0,n.kt)("th",{parentName:"tr",align:"right"},"AvgVolume ","[1M]"),(0,n.kt)("th",{parentName:"tr",align:"right"},"RelVolume"),(0,n.kt)("th",{parentName:"tr",align:"right"},"Change"),(0,n.kt)("th",{parentName:"tr",align:"right"},"Volume ","[1M]"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"0"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Basic Materials"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0032"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.129"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0195"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0572"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0684"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0928"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.22"),(0,n.kt)("td",{parentName:"tr",align:"right"},"469.94"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.66"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0116"),(0,n.kt)("td",{parentName:"tr",align:"right"},"222.2")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"1"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Communication Services"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0343"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0128"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.1444"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.1297"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.3837"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.3529"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1.97"),(0,n.kt)("td",{parentName:"tr",align:"right"},"731.34"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.72"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0004"),(0,n.kt)("td",{parentName:"tr",align:"right"},"377.12")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"2"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Consumer Cyclical"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0111"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0266"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.1386"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0182"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.3665"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.3221"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.14"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1430"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1.01"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0034"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1040")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"3"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Consumer Defensive"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.003"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0757"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0302"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0573"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.019"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0574"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.31"),(0,n.kt)("td",{parentName:"tr",align:"right"},"298.74"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.85"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0019"),(0,n.kt)("td",{parentName:"tr",align:"right"},"181.95")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"4"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Energy"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0067"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0629"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0913"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0736"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.4208"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.4497"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.21"),(0,n.kt)("td",{parentName:"tr",align:"right"},"694.52"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.65"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.008"),(0,n.kt)("td",{parentName:"tr",align:"right"},"322.19")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"5"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Financial"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0095"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0934"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0098"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0339"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.1259"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.1137"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.24"),(0,n.kt)("td",{parentName:"tr",align:"right"},"861.74"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.79"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.005"),(0,n.kt)("td",{parentName:"tr",align:"right"},"489.78")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"6"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Healthcare"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0121"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0703"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0125"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0177"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.1074"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.1161"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.11"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1180"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.87"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0002"),(0,n.kt)("td",{parentName:"tr",align:"right"},"736.58")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"7"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Industrials"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0118"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0969"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0223"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0723"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.1138"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.101"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.32"),(0,n.kt)("td",{parentName:"tr",align:"right"},"573.08"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.7"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.005"),(0,n.kt)("td",{parentName:"tr",align:"right"},"285.24")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"8"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Real Estate"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0259"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0884"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.1441"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0961"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.2413"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.2738"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.18"),(0,n.kt)("td",{parentName:"tr",align:"right"},"341.84"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.55"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0055"),(0,n.kt)("td",{parentName:"tr",align:"right"},"134.66")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"9"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Technology"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0149"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0938"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.1095"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0044"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.3024"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.2957"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.03"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1460"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.86"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0039"),(0,n.kt)("td",{parentName:"tr",align:"right"},"904.44")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"10"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Utilities"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0235"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.0485"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.1212"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0582"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0054"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0569"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.29"),(0,n.kt)("td",{parentName:"tr",align:"right"},"166.21"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.67"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.0142"),(0,n.kt)("td",{parentName:"tr",align:"right"},"79.25")))),(0,n.kt)("h3",{id:"events"},"Events"),(0,n.kt)("p",null,"A global economic calendar is accessible through the ",(0,n.kt)("inlineCode",{parentName:"p"},"events")," function:"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-python"},"help(openbb.economy.events)\n\nHelp on Operation in module openbb_terminal.core.library.operation:\n\n<openbb_terminal.core.library.operation.Operation object>\n Get economic calendar for countries between specified dates\n\n Parameters\n ----------\n countries : [List[str],str]\n List of countries to include in calendar. Empty returns all\n start_date : str\n Start date for calendar\n end_date : str\n End date for calendar\n\n Returns\n -------\n pd.DataFrame\n Economic calendar\n")),(0,n.kt)("p",null,"With no arguments, ",(0,n.kt)("inlineCode",{parentName:"p"},"events")," will return the calendar from today:"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-python"},"openbb.economy.events()\n")),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"right"}),(0,n.kt)("th",{parentName:"tr",align:"left"},"Time (GMT)"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Country"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Event"),(0,n.kt)("th",{parentName:"tr",align:"left"},"actual"),(0,n.kt)("th",{parentName:"tr",align:"left"},"consensus"),(0,n.kt)("th",{parentName:"tr",align:"left"},"previous"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Date"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"0"),(0,n.kt)("td",{parentName:"tr",align:"left"},"02:00"),(0,n.kt)("td",{parentName:"tr",align:"left"},"United Kingdom"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Car Registration"),(0,n.kt)("td",{parentName:"tr",align:"left"},"-40.4%"),(0,n.kt)("td",{parentName:"tr",align:"left"},"-"),(0,n.kt)("td",{parentName:"tr",align:"left"},"227.2%"),(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-11-17")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"1"),(0,n.kt)("td",{parentName:"tr",align:"left"},"02:00"),(0,n.kt)("td",{parentName:"tr",align:"left"},"United Kingdom"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Car Registration"),(0,n.kt)("td",{parentName:"tr",align:"left"},"26.4%"),(0,n.kt)("td",{parentName:"tr",align:"left"},"-"),(0,n.kt)("td",{parentName:"tr",align:"left"},"4.6%"),(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-11-17")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"2"),(0,n.kt)("td",{parentName:"tr",align:"left"},"02:00"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Italy"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Italian Car Registration"),(0,n.kt)("td",{parentName:"tr",align:"left"},"14.6%"),(0,n.kt)("td",{parentName:"tr",align:"left"},"-"),(0,n.kt)("td",{parentName:"tr",align:"left"},"5.4%"),(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-11-17")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"3"),(0,n.kt)("td",{parentName:"tr",align:"left"},"02:00"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Italy"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Italian Car Registration"),(0,n.kt)("td",{parentName:"tr",align:"left"},"4.4%"),(0,n.kt)("td",{parentName:"tr",align:"left"},"-"),(0,n.kt)("td",{parentName:"tr",align:"left"},"55.9%"),(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-11-17")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"4"),(0,n.kt)("td",{parentName:"tr",align:"left"},"02:00"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Switzerland"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Trade Balance"),(0,n.kt)("td",{parentName:"tr",align:"left"},"4.140B"),(0,n.kt)("td",{parentName:"tr",align:"left"},"-"),(0,n.kt)("td",{parentName:"tr",align:"left"},"4.193B"),(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-11-17")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"56"),(0,n.kt)("td",{parentName:"tr",align:"left"},"13:00"),(0,n.kt)("td",{parentName:"tr",align:"left"},"United States"),(0,n.kt)("td",{parentName:"tr",align:"left"},"10-Year TIPS Auction"),(0,n.kt)("td",{parentName:"tr",align:"left"},"1.485%"),(0,n.kt)("td",{parentName:"tr",align:"left"},"-"),(0,n.kt)("td",{parentName:"tr",align:"left"},"1.248%"),(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-11-17")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"57"),(0,n.kt)("td",{parentName:"tr",align:"left"},"18:30"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Japan"),(0,n.kt)("td",{parentName:"tr",align:"left"},"CPI, n.s.a"),(0,n.kt)("td",{parentName:"tr",align:"left"},"-"),(0,n.kt)("td",{parentName:"tr",align:"left"},"-"),(0,n.kt)("td",{parentName:"tr",align:"left"},"0.4%"),(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-11-17")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"58"),(0,n.kt)("td",{parentName:"tr",align:"left"},"18:30"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Japan"),(0,n.kt)("td",{parentName:"tr",align:"left"},"National Core CPI"),(0,n.kt)("td",{parentName:"tr",align:"left"},"-"),(0,n.kt)("td",{parentName:"tr",align:"left"},"3.5%"),(0,n.kt)("td",{parentName:"tr",align:"left"},"3.0%"),(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-11-17")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"59"),(0,n.kt)("td",{parentName:"tr",align:"left"},"18:30"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Japan"),(0,n.kt)("td",{parentName:"tr",align:"left"},"National CPI"),(0,n.kt)("td",{parentName:"tr",align:"left"},"-"),(0,n.kt)("td",{parentName:"tr",align:"left"},"-"),(0,n.kt)("td",{parentName:"tr",align:"left"},"3.0%"),(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-11-17")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"60"),(0,n.kt)("td",{parentName:"tr",align:"left"},"19:01"),(0,n.kt)("td",{parentName:"tr",align:"left"},"United Kingdom"),(0,n.kt)("td",{parentName:"tr",align:"left"},"GfK Consumer Confidence"),(0,n.kt)("td",{parentName:"tr",align:"left"},"-"),(0,n.kt)("td",{parentName:"tr",align:"left"},"-52"),(0,n.kt)("td",{parentName:"tr",align:"left"},"-47"),(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-11-17")))),(0,n.kt)("p",null,"Calendar events can be requested for a specific countries and date ranges:"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-python"},"openbb.economy.events(countries = ['United States'], start_date = '2022-11-18', end_date = '2022-11-18')\n")),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"right"}),(0,n.kt)("th",{parentName:"tr",align:"left"},"Time (GMT)"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Country"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Event"),(0,n.kt)("th",{parentName:"tr",align:"left"},"actual"),(0,n.kt)("th",{parentName:"tr",align:"left"},"consensus"),(0,n.kt)("th",{parentName:"tr",align:"left"},"previous"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Date"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"0"),(0,n.kt)("td",{parentName:"tr",align:"left"},"10:00"),(0,n.kt)("td",{parentName:"tr",align:"left"},"United States"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Existing Home Sales"),(0,n.kt)("td",{parentName:"tr",align:"left"},"-"),(0,n.kt)("td",{parentName:"tr",align:"left"},"4.38M"),(0,n.kt)("td",{parentName:"tr",align:"left"},"4.71M"),(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-11-18")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"1"),(0,n.kt)("td",{parentName:"tr",align:"left"},"10:00"),(0,n.kt)("td",{parentName:"tr",align:"left"},"United States"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Existing Home Sales"),(0,n.kt)("td",{parentName:"tr",align:"left"},"-"),(0,n.kt)("td",{parentName:"tr",align:"left"},"-"),(0,n.kt)("td",{parentName:"tr",align:"left"},"-1.5%"),(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-11-18")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"2"),(0,n.kt)("td",{parentName:"tr",align:"left"},"10:00"),(0,n.kt)("td",{parentName:"tr",align:"left"},"United States"),(0,n.kt)("td",{parentName:"tr",align:"left"},"US Leading Index"),(0,n.kt)("td",{parentName:"tr",align:"left"},"-"),(0,n.kt)("td",{parentName:"tr",align:"left"},"-0.4%"),(0,n.kt)("td",{parentName:"tr",align:"left"},"-0.4%"),(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-11-18")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"3"),(0,n.kt)("td",{parentName:"tr",align:"left"},"13:00"),(0,n.kt)("td",{parentName:"tr",align:"left"},"United States"),(0,n.kt)("td",{parentName:"tr",align:"left"},"U.S. Baker Hughes Oil Rig Count"),(0,n.kt)("td",{parentName:"tr",align:"left"},"-"),(0,n.kt)("td",{parentName:"tr",align:"left"},"-"),(0,n.kt)("td",{parentName:"tr",align:"left"},"622"),(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-11-18")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"right"},"4"),(0,n.kt)("td",{parentName:"tr",align:"left"},"13:00"),(0,n.kt)("td",{parentName:"tr",align:"left"},"United States"),(0,n.kt)("td",{parentName:"tr",align:"left"},"U.S. Baker Hughes Total Rig Count"),(0,n.kt)("td",{parentName:"tr",align:"left"},"-"),(0,n.kt)("td",{parentName:"tr",align:"left"},"-"),(0,n.kt)("td",{parentName:"tr",align:"left"},"779"),(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-11-18")))),(0,n.kt)("h3",{id:"fred"},"FRED"),(0,n.kt)("p",null,"Search the FRED database for a series titles containing keywords:"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-python"},"series_ids = openbb.economy.fred_ids(search_query = 'Oil and Gas')\n\nseries_ids.head(5)\n")),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"id"),(0,n.kt)("th",{parentName:"tr",align:"left"},"title"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"PCU333132333132"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Producer Price Index by Industry: Oil and Gas Field Machinery and Equipment Manufacturing")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"CES1021100001"),(0,n.kt)("td",{parentName:"tr",align:"left"},"All Employees, Oil and Gas Extraction")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"IPG211111CS"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Industrial Production: Mining, Quarrying, and Oil and Gas Extraction: Crude Oil (NAICS = 211111pt.)")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"A33DNO"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Manufacturers' New Orders: Mining, Oil, and Gas Field Machinery Manufacturing")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"PCU21112111"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Producer Price Index by Industry: Oil and Gas Extraction")))),(0,n.kt)("h3",{id:"macro"},"Macro"),(0,n.kt)("p",null,"The ",(0,n.kt)("inlineCode",{parentName:"p"},"macro")," function will return a Tuple. See refer to the docstring below to see the input arguments:"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-python"},'help(openbb.economy.macro)\n\nHelp on Operation in module openbb_terminal.core.library.operation:\n\n<openbb_terminal.core.library.operation.Operation object>\n Use \'economy.macro_chart\' to access the view.\n This functions groups the data queried from the EconDB database [Source: EconDB]\n\n Parameters\n ----------\n parameters: list\n The type of data you wish to download. Available parameters can be accessed through economy.macro_parameters().\n countries : list\n The selected country or countries. Available countries can be accessed through economy.macro_countries().\n transform : str\n The selected transform. Available transforms can be accessed through get_macro_transform().\n start_date : str\n The starting date, format "YEAR-MONTH-DAY", i.e. 2010-12-31.\n end_date : str\n The end date, format "YEAR-MONTH-DAY", i.e. 2020-06-05.\n symbol : str\n In what currency you wish to convert all values.\n\n Returns\n -------\n Tuple[pd.DataFrame, Dict[Any, Dict[Any, Any]], str]\n A DataFrame with the requested macro data of all chosen countries,\n A dictionary containing the units of each country\'s parameter (e.g. EUR),\n A string denomination which can be Trillions, Billions, Millions, Thousands\n\n Examples\n --------\n >>> from openbb_terminal.sdk import openbb\n >>> macro_df = openbb.economy.macro()\n')),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"openbb.economy.macro_parameters()")," will return a list of dictionaries. Read it as a DataFrame with:"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-python"},"parameters = pd.DataFrame.from_dict(openbb.economy.macro_parameters()).transpose()\n\nparameters.tail(5)\n")),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"}),(0,n.kt)("th",{parentName:"tr",align:"left"},"name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"period"),(0,n.kt)("th",{parentName:"tr",align:"left"},"description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"Y10YD"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Long term yield (10-year)"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Monthly"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The 10-year yield is used as a proxy for mortgage rates. It's also seen as a sign of investor sentiment about the country's economy.")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"M3YD"),(0,n.kt)("td",{parentName:"tr",align:"left"},"3 month yield"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Monthly"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The yield received for investing in a government issued treasury security that has a maturity of 3 months")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"HOU"),(0,n.kt)("td",{parentName:"tr",align:"left"},"House price index"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Monthly"),(0,n.kt)("td",{parentName:"tr",align:"left"},"House price index defined with base 2015 for Europe with varying bases for others. See: ",(0,n.kt)("a",{parentName:"td",href:"https://www.econdb.com/main-indicators"},"https://www.econdb.com/main-indicators"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"OILPROD"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Oil production"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Monthly"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The amount of oil barrels produced per day in a month within a country.")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"POP"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Population"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Monthly"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The population of a country. This can be in thousands or, when relatively small, in actual units.")))),(0,n.kt)("p",null,"The data from the ",(0,n.kt)("inlineCode",{parentName:"p"},"macro")," function is unpacked like:"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-python"},"data,units,denomination = openbb.economy.macro(parameters = ['Y10YD'], countries = ['United States', 'Poland', 'France', 'Italy', 'Spain', 'Germany'])\n\ndata.tail(10)\n")),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"date"),(0,n.kt)("th",{parentName:"tr",align:"right"},"France"),(0,n.kt)("th",{parentName:"tr",align:"right"},"Germany"),(0,n.kt)("th",{parentName:"tr",align:"right"},"Italy"),(0,n.kt)("th",{parentName:"tr",align:"right"},"Poland"),(0,n.kt)("th",{parentName:"tr",align:"right"},"Spain"),(0,n.kt)("th",{parentName:"tr",align:"right"},"United States"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-01-01 00:00:00"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.31"),(0,n.kt)("td",{parentName:"tr",align:"right"},"-0.12"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1.35"),(0,n.kt)("td",{parentName:"tr",align:"right"},"4"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.66"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1.76")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-02-01 00:00:00"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.68"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.15"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1.79"),(0,n.kt)("td",{parentName:"tr",align:"right"},"3.95"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1.11"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1.93")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-03-01 00:00:00"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.78"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.28"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1.85"),(0,n.kt)("td",{parentName:"tr",align:"right"},"4.83"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1.22"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.13")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-04-01 00:00:00"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1.28"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.75"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.44"),(0,n.kt)("td",{parentName:"tr",align:"right"},"5.96"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1.69"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.75")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-05-01 00:00:00"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1.52"),(0,n.kt)("td",{parentName:"tr",align:"right"},"0.95"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.99"),(0,n.kt)("td",{parentName:"tr",align:"right"},"6.64"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.04"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.9")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-06-01 00:00:00"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.06"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1.45"),(0,n.kt)("td",{parentName:"tr",align:"right"},"3.64"),(0,n.kt)("td",{parentName:"tr",align:"right"},"7.14"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.63"),(0,n.kt)("td",{parentName:"tr",align:"right"},"3.14")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-07-01 00:00:00"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1.71"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1.08"),(0,n.kt)("td",{parentName:"tr",align:"right"},"3.36"),(0,n.kt)("td",{parentName:"tr",align:"right"},"6.37"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.31"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.9")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-08-01 00:00:00"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1.69"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1.03"),(0,n.kt)("td",{parentName:"tr",align:"right"},"3.3"),(0,n.kt)("td",{parentName:"tr",align:"right"},"5.8"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.15"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.9")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-09-01 00:00:00"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.41"),(0,n.kt)("td",{parentName:"tr",align:"right"},"1.8"),(0,n.kt)("td",{parentName:"tr",align:"right"},"4.14"),(0,n.kt)("td",{parentName:"tr",align:"right"},"6.28"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.92"),(0,n.kt)("td",{parentName:"tr",align:"right"},"3.52")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},"2022-10-01 00:00:00"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.77"),(0,n.kt)("td",{parentName:"tr",align:"right"},"2.19"),(0,n.kt)("td",{parentName:"tr",align:"right"},"4.53"),(0,n.kt)("td",{parentName:"tr",align:"right"},"7.82"),(0,n.kt)("td",{parentName:"tr",align:"right"},"3.29"),(0,n.kt)("td",{parentName:"tr",align:"right"},"3.98")))))}o.isMDXComponent=!0}}]); |