OpenBB/assets/js/b5b4f435.bfed46fb.js

"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[30802],{3905:(e,t,r)=>{r.d(t,{Zo:()=>u,kt:()=>f});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function l(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?l(Object(r),!0).forEach((function(t){a(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):l(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function i(e,t){if(null==e)return{};var r,n,a=function(e,t){if(null==e)return{};var r,n,a={},l=Object.keys(e);for(n=0;n<l.length;n++)r=l[n],t.indexOf(r)>=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n<l.length;n++)r=l[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),c=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},u=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,l=e.originalType,p=e.parentName,u=i(e,["components","mdxType","originalType","parentName"]),m=c(r),f=a,d=m["".concat(p,".").concat(f)]||m[f]||s[f]||l;return r?n.createElement(d,o(o({ref:t},u),{},{components:r})):n.createElement(d,o({ref:t},u))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=r.length,o=new Array(l);o[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i.mdxType="string"==typeof e?e:a,o[1]=i;for(var c=2;c<l;c++)o[c]=r[c];return n.createElement.apply(null,o)}return n.createElement.apply(null,r)}m.displayName="MDXCreateElement"},88210:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>l,metadata:()=>i,toc:()=>c});var n=r(87462),a=(r(67294),r(3905));const l={title:"bench",description:"OpenBB Terminal Function"},o="bench",i={unversionedId:"reference/portfolio/bench",id:"reference/portfolio/bench",title:"bench",description:"OpenBB Terminal Function",source:"@site/content/terminal/reference/portfolio/bench.md",sourceDirName:"reference/portfolio",slug:"/reference/portfolio/bench",permalink:"/terminal/reference/portfolio/bench",draft:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/terminal/reference/portfolio/bench.md",tags:[],version:"current",frontMatter:{title:"bench",description:"OpenBB Terminal Function"},sidebar:"tutorialSidebar",previous:{title:"attrib",permalink:"/terminal/reference/portfolio/attrib"},next:{title:"balances",permalink:"/terminal/reference/portfolio/brokers/ally/balances"}},p={},c=[{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:2},{value:"Examples",id:"examples",level:2}],u={toc:c};function s(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"bench"},"bench"),(0,a.kt)("p",null,"Load in a benchmark from a selected list or set your own based on the ticker."),(0,a.kt)("h3",{id:"usage"},"Usage"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-python",metastring:"wordwrap",wordwrap:!0},"bench -b BENCHMARK [-s]\n")),(0,a.kt)("hr",null),(0,a.kt)("h2",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Name"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"),(0,a.kt)("th",{parentName:"tr",align:null},"Default"),(0,a.kt)("th",{parentName:"tr",align:null},"Optional"),(0,a.kt)("th",{parentName:"tr",align:null},"Choices"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"benchmark"),(0,a.kt)("td",{parentName:"tr",align:null},"Set the benchmark for the portfolio. By default, this is SPDR S&P 500 ETF Trust (SPY)."),(0,a.kt)("td",{parentName:"tr",align:null},"SPY"),(0,a.kt)("td",{parentName:"tr",align:null},"False"),(0,a.kt)("td",{parentName:"tr",align:null},"SPY, IVV, VTI, VOO, QQQ, VTV, VEA, IEFA, AGG, BND, VWO, VUG, IEMG, IJR, GLD, IWF, IJH, VIG, IWM, IWD, VO, EFA, VXUS, VGT, VYM, BNDX, VNQ, VB, XLK, ITOT, VCIT, VCSH, XLE, XLV, BSV, XLF, SCHD, RSP, LQD, IVW, VEU, TIP, IAU, SCHX, IXUS, IWR, IWB, DIA, EEM, USMV, SCHF, IVE, MUB, VV, VBR, ESGU, VT, DGRO, SHY, DVY, QUAL, SCHB, MBB, SDY, IGSB, VTIP, JPST, TLT, ACWI, MDY, IUSB, SHV, VGK, XLY, BIL, GOVT, VHT, VOE, XLP, SCHP, IEF, PFF, XLU, VTEB, EFV, SCHG, EMB, DFAC, SCHA, GDX, VMBS, TQQQ, VGSH, HYG, XLI, IWS, VXF, SPLG, SPYV, IWN")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"full_shares"),(0,a.kt)("td",{parentName:"tr",align:null},"Whether to only make a trade with the benchmark when a full share can be bought (no partial shares)."),(0,a.kt)("td",{parentName:"tr",align:null},"False"),(0,a.kt)("td",{parentName:"tr",align:null},"True"),(0,a.kt)("td",{parentName:"tr",align:null},"None")))),(0,a.kt)("hr",null),(0,a.kt)("h2",{id:"examples"},"Examples"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-python"},"2022 May 10, 09:53 (\ud83e\udd8b) /portfolio/ $ bench Vanguard FTSE Developed Markets ETF (VEA)\n\nBenchmark: Vanguard Developed Markets Index Fund (VEA)\n\n2022 May 10, 09:53 (\ud83e\udd8b) /portfolio/ $\n")),(0,a.kt)("hr",null))}s.isMDXComponent=!0}}]);