OpenBB/assets/js/1be78505.7869bed0.js

"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[29514,84204],{11834:(e,t,a)=>{a.r(t),a.d(t,{default:()=>Te});var n=a(67294),l=a(86010),r=a(1944),c=a(35281),o=a(43320),i=a(53438),s=a(74477),m=a(1116),d=a(39370),u=a(95999),b=a(12466),p=a(85936);const E="backToTopButton_sjWU",h="backToTopButtonShow_xfvO";function g(){const{shown:e,scrollToTop:t}=function(e){let{threshold:t}=e;const[a,l]=(0,n.useState)(!1),r=(0,n.useRef)(!1),{startScroll:c,cancelScroll:o}=(0,b.Ct)();return(0,b.RF)(((e,a)=>{let{scrollY:n}=e;const c=null==a?void 0:a.scrollY;c&&(r.current?r.current=!1:n>=c?(o(),l(!1)):n<t?l(!1):n+window.innerHeight<document.documentElement.scrollHeight&&l(!0))})),(0,p.S)((e=>{e.location.hash&&(r.current=!0,l(!1))})),{shown:a,scrollToTop:()=>c(0)}}({threshold:300});return n.createElement("button",{"aria-label":(0,u.I)({id:"theme.BackToTopButton.buttonAriaLabel",message:"Scroll back to top",description:"The ARIA label for the back to top button"}),className:(0,l.Z)("clean-btn",c.k.common.backToTopButton,E,e&&h),type:"button",onClick:t})}var f=a(16550),v=a(87524),k=a(86668),_=a(87462),C=a(39960),N=a(44996),I=a(52263),S=a(72389),Z=a(92949);const x={themedImage:"themedImage_ToTc","themedImage--light":"themedImage--light_HNdA","themedImage--dark":"themedImage--dark_i4oU"};function y(e){const t=(0,S.Z)(),{colorMode:a}=(0,Z.I)(),{sources:r,className:c,alt:o,...i}=e,s=t?"dark"===a?["dark"]:["light"]:["light","dark"];return n.createElement(n.Fragment,null,s.map((e=>n.createElement("img",(0,_.Z)({key:e,src:r[e],alt:o,className:(0,l.Z)(x.themedImage,x[`themedImage--${e}`],c)},i)))))}function T(e){let{logo:t,alt:a,imageClassName:l}=e;const r={light:(0,N.Z)(t.src),dark:(0,N.Z)(t.srcDark||t.src)},c=n.createElement(y,{className:t.className,sources:r,height:t.height,width:t.width,alt:a,style:t.style});return l?n.createElement("div",{className:l},c):c}function w(e){const{siteConfig:{title:t}}=(0,I.Z)(),{navbar:{title:a,logo:l}}=(0,k.L)(),{imageClassName:r,titleClassName:c,...o}=e,i=(0,N.Z)((null==l?void 0:l.href)||"/"),s=a?"":t,m=(null==l?void 0:l.alt)??s;return n.createElement(C.Z,(0,_.Z)({to:i},o,(null==l?void 0:l.target)&&{target:l.target}),l&&n.createElement(T,{logo:l,alt:m,imageClassName:r}),null!=a&&n.createElement("b",{className:c},a))}function L(e){return n.createElement("svg",(0,_.Z)({width:"20",height:"20","aria-hidden":"true"},e),n.createElement("g",{fill:"#7a7a7a"},n.createElement("path",{d:"M9.992 10.023c0 .2-.062.399-.172.547l-4.996 7.492a.982.982 0 01-.828.454H1c-.55 0-1-.453-1-1 0-.2.059-.403.168-.551l4.629-6.942L.168 3.078A.939.939 0 010 2.528c0-.548.45-.997 1-.997h2.996c.352 0 .649.18.828.45L9.82 9.472c.11.148.172.347.172.55zm0 0"}),n.createElement("path",{d:"M19.98 10.023c0 .2-.058.399-.168.547l-4.996 7.492a.987.987 0 01-.828.454h-3c-.547 0-.996-.453-.996-1 0-.2.059-.403.168-.551l4.625-6.942-4.625-6.945a.939.939 0 01-.168-.55 1 1 0 01.996-.997h3c.348 0 .649.18.828.45l4.996 7.492c.11.148.168.347.168.55zm0 0"})))}const M="collapseSidebarButton_PEFL",A="collapseSidebarButtonIcon_kv0_";function B(e){let{onClick:t}=e;return n.createElement("button",{type:"button",title:(0,u.I)({id:"theme.docs.sidebar.collapseButtonTitle",message:"Collapse sidebar",description:"The title attribute for collapse button of doc sidebar"}),"aria-label":(0,u.I)({id:"theme.docs.sidebar.collapseButtonAriaLabel",message:"Collapse sidebar",description:"The title attribute for collapse button of doc sidebar"}),className:(0,l.Z)("button button--secondary button--outline",M),onClick:t},n.createElement(L,{className:A}))}var F=a(59689),P=a(902);const D=Symbol("EmptyContext"),H=n.createContext(D);function W(e){let{children:t}=e;const[a,l]=(0,n.useState)(null),r=(0,n.useMemo)((()=>({expandedItem:a,setExpandedItem:l})),[a]);return n.createElement(H.Provider,{value:r},t)}var R=a(86043),U=a(48596);function z(e){let{categoryLabel:t,onClick:a}=e;return n.createElement("button",{"aria-label":(0,u.I)({id:"theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel",message:"Toggle the collapsible sidebar category '{label}'",description:"The ARIA label to toggle the collapsible sidebar category"},{label:t}),type:"button",className:"clean-btn menu__caret",onClick:a})}function V(e){let{item:t,onItemClick:a,activePath:r,level:o,index:s,...m}=e;const{items:d,label:u,collapsible:b,className:p,href:E}=t,{docs:{sidebar:{autoCollapseCategories:h}}}=(0,k.L)(),g=function(e){const t=(0,S.Z)();return(0,n.useMemo)((()=>e.href?e.href:!t&&e.collapsible?(0,i.Wl)(e):void 0),[e,t])}(t),f=(0,i._F)(t,r),v=(0,U.Mg)(E,r),{collapsed:N,setCollapsed:I}=(0,R.u)({initialState:()=>!!b&&(!f&&t.collapsed)}),{expandedItem:Z,setExpandedItem:x}=function(){const e=(0,n.useContext)(H);if(e===D)throw new P.i6("DocSidebarItemsExpandedStateProvider");return e}(),y=function(e){void 0===e&&(e=!N),x(e?null:s),I(e)};return function(e){let{isActive:t,collapsed:a,updateCollapsed:l}=e;const r=(0,P.D9)(t);(0,n.useEffect)((()=>{t&&!r&&a&&l(!1)}),[t,r,a,l])}({isActive:f,collapsed:N,updateCollapsed:y}),(0,n.useEffect)((()=>{b&&null!=Z&&Z!==s&&h&&I(!0)}),[b,Z,s,I,h]),n.createElement("li",{className:(0,l.Z)(c.k.docs.docSidebarItemCategory,c.k.docs.docSidebarItemCategoryLevel(o),"menu__list-item",{"menu__list-item--collapsed":N},p)},n.createElement("div",{className:(0,l.Z)("menu__list-item-collapsible",{"menu__list-item-collapsible--active":v})},n.createElement(C.Z,(0,_.Z)({className:(0,l.Z)("menu__link",{"menu__link--sublist":b,"menu__link--sublist-caret":!E&&b,"menu__link--active":f}),onClick:b?e=>{null==a||a(t),E?y(!1):(e.preventDefault(),y())}:()=>{null==a||a(t)},"aria-current":v?"page":void 0,"aria-expanded":b?!N:void 0,href:b?g??"#":g},m),u),E&&b&&n.createElement(z,{categoryLabel:u,onClick:e=>{e.preventDefault(),y()}})),n.createElement(R.z,{lazy:!0,as:"ul",className:"menu__list",collapsed:N},n.createElement(J,{items:d,tabIndex:N?-1:0,onItemClick:a,activePath:r,level:o+1})))}var q=a(13919),K=a(39471);const Y="menuExternalLink_NnFM";function j(e){let{item:t,onItemClick:a,activePath:r,level:o,index:s,...m}=e;const{href:d,label:u,className:b,autoAddBaseUrl:p}=t,E=(0,i._F)(t,r),h=(0,q.Z)(d);return n.createElement("li",{className:(0,l.Z)(c.k.docs.docSidebarItemLink,c.k.docs.docSidebarItemLinkLevel(o),"menu__list-item",b),key:u},n.createElement(C.Z,(0,_.Z)({className:(0,l.Z)("menu__link",!h&&Y,{"menu__link--active":E}),autoAddBaseUrl:p,"aria-current":E?"page":void 0,to:d},h&&{onClick:a?()=>a(t):void 0},m),u,!h&&n.createElement(K.Z,null)))}const O="menuHtmlItem_PEWV";function G(e){let{item:t,level:a,index:r}=e;const{value:o,defaultStyle:i,className:s}=t;return n.createElement("li",{className:(0,l.Z)(c.k.docs.docSidebarItemLink,c.k.docs.docSidebarItemLinkLevel(a),i&&[O,"menu__list-item"],s),key:r,dangerouslySetInnerHTML:{__html:o}})}function X(e){let{item:t,...a}=e;switch(t.type){case"category":return n.createElement(V,(0,_.Z)({item:t},a));case"html":return n.createElement(G,(0,_.Z)({item:t},a));default:return n.createElement(j,(0,_.Z)({item:t},a))}}function $(e){let{items:t,...a}=e;return n.createElement(W,null,t.map(((e,t)=>n.createElement(X,(0,_.Z)({key:t,item:e,index:t},a)))))}const J=(0,n.memo)($),Q="menu_Y1UP",ee="menuWithAnnouncementBar_fPny";function te(e){let{path:t,sidebar:a,className:r}=e;const o=function(){const{isActive:e}=(0,F.nT)(),[t,a]=(0,n.useState)(e);return(0,b.RF)((t=>{let{scrollY:n}=t;e&&a(0===n)}),[e]),e&&t}();return n.createElement("nav",{className:(0,l.Z)("menu thin-scrollbar mt-[40px] !px-10 text-sm !pb-10",Q,o&&ee,r)},n.createElement("ul",{className:(0,l.Z)(c.k.docs.docSidebarMenu,"menu__list")},n.createElement(J,{items:a,activePath:t,level:1})))}const ae="sidebar_njMd",ne="sidebarWithHideableNavbar_wUlq",le="sidebarHidden_VK0M",re="sidebarLogo_isFc";function ce(e){let{path:t,sidebar:a,onCollapse:r,isHidden:c}=e;const{navbar:{hideOnScroll:o},docs:{sidebar:{hideable:i}}}=(0,k.L)();return n.createElement("div",{className:(0,l.Z)(ae,o&&ne,c&&le)},o&&n.createElement(w,{tabIndex:-1,className:re}),n.createElement(te,{path:t,sidebar:a}),i&&n.createElement(B,{onClick:r}))}const oe=n.memo(ce);var ie=a(13102),se=a(72961);const me=e=>{let{sidebar:t,path:a}=e;const r=(0,se.e)();return n.createElement("ul",{className:(0,l.Z)(c.k.docs.docSidebarMenu,"menu__list")},n.createElement(J,{items:t,activePath:a,onItemClick:e=>{"category"===e.type&&e.href&&r.toggle(),"link"===e.type&&r.toggle()},level:1}))};function de(e){return n.createElement(ie.Zo,{component:me,props:e})}const ue=n.memo(de);function be(e){const t=(0,v.i)(),a="desktop"===t||"ssr"===t,l="mobile"===t;return n.createElement(n.Fragment,null,a&&n.createElement(oe,e),l&&n.createElement(ue,e))}const pe="expandButton_m80_",Ee="expandButtonIcon_BlDH";function he(e){let{toggleSidebar:t}=e;return n.createElement("div",{className:pe,title:(0,u.I)({id:"theme.docs.sidebar.expandButtonTitle",message:"Expand sidebar",description:"The ARIA label and title attribute for expand button of doc sidebar"}),"aria-label":(0,u.I)({id:"theme.docs.sidebar.expandButtonAriaLabel",message:"Expand sidebar",description:"The ARIA label and title attribute for expand button of doc sidebar"}),tabIndex:0,role:"button",onKeyDown:t,onClick:t},n.createElement(L,{className:Ee}))}const ge="docSidebarContainer_b6E3",fe="docSidebarContainerHidden_b3ry";function ve(e){let{children:t}=e;const a=(0,m.V)();return n.createElement(n.Fragment,{key:(null==a?void 0:a.name)??"noSidebar"},t)}function ke(e){let{sidebar:t,hiddenSidebarContainer:a,setHiddenSidebarContainer:r}=e;const{pathname:o}=(0,f.TH)(),[i,s]=(0,n.useState)(!1),m=(0,n.useCallback)((()=>{i&&s(!1),r((e=>!e))}),[r,i]);return n.createElement("aside",{className:(0,l.Z)(c.k.docs.docSidebarContainer,ge,a&&fe),onTransitionEnd:e=>{e.currentTarget.classList.contains(ge)&&a&&s(!0)}},n.createElement(ve,null,n.createElement(be,{sidebar:t,path:o,onCollapse:m,isHidden:i})),i&&n.createElement(he,{toggleSidebar:m}))}const _e={docMainContainer:"docMainContainer_gTbr",docMainContainerEnhanced:"docMainContainerEnhanced_Uz_u",docItemWrapperEnhanced:"docItemWrapperEnhanced_czyv"};function Ce(e){let{hiddenSidebarContainer:t,children:a}=e;const r=(0,m.V)();return n.createElement("main",{className:(0,l.Z)(_e.docMainContainer,(t||!r)&&_e.docMainContainerEnhanced)},n.createElement("div",{className:(0,l.Z)("container padding-top--md padding-bottom--lg",_e.docItemWrapper,t&&_e.docItemWrapperEnhanced)},a))}const Ne="docPage__5DB",Ie="docsWrapper_BCFX";function Se(e){let{children:t}=e;const a=(0,m.V)(),[l,r]=(0,n.useState)(!1);return n.createElement(d.Z,{wrapperClassName:Ie},n.createElement(g,null),n.createElement("div",{className:Ne},a&&n.createElement(ke,{sidebar:a.items,hiddenSidebarContainer:l,setHiddenSidebarContainer:r}),n.createElement(Ce,{hiddenSidebarContainer:l},t)))}var Ze=a(84204),xe=a(90197);function ye(e){const{versionMetadata:t}=e;return n.createElement(n.Fragment,null,n.createElement(xe.Z,{version:t.version,tag:(0,o.os)(t.pluginId,t.version)}),n.createElement(r.d,null,t.noIndex&&n.createElement("meta",{name:"robots",content:"noindex, nofollow"})))}function Te(e){const{versionMetadata:t}=e,a=(0,i.hI)(e);if(!a)return n.createElement(Ze.default,null);const{docElement:o,sidebarName:d,sidebarItems:u}=a;return n.createElement(n.Fragment,null,n.createElement(ye,e),n.createElement(r.FG,{className:(0,l.Z)(c.k.wrapper.docsPages,c.k.page.docsDocPage,e.versionMetadata.className)},n.createElement(s.q,{version:t},n.createElement(m.b,{name:d,items:u},n.createElement(Se,null,o)))))}},74477:(e,t,a)=>{a.d(t,{E:()=>o,q:()=>c});var n=a(67294),l=a(902);const r=n.createContext(null);function c(e){let{children:t,version:a}=e;return n.createElement(r.Provider,{value:a},t)}function o(){const e=(0,n.useContext)(r);if(null===e)throw new l.i6("DocsVersionProvider");return e}},84204:(e,t,a)=>{a.r(t),a.d(t,{default:()=>o});var n=a(67294),l=a(95999),r=a(1944),c=a(39370);function o(){return n.createElement(n.Fragment,null,n.createElement(r.d,{title:(0,l.I)({id:"theme.NotFound.title",message:"Page Not Found"})}),n.createElement(c.Z,null,n.createElement("main",{className:"container margin-vert--xl mb-20"},n.createElement("div",{className:"row"},n.createElement("div",{className:"col col--6 col--offset-3"},n.createElement("h1",{className:"mt-10 !text-[32px] uppercase font-bold tracking-widest"},n.createElement(l.Z,{id:"theme.NotFound.title",description:"The title of the 404 page"},"Page Not Found")),n.createElement("p",{className:"mt-6 mb-2"},"We could not find what you were looking for."),n.createElement("p",null,"We recently moved our documentation to a new location and some links may be broken. Popular links are listed below:"),n.createElement("ul",{className:"space-y-1 max-w-md list-disc list-inside mt-4"},n.createElement("li",null,n.createElement("a",{href:"/"},"Homepage")),n.createElement("li",null,n.createElement("a",{href:"/sdk"},"Terminal Documentation"),n.createElement("ul",{className:"space-y-1 max-w-md list-disc ml-4 mt-2 mb-3 list-inside"},n.createElement("li",null,n.createElement("a",{href:"/terminal/quickstart/installation"},"Terminal Installation")),n.createElement("li",null,n.createElement("a",{href:"/terminal/reference"},"Terminal Reference")))),n.createElement("li",null,n.createElement("a",{href:"/sdk"},"SDK Documentation"),n.createElement("ul",{className:"space-y-1 max-w-md list-disc ml-4 mt-2 mb-3 list-inside"},n.createElement("li",null,n.createElement("a",{href:"/sdk/quickstart/installation"},"SDK Installation")),n.createElement("li",null,n.createElement("a",{href:"/sdk/reference"},"SDK Reference"))))))))))}}}]);