deploy: 2392a8a9e2

assets/js/00313a1e.23db1722.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96209],{88576:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>p,frontMatter:()=>c,metadata:()=>a,toc:()=>l});var t=s(74848),r=s(28453),i=s(94331);const c={title:"mykeys",description:"This documentation page offers detailed instructions on how to get currently set API keys using the OpenBB finance mykeys function. Includes parameter descriptions, return types, and usage examples.",keywords:["API keys","OpenBB finance","mykeys function","Parameters","Return types","Examples"]},d=void 0,a={id:"sdk/reference/keys/mykeys",title:"mykeys",description:"This documentation page offers detailed instructions on how to get currently set API keys using the OpenBB finance mykeys function. Includes parameter descriptions, return types, and usage examples.",source:"@site/content/sdk/reference/keys/mykeys.md",sourceDirName:"sdk/reference/keys",slug:"/sdk/reference/keys/mykeys",permalink:"/sdk/reference/keys/mykeys",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/sdk/reference/keys/mykeys.md",tags:[],version:"current",lastUpdatedBy:"Henrique Joaquim",lastUpdatedAt:1718799515e3,frontMatter:{title:"mykeys",description:"This documentation page offers detailed instructions on how to get currently set API keys using the OpenBB finance mykeys function. Includes parameter descriptions, return types, and usage examples.",keywords:["API keys","OpenBB finance","mykeys function","Parameters","Return types","Examples"]},sidebar:"tutorialSidebar",previous:{title:"messari",permalink:"/sdk/reference/keys/messari"},next:{title:"news",permalink:"/sdk/reference/keys/news"}},o={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Examples",id:"examples",level:2}];function h(e){const n={a:"a",code:"code",h2:"h2",hr:"hr",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(i.A,{title:"keys.mykeys - Reference | OpenBB SDK Docs"}),"\n",(0,t.jsx)(n.p,{children:"Get currently set API keys."}),"\n",(0,t.jsxs)(n.p,{children:["Source Code: [",(0,t.jsx)(n.a,{href:"https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L241",children:"link"}),"]"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-python",children:"openbb.keys.mykeys(show: bool = False)\n"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{children:"Name"}),(0,t.jsx)(n.th,{children:"Type"}),(0,t.jsx)(n.th,{children:"Description"}),(0,t.jsx)(n.th,{children:"Default"}),(0,t.jsx)(n.th,{children:"Optional"})]})}),(0,t.jsx)(n.tbody,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"show"}),(0,t.jsx)(n.td,{children:"bool"}),(0,t.jsxs)(n.td,{children:["Flag to choose whether to show actual keys or not.",(0,t.jsx)("br",{}),"By default, False."]}),(0,t.jsx)(n.td,{children:"False"}),(0,t.jsx)(n.td,{children:"True"})]})})]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{children:"Type"}),(0,t.jsx)(n.th,{children:"Description"})]})}),(0,t.jsx)(n.tbody,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"pd.DataFrame"}),(0,t.jsx)(n.td,{children:"Currents keys"})]})})]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"examples",children:"Examples"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-python",children:"from openbb_terminal.sdk import openbb\nopenbb.keys.mykeys()\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"Key\n          API\n BITQUERY_KEY  *******\n      CMC_KEY  *******\nCOINGLASS_KEY  *******\n"})}),"\n",(0,t.jsx)(n.hr,{})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},94331:(e,n,s)=>{s.d(n,{A:()=>i});s(96540);var t=s(5260),r=s(74848);function i(e){let{title:n}=e;return(0,r.jsx)(t.A,{children:(0,r.jsx)("title",{children:n})})}},28453:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>d});var t=s(96540);const r={},i=t.createContext(r);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]);

assets/js/00313a1e.5d4b63ee.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96209],{88576:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>p,frontMatter:()=>c,metadata:()=>a,toc:()=>l});var t=s(74848),r=s(28453),i=s(94331);const c={title:"mykeys",description:"This documentation page offers detailed instructions on how to get currently set API keys using the OpenBB finance mykeys function. Includes parameter descriptions, return types, and usage examples.",keywords:["API keys","OpenBB finance","mykeys function","Parameters","Return types","Examples"]},d=void 0,a={id:"sdk/reference/keys/mykeys",title:"mykeys",description:"This documentation page offers detailed instructions on how to get currently set API keys using the OpenBB finance mykeys function. Includes parameter descriptions, return types, and usage examples.",source:"@site/content/sdk/reference/keys/mykeys.md",sourceDirName:"sdk/reference/keys",slug:"/sdk/reference/keys/mykeys",permalink:"/sdk/reference/keys/mykeys",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/sdk/reference/keys/mykeys.md",tags:[],version:"current",lastUpdatedBy:"montezdesousa",lastUpdatedAt:1718403738e3,frontMatter:{title:"mykeys",description:"This documentation page offers detailed instructions on how to get currently set API keys using the OpenBB finance mykeys function. Includes parameter descriptions, return types, and usage examples.",keywords:["API keys","OpenBB finance","mykeys function","Parameters","Return types","Examples"]},sidebar:"tutorialSidebar",previous:{title:"messari",permalink:"/sdk/reference/keys/messari"},next:{title:"news",permalink:"/sdk/reference/keys/news"}},o={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Examples",id:"examples",level:2}];function h(e){const n={a:"a",code:"code",h2:"h2",hr:"hr",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(i.A,{title:"keys.mykeys - Reference | OpenBB SDK Docs"}),"\n",(0,t.jsx)(n.p,{children:"Get currently set API keys."}),"\n",(0,t.jsxs)(n.p,{children:["Source Code: [",(0,t.jsx)(n.a,{href:"https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L241",children:"link"}),"]"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-python",children:"openbb.keys.mykeys(show: bool = False)\n"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{children:"Name"}),(0,t.jsx)(n.th,{children:"Type"}),(0,t.jsx)(n.th,{children:"Description"}),(0,t.jsx)(n.th,{children:"Default"}),(0,t.jsx)(n.th,{children:"Optional"})]})}),(0,t.jsx)(n.tbody,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"show"}),(0,t.jsx)(n.td,{children:"bool"}),(0,t.jsxs)(n.td,{children:["Flag to choose whether to show actual keys or not.",(0,t.jsx)("br",{}),"By default, False."]}),(0,t.jsx)(n.td,{children:"False"}),(0,t.jsx)(n.td,{children:"True"})]})})]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{children:"Type"}),(0,t.jsx)(n.th,{children:"Description"})]})}),(0,t.jsx)(n.tbody,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"pd.DataFrame"}),(0,t.jsx)(n.td,{children:"Currents keys"})]})})]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"examples",children:"Examples"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-python",children:"from openbb_terminal.sdk import openbb\nopenbb.keys.mykeys()\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"Key\n          API\n BITQUERY_KEY  *******\n      CMC_KEY  *******\nCOINGLASS_KEY  *******\n"})}),"\n",(0,t.jsx)(n.hr,{})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},94331:(e,n,s)=>{s.d(n,{A:()=>i});s(96540);var t=s(5260),r=s(74848);function i(e){let{title:n}=e;return(0,r.jsx)(t.A,{children:(0,r.jsx)("title",{children:n})})}},28453:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>d});var t=s(96540);const r={},i=t.createContext(r);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]);

assets/js/0050c985.b724239b.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76589],{95446:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var r=n(74848),s=n(28453),a=n(94331);const o={title:"mom",description:"This page provides information about the momentum oscillator 'mom' function in the OpenBB forecast module. It explains the parameters and returns a DataFrame with an added MOM column.",keywords:["momentum oscillator","mom function","OpenBB forecast module","MOM column","parameters"]},d=void 0,i={id:"sdk/reference/forecast/mom",title:"mom",description:"This page provides information about the momentum oscillator 'mom' function in the OpenBB forecast module. It explains the parameters and returns a DataFrame with an added MOM column.",source:"@site/content/sdk/reference/forecast/mom.md",sourceDirName:"sdk/reference/forecast",slug:"/sdk/reference/forecast/mom",permalink:"/sdk/reference/forecast/mom",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/sdk/reference/forecast/mom.md",tags:[],version:"current",lastUpdatedBy:"montezdesousa",lastUpdatedAt:1718403738e3,frontMatter:{title:"mom",description:"This page provides information about the momentum oscillator 'mom' function in the OpenBB forecast module. It explains the parameters and returns a DataFrame with an added MOM column.",keywords:["momentum oscillator","mom function","OpenBB forecast module","MOM column","parameters"]},sidebar:"tutorialSidebar",previous:{title:"load",permalink:"/sdk/reference/forecast/load"},next:{title:"mstl",permalink:"/sdk/reference/forecast/mstl"}},c={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2}];function m(e){const t={a:"a",code:"code",h2:"h2",hr:"hr",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(a.A,{title:"forecast.mom - Reference | OpenBB SDK Docs"}),"\n",(0,r.jsx)(t.p,{children:"A momentum oscillator, which measures the percentage change between the current"}),"\n",(0,r.jsxs)(t.p,{children:["Source Code: [",(0,r.jsx)(t.a,{href:"https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_model.py#L308",children:"link"}),"]"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-python",children:'openbb.forecast.mom(dataset: pd.DataFrame, target_column: str = "close", period: int = 10)\n'})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Name"}),(0,r.jsx)(t.th,{children:"Type"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Default"}),(0,r.jsx)(t.th,{children:"Optional"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"dataset"}),(0,r.jsx)(t.td,{children:"pd.DataFrame"}),(0,r.jsx)(t.td,{children:"The dataset you wish to calculate with"}),(0,r.jsx)(t.td,{children:"None"}),(0,r.jsx)(t.td,{children:"False"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"target_column"}),(0,r.jsx)(t.td,{children:"str"}),(0,r.jsx)(t.td,{children:"The column you wish to add the MOM to"}),(0,r.jsx)(t.td,{children:"close"}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"period"}),(0,r.jsx)(t.td,{children:"int"}),(0,r.jsx)(t.td,{children:"Time Span"}),(0,r.jsx)(t.td,{children:"10"}),(0,r.jsx)(t.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Type"}),(0,r.jsx)(t.th,{children:"Description"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"pd.DataFrame"}),(0,r.jsx)(t.td,{children:"Dataframe with added MOM column"})]})})]}),"\n",(0,r.jsx)(t.hr,{})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(m,{...e})}):m(e)}},94331:(e,t,n)=>{n.d(t,{A:()=>a});n(96540);var r=n(5260),s=n(74848);function a(e){let{title:t}=e;return(0,s.jsx)(r.A,{children:(0,s.jsx)("title",{children:t})})}},28453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>d});var r=n(96540);const s={},a=r.createContext(s);function o(e){const t=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]);

assets/js/0050c985.d2c6cf4f.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76589],{95446:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var r=n(74848),s=n(28453),a=n(94331);const o={title:"mom",description:"This page provides information about the momentum oscillator 'mom' function in the OpenBB forecast module. It explains the parameters and returns a DataFrame with an added MOM column.",keywords:["momentum oscillator","mom function","OpenBB forecast module","MOM column","parameters"]},d=void 0,i={id:"sdk/reference/forecast/mom",title:"mom",description:"This page provides information about the momentum oscillator 'mom' function in the OpenBB forecast module. It explains the parameters and returns a DataFrame with an added MOM column.",source:"@site/content/sdk/reference/forecast/mom.md",sourceDirName:"sdk/reference/forecast",slug:"/sdk/reference/forecast/mom",permalink:"/sdk/reference/forecast/mom",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/sdk/reference/forecast/mom.md",tags:[],version:"current",lastUpdatedBy:"Henrique Joaquim",lastUpdatedAt:1718799515e3,frontMatter:{title:"mom",description:"This page provides information about the momentum oscillator 'mom' function in the OpenBB forecast module. It explains the parameters and returns a DataFrame with an added MOM column.",keywords:["momentum oscillator","mom function","OpenBB forecast module","MOM column","parameters"]},sidebar:"tutorialSidebar",previous:{title:"load",permalink:"/sdk/reference/forecast/load"},next:{title:"mstl",permalink:"/sdk/reference/forecast/mstl"}},c={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2}];function m(e){const t={a:"a",code:"code",h2:"h2",hr:"hr",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(a.A,{title:"forecast.mom - Reference | OpenBB SDK Docs"}),"\n",(0,r.jsx)(t.p,{children:"A momentum oscillator, which measures the percentage change between the current"}),"\n",(0,r.jsxs)(t.p,{children:["Source Code: [",(0,r.jsx)(t.a,{href:"https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_model.py#L308",children:"link"}),"]"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-python",children:'openbb.forecast.mom(dataset: pd.DataFrame, target_column: str = "close", period: int = 10)\n'})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Name"}),(0,r.jsx)(t.th,{children:"Type"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Default"}),(0,r.jsx)(t.th,{children:"Optional"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"dataset"}),(0,r.jsx)(t.td,{children:"pd.DataFrame"}),(0,r.jsx)(t.td,{children:"The dataset you wish to calculate with"}),(0,r.jsx)(t.td,{children:"None"}),(0,r.jsx)(t.td,{children:"False"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"target_column"}),(0,r.jsx)(t.td,{children:"str"}),(0,r.jsx)(t.td,{children:"The column you wish to add the MOM to"}),(0,r.jsx)(t.td,{children:"close"}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"period"}),(0,r.jsx)(t.td,{children:"int"}),(0,r.jsx)(t.td,{children:"Time Span"}),(0,r.jsx)(t.td,{children:"10"}),(0,r.jsx)(t.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Type"}),(0,r.jsx)(t.th,{children:"Description"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"pd.DataFrame"}),(0,r.jsx)(t.td,{children:"Dataframe with added MOM column"})]})})]}),"\n",(0,r.jsx)(t.hr,{})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(m,{...e})}):m(e)}},94331:(e,t,n)=>{n.d(t,{A:()=>a});n(96540);var r=n(5260),s=n(74848);function a(e){let{title:t}=e;return(0,s.jsx)(r.A,{children:(0,s.jsx)("title",{children:t})})}},28453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>d});var r=n(96540);const s={},a=r.createContext(s);function o(e){const t=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]);

assets/js/0072b744.34bc0ba2.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[34669],{54081:(t,n,e)=>{e.r(n),e.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>u,frontMatter:()=>s,metadata:()=>l,toc:()=>d});var i=e(74848),o=e(28453),a=e(94331);const s={title:"Installation",sidebar_position:1,description:"Learn about the OpenBB SDK that provides programmatic access to all Terminal functions, allowing users to build their own tools and applications on the existing architecture. Understand how it is part of the OpenBB Terminal and the installation process.",keywords:["OpenBB SDK","programmatic access","Terminal functions","build tools","build applications","existing architecture","installation source code","PyPI"]},r=void 0,l={id:"sdk/installation",title:"Installation",description:"Learn about the OpenBB SDK that provides programmatic access to all Terminal functions, allowing users to build their own tools and applications on the existing architecture. Understand how it is part of the OpenBB Terminal and the installation process.",source:"@site/content/sdk/installation.md",sourceDirName:"sdk",slug:"/sdk/installation",permalink:"/sdk/installation",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/sdk/installation.md",tags:[],version:"current",lastUpdatedBy:"montezdesousa",lastUpdatedAt:1718403738e3,sidebarPosition:1,frontMatter:{title:"Installation",sidebar_position:1,description:"Learn about the OpenBB SDK that provides programmatic access to all Terminal functions, allowing users to build their own tools and applications on the existing architecture. Understand how it is part of the OpenBB Terminal and the installation process.",keywords:["OpenBB SDK","programmatic access","Terminal functions","build tools","build applications","existing architecture","installation source code","PyPI"]},sidebar:"tutorialSidebar",previous:{title:"Introduction",permalink:"/sdk/"},next:{title:"Usage",permalink:"/sdk/usage/"}},c={},d=[];function p(t){const n={a:"a",admonition:"admonition",p:"p",...(0,o.R)(),...t.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(a.A,{title:"Installation | OpenBB SDK Docs"}),"\n",(0,i.jsx)(n.p,{children:"The OpenBB SDK provides programmatic access to all Terminal functions and much more. This layer of code allows users to build their own tools and applications on top of the existing architecture."}),"\n",(0,i.jsx)(n.admonition,{type:"note",children:(0,i.jsxs)(n.p,{children:["The OpenBB SDK is a part of the OpenBB Terminal when installed via ",(0,i.jsx)(n.a,{href:"/terminal/installation/source",children:"source code"})," or ",(0,i.jsx)(n.a,{href:"/terminal/installation/pypi",children:"PyPI"}),"."]})})]})}function u(t={}){const{wrapper:n}={...(0,o.R)(),...t.components};return n?(0,i.jsx)(n,{...t,children:(0,i.jsx)(p,{...t})}):p(t)}},94331:(t,n,e)=>{e.d(n,{A:()=>a});e(96540);var i=e(5260),o=e(74848);function a(t){let{title:n}=t;return(0,o.jsx)(i.A,{children:(0,o.jsx)("title",{children:n})})}},28453:(t,n,e)=>{e.d(n,{R:()=>s,x:()=>r});var i=e(96540);const o={},a=i.createContext(o);function s(t){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof t?t(n):{...n,...t}}),[n,t])}function r(t){let n;return n=t.disableParentContext?"function"==typeof t.components?t.components(o):t.components||o:s(t.components),i.createElement(a.Provider,{value:n},t.children)}}}]);

assets/js/0072b744.ea454506.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[34669],{54081:(t,n,e)=>{e.r(n),e.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>u,frontMatter:()=>s,metadata:()=>l,toc:()=>d});var i=e(74848),o=e(28453),a=e(94331);const s={title:"Installation",sidebar_position:1,description:"Learn about the OpenBB SDK that provides programmatic access to all Terminal functions, allowing users to build their own tools and applications on the existing architecture. Understand how it is part of the OpenBB Terminal and the installation process.",keywords:["OpenBB SDK","programmatic access","Terminal functions","build tools","build applications","existing architecture","installation source code","PyPI"]},r=void 0,l={id:"sdk/installation",title:"Installation",description:"Learn about the OpenBB SDK that provides programmatic access to all Terminal functions, allowing users to build their own tools and applications on the existing architecture. Understand how it is part of the OpenBB Terminal and the installation process.",source:"@site/content/sdk/installation.md",sourceDirName:"sdk",slug:"/sdk/installation",permalink:"/sdk/installation",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/sdk/installation.md",tags:[],version:"current",lastUpdatedBy:"Henrique Joaquim",lastUpdatedAt:1718799515e3,sidebarPosition:1,frontMatter:{title:"Installation",sidebar_position:1,description:"Learn about the OpenBB SDK that provides programmatic access to all Terminal functions, allowing users to build their own tools and applications on the existing architecture. Understand how it is part of the OpenBB Terminal and the installation process.",keywords:["OpenBB SDK","programmatic access","Terminal functions","build tools","build applications","existing architecture","installation source code","PyPI"]},sidebar:"tutorialSidebar",previous:{title:"Introduction",permalink:"/sdk/"},next:{title:"Usage",permalink:"/sdk/usage/"}},c={},d=[];function p(t){const n={a:"a",admonition:"admonition",p:"p",...(0,o.R)(),...t.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(a.A,{title:"Installation | OpenBB SDK Docs"}),"\n",(0,i.jsx)(n.p,{children:"The OpenBB SDK provides programmatic access to all Terminal functions and much more. This layer of code allows users to build their own tools and applications on top of the existing architecture."}),"\n",(0,i.jsx)(n.admonition,{type:"note",children:(0,i.jsxs)(n.p,{children:["The OpenBB SDK is a part of the OpenBB Terminal when installed via ",(0,i.jsx)(n.a,{href:"/terminal/installation/source",children:"source code"})," or ",(0,i.jsx)(n.a,{href:"/terminal/installation/pypi",children:"PyPI"}),"."]})})]})}function u(t={}){const{wrapper:n}={...(0,o.R)(),...t.components};return n?(0,i.jsx)(n,{...t,children:(0,i.jsx)(p,{...t})}):p(t)}},94331:(t,n,e)=>{e.d(n,{A:()=>a});e(96540);var i=e(5260),o=e(74848);function a(t){let{title:n}=t;return(0,o.jsx)(i.A,{children:(0,o.jsx)("title",{children:n})})}},28453:(t,n,e)=>{e.d(n,{R:()=>s,x:()=>r});var i=e(96540);const o={},a=i.createContext(o);function s(t){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof t?t(n):{...n,...t}}),[n,t])}function r(t){let n;return n=t.disableParentContext?"function"==typeof t.components?t.components(o):t.components||o:s(t.components),i.createElement(a.Provider,{value:n},t.children)}}}]);

assets/js/00b13405.23ac53f4.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43036],{98648:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>m});var c=r(74848),n=r(28453),s=r(94331);const a={title:"c15m",description:"The c15m command helps to retrieve a 15-minute intraday chart for a specific stock ticker, useful for technical analysis and tracking short-term price movements.",keywords:["c15m command","intraday chart","stock ticker","technical analysis","short-term price movements","stock tracking","stock volume","stock price"]},i=void 0,o={id:"bot/reference/telegram/charts/c15m",title:"c15m",description:"The c15m command helps to retrieve a 15-minute intraday chart for a specific stock ticker, useful for technical analysis and tracking short-term price movements.",source:"@site/content/bot/reference/telegram/charts/c15m.md",sourceDirName:"bot/reference/telegram/charts",slug:"/bot/reference/telegram/charts/c15m",permalink:"/bot/reference/telegram/charts/c15m",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/bot/reference/telegram/charts/c15m.md",tags:[],version:"current",lastUpdatedBy:"Henrique Joaquim",lastUpdatedAt:1718799515e3,frontMatter:{title:"c15m",description:"The c15m command helps to retrieve a 15-minute intraday chart for a specific stock ticker, useful for technical analysis and tracking short-term price movements.",keywords:["c15m command","intraday chart","stock ticker","technical analysis","short-term price movements","stock tracking","stock volume","stock price"]},sidebar:"tutorialSidebar",previous:{title:"c",permalink:"/bot/reference/telegram/charts/c"},next:{title:"c3m",permalink:"/bot/reference/telegram/charts/c3m"}},l={},m=[{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:2},{value:"Examples",id:"examples",level:2}];function d(e){const t={code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,n.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(s.A,{title:"charts: c15m - Telegram Reference | OpenBB Bot Docs"}),"\n",(0,c.jsx)(t.p,{children:"This command allows the user to retrieve a 15-minute intraday chart for a given ticker. The chart will show the price and volume of the stock over the past 3 days in 15 minute intervals. This command is useful for performing technical analysis and tracking short-term price movements."}),"\n",(0,c.jsx)(t.h3,{id:"usage",children:"Usage"}),"\n",(0,c.jsx)(t.pre,{children:(0,c.jsx)(t.code,{className:"language-python",metastring:"wordwrap",children:"/c15m ticker\n"})}),"\n",(0,c.jsx)(t.hr,{}),"\n",(0,c.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,c.jsxs)(t.table,{children:[(0,c.jsx)(t.thead,{children:(0,c.jsxs)(t.tr,{children:[(0,c.jsx)(t.th,{children:"Name"}),(0,c.jsx)(t.th,{children:"Description"}),(0,c.jsx)(t.th,{children:"Optional"}),(0,c.jsx)(t.th,{children:"Choices"})]})}),(0,c.jsx)(t.tbody,{children:(0,c.jsxs)(t.tr,{children:[(0,c.jsx)(t.td,{children:"ticker"}),(0,c.jsx)(t.td,{children:"Stock Ticker"}),(0,c.jsx)(t.td,{children:"False"}),(0,c.jsx)(t.td,{children:"None"})]})})]}),"\n",(0,c.jsx)(t.hr,{}),"\n",(0,c.jsx)(t.h2,{id:"examples",children:"Examples"}),"\n",(0,c.jsx)(t.pre,{children:(0,c.jsx)(t.code,{children:"/c15m AMD\n"})}),"\n",(0,c.jsx)(t.hr,{})]})}function h(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,c.jsx)(t,{...e,children:(0,c.jsx)(d,{...e})}):d(e)}},94331:(e,t,r)=>{r.d(t,{A:()=>s});r(96540);var c=r(5260),n=r(74848);function s(e){let{title:t}=e;return(0,n.jsx)(c.A,{children:(0,n.jsx)("title",{children:t})})}},28453:(e,t,r)=>{r.d(t,{R:()=>a,x:()=>i});var c=r(96540);const n={},s=c.createContext(n);function a(e){const t=c.useContext(s);return c.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),c.createElement(s.Provider,{value:t},e.children)}}}]);

assets/js/00b13405.607256f0.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43036],{98648:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>m});var c=r(74848),n=r(28453),s=r(94331);const a={title:"c15m",description:"The c15m command helps to retrieve a 15-minute intraday chart for a specific stock ticker, useful for technical analysis and tracking short-term price movements.",keywords:["c15m command","intraday chart","stock ticker","technical analysis","short-term price movements","stock tracking","stock volume","stock price"]},i=void 0,o={id:"bot/reference/telegram/charts/c15m",title:"c15m",description:"The c15m command helps to retrieve a 15-minute intraday chart for a specific stock ticker, useful for technical analysis and tracking short-term price movements.",source:"@site/content/bot/reference/telegram/charts/c15m.md",sourceDirName:"bot/reference/telegram/charts",slug:"/bot/reference/telegram/charts/c15m",permalink:"/bot/reference/telegram/charts/c15m",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/bot/reference/telegram/charts/c15m.md",tags:[],version:"current",lastUpdatedBy:"montezdesousa",lastUpdatedAt:1718403738e3,frontMatter:{title:"c15m",description:"The c15m command helps to retrieve a 15-minute intraday chart for a specific stock ticker, useful for technical analysis and tracking short-term price movements.",keywords:["c15m command","intraday chart","stock ticker","technical analysis","short-term price movements","stock tracking","stock volume","stock price"]},sidebar:"tutorialSidebar",previous:{title:"c",permalink:"/bot/reference/telegram/charts/c"},next:{title:"c3m",permalink:"/bot/reference/telegram/charts/c3m"}},l={},m=[{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:2},{value:"Examples",id:"examples",level:2}];function d(e){const t={code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,n.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(s.A,{title:"charts: c15m - Telegram Reference | OpenBB Bot Docs"}),"\n",(0,c.jsx)(t.p,{children:"This command allows the user to retrieve a 15-minute intraday chart for a given ticker. The chart will show the price and volume of the stock over the past 3 days in 15 minute intervals. This command is useful for performing technical analysis and tracking short-term price movements."}),"\n",(0,c.jsx)(t.h3,{id:"usage",children:"Usage"}),"\n",(0,c.jsx)(t.pre,{children:(0,c.jsx)(t.code,{className:"language-python",metastring:"wordwrap",children:"/c15m ticker\n"})}),"\n",(0,c.jsx)(t.hr,{}),"\n",(0,c.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,c.jsxs)(t.table,{children:[(0,c.jsx)(t.thead,{children:(0,c.jsxs)(t.tr,{children:[(0,c.jsx)(t.th,{children:"Name"}),(0,c.jsx)(t.th,{children:"Description"}),(0,c.jsx)(t.th,{children:"Optional"}),(0,c.jsx)(t.th,{children:"Choices"})]})}),(0,c.jsx)(t.tbody,{children:(0,c.jsxs)(t.tr,{children:[(0,c.jsx)(t.td,{children:"ticker"}),(0,c.jsx)(t.td,{children:"Stock Ticker"}),(0,c.jsx)(t.td,{children:"False"}),(0,c.jsx)(t.td,{children:"None"})]})})]}),"\n",(0,c.jsx)(t.hr,{}),"\n",(0,c.jsx)(t.h2,{id:"examples",children:"Examples"}),"\n",(0,c.jsx)(t.pre,{children:(0,c.jsx)(t.code,{children:"/c15m AMD\n"})}),"\n",(0,c.jsx)(t.hr,{})]})}function h(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,c.jsx)(t,{...e,children:(0,c.jsx)(d,{...e})}):d(e)}},94331:(e,t,r)=>{r.d(t,{A:()=>s});r(96540);var c=r(5260),n=r(74848);function s(e){let{title:t}=e;return(0,n.jsx)(c.A,{children:(0,n.jsx)("title",{children:t})})}},28453:(e,t,r)=>{r.d(t,{R:()=>a,x:()=>i});var c=r(96540);const n={},s=c.createContext(n);function a(e){const t=c.useContext(s);return c.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),c.createElement(s.Provider,{value:t},e.children)}}}]);

assets/js/00f186ed.672adeab.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75713],{89433:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>d,default:()=>m,frontMatter:()=>s,metadata:()=>o,toc:()=>c});var i=n(74848),r=n(28453),a=n(94331);const s={title:"sma",description:"This page explains the Simple Moving Average (sma), a method used to filter noise and identify trends in data by averaging the previous set of values within a given time period. It includes the usage and parameter details.",keywords:["sma","moving averages","simple moving average","filter noise","identify trends","time period","n_length","n_offset"]},d=void 0,o={id:"terminal/reference/forex/ta/sma",title:"sma",description:"This page explains the Simple Moving Average (sma), a method used to filter noise and identify trends in data by averaging the previous set of values within a given time period. It includes the usage and parameter details.",source:"@site/content/terminal/reference/forex/ta/sma.md",sourceDirName:"terminal/reference/forex/ta",slug:"/terminal/reference/forex/ta/sma",permalink:"/terminal/reference/forex/ta/sma",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/terminal/reference/forex/ta/sma.md",tags:[],version:"current",lastUpdatedBy:"montezdesousa",lastUpdatedAt:1718403738e3,frontMatter:{title:"sma",description:"This page explains the Simple Moving Average (sma), a method used to filter noise and identify trends in data by averaging the previous set of values within a given time period. It includes the usage and parameter details.",keywords:["sma","moving averages","simple moving average","filter noise","identify trends","time period","n_length","n_offset"]},sidebar:"tutorialSidebar",previous:{title:"rsi",permalink:"/terminal/reference/forex/ta/rsi"},next:{title:"stoch",permalink:"/terminal/reference/forex/ta/stoch"}},l={},c=[{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:2}];function h(e){const t={code:"code",h2:"h2",h3:"h3",hr:"hr",img:"img",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(a.A,{title:"forex/ta/sma - Reference | OpenBB Terminal Docs"}),"\n",(0,i.jsx)(t.p,{children:"Moving Averages are used to smooth the data in an array to help eliminate noise and identify trends. The Simple Moving Average is literally the simplest form of a moving average. Each output value is the average of the previous n values. In a Simple Moving Average, each value in the time period carries equal weight, and values outside of the time period are not included in the average. This makes it less responsive to recent changes in the data, which can be useful for filtering out those changes."}),"\n",(0,i.jsx)(t.h3,{id:"usage",children:"Usage"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-python",children:"sma [-l N_LENGTH] [-o N_OFFSET]\n"})}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Name"}),(0,i.jsx)(t.th,{children:"Description"}),(0,i.jsx)(t.th,{children:"Default"}),(0,i.jsx)(t.th,{children:"Optional"}),(0,i.jsx)(t.th,{children:"Choices"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"n_length"}),(0,i.jsx)(t.td,{children:"Window lengths. Multiple values indicated as comma separated values."}),(0,i.jsx)(t.td,{children:"20, 50"}),(0,i.jsx)(t.td,{children:"True"}),(0,i.jsx)(t.td,{children:"None"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"n_offset"}),(0,i.jsx)(t.td,{children:"offset"}),(0,i.jsx)(t.td,{children:"0"}),(0,i.jsx)(t.td,{children:"True"}),(0,i.jsx)(t.td,{children:"None"})]})]})]}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{src:"https://user-images.githubusercontent.com/46355364/154311791-5b130d08-55bd-406b-a68e-914a733c5191.png",alt:"sma"})}),"\n",(0,i.jsx)(t.hr,{})]})}function m(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},94331:(e,t,n)=>{n.d(t,{A:()=>a});n(96540);var i=n(5260),r=n(74848);function a(e){let{title:t}=e;return(0,r.jsx)(i.A,{children:(0,r.jsx)("title",{children:t})})}},28453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>d});var i=n(96540);const r={},a=i.createContext(r);function s(e){const t=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),i.createElement(a.Provider,{value:t},e.children)}}}]);

assets/js/00f186ed.acf2b3b7.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75713],{89433:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>d,default:()=>m,frontMatter:()=>s,metadata:()=>o,toc:()=>c});var i=n(74848),r=n(28453),a=n(94331);const s={title:"sma",description:"This page explains the Simple Moving Average (sma), a method used to filter noise and identify trends in data by averaging the previous set of values within a given time period. It includes the usage and parameter details.",keywords:["sma","moving averages","simple moving average","filter noise","identify trends","time period","n_length","n_offset"]},d=void 0,o={id:"terminal/reference/forex/ta/sma",title:"sma",description:"This page explains the Simple Moving Average (sma), a method used to filter noise and identify trends in data by averaging the previous set of values within a given time period. It includes the usage and parameter details.",source:"@site/content/terminal/reference/forex/ta/sma.md",sourceDirName:"terminal/reference/forex/ta",slug:"/terminal/reference/forex/ta/sma",permalink:"/terminal/reference/forex/ta/sma",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/terminal/reference/forex/ta/sma.md",tags:[],version:"current",lastUpdatedBy:"Henrique Joaquim",lastUpdatedAt:1718799515e3,frontMatter:{title:"sma",description:"This page explains the Simple Moving Average (sma), a method used to filter noise and identify trends in data by averaging the previous set of values within a given time period. It includes the usage and parameter details.",keywords:["sma","moving averages","simple moving average","filter noise","identify trends","time period","n_length","n_offset"]},sidebar:"tutorialSidebar",previous:{title:"rsi",permalink:"/terminal/reference/forex/ta/rsi"},next:{title:"stoch",permalink:"/terminal/reference/forex/ta/stoch"}},l={},c=[{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:2}];function h(e){const t={code:"code",h2:"h2",h3:"h3",hr:"hr",img:"img",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(a.A,{title:"forex/ta/sma - Reference | OpenBB Terminal Docs"}),"\n",(0,i.jsx)(t.p,{children:"Moving Averages are used to smooth the data in an array to help eliminate noise and identify trends. The Simple Moving Average is literally the simplest form of a moving average. Each output value is the average of the previous n values. In a Simple Moving Average, each value in the time period carries equal weight, and values outside of the time period are not included in the average. This makes it less responsive to recent changes in the data, which can be useful for filtering out those changes."}),"\n",(0,i.jsx)(t.h3,{id:"usage",children:"Usage"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-python",children:"sma [-l N_LENGTH] [-o N_OFFSET]\n"})}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Name"}),(0,i.jsx)(t.th,{children:"Description"}),(0,i.jsx)(t.th,{children:"Default"}),(0,i.jsx)(t.th,{children:"Optional"}),(0,i.jsx)(t.th,{children:"Choices"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"n_length"}),(0,i.jsx)(t.td,{children:"Window lengths. Multiple values indicated as comma separated values."}),(0,i.jsx)(t.td,{children:"20, 50"}),(0,i.jsx)(t.td,{children:"True"}),(0,i.jsx)(t.td,{children:"None"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"n_offset"}),(0,i.jsx)(t.td,{children:"offset"}),(0,i.jsx)(t.td,{children:"0"}),(0,i.jsx)(t.td,{children:"True"}),(0,i.jsx)(t.td,{children:"None"})]})]})]}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{src:"https://user-images.githubusercontent.com/46355364/154311791-5b130d08-55bd-406b-a68e-914a733c5191.png",alt:"sma"})}),"\n",(0,i.jsx)(t.hr,{})]})}function m(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},94331:(e,t,n)=>{n.d(t,{A:()=>a});n(96540);var i=n(5260),r=n(74848);function a(e){let{title:t}=e;return(0,r.jsx)(i.A,{children:(0,r.jsx)("title",{children:t})})}},28453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>d});var i=n(96540);const r={},a=i.createContext(r);function s(e){const t=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),i.createElement(a.Provider,{value:t},e.children)}}}]);

assets/js/00fc55de.343b46ba.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2461],{52981:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>n,default:()=>p,frontMatter:()=>s,metadata:()=>i,toc:()=>c});var o=r(74848),a=r(28453),l=r(62510);const s={},n="darkpool",i={id:"bot/reference/telegram/darkpool/index",title:"darkpool",description:"<ReferenceCard",source:"@site/content/bot/reference/telegram/darkpool/index.mdx",sourceDirName:"bot/reference/telegram/darkpool",slug:"/bot/reference/telegram/darkpool/",permalink:"/bot/reference/telegram/darkpool/",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/bot/reference/telegram/darkpool/index.mdx",tags:[],version:"current",lastUpdatedBy:"Henrique Joaquim",lastUpdatedAt:1718799515e3,frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"tvl",permalink:"/bot/reference/telegram/crypto/tvl"},next:{title:"allblocks",permalink:"/bot/reference/telegram/darkpool/allblocks"}},d={},c=[];function m(e){const t={h1:"h1",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h1,{id:"darkpool",children:"darkpool"}),"\n","\n",(0,o.jsxs)("ul",{className:"grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6",children:[(0,o.jsx)(l.A,{title:"allblocks",description:"The command allows the user to retrieve the last 15 block trades of a given security. This command will provide a...",url:"/bot/reference/telegram/darkpool/allblocks"}),(0,o.jsx)(l.A,{title:"alldp",description:"This command allows the user to retrieve the last 15 darkpool trades for the specified stock ticker. A darkpool...",url:"/bot/reference/telegram/darkpool/alldp"}),(0,o.jsx)(l.A,{title:"allprints",description:"This command retrieves the Last 15 Combination of Dark Pool and Blocks for a given ticker symbol. This can be...",url:"/bot/reference/telegram/darkpool/allprints"}),(0,o.jsx)(l.A,{title:"bigprintsdp",description:"This command will retrieve the largest combination of dark pool and block trades over a specified amount of days....",url:"/bot/reference/telegram/darkpool/bigprintsdp"}),(0,o.jsx)(l.A,{title:"levels",description:"This command allows the user to retrieve the Biggest Levels for All Prints over the last x days for the given...",url:"/bot/reference/telegram/darkpool/levels"}),(0,o.jsx)(l.A,{title:"sectors",description:"This command allows the user to retrieve a summary of all prints by % of MarketCap by Sector over the last x...",url:"/bot/reference/telegram/darkpool/sectors"}),(0,o.jsx)(l.A,{title:"summary",description:"This command retrieves a summary of all the prints by percentage of MarketCap over the last x days, sorted by...",url:"/bot/reference/telegram/darkpool/summary"}),(0,o.jsx)(l.A,{title:"topsum",description:"This command allows the user to retrieve total block and dark pool data summary. It sums all darkpool prints and...",url:"/bot/reference/telegram/darkpool/topsum"})]})]})}function p(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(m,{...e})}):m(e)}},62510:(e,t,r)=>{r.d(t,{A:()=>n});var o=r(28774),a=r(34164),l=(r(96540),r(56347)),s=r(74848);function n(e){let{title:t,url:r,description:n,command:i}=e;const{pathname:d}=(0,l.zy)(),c=d.replace(/\/v\d+/,"");return(0,s.jsxs)(o.A,{className:(0,a.A)("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",{header_docs_terminal:c.startsWith("/terminal"),"bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]":c.startsWith("/sdk")||c.startsWith("/cli")||c.startsWith("/platform"),"bg-gradient-to-r from-grey-800 to-purple-800":c.startsWith("/bot"),header_docs:!(c.startsWith("/terminal")||c.startsWith("/sdk")||c.startsWith("/platform")||c.startsWith("/bot")||c.startsWith("/cli"))}),to:r,children:[(0,s.jsx)("div",{className:"absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"}),(0,s.jsxs)("p",{className:"py-2 font-bold text-lg my-0",children:[t,""]}),n?(0,s.jsx)("p",{className:"text-grey-200 text-xs mt-2 mb-0",children:n}):null]})}},28453:(e,t,r)=>{r.d(t,{R:()=>s,x:()=>n});var o=r(96540);const a={},l=o.createContext(a);function s(e){const t=o.useContext(l);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function n(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),o.createElement(l.Provider,{value:t},e.children)}}}]);

assets/js/00fc55de.a11dc8b0.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2461],{52981:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>n,default:()=>p,frontMatter:()=>l,metadata:()=>i,toc:()=>c});var o=r(74848),a=r(28453),s=r(62510);const l={},n="darkpool",i={id:"bot/reference/telegram/darkpool/index",title:"darkpool",description:"<ReferenceCard",source:"@site/content/bot/reference/telegram/darkpool/index.mdx",sourceDirName:"bot/reference/telegram/darkpool",slug:"/bot/reference/telegram/darkpool/",permalink:"/bot/reference/telegram/darkpool/",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/bot/reference/telegram/darkpool/index.mdx",tags:[],version:"current",lastUpdatedBy:"montezdesousa",lastUpdatedAt:1718403738e3,frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"tvl",permalink:"/bot/reference/telegram/crypto/tvl"},next:{title:"allblocks",permalink:"/bot/reference/telegram/darkpool/allblocks"}},d={},c=[];function m(e){const t={h1:"h1",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h1,{id:"darkpool",children:"darkpool"}),"\n","\n",(0,o.jsxs)("ul",{className:"grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6",children:[(0,o.jsx)(s.A,{title:"allblocks",description:"The command allows the user to retrieve the last 15 block trades of a given security. This command will provide a...",url:"/bot/reference/telegram/darkpool/allblocks"}),(0,o.jsx)(s.A,{title:"alldp",description:"This command allows the user to retrieve the last 15 darkpool trades for the specified stock ticker. A darkpool...",url:"/bot/reference/telegram/darkpool/alldp"}),(0,o.jsx)(s.A,{title:"allprints",description:"This command retrieves the Last 15 Combination of Dark Pool and Blocks for a given ticker symbol. This can be...",url:"/bot/reference/telegram/darkpool/allprints"}),(0,o.jsx)(s.A,{title:"bigprintsdp",description:"This command will retrieve the largest combination of dark pool and block trades over a specified amount of days....",url:"/bot/reference/telegram/darkpool/bigprintsdp"}),(0,o.jsx)(s.A,{title:"levels",description:"This command allows the user to retrieve the Biggest Levels for All Prints over the last x days for the given...",url:"/bot/reference/telegram/darkpool/levels"}),(0,o.jsx)(s.A,{title:"sectors",description:"This command allows the user to retrieve a summary of all prints by % of MarketCap by Sector over the last x...",url:"/bot/reference/telegram/darkpool/sectors"}),(0,o.jsx)(s.A,{title:"summary",description:"This command retrieves a summary of all the prints by percentage of MarketCap over the last x days, sorted by...",url:"/bot/reference/telegram/darkpool/summary"}),(0,o.jsx)(s.A,{title:"topsum",description:"This command allows the user to retrieve total block and dark pool data summary. It sums all darkpool prints and...",url:"/bot/reference/telegram/darkpool/topsum"})]})]})}function p(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(m,{...e})}):m(e)}},62510:(e,t,r)=>{r.d(t,{A:()=>n});var o=r(28774),a=r(34164),s=(r(96540),r(56347)),l=r(74848);function n(e){let{title:t,url:r,description:n,command:i}=e;const{pathname:d}=(0,s.zy)(),c=d.replace(/\/v\d+/,"");return(0,l.jsxs)(o.A,{className:(0,a.A)("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",{header_docs_terminal:c.startsWith("/terminal"),"bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]":c.startsWith("/sdk")||c.startsWith("/cli")||c.startsWith("/platform"),"bg-gradient-to-r from-grey-800 to-purple-800":c.startsWith("/bot"),header_docs:!(c.startsWith("/terminal")||c.startsWith("/sdk")||c.startsWith("/platform")||c.startsWith("/bot")||c.startsWith("/cli"))}),to:r,children:[(0,l.jsx)("div",{className:"absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"}),(0,l.jsxs)("p",{className:"py-2 font-bold text-lg my-0",children:[t,""]}),n?(0,l.jsx)("p",{className:"text-grey-200 text-xs mt-2 mb-0",children:n}):null]})}},28453:(e,t,r)=>{r.d(t,{R:()=>l,x:()=>n});var o=r(96540);const a={},s=o.createContext(a);function l(e){const t=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function n(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:l(e.components),o.createElement(s.Provider,{value:t},e.children)}}}]);

assets/js/010a60cc.7f713c16.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[79947],{79263:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>m,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var n=r(74848),o=r(28453),s=r(62510);const i={},a="reports",l={id:"terminal/reference/reports/index",title:"reports",description:"<ReferenceCard",source:"@site/content/terminal/reference/reports/index.mdx",sourceDirName:"terminal/reference/reports",slug:"/terminal/reference/reports/",permalink:"/terminal/reference/reports/",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/terminal/reference/reports/index.mdx",tags:[],version:"current",lastUpdatedBy:"montezdesousa",lastUpdatedAt:1718403738e3,frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"yret",permalink:"/terminal/reference/portfolio/yret"},next:{title:"run",permalink:"/terminal/reference/reports/run"}},c={},d=[];function p(e){const t={h1:"h1",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"reports",children:"reports"}),"\n","\n",(0,n.jsx)("ul",{className:"grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6",children:(0,n.jsx)(s.A,{title:"run",description:"Learn how to effectively run a notebook from a specific location using",url:"reports/run"})})]})}function m(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}},62510:(e,t,r)=>{r.d(t,{A:()=>a});var n=r(28774),o=r(34164),s=(r(96540),r(56347)),i=r(74848);function a(e){let{title:t,url:r,description:a,command:l}=e;const{pathname:c}=(0,s.zy)(),d=c.replace(/\/v\d+/,"");return(0,i.jsxs)(n.A,{className:(0,o.A)("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",{header_docs_terminal:d.startsWith("/terminal"),"bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]":d.startsWith("/sdk")||d.startsWith("/cli")||d.startsWith("/platform"),"bg-gradient-to-r from-grey-800 to-purple-800":d.startsWith("/bot"),header_docs:!(d.startsWith("/terminal")||d.startsWith("/sdk")||d.startsWith("/platform")||d.startsWith("/bot")||d.startsWith("/cli"))}),to:r,children:[(0,i.jsx)("div",{className:"absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"}),(0,i.jsxs)("p",{className:"py-2 font-bold text-lg my-0",children:[t,""]}),a?(0,i.jsx)("p",{className:"text-grey-200 text-xs mt-2 mb-0",children:a}):null]})}},28453:(e,t,r)=>{r.d(t,{R:()=>i,x:()=>a});var n=r(96540);const o={},s=n.createContext(o);function i(e){const t=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]);

assets/js/010a60cc.bcd5b61a.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[79947],{79263:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>m,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var n=r(74848),o=r(28453),s=r(62510);const i={},a="reports",l={id:"terminal/reference/reports/index",title:"reports",description:"<ReferenceCard",source:"@site/content/terminal/reference/reports/index.mdx",sourceDirName:"terminal/reference/reports",slug:"/terminal/reference/reports/",permalink:"/terminal/reference/reports/",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/terminal/reference/reports/index.mdx",tags:[],version:"current",lastUpdatedBy:"Henrique Joaquim",lastUpdatedAt:1718799515e3,frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"yret",permalink:"/terminal/reference/portfolio/yret"},next:{title:"run",permalink:"/terminal/reference/reports/run"}},c={},d=[];function p(e){const t={h1:"h1",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"reports",children:"reports"}),"\n","\n",(0,n.jsx)("ul",{className:"grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6",children:(0,n.jsx)(s.A,{title:"run",description:"Learn how to effectively run a notebook from a specific location using",url:"reports/run"})})]})}function m(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}},62510:(e,t,r)=>{r.d(t,{A:()=>a});var n=r(28774),o=r(34164),s=(r(96540),r(56347)),i=r(74848);function a(e){let{title:t,url:r,description:a,command:l}=e;const{pathname:c}=(0,s.zy)(),d=c.replace(/\/v\d+/,"");return(0,i.jsxs)(n.A,{className:(0,o.A)("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",{header_docs_terminal:d.startsWith("/terminal"),"bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]":d.startsWith("/sdk")||d.startsWith("/cli")||d.startsWith("/platform"),"bg-gradient-to-r from-grey-800 to-purple-800":d.startsWith("/bot"),header_docs:!(d.startsWith("/terminal")||d.startsWith("/sdk")||d.startsWith("/platform")||d.startsWith("/bot")||d.startsWith("/cli"))}),to:r,children:[(0,i.jsx)("div",{className:"absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"}),(0,i.jsxs)("p",{className:"py-2 font-bold text-lg my-0",children:[t,""]}),a?(0,i.jsx)("p",{className:"text-grey-200 text-xs mt-2 mb-0",children:a}):null]})}},28453:(e,t,r)=>{r.d(t,{R:()=>i,x:()=>a});var n=r(96540);const o={},s=n.createContext(o);function i(e){const t=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]);

assets/js/013c5d94.5a42a714.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[26004],{93274:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>s,contentTitle:()=>i,default:()=>h,frontMatter:()=>a,metadata:()=>d,toc:()=>l});var t=o(74848),c=o(28453),r=o(94331);const a={title:"calendar",description:"Get an Economic Calendar for the day and read about the key economic indicators with the /econ calendar command.",keywords:["economic calendar","economic events","economic indicators","GDP","inflation","employment"]},i=void 0,d={id:"bot/reference/discord/economy/calendar",title:"calendar",description:"Get an Economic Calendar for the day and read about the key economic indicators with the /econ calendar command.",source:"@site/content/bot/reference/discord/economy/calendar.md",sourceDirName:"bot/reference/discord/economy",slug:"/bot/reference/discord/economy/calendar",permalink:"/bot/reference/discord/economy/calendar",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/bot/reference/discord/economy/calendar.md",tags:[],version:"current",lastUpdatedBy:"Henrique Joaquim",lastUpdatedAt:1718799515e3,frontMatter:{title:"calendar",description:"Get an Economic Calendar for the day and read about the key economic indicators with the /econ calendar command.",keywords:["economic calendar","economic events","economic indicators","GDP","inflation","employment"]},sidebar:"tutorialSidebar",previous:{title:"economy",permalink:"/bot/reference/discord/economy/"},next:{title:"commodities",permalink:"/bot/reference/discord/economy/commodities"}},s={},l=[{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:2},{value:"Examples",id:"examples",level:2}];function m(e){const n={code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",...(0,c.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.A,{title:"economy: calendar - Discord Reference | OpenBB Bot Docs"}),"\n",(0,t.jsx)(n.p,{children:"This command allows the user to retrieve an Economic Calendar for the day, which displays the upcoming economic events along with their expected impact. The Economic Calendar includes a list of key economic indicators such as GDP, inflation, employment, and more, which can provide insight into the future trajectory of the economy."}),"\n",(0,t.jsx)(n.h3,{id:"usage",children:"Usage"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-python",metastring:"wordwrap",children:"/econ calendar\n"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsx)(n.p,{children:"This command has no parameters"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"examples",children:"Examples"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"/econ calendar\n"})}),"\n",(0,t.jsx)(n.hr,{})]})}function h(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(m,{...e})}):m(e)}},94331:(e,n,o)=>{o.d(n,{A:()=>r});o(96540);var t=o(5260),c=o(74848);function r(e){let{title:n}=e;return(0,c.jsx)(t.A,{children:(0,c.jsx)("title",{children:n})})}},28453:(e,n,o)=>{o.d(n,{R:()=>a,x:()=>i});var t=o(96540);const c={},r=t.createContext(c);function a(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:a(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]);

assets/js/013c5d94.d8749fe5.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[26004],{93274:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>s,contentTitle:()=>i,default:()=>h,frontMatter:()=>a,metadata:()=>d,toc:()=>l});var t=o(74848),c=o(28453),r=o(94331);const a={title:"calendar",description:"Get an Economic Calendar for the day and read about the key economic indicators with the /econ calendar command.",keywords:["economic calendar","economic events","economic indicators","GDP","inflation","employment"]},i=void 0,d={id:"bot/reference/discord/economy/calendar",title:"calendar",description:"Get an Economic Calendar for the day and read about the key economic indicators with the /econ calendar command.",source:"@site/content/bot/reference/discord/economy/calendar.md",sourceDirName:"bot/reference/discord/economy",slug:"/bot/reference/discord/economy/calendar",permalink:"/bot/reference/discord/economy/calendar",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/bot/reference/discord/economy/calendar.md",tags:[],version:"current",lastUpdatedBy:"montezdesousa",lastUpdatedAt:1718403738e3,frontMatter:{title:"calendar",description:"Get an Economic Calendar for the day and read about the key economic indicators with the /econ calendar command.",keywords:["economic calendar","economic events","economic indicators","GDP","inflation","employment"]},sidebar:"tutorialSidebar",previous:{title:"economy",permalink:"/bot/reference/discord/economy/"},next:{title:"commodities",permalink:"/bot/reference/discord/economy/commodities"}},s={},l=[{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:2},{value:"Examples",id:"examples",level:2}];function m(e){const n={code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",...(0,c.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.A,{title:"economy: calendar - Discord Reference | OpenBB Bot Docs"}),"\n",(0,t.jsx)(n.p,{children:"This command allows the user to retrieve an Economic Calendar for the day, which displays the upcoming economic events along with their expected impact. The Economic Calendar includes a list of key economic indicators such as GDP, inflation, employment, and more, which can provide insight into the future trajectory of the economy."}),"\n",(0,t.jsx)(n.h3,{id:"usage",children:"Usage"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-python",metastring:"wordwrap",children:"/econ calendar\n"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsx)(n.p,{children:"This command has no parameters"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"examples",children:"Examples"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"/econ calendar\n"})}),"\n",(0,t.jsx)(n.hr,{})]})}function h(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(m,{...e})}):m(e)}},94331:(e,n,o)=>{o.d(n,{A:()=>r});o(96540);var t=o(5260),c=o(74848);function r(e){let{title:n}=e;return(0,c.jsx)(t.A,{children:(0,c.jsx)("title",{children:n})})}},28453:(e,n,o)=>{o.d(n,{R:()=>a,x:()=>i});var t=o(96540);const c={},r=t.createContext(c);function a(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:a(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]);

assets/js/01a870d0.3fd82fb3.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84840],{61931:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>s,default:()=>u,frontMatter:()=>d,metadata:()=>l,toc:()=>a});var i=t(74848),o=t(28453);const d={title:"v1.0.1",version:"1.0.1",date:new Date("2022-08-04T00:00:00.000Z"),description:"v1.0.1",sidebar_position:8},s=void 0,l={id:"bot/changelog/version1_0_1",title:"v1.0.1",description:"v1.0.1",source:"@site/content/bot/changelog/version1_0_1.mdx",sourceDirName:"bot/changelog",slug:"/bot/changelog/version1_0_1",permalink:"/bot/changelog/version1_0_1",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/bot/changelog/version1_0_1.mdx",tags:[],version:"current",lastUpdatedBy:"montezdesousa",lastUpdatedAt:1718403738e3,sidebarPosition:8,frontMatter:{title:"v1.0.1",version:"1.0.1",date:"2022-08-04T00:00:00.000Z",description:"v1.0.1",sidebar_position:8},sidebar:"tutorialSidebar",previous:{title:"v1.0.2",permalink:"/bot/changelog/version1_0_2"},next:{title:"v1.0.0",permalink:"/bot/changelog/version1_0_0"}},r={},a=[{value:"Added",id:"added",level:2},{value:"Changed",id:"changed",level:2},{value:"Fixed",id:"fixed",level:2}];function c(e){const n={h2:"h2",li:"li",ul:"ul",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"added",children:"Added"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'Charts : new layout on charts "classic" theme - made this default'}),"\n",(0,i.jsx)(n.li,{children:"Discovery menu including: heatmap"}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"changed",children:"Changed"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'Charts menu including: "classic" theme on charts'}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"fixed",children:"Fixed"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Due diligence menu including : added ah and pm to ! commands"}),"\n",(0,i.jsx)(n.li,{children:"Premium Flow menu including : added weekly and opening to ! commands"}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},28453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>l});var i=t(96540);const o={},d=i.createContext(o);function s(e){const n=i.useContext(d);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),i.createElement(d.Provider,{value:n},e.children)}}}]);

assets/js/01a870d0.f6efe661.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84840],{61931:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>s,default:()=>u,frontMatter:()=>d,metadata:()=>r,toc:()=>a});var i=t(74848),o=t(28453);const d={title:"v1.0.1",version:"1.0.1",date:new Date("2022-08-04T00:00:00.000Z"),description:"v1.0.1",sidebar_position:8},s=void 0,r={id:"bot/changelog/version1_0_1",title:"v1.0.1",description:"v1.0.1",source:"@site/content/bot/changelog/version1_0_1.mdx",sourceDirName:"bot/changelog",slug:"/bot/changelog/version1_0_1",permalink:"/bot/changelog/version1_0_1",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/bot/changelog/version1_0_1.mdx",tags:[],version:"current",lastUpdatedBy:"Henrique Joaquim",lastUpdatedAt:1718799515e3,sidebarPosition:8,frontMatter:{title:"v1.0.1",version:"1.0.1",date:"2022-08-04T00:00:00.000Z",description:"v1.0.1",sidebar_position:8},sidebar:"tutorialSidebar",previous:{title:"v1.0.2",permalink:"/bot/changelog/version1_0_2"},next:{title:"v1.0.0",permalink:"/bot/changelog/version1_0_0"}},l={},a=[{value:"Added",id:"added",level:2},{value:"Changed",id:"changed",level:2},{value:"Fixed",id:"fixed",level:2}];function c(e){const n={h2:"h2",li:"li",ul:"ul",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"added",children:"Added"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'Charts : new layout on charts "classic" theme - made this default'}),"\n",(0,i.jsx)(n.li,{children:"Discovery menu including: heatmap"}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"changed",children:"Changed"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'Charts menu including: "classic" theme on charts'}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"fixed",children:"Fixed"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Due diligence menu including : added ah and pm to ! commands"}),"\n",(0,i.jsx)(n.li,{children:"Premium Flow menu including : added weekly and opening to ! commands"}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},28453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>r});var i=t(96540);const o={},d=i.createContext(o);function s(e){const n=i.useContext(d);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),i.createElement(d.Provider,{value:n},e.children)}}}]);

assets/js/0221b641.231fcec8.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60515],{6604:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>s,metadata:()=>a,toc:()=>l});var r=n(74848),o=n(28453),i=n(94331);const s={title:"dt",description:"This page provides info on how to get daily transactions for certain symbols in ethereum blockchain using the 'dt' command.",keywords:["dt","transactions","symbols","ethereum","blockchain","flipsidecrypto","crypto"]},c=void 0,a={id:"terminal/reference/crypto/onchain/dt",title:"dt",description:"This page provides info on how to get daily transactions for certain symbols in ethereum blockchain using the 'dt' command.",source:"@site/content/terminal/reference/crypto/onchain/dt.md",sourceDirName:"terminal/reference/crypto/onchain",slug:"/terminal/reference/crypto/onchain/dt",permalink:"/terminal/reference/crypto/onchain/dt",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/terminal/reference/crypto/onchain/dt.md",tags:[],version:"current",lastUpdatedBy:"Henrique Joaquim",lastUpdatedAt:1718799515e3,frontMatter:{title:"dt",description:"This page provides info on how to get daily transactions for certain symbols in ethereum blockchain using the 'dt' command.",keywords:["dt","transactions","symbols","ethereum","blockchain","flipsidecrypto","crypto"]},sidebar:"tutorialSidebar",previous:{title:"ds",permalink:"/terminal/reference/crypto/onchain/ds"},next:{title:"dvcp",permalink:"/terminal/reference/crypto/onchain/dvcp"}},d={},l=[{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:2}];function p(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(i.A,{title:"crypto/onchain/dt - Reference | OpenBB Terminal Docs"}),"\n",(0,r.jsxs)(t.p,{children:["Get daily transactions for certain symbols in ethereum blockchain [Source: ",(0,r.jsx)(t.a,{href:"https://sdk.flipsidecrypto.xyz/shroomdk",children:"https://sdk.flipsidecrypto.xyz/shroomdk"}),"]"]}),"\n",(0,r.jsx)(t.h3,{id:"usage",children:"Usage"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-python",children:"dt\n"})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsx)(t.p,{children:"This command has no parameters"}),"\n",(0,r.jsx)(t.hr,{})]})}function h(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},94331:(e,t,n)=>{n.d(t,{A:()=>i});n(96540);var r=n(5260),o=n(74848);function i(e){let{title:t}=e;return(0,o.jsx)(r.A,{children:(0,o.jsx)("title",{children:t})})}},28453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>c});var r=n(96540);const o={},i=r.createContext(o);function s(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]);

assets/js/0221b641.729a88c7.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60515],{6604:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>s,metadata:()=>a,toc:()=>l});var r=n(74848),o=n(28453),i=n(94331);const s={title:"dt",description:"This page provides info on how to get daily transactions for certain symbols in ethereum blockchain using the 'dt' command.",keywords:["dt","transactions","symbols","ethereum","blockchain","flipsidecrypto","crypto"]},c=void 0,a={id:"terminal/reference/crypto/onchain/dt",title:"dt",description:"This page provides info on how to get daily transactions for certain symbols in ethereum blockchain using the 'dt' command.",source:"@site/content/terminal/reference/crypto/onchain/dt.md",sourceDirName:"terminal/reference/crypto/onchain",slug:"/terminal/reference/crypto/onchain/dt",permalink:"/terminal/reference/crypto/onchain/dt",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/terminal/reference/crypto/onchain/dt.md",tags:[],version:"current",lastUpdatedBy:"montezdesousa",lastUpdatedAt:1718403738e3,frontMatter:{title:"dt",description:"This page provides info on how to get daily transactions for certain symbols in ethereum blockchain using the 'dt' command.",keywords:["dt","transactions","symbols","ethereum","blockchain","flipsidecrypto","crypto"]},sidebar:"tutorialSidebar",previous:{title:"ds",permalink:"/terminal/reference/crypto/onchain/ds"},next:{title:"dvcp",permalink:"/terminal/reference/crypto/onchain/dvcp"}},d={},l=[{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:2}];function p(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(i.A,{title:"crypto/onchain/dt - Reference | OpenBB Terminal Docs"}),"\n",(0,r.jsxs)(t.p,{children:["Get daily transactions for certain symbols in ethereum blockchain [Source: ",(0,r.jsx)(t.a,{href:"https://sdk.flipsidecrypto.xyz/shroomdk",children:"https://sdk.flipsidecrypto.xyz/shroomdk"}),"]"]}),"\n",(0,r.jsx)(t.h3,{id:"usage",children:"Usage"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-python",children:"dt\n"})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsx)(t.p,{children:"This command has no parameters"}),"\n",(0,r.jsx)(t.hr,{})]})}function h(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},94331:(e,t,n)=>{n.d(t,{A:()=>i});n(96540);var r=n(5260),o=n(74848);function i(e){let{title:t}=e;return(0,o.jsx)(r.A,{children:(0,o.jsx)("title",{children:t})})}},28453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>c});var r=n(96540);const o={},i=r.createContext(o);function s(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]);

assets/js/022957b9.76cd702e.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97901],{9727:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>c,default:()=>u,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var r=n(74848),o=n(28453),s=n(94331);const a={title:"contracts",description:"The page provides details on how to retrieve the top 15 Government contracts by amount for all tickers using the /disc contracts command. It gives insights into the total value of Government contracts awarded to various companies, helping users understand their financial health.",keywords:["contracts","Government contracts","tickers","database","financial health","/disc contracts"]},c=void 0,i={id:"bot/reference/discord/discovery/contracts",title:"contracts",description:"The page provides details on how to retrieve the top 15 Government contracts by amount for all tickers using the /disc contracts command. It gives insights into the total value of Government contracts awarded to various companies, helping users understand their financial health.",source:"@site/content/bot/reference/discord/discovery/contracts.md",sourceDirName:"bot/reference/discord/discovery",slug:"/bot/reference/discord/discovery/contracts",permalink:"/bot/reference/discord/discovery/contracts",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/bot/reference/discord/discovery/contracts.md",tags:[],version:"current",lastUpdatedBy:"Henrique Joaquim",lastUpdatedAt:1718799515e3,frontMatter:{title:"contracts",description:"The page provides details on how to retrieve the top 15 Government contracts by amount for all tickers using the /disc contracts command. It gives insights into the total value of Government contracts awarded to various companies, helping users understand their financial health.",keywords:["contracts","Government contracts","tickers","database","financial health","/disc contracts"]},sidebar:"tutorialSidebar",previous:{title:"arktrades",permalink:"/bot/reference/discord/discovery/arktrades"},next:{title:"fgindex",permalink:"/bot/reference/discord/discovery/fgindex"}},d={},l=[{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:2},{value:"Examples",id:"examples",level:2}];function h(e){const t={code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.A,{title:"discovery: contracts - Discord Reference | OpenBB Bot Docs"}),"\n",(0,r.jsx)(t.p,{children:"This command allows the user to retrieve the Top 15 Government contracts by amount for all tickers. This is a helpful tool for those who want to quickly get an overview of the total value of Government contracts awarded to various companies. The data is retrieved from a database of contracts and can be used to gain valuable insights into the financial health of those companies."}),"\n",(0,r.jsx)(t.h3,{id:"usage",children:"Usage"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-python",metastring:"wordwrap",children:"/disc contracts\n"})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsx)(t.p,{children:"This command has no parameters"}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h2,{id:"examples",children:"Examples"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:"/disc contracts\n"})}),"\n",(0,r.jsx)(t.hr,{})]})}function u(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},94331:(e,t,n)=>{n.d(t,{A:()=>s});n(96540);var r=n(5260),o=n(74848);function s(e){let{title:t}=e;return(0,o.jsx)(r.A,{children:(0,o.jsx)("title",{children:t})})}},28453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>c});var r=n(96540);const o={},s=r.createContext(o);function a(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]);

assets/js/022957b9.9625706e.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97901],{9727:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>c,default:()=>u,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var r=n(74848),o=n(28453),s=n(94331);const a={title:"contracts",description:"The page provides details on how to retrieve the top 15 Government contracts by amount for all tickers using the /disc contracts command. It gives insights into the total value of Government contracts awarded to various companies, helping users understand their financial health.",keywords:["contracts","Government contracts","tickers","database","financial health","/disc contracts"]},c=void 0,i={id:"bot/reference/discord/discovery/contracts",title:"contracts",description:"The page provides details on how to retrieve the top 15 Government contracts by amount for all tickers using the /disc contracts command. It gives insights into the total value of Government contracts awarded to various companies, helping users understand their financial health.",source:"@site/content/bot/reference/discord/discovery/contracts.md",sourceDirName:"bot/reference/discord/discovery",slug:"/bot/reference/discord/discovery/contracts",permalink:"/bot/reference/discord/discovery/contracts",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/bot/reference/discord/discovery/contracts.md",tags:[],version:"current",lastUpdatedBy:"montezdesousa",lastUpdatedAt:1718403738e3,frontMatter:{title:"contracts",description:"The page provides details on how to retrieve the top 15 Government contracts by amount for all tickers using the /disc contracts command. It gives insights into the total value of Government contracts awarded to various companies, helping users understand their financial health.",keywords:["contracts","Government contracts","tickers","database","financial health","/disc contracts"]},sidebar:"tutorialSidebar",previous:{title:"arktrades",permalink:"/bot/reference/discord/discovery/arktrades"},next:{title:"fgindex",permalink:"/bot/reference/discord/discovery/fgindex"}},d={},l=[{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:2},{value:"Examples",id:"examples",level:2}];function h(e){const t={code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.A,{title:"discovery: contracts - Discord Reference | OpenBB Bot Docs"}),"\n",(0,r.jsx)(t.p,{children:"This command allows the user to retrieve the Top 15 Government contracts by amount for all tickers. This is a helpful tool for those who want to quickly get an overview of the total value of Government contracts awarded to various companies. The data is retrieved from a database of contracts and can be used to gain valuable insights into the financial health of those companies."}),"\n",(0,r.jsx)(t.h3,{id:"usage",children:"Usage"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-python",metastring:"wordwrap",children:"/disc contracts\n"})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsx)(t.p,{children:"This command has no parameters"}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h2,{id:"examples",children:"Examples"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:"/disc contracts\n"})}),"\n",(0,r.jsx)(t.hr,{})]})}function u(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},94331:(e,t,n)=>{n.d(t,{A:()=>s});n(96540);var r=n(5260),o=n(74848);function s(e){let{title:t}=e;return(0,o.jsx)(r.A,{children:(0,o.jsx)("title",{children:t})})}},28453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>c});var r=n(96540);const o={},s=r.createContext(o);function a(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]);

assets/js/02582d64.4b8f2005.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[18466],{11490:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>l,contentTitle:()=>c,default:()=>m,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var s=t(74848),n=t(28453),o=t(62510);const i={},c="screeners",a={id:"bot/reference/discord/screeners/index",title:"screeners",description:"<ReferenceCard",source:"@site/content/bot/reference/discord/screeners/index.mdx",sourceDirName:"bot/reference/discord/screeners",slug:"/bot/reference/discord/screeners/",permalink:"/bot/reference/discord/screeners/",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/bot/reference/discord/screeners/index.mdx",tags:[],version:"current",lastUpdatedBy:"montezdesousa",lastUpdatedAt:1718403738e3,frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"1hr",permalink:"/bot/reference/discord/pop/1hr"},next:{title:"ah",permalink:"/bot/reference/discord/screeners/ah"}},l={},d=[];function h(e){const r={h1:"h1",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.h1,{id:"screeners",children:"screeners"}),"\n","\n",(0,s.jsxs)("ul",{className:"grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6",children:[(0,s.jsx)(o.A,{title:"ah",description:"This command allows the user to retrieve After-Hours stock movers according to a chosen screener.",url:"/bot/reference/discord/screeners/ah"}),(0,s.jsx)(o.A,{title:"ah_all",description:"This command retrieves all available after-hours screeners (gainers, losers, and most active). It is helpful for...",url:"/bot/reference/discord/screeners/ah_all"}),(0,s.jsx)(o.A,{title:"all",description:"This command allows the user to view all available screeners during market hours. The results can then be used to...",url:"/bot/reference/discord/screeners/all"}),(0,s.jsx)(o.A,{title:"pm",description:"This command offers the user the ability to view the top pre-market gainers, losers, and most active, giving the...",url:"/bot/reference/discord/screeners/pm"}),(0,s.jsx)(o.A,{title:"pm_all",description:"This command allows the user to retrieve all available pre-market screeners.",url:"/bot/reference/discord/screeners/pm_all"}),(0,s.jsx)(o.A,{title:"technical",description:"This command allows the user to retrieve stock screener results according to the chosen technical signal.",url:"/bot/reference/discord/screeners/technical"})]})]})}function m(e={}){const{wrapper:r}={...(0,n.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},62510:(e,r,t)=>{t.d(r,{A:()=>c});var s=t(28774),n=t(34164),o=(t(96540),t(56347)),i=t(74848);function c(e){let{title:r,url:t,description:c,command:a}=e;const{pathname:l}=(0,o.zy)(),d=l.replace(/\/v\d+/,"");return(0,i.jsxs)(s.A,{className:(0,n.A)("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",{header_docs_terminal:d.startsWith("/terminal"),"bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]":d.startsWith("/sdk")||d.startsWith("/cli")||d.startsWith("/platform"),"bg-gradient-to-r from-grey-800 to-purple-800":d.startsWith("/bot"),header_docs:!(d.startsWith("/terminal")||d.startsWith("/sdk")||d.startsWith("/platform")||d.startsWith("/bot")||d.startsWith("/cli"))}),to:t,children:[(0,i.jsx)("div",{className:"absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"}),(0,i.jsxs)("p",{className:"py-2 font-bold text-lg my-0",children:[r,""]}),c?(0,i.jsx)("p",{className:"text-grey-200 text-xs mt-2 mb-0",children:c}):null]})}},28453:(e,r,t)=>{t.d(r,{R:()=>i,x:()=>c});var s=t(96540);const n={},o=s.createContext(n);function i(e){const r=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),s.createElement(o.Provider,{value:r},e.children)}}}]);

assets/js/02582d64.b8b8f09e.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[18466],{11490:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>l,contentTitle:()=>c,default:()=>m,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var s=t(74848),n=t(28453),o=t(62510);const i={},c="screeners",a={id:"bot/reference/discord/screeners/index",title:"screeners",description:"<ReferenceCard",source:"@site/content/bot/reference/discord/screeners/index.mdx",sourceDirName:"bot/reference/discord/screeners",slug:"/bot/reference/discord/screeners/",permalink:"/bot/reference/discord/screeners/",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/bot/reference/discord/screeners/index.mdx",tags:[],version:"current",lastUpdatedBy:"Henrique Joaquim",lastUpdatedAt:1718799515e3,frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"1hr",permalink:"/bot/reference/discord/pop/1hr"},next:{title:"ah",permalink:"/bot/reference/discord/screeners/ah"}},l={},d=[];function h(e){const r={h1:"h1",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.h1,{id:"screeners",children:"screeners"}),"\n","\n",(0,s.jsxs)("ul",{className:"grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6",children:[(0,s.jsx)(o.A,{title:"ah",description:"This command allows the user to retrieve After-Hours stock movers according to a chosen screener.",url:"/bot/reference/discord/screeners/ah"}),(0,s.jsx)(o.A,{title:"ah_all",description:"This command retrieves all available after-hours screeners (gainers, losers, and most active). It is helpful for...",url:"/bot/reference/discord/screeners/ah_all"}),(0,s.jsx)(o.A,{title:"all",description:"This command allows the user to view all available screeners during market hours. The results can then be used to...",url:"/bot/reference/discord/screeners/all"}),(0,s.jsx)(o.A,{title:"pm",description:"This command offers the user the ability to view the top pre-market gainers, losers, and most active, giving the...",url:"/bot/reference/discord/screeners/pm"}),(0,s.jsx)(o.A,{title:"pm_all",description:"This command allows the user to retrieve all available pre-market screeners.",url:"/bot/reference/discord/screeners/pm_all"}),(0,s.jsx)(o.A,{title:"technical",description:"This command allows the user to retrieve stock screener results according to the chosen technical signal.",url:"/bot/reference/discord/screeners/technical"})]})]})}function m(e={}){const{wrapper:r}={...(0,n.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},62510:(e,r,t)=>{t.d(r,{A:()=>c});var s=t(28774),n=t(34164),o=(t(96540),t(56347)),i=t(74848);function c(e){let{title:r,url:t,description:c,command:a}=e;const{pathname:l}=(0,o.zy)(),d=l.replace(/\/v\d+/,"");return(0,i.jsxs)(s.A,{className:(0,n.A)("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",{header_docs_terminal:d.startsWith("/terminal"),"bg-gradient-to-r from-[#541c12] to-[rgba(84, 29, 19, 1)]":d.startsWith("/sdk")||d.startsWith("/cli")||d.startsWith("/platform"),"bg-gradient-to-r from-grey-800 to-purple-800":d.startsWith("/bot"),header_docs:!(d.startsWith("/terminal")||d.startsWith("/sdk")||d.startsWith("/platform")||d.startsWith("/bot")||d.startsWith("/cli"))}),to:t,children:[(0,i.jsx)("div",{className:"absolute top-0 right-0 left-0 bottom-0 bg-gradient-to-t from-black to-transparent"}),(0,i.jsxs)("p",{className:"py-2 font-bold text-lg my-0",children:[r,""]}),c?(0,i.jsx)("p",{className:"text-grey-200 text-xs mt-2 mb-0",children:c}):null]})}},28453:(e,r,t)=>{t.d(r,{R:()=>i,x:()=>c});var s=t(96540);const n={},o=s.createContext(n);function i(e){const r=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),s.createElement(o.Provider,{value:r},e.children)}}}]);

assets/js/029ca369.747be768.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[42106],{46606:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>a,contentTitle:()=>i,default:()=>h,frontMatter:()=>c,metadata:()=>d,toc:()=>p});var o=r(74848),s=r(28453),n=r(94331);const c={title:"fees",description:"The page provides information about how to fetch the fee rate of top crypto protocols on a specified date. It helps users to compare different protocols' fees, enhancing their decision-making process.",keywords:["crypto","fees","comparison","date","crypto fees","protocol"]},i=void 0,d={id:"bot/reference/discord/crypto/fees",title:"fees",description:"The page provides information about how to fetch the fee rate of top crypto protocols on a specified date. It helps users to compare different protocols' fees, enhancing their decision-making process.",source:"@site/content/bot/reference/discord/crypto/fees.md",sourceDirName:"bot/reference/discord/crypto",slug:"/bot/reference/discord/crypto/fees",permalink:"/bot/reference/discord/crypto/fees",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/bot/reference/discord/crypto/fees.md",tags:[],version:"current",lastUpdatedBy:"montezdesousa",lastUpdatedAt:1718403738e3,frontMatter:{title:"fees",description:"The page provides information about how to fetch the fee rate of top crypto protocols on a specified date. It helps users to compare different protocols' fees, enhancing their decision-making process.",keywords:["crypto","fees","comparison","date","crypto fees","protocol"]},sidebar:"tutorialSidebar",previous:{title:"table",permalink:"/bot/reference/discord/crypto/defi/table"},next:{title:"ir",permalink:"/bot/reference/discord/crypto/ir"}},a={},p=[{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:2},{value:"Examples",id:"examples",level:2}];function l(e){const t={code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.A,{title:"crypto: fees - Discord Reference | OpenBB Bot Docs"}),"\n",(0,o.jsx)(t.p,{children:"This will provide the user with the fee rate of the top crypto protocols on a specified date, allowing the user to compare different protocols' fees and make an informed decision."}),"\n",(0,o.jsx)(t.h3,{id:"usage",children:"Usage"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-python",metastring:"wordwrap",children:"/crypto fees date\n"})}),"\n",(0,o.jsx)(t.hr,{}),"\n",(0,o.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(t.table,{children:[(0,o.jsx)(t.thead,{children:(0,o.jsxs)(t.tr,{children:[(0,o.jsx)(t.th,{children:"Name"}),(0,o.jsx)(t.th,{children:"Description"}),(0,o.jsx)(t.th,{children:"Optional"}),(0,o.jsx)(t.th,{children:"Choices"})]})}),(0,o.jsx)(t.tbody,{children:(0,o.jsxs)(t.tr,{children:[(0,o.jsx)(t.td,{children:"date"}),(0,o.jsx)(t.td,{children:"Date to get fees for (e.g., 2022-01-01)"}),(0,o.jsx)(t.td,{children:"False"}),(0,o.jsx)(t.td,{children:"None"})]})})]}),"\n",(0,o.jsx)(t.hr,{}),"\n",(0,o.jsx)(t.h2,{id:"examples",children:"Examples"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"/crypto fees date: 2022-09-19\n"})}),"\n",(0,o.jsx)(t.hr,{})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},94331:(e,t,r)=>{r.d(t,{A:()=>n});r(96540);var o=r(5260),s=r(74848);function n(e){let{title:t}=e;return(0,s.jsx)(o.A,{children:(0,s.jsx)("title",{children:t})})}},28453:(e,t,r)=>{r.d(t,{R:()=>c,x:()=>i});var o=r(96540);const s={},n=o.createContext(s);function c(e){const t=o.useContext(n);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),o.createElement(n.Provider,{value:t},e.children)}}}]);

assets/js/029ca369.7733f2a1.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[42106],{46606:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>d,toc:()=>p});var o=r(74848),s=r(28453),n=r(94331);const i={title:"fees",description:"The page provides information about how to fetch the fee rate of top crypto protocols on a specified date. It helps users to compare different protocols' fees, enhancing their decision-making process.",keywords:["crypto","fees","comparison","date","crypto fees","protocol"]},c=void 0,d={id:"bot/reference/discord/crypto/fees",title:"fees",description:"The page provides information about how to fetch the fee rate of top crypto protocols on a specified date. It helps users to compare different protocols' fees, enhancing their decision-making process.",source:"@site/content/bot/reference/discord/crypto/fees.md",sourceDirName:"bot/reference/discord/crypto",slug:"/bot/reference/discord/crypto/fees",permalink:"/bot/reference/discord/crypto/fees",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/bot/reference/discord/crypto/fees.md",tags:[],version:"current",lastUpdatedBy:"Henrique Joaquim",lastUpdatedAt:1718799515e3,frontMatter:{title:"fees",description:"The page provides information about how to fetch the fee rate of top crypto protocols on a specified date. It helps users to compare different protocols' fees, enhancing their decision-making process.",keywords:["crypto","fees","comparison","date","crypto fees","protocol"]},sidebar:"tutorialSidebar",previous:{title:"table",permalink:"/bot/reference/discord/crypto/defi/table"},next:{title:"ir",permalink:"/bot/reference/discord/crypto/ir"}},a={},p=[{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:2},{value:"Examples",id:"examples",level:2}];function l(e){const t={code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.A,{title:"crypto: fees - Discord Reference | OpenBB Bot Docs"}),"\n",(0,o.jsx)(t.p,{children:"This will provide the user with the fee rate of the top crypto protocols on a specified date, allowing the user to compare different protocols' fees and make an informed decision."}),"\n",(0,o.jsx)(t.h3,{id:"usage",children:"Usage"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-python",metastring:"wordwrap",children:"/crypto fees date\n"})}),"\n",(0,o.jsx)(t.hr,{}),"\n",(0,o.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(t.table,{children:[(0,o.jsx)(t.thead,{children:(0,o.jsxs)(t.tr,{children:[(0,o.jsx)(t.th,{children:"Name"}),(0,o.jsx)(t.th,{children:"Description"}),(0,o.jsx)(t.th,{children:"Optional"}),(0,o.jsx)(t.th,{children:"Choices"})]})}),(0,o.jsx)(t.tbody,{children:(0,o.jsxs)(t.tr,{children:[(0,o.jsx)(t.td,{children:"date"}),(0,o.jsx)(t.td,{children:"Date to get fees for (e.g., 2022-01-01)"}),(0,o.jsx)(t.td,{children:"False"}),(0,o.jsx)(t.td,{children:"None"})]})})]}),"\n",(0,o.jsx)(t.hr,{}),"\n",(0,o.jsx)(t.h2,{id:"examples",children:"Examples"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"/crypto fees date: 2022-09-19\n"})}),"\n",(0,o.jsx)(t.hr,{})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},94331:(e,t,r)=>{r.d(t,{A:()=>n});r(96540);var o=r(5260),s=r(74848);function n(e){let{title:t}=e;return(0,s.jsx)(o.A,{children:(0,s.jsx)("title",{children:t})})}},28453:(e,t,r)=>{r.d(t,{R:()=>i,x:()=>c});var o=r(96540);const s={},n=o.createContext(s);function i(e){const t=o.useContext(n);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),o.createElement(n.Provider,{value:t},e.children)}}}]);

assets/js/02b4c32f.0c1c9440.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[20105],{28172:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>o,toc:()=>l});var s=r(74848),n=r(28453),a=r(94331);const i={title:"cpcs",description:"CPCS is a powerful tool that allows users to view company distribution based on various parameters like sector, market cap and more. It offers customizable options to control the data display.",keywords:["CPCS","Company distribution by Country, Sector and Market Cap","Country distribution data","Sector distribution data","Market cap data","Data visualization","Data customization"]},c=void 0,o={id:"terminal/reference/stocks/sia/cpcs",title:"cpcs",description:"CPCS is a powerful tool that allows users to view company distribution based on various parameters like sector, market cap and more. It offers customizable options to control the data display.",source:"@site/content/terminal/reference/stocks/sia/cpcs.md",sourceDirName:"terminal/reference/stocks/sia",slug:"/terminal/reference/stocks/sia/cpcs",permalink:"/terminal/reference/stocks/sia/cpcs",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/terminal/reference/stocks/sia/cpcs.md",tags:[],version:"current",lastUpdatedBy:"Henrique Joaquim",lastUpdatedAt:1718799515e3,frontMatter:{title:"cpcs",description:"CPCS is a powerful tool that allows users to view company distribution based on various parameters like sector, market cap and more. It offers customizable options to control the data display.",keywords:["CPCS","Company distribution by Country, Sector and Market Cap","Country distribution data","Sector distribution data","Market cap data","Data visualization","Data customization"]},sidebar:"tutorialSidebar",previous:{title:"cpci",permalink:"/terminal/reference/stocks/sia/cpci"},next:{title:"cpic",permalink:"/terminal/reference/stocks/sia/cpic"}},d={},l=[{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:2}];function p(e){const t={code:"code",h2:"h2",h3:"h3",hr:"hr",img:"img",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(a.A,{title:"stocks/sia/cpcs - Reference | OpenBB Terminal Docs"}),"\n",(0,s.jsx)(t.p,{children:"Companies per Country based on Sector and Market Cap"}),"\n",(0,s.jsx)(t.h3,{id:"usage",children:"Usage"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-python",children:"cpcs [-M MAX_COUNTRIES_TO_DISPLAY] [-m MIN_PCT_TO_DISPLAY_COUNTRY] [-r]\n"})}),"\n",(0,s.jsx)(t.hr,{}),"\n",(0,s.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Name"}),(0,s.jsx)(t.th,{children:"Description"}),(0,s.jsx)(t.th,{children:"Default"}),(0,s.jsx)(t.th,{children:"Optional"}),(0,s.jsx)(t.th,{children:"Choices"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"max_countries_to_display"}),(0,s.jsx)(t.td,{children:"Maximum number of countries to display"}),(0,s.jsx)(t.td,{children:"15"}),(0,s.jsx)(t.td,{children:"True"}),(0,s.jsx)(t.td,{children:"None"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"min_pct_to_display_country"}),(0,s.jsx)(t.td,{children:"Minimum percentage to display country"}),(0,s.jsx)(t.td,{children:"0.015"}),(0,s.jsx)(t.td,{children:"True"}),(0,s.jsx)(t.td,{children:"None"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"raw"}),(0,s.jsx)(t.td,{children:"Output all raw data"}),(0,s.jsx)(t.td,{children:"False"}),(0,s.jsx)(t.td,{children:"True"}),(0,s.jsx)(t.td,{children:"None"})]})]})]}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.img,{src:"https://user-images.githubusercontent.com/46355364/153896494-5c0c9c00-aa2a-45cb-8a93-cfaa908b35df.png",alt:"CPCS"})}),"\n",(0,s.jsx)(t.hr,{})]})}function u(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},94331:(e,t,r)=>{r.d(t,{A:()=>a});r(96540);var s=r(5260),n=r(74848);function a(e){let{title:t}=e;return(0,n.jsx)(s.A,{children:(0,n.jsx)("title",{children:t})})}},28453:(e,t,r)=>{r.d(t,{R:()=>i,x:()=>c});var s=r(96540);const n={},a=s.createContext(n);function i(e){const t=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),s.createElement(a.Provider,{value:t},e.children)}}}]);

assets/js/02b4c32f.19e3f90a.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[20105],{28172:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var s=r(74848),n=r(28453),a=r(94331);const i={title:"cpcs",description:"CPCS is a powerful tool that allows users to view company distribution based on various parameters like sector, market cap and more. It offers customizable options to control the data display.",keywords:["CPCS","Company distribution by Country, Sector and Market Cap","Country distribution data","Sector distribution data","Market cap data","Data visualization","Data customization"]},o=void 0,c={id:"terminal/reference/stocks/sia/cpcs",title:"cpcs",description:"CPCS is a powerful tool that allows users to view company distribution based on various parameters like sector, market cap and more. It offers customizable options to control the data display.",source:"@site/content/terminal/reference/stocks/sia/cpcs.md",sourceDirName:"terminal/reference/stocks/sia",slug:"/terminal/reference/stocks/sia/cpcs",permalink:"/terminal/reference/stocks/sia/cpcs",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/terminal/reference/stocks/sia/cpcs.md",tags:[],version:"current",lastUpdatedBy:"montezdesousa",lastUpdatedAt:1718403738e3,frontMatter:{title:"cpcs",description:"CPCS is a powerful tool that allows users to view company distribution based on various parameters like sector, market cap and more. It offers customizable options to control the data display.",keywords:["CPCS","Company distribution by Country, Sector and Market Cap","Country distribution data","Sector distribution data","Market cap data","Data visualization","Data customization"]},sidebar:"tutorialSidebar",previous:{title:"cpci",permalink:"/terminal/reference/stocks/sia/cpci"},next:{title:"cpic",permalink:"/terminal/reference/stocks/sia/cpic"}},d={},l=[{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:2}];function p(e){const t={code:"code",h2:"h2",h3:"h3",hr:"hr",img:"img",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(a.A,{title:"stocks/sia/cpcs - Reference | OpenBB Terminal Docs"}),"\n",(0,s.jsx)(t.p,{children:"Companies per Country based on Sector and Market Cap"}),"\n",(0,s.jsx)(t.h3,{id:"usage",children:"Usage"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-python",children:"cpcs [-M MAX_COUNTRIES_TO_DISPLAY] [-m MIN_PCT_TO_DISPLAY_COUNTRY] [-r]\n"})}),"\n",(0,s.jsx)(t.hr,{}),"\n",(0,s.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Name"}),(0,s.jsx)(t.th,{children:"Description"}),(0,s.jsx)(t.th,{children:"Default"}),(0,s.jsx)(t.th,{children:"Optional"}),(0,s.jsx)(t.th,{children:"Choices"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"max_countries_to_display"}),(0,s.jsx)(t.td,{children:"Maximum number of countries to display"}),(0,s.jsx)(t.td,{children:"15"}),(0,s.jsx)(t.td,{children:"True"}),(0,s.jsx)(t.td,{children:"None"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"min_pct_to_display_country"}),(0,s.jsx)(t.td,{children:"Minimum percentage to display country"}),(0,s.jsx)(t.td,{children:"0.015"}),(0,s.jsx)(t.td,{children:"True"}),(0,s.jsx)(t.td,{children:"None"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"raw"}),(0,s.jsx)(t.td,{children:"Output all raw data"}),(0,s.jsx)(t.td,{children:"False"}),(0,s.jsx)(t.td,{children:"True"}),(0,s.jsx)(t.td,{children:"None"})]})]})]}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.img,{src:"https://user-images.githubusercontent.com/46355364/153896494-5c0c9c00-aa2a-45cb-8a93-cfaa908b35df.png",alt:"CPCS"})}),"\n",(0,s.jsx)(t.hr,{})]})}function u(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},94331:(e,t,r)=>{r.d(t,{A:()=>a});r(96540);var s=r(5260),n=r(74848);function a(e){let{title:t}=e;return(0,n.jsx)(s.A,{children:(0,n.jsx)("title",{children:t})})}},28453:(e,t,r)=>{r.d(t,{R:()=>i,x:()=>o});var s=r(96540);const n={},a=s.createContext(n);function i(e){const t=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),s.createElement(a.Provider,{value:t},e.children)}}}]);

assets/js/02bfdfd2.64a55ebc.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[29237],{37683:(e,a,n)=>{n.r(a),n.d(a,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var t=n(74848),r=n(28453),s=n(94331);const i={title:"fama_raw",description:"The page provides detailed information on retrieving Fama French data through the openbb.stocks.fa.fama_raw() method in the OpenBB terminal. It serves as a resource for financial analysis and coding in Python involving DCF models.",keywords:["Fama French data","openbb stocks","fa fama raw","Data Frame","coding in Python","fundamental analysis","DCF model","OpenBB-finance"]},o=void 0,c={id:"sdk/reference/stocks/fa/fama_raw",title:"fama_raw",description:"The page provides detailed information on retrieving Fama French data through the openbb.stocks.fa.fama_raw() method in the OpenBB terminal. It serves as a resource for financial analysis and coding in Python involving DCF models.",source:"@site/content/sdk/reference/stocks/fa/fama_raw.md",sourceDirName:"sdk/reference/stocks/fa",slug:"/sdk/reference/stocks/fa/fama_raw",permalink:"/sdk/reference/stocks/fa/fama_raw",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/sdk/reference/stocks/fa/fama_raw.md",tags:[],version:"current",lastUpdatedBy:"Henrique Joaquim",lastUpdatedAt:1718799515e3,frontMatter:{title:"fama_raw",description:"The page provides detailed information on retrieving Fama French data through the openbb.stocks.fa.fama_raw() method in the OpenBB terminal. It serves as a resource for financial analysis and coding in Python involving DCF models.",keywords:["Fama French data","openbb stocks","fa fama raw","Data Frame","coding in Python","fundamental analysis","DCF model","OpenBB-finance"]},sidebar:"tutorialSidebar",previous:{title:"fama_coe",permalink:"/sdk/reference/stocks/fa/fama_coe"},next:{title:"fraud",permalink:"/sdk/reference/stocks/fa/fraud"}},d={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2}];function f(e){const a={a:"a",code:"code",h2:"h2",hr:"hr",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.A,{title:"stocks.fa.fama_raw - Reference | OpenBB SDK Docs"}),"\n",(0,t.jsx)(a.p,{children:"Get Fama French data"}),"\n",(0,t.jsxs)(a.p,{children:["Source Code: [",(0,t.jsx)(a.a,{href:"https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/dcf_model.py#L240",children:"link"}),"]"]}),"\n",(0,t.jsx)(a.pre,{children:(0,t.jsx)(a.code,{className:"language-python",children:"openbb.stocks.fa.fama_raw()\n"})}),"\n",(0,t.jsx)(a.hr,{}),"\n",(0,t.jsx)(a.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsx)(a.p,{children:"This function does not take any parameters."}),"\n",(0,t.jsx)(a.hr,{}),"\n",(0,t.jsx)(a.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(a.table,{children:[(0,t.jsx)(a.thead,{children:(0,t.jsxs)(a.tr,{children:[(0,t.jsx)(a.th,{children:"Type"}),(0,t.jsx)(a.th,{children:"Description"})]})}),(0,t.jsx)(a.tbody,{children:(0,t.jsxs)(a.tr,{children:[(0,t.jsx)(a.td,{children:"pd.DataFrame"}),(0,t.jsx)(a.td,{children:"Fama French data"})]})})]}),"\n",(0,t.jsx)(a.hr,{})]})}function h(e={}){const{wrapper:a}={...(0,r.R)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}},94331:(e,a,n)=>{n.d(a,{A:()=>s});n(96540);var t=n(5260),r=n(74848);function s(e){let{title:a}=e;return(0,r.jsx)(t.A,{children:(0,r.jsx)("title",{children:a})})}},28453:(e,a,n)=>{n.d(a,{R:()=>i,x:()=>o});var t=n(96540);const r={},s=t.createContext(r);function i(e){const a=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(a):{...a,...e}}),[a,e])}function o(e){let a;return a=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),t.createElement(s.Provider,{value:a},e.children)}}}]);

assets/js/02bfdfd2.6961c234.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[29237],{37683:(e,a,n)=>{n.r(a),n.d(a,{assets:()=>d,contentTitle:()=>i,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var t=n(74848),r=n(28453),s=n(94331);const o={title:"fama_raw",description:"The page provides detailed information on retrieving Fama French data through the openbb.stocks.fa.fama_raw() method in the OpenBB terminal. It serves as a resource for financial analysis and coding in Python involving DCF models.",keywords:["Fama French data","openbb stocks","fa fama raw","Data Frame","coding in Python","fundamental analysis","DCF model","OpenBB-finance"]},i=void 0,c={id:"sdk/reference/stocks/fa/fama_raw",title:"fama_raw",description:"The page provides detailed information on retrieving Fama French data through the openbb.stocks.fa.fama_raw() method in the OpenBB terminal. It serves as a resource for financial analysis and coding in Python involving DCF models.",source:"@site/content/sdk/reference/stocks/fa/fama_raw.md",sourceDirName:"sdk/reference/stocks/fa",slug:"/sdk/reference/stocks/fa/fama_raw",permalink:"/sdk/reference/stocks/fa/fama_raw",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/sdk/reference/stocks/fa/fama_raw.md",tags:[],version:"current",lastUpdatedBy:"montezdesousa",lastUpdatedAt:1718403738e3,frontMatter:{title:"fama_raw",description:"The page provides detailed information on retrieving Fama French data through the openbb.stocks.fa.fama_raw() method in the OpenBB terminal. It serves as a resource for financial analysis and coding in Python involving DCF models.",keywords:["Fama French data","openbb stocks","fa fama raw","Data Frame","coding in Python","fundamental analysis","DCF model","OpenBB-finance"]},sidebar:"tutorialSidebar",previous:{title:"fama_coe",permalink:"/sdk/reference/stocks/fa/fama_coe"},next:{title:"fraud",permalink:"/sdk/reference/stocks/fa/fraud"}},d={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2}];function f(e){const a={a:"a",code:"code",h2:"h2",hr:"hr",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.A,{title:"stocks.fa.fama_raw - Reference | OpenBB SDK Docs"}),"\n",(0,t.jsx)(a.p,{children:"Get Fama French data"}),"\n",(0,t.jsxs)(a.p,{children:["Source Code: [",(0,t.jsx)(a.a,{href:"https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/dcf_model.py#L240",children:"link"}),"]"]}),"\n",(0,t.jsx)(a.pre,{children:(0,t.jsx)(a.code,{className:"language-python",children:"openbb.stocks.fa.fama_raw()\n"})}),"\n",(0,t.jsx)(a.hr,{}),"\n",(0,t.jsx)(a.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsx)(a.p,{children:"This function does not take any parameters."}),"\n",(0,t.jsx)(a.hr,{}),"\n",(0,t.jsx)(a.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(a.table,{children:[(0,t.jsx)(a.thead,{children:(0,t.jsxs)(a.tr,{children:[(0,t.jsx)(a.th,{children:"Type"}),(0,t.jsx)(a.th,{children:"Description"})]})}),(0,t.jsx)(a.tbody,{children:(0,t.jsxs)(a.tr,{children:[(0,t.jsx)(a.td,{children:"pd.DataFrame"}),(0,t.jsx)(a.td,{children:"Fama French data"})]})})]}),"\n",(0,t.jsx)(a.hr,{})]})}function h(e={}){const{wrapper:a}={...(0,r.R)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}},94331:(e,a,n)=>{n.d(a,{A:()=>s});n(96540);var t=n(5260),r=n(74848);function s(e){let{title:a}=e;return(0,r.jsx)(t.A,{children:(0,r.jsx)("title",{children:a})})}},28453:(e,a,n)=>{n.d(a,{R:()=>o,x:()=>i});var t=n(96540);const r={},s=t.createContext(r);function o(e){const a=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(a):{...a,...e}}),[a,e])}function i(e){let a;return a=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),t.createElement(s.Provider,{value:a},e.children)}}}]);

assets/js/02d621a0.04ef8a9a.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[74103],{88988:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>a,metadata:()=>d,toc:()=>l});var i=r(74848),s=r(28453),n=r(94331);const a={title:"historical",description:"This documentation page provides the user with instructions on how to display futures historical data. Certain parameters like ticker data, start date, and expiry date can be specified to customize the output according to individual needs.",keywords:["display futures historical","futures timeseries","Ticker data","historical data","future expiry date"]},c=void 0,d={id:"terminal/reference/futures/historical",title:"historical",description:"This documentation page provides the user with instructions on how to display futures historical data. Certain parameters like ticker data, start date, and expiry date can be specified to customize the output according to individual needs.",source:"@site/content/terminal/reference/futures/historical.md",sourceDirName:"terminal/reference/futures",slug:"/terminal/reference/futures/historical",permalink:"/terminal/reference/futures/historical",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/terminal/reference/futures/historical.md",tags:[],version:"current",lastUpdatedBy:"montezdesousa",lastUpdatedAt:1718403738e3,frontMatter:{title:"historical",description:"This documentation page provides the user with instructions on how to display futures historical data. Certain parameters like ticker data, start date, and expiry date can be specified to customize the output according to individual needs.",keywords:["display futures historical","futures timeseries","Ticker data","historical data","future expiry date"]},sidebar:"tutorialSidebar",previous:{title:"curve",permalink:"/terminal/reference/futures/curve"},next:{title:"search",permalink:"/terminal/reference/futures/search"}},o={},l=[{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:2}];function u(e){const t={code:"code",h2:"h2",h3:"h3",hr:"hr",img:"img",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.A,{title:"futures /historical - Reference | OpenBB Terminal Docs"}),"\n",(0,i.jsx)(t.p,{children:"Display futures historical. [Source: YahooFinance]"}),"\n",(0,i.jsx)(t.h3,{id:"usage",children:"Usage"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-python",children:"historical -t TICKER [-s START] [-e EXPIRY]\n"})}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Name"}),(0,i.jsx)(t.th,{children:"Description"}),(0,i.jsx)(t.th,{children:"Default"}),(0,i.jsx)(t.th,{children:"Optional"}),(0,i.jsx)(t.th,{children:"Choices"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"ticker"}),(0,i.jsx)(t.td,{children:"Future ticker to display timeseries separated by comma when multiple, e.g.: BLK,QI"}),(0,i.jsx)(t.td,{}),(0,i.jsx)(t.td,{children:"False"}),(0,i.jsx)(t.td,{children:"None"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"start"}),(0,i.jsx)(t.td,{children:"Initial date. Default: 3 years ago"}),(0,i.jsx)(t.td,{children:"datetime.now() - timedelta(days=365)"}),(0,i.jsx)(t.td,{children:"True"}),(0,i.jsx)(t.td,{children:"None"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"expiry"}),(0,i.jsx)(t.td,{children:"Select future expiry date with format YYYY-MM"}),(0,i.jsx)(t.td,{}),(0,i.jsx)(t.td,{children:"True"}),(0,i.jsx)(t.td,{children:"None"})]})]})]}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{src:"https://user-images.githubusercontent.com/25267873/196562549-1251b0fd-ca36-4e0f-bca6-b6bfe473effa.png",alt:"blk"})}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{src:"https://user-images.githubusercontent.com/25267873/196562627-79f9ffa1-8582-457c-91e8-5c18d6d4304f.png",alt:"Figure_31"})}),"\n",(0,i.jsx)(t.hr,{})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},94331:(e,t,r)=>{r.d(t,{A:()=>n});r(96540);var i=r(5260),s=r(74848);function n(e){let{title:t}=e;return(0,s.jsx)(i.A,{children:(0,s.jsx)("title",{children:t})})}},28453:(e,t,r)=>{r.d(t,{R:()=>a,x:()=>c});var i=r(96540);const s={},n=i.createContext(s);function a(e){const t=i.useContext(n);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),i.createElement(n.Provider,{value:t},e.children)}}}]);

assets/js/02d621a0.9523a939.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[74103],{88988:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>a,metadata:()=>d,toc:()=>l});var i=r(74848),s=r(28453),n=r(94331);const a={title:"historical",description:"This documentation page provides the user with instructions on how to display futures historical data. Certain parameters like ticker data, start date, and expiry date can be specified to customize the output according to individual needs.",keywords:["display futures historical","futures timeseries","Ticker data","historical data","future expiry date"]},c=void 0,d={id:"terminal/reference/futures/historical",title:"historical",description:"This documentation page provides the user with instructions on how to display futures historical data. Certain parameters like ticker data, start date, and expiry date can be specified to customize the output according to individual needs.",source:"@site/content/terminal/reference/futures/historical.md",sourceDirName:"terminal/reference/futures",slug:"/terminal/reference/futures/historical",permalink:"/terminal/reference/futures/historical",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/terminal/reference/futures/historical.md",tags:[],version:"current",lastUpdatedBy:"Henrique Joaquim",lastUpdatedAt:1718799515e3,frontMatter:{title:"historical",description:"This documentation page provides the user with instructions on how to display futures historical data. Certain parameters like ticker data, start date, and expiry date can be specified to customize the output according to individual needs.",keywords:["display futures historical","futures timeseries","Ticker data","historical data","future expiry date"]},sidebar:"tutorialSidebar",previous:{title:"curve",permalink:"/terminal/reference/futures/curve"},next:{title:"search",permalink:"/terminal/reference/futures/search"}},o={},l=[{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:2}];function u(e){const t={code:"code",h2:"h2",h3:"h3",hr:"hr",img:"img",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.A,{title:"futures /historical - Reference | OpenBB Terminal Docs"}),"\n",(0,i.jsx)(t.p,{children:"Display futures historical. [Source: YahooFinance]"}),"\n",(0,i.jsx)(t.h3,{id:"usage",children:"Usage"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-python",children:"historical -t TICKER [-s START] [-e EXPIRY]\n"})}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Name"}),(0,i.jsx)(t.th,{children:"Description"}),(0,i.jsx)(t.th,{children:"Default"}),(0,i.jsx)(t.th,{children:"Optional"}),(0,i.jsx)(t.th,{children:"Choices"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"ticker"}),(0,i.jsx)(t.td,{children:"Future ticker to display timeseries separated by comma when multiple, e.g.: BLK,QI"}),(0,i.jsx)(t.td,{}),(0,i.jsx)(t.td,{children:"False"}),(0,i.jsx)(t.td,{children:"None"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"start"}),(0,i.jsx)(t.td,{children:"Initial date. Default: 3 years ago"}),(0,i.jsx)(t.td,{children:"datetime.now() - timedelta(days=365)"}),(0,i.jsx)(t.td,{children:"True"}),(0,i.jsx)(t.td,{children:"None"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"expiry"}),(0,i.jsx)(t.td,{children:"Select future expiry date with format YYYY-MM"}),(0,i.jsx)(t.td,{}),(0,i.jsx)(t.td,{children:"True"}),(0,i.jsx)(t.td,{children:"None"})]})]})]}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{src:"https://user-images.githubusercontent.com/25267873/196562549-1251b0fd-ca36-4e0f-bca6-b6bfe473effa.png",alt:"blk"})}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{src:"https://user-images.githubusercontent.com/25267873/196562627-79f9ffa1-8582-457c-91e8-5c18d6d4304f.png",alt:"Figure_31"})}),"\n",(0,i.jsx)(t.hr,{})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},94331:(e,t,r)=>{r.d(t,{A:()=>n});r(96540);var i=r(5260),s=r(74848);function n(e){let{title:t}=e;return(0,s.jsx)(i.A,{children:(0,s.jsx)("title",{children:t})})}},28453:(e,t,r)=>{r.d(t,{R:()=>a,x:()=>c});var i=r(96540);const s={},n=i.createContext(s);function a(e){const t=i.useContext(n);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),i.createElement(n.Provider,{value:t},e.children)}}}]);

assets/js/02f75aff.0ea59100.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52830],{33370:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>s,metadata:()=>a,toc:()=>l});var i=r(74848),n=r(28453),o=r(94331);const s={title:"bigprints",description:"Bigprints command provides a comprehensive view of the biggest dark pool and block trades over a specified number of days, offering insights into the market activity over that period.",keywords:["bigprints","dark pool trades","block trades","/dp bigprints days","market activity"]},d=void 0,a={id:"bot/reference/discord/darkpool/bigprints",title:"bigprints",description:"Bigprints command provides a comprehensive view of the biggest dark pool and block trades over a specified number of days, offering insights into the market activity over that period.",source:"@site/content/bot/reference/discord/darkpool/bigprints.md",sourceDirName:"bot/reference/discord/darkpool",slug:"/bot/reference/discord/darkpool/bigprints",permalink:"/bot/reference/discord/darkpool/bigprints",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/bot/reference/discord/darkpool/bigprints.md",tags:[],version:"current",lastUpdatedBy:"Henrique Joaquim",lastUpdatedAt:1718799515e3,frontMatter:{title:"bigprints",description:"Bigprints command provides a comprehensive view of the biggest dark pool and block trades over a specified number of days, offering insights into the market activity over that period.",keywords:["bigprints","dark pool trades","block trades","/dp bigprints days","market activity"]},sidebar:"tutorialSidebar",previous:{title:"allprints",permalink:"/bot/reference/discord/darkpool/allprints"},next:{title:"levels",permalink:"/bot/reference/discord/darkpool/levels"}},c={},l=[{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:2},{value:"Examples",id:"examples",level:2}];function p(e){const t={code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(o.A,{title:"darkpool: bigprints - Discord Reference | OpenBB Bot Docs"}),"\n",(0,i.jsx)(t.p,{children:"This command will retrieve the largest combination of dark pool and block trades over a specified amount of days. It will provide a comprehensive view of the biggest dark pool and block trades over the specified number of days and give the user an idea of the market activity over that period."}),"\n",(0,i.jsx)(t.h3,{id:"usage",children:"Usage"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-python",metastring:"wordwrap",children:"/dp bigprints days\n"})}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Name"}),(0,i.jsx)(t.th,{children:"Description"}),(0,i.jsx)(t.th,{children:"Optional"}),(0,i.jsx)(t.th,{children:"Choices"})]})}),(0,i.jsx)(t.tbody,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"days"}),(0,i.jsx)(t.td,{children:"Number of days to look back"}),(0,i.jsx)(t.td,{children:"False"}),(0,i.jsx)(t.td,{children:"None"})]})})]}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h2,{id:"examples",children:"Examples"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:"/dp bigprints days:6\n"})}),"\n",(0,i.jsx)(t.hr,{})]})}function h(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},94331:(e,t,r)=>{r.d(t,{A:()=>o});r(96540);var i=r(5260),n=r(74848);function o(e){let{title:t}=e;return(0,n.jsx)(i.A,{children:(0,n.jsx)("title",{children:t})})}},28453:(e,t,r)=>{r.d(t,{R:()=>s,x:()=>d});var i=r(96540);const n={},o=i.createContext(n);function s(e){const t=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:s(e.components),i.createElement(o.Provider,{value:t},e.children)}}}]);

assets/js/02f75aff.1cce3802.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52830],{33370:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>s,metadata:()=>a,toc:()=>l});var i=r(74848),n=r(28453),o=r(94331);const s={title:"bigprints",description:"Bigprints command provides a comprehensive view of the biggest dark pool and block trades over a specified number of days, offering insights into the market activity over that period.",keywords:["bigprints","dark pool trades","block trades","/dp bigprints days","market activity"]},d=void 0,a={id:"bot/reference/discord/darkpool/bigprints",title:"bigprints",description:"Bigprints command provides a comprehensive view of the biggest dark pool and block trades over a specified number of days, offering insights into the market activity over that period.",source:"@site/content/bot/reference/discord/darkpool/bigprints.md",sourceDirName:"bot/reference/discord/darkpool",slug:"/bot/reference/discord/darkpool/bigprints",permalink:"/bot/reference/discord/darkpool/bigprints",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/bot/reference/discord/darkpool/bigprints.md",tags:[],version:"current",lastUpdatedBy:"montezdesousa",lastUpdatedAt:1718403738e3,frontMatter:{title:"bigprints",description:"Bigprints command provides a comprehensive view of the biggest dark pool and block trades over a specified number of days, offering insights into the market activity over that period.",keywords:["bigprints","dark pool trades","block trades","/dp bigprints days","market activity"]},sidebar:"tutorialSidebar",previous:{title:"allprints",permalink:"/bot/reference/discord/darkpool/allprints"},next:{title:"levels",permalink:"/bot/reference/discord/darkpool/levels"}},c={},l=[{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:2},{value:"Examples",id:"examples",level:2}];function p(e){const t={code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(o.A,{title:"darkpool: bigprints - Discord Reference | OpenBB Bot Docs"}),"\n",(0,i.jsx)(t.p,{children:"This command will retrieve the largest combination of dark pool and block trades over a specified amount of days. It will provide a comprehensive view of the biggest dark pool and block trades over the specified number of days and give the user an idea of the market activity over that period."}),"\n",(0,i.jsx)(t.h3,{id:"usage",children:"Usage"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-python",metastring:"wordwrap",children:"/dp bigprints days\n"})}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Name"}),(0,i.jsx)(t.th,{children:"Description"}),(0,i.jsx)(t.th,{children:"Optional"}),(0,i.jsx)(t.th,{children:"Choices"})]})}),(0,i.jsx)(t.tbody,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"days"}),(0,i.jsx)(t.td,{children:"Number of days to look back"}),(0,i.jsx)(t.td,{children:"False"}),(0,i.jsx)(t.td,{children:"None"})]})})]}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h2,{id:"examples",children:"Examples"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:"/dp bigprints days:6\n"})}),"\n",(0,i.jsx)(t.hr,{})]})}function h(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},94331:(e,t,r)=>{r.d(t,{A:()=>o});r(96540);var i=r(5260),n=r(74848);function o(e){let{title:t}=e;return(0,n.jsx)(i.A,{children:(0,n.jsx)("title",{children:t})})}},28453:(e,t,r)=>{r.d(t,{R:()=>s,x:()=>d});var i=r(96540);const n={},o=i.createContext(n);function s(e){const t=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:s(e.components),i.createElement(o.Provider,{value:t},e.children)}}}]);

assets/js/0400a870.3e2a1031.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[46845],{48006:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>l,contentTitle:()=>a,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var o=t(74848),s=t(28453),n=t(77968);const i={},a="Crypto",c={id:"platform/reference/crypto/index",title:"Crypto",description:"Menus",source:"@site/content/platform/reference/crypto/index.mdx",sourceDirName:"platform/reference/crypto",slug:"/platform/reference/crypto/",permalink:"/platform/reference/crypto/",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/platform/reference/crypto/index.mdx",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"unitroot_test",permalink:"/platform/reference/quantitative/unitroot_test"},next:{title:"Price",permalink:"/platform/reference/crypto/price/"}},l={},d=[{value:"Menus",id:"menus",level:3},{value:"Commands",id:"commands",level:3}];function m(e){const r={h1:"h1",h3:"h3",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(r.h1,{id:"crypto",children:"Crypto"}),"\n","\n",(0,o.jsx)(r.h3,{id:"menus",children:"Menus"}),"\n",(0,o.jsx)("ul",{className:"grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6",children:(0,o.jsx)(n.A,{title:"Price",description:"historical",url:"/platform/reference/crypto/price"})}),"\n",(0,o.jsx)(r.h3,{id:"commands",children:"Commands"}),"\n",(0,o.jsx)("ul",{className:"grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6",children:(0,o.jsx)(n.A,{title:"search",description:"Search available cryptocurrency pairs within a provider",url:"/platform/reference/crypto/search"})})]})}function p(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,o.jsx)(r,{...e,children:(0,o.jsx)(m,{...e})}):m(e)}},77968:(e,r,t)=>{t.d(r,{A:()=>c});var o=t(28774),s=t(34164),n=(t(96540),t(56347)),i=t(51820),a=t(74848);function c(e){let{title:r,url:t,description:c,command:l}=e;const{pathname:d}=(0,n.zy)(),m=d.replace(/\/v\d+/,""),p=!m.includes("/reference")&&!m.includes("/widgets-library/")&&!m.includes("/data_models");return(0,a.jsxs)(o.A,{className:(0,s.A)("rounded border-2 hover:!text-black dark:hover:!text-white !no-underline p-6 cursor-pointer relative overflow-hidden hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-md",{"hover:bg-[#669DCB] border-[#669DCB] dark:hover:bg-[#004A87] dark:border-[#004A87]":m.startsWith("/terminal")||m.startsWith("/pro"),"hover:bg-[#b186bb] border-[#b186bb] dark:hover:bg-[#3a204f] dark:border-[#3a204f]":m.startsWith("/bot"),"hover:bg-[#F5B166] border-[#F5B166] dark:hover:bg-[#511d11] dark:border-[#511d11]":m.startsWith("/sdk")||m.startsWith("/cli")||m.startsWith("/platform"),"hover:bg-[#16A34A] border-[#16A34A] dark:hover:bg-[#14532D] dark:border-[#14532D]":m.startsWith("/excel"),header_docs:!(m.startsWith("/terminal")||m.startsWith("/pro")||m.startsWith("/excel")||m.startsWith("/sdk")||m.startsWith("/platform")||m.startsWith("/bot")||m.startsWith("/cli"))}),to:t,children:[(0,a.jsx)("div",{className:"absolute top-0 right-0 left-0 bottom-0"}),(0,a.jsxs)("div",{className:"flex items-center",children:[(0,a.jsxs)("p",{className:"py-2 font-bold text-lg my-0",children:[r,""]}),p&&(0,a.jsx)(i.A,{className:"ml-auto mr-4"})]}),c?(0,a.jsx)("p",{className:"text-grey-900 dark:text-grey-200 text-xs font-medium mt-2 mb-0",children:c}):null]})}},28453:(e,r,t)=>{t.d(r,{R:()=>i,x:()=>a});var o=t(96540);const s={},n=o.createContext(s);function i(e){const r=o.useContext(n);return o.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function a(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),o.createElement(n.Provider,{value:r},e.children)}}}]);

assets/js/0400a870.e192f0ba.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[46845],{48006:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>l,contentTitle:()=>a,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var o=t(74848),s=t(28453),n=t(77968);const i={},a="Crypto",c={id:"platform/reference/crypto/index",title:"Crypto",description:"Menus",source:"@site/content/platform/reference/crypto/index.mdx",sourceDirName:"platform/reference/crypto",slug:"/platform/reference/crypto/",permalink:"/platform/reference/crypto/",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/platform/reference/crypto/index.mdx",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"unit_root",permalink:"/platform/reference/econometrics/unit_root"},next:{title:"Price",permalink:"/platform/reference/crypto/price/"}},l={},d=[{value:"Menus",id:"menus",level:3},{value:"Commands",id:"commands",level:3}];function m(e){const r={h1:"h1",h3:"h3",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(r.h1,{id:"crypto",children:"Crypto"}),"\n","\n",(0,o.jsx)(r.h3,{id:"menus",children:"Menus"}),"\n",(0,o.jsx)("ul",{className:"grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6",children:(0,o.jsx)(n.A,{title:"Price",description:"historical",url:"/platform/reference/crypto/price"})}),"\n",(0,o.jsx)(r.h3,{id:"commands",children:"Commands"}),"\n",(0,o.jsx)("ul",{className:"grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6",children:(0,o.jsx)(n.A,{title:"search",description:"Search available cryptocurrency pairs within a provider",url:"/platform/reference/crypto/search"})})]})}function p(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,o.jsx)(r,{...e,children:(0,o.jsx)(m,{...e})}):m(e)}},77968:(e,r,t)=>{t.d(r,{A:()=>c});var o=t(28774),s=t(34164),n=(t(96540),t(56347)),i=t(51820),a=t(74848);function c(e){let{title:r,url:t,description:c,command:l}=e;const{pathname:d}=(0,n.zy)(),m=d.replace(/\/v\d+/,""),p=!m.includes("/reference")&&!m.includes("/widgets-library/")&&!m.includes("/data_models");return(0,a.jsxs)(o.A,{className:(0,s.A)("rounded border-2 hover:!text-black dark:hover:!text-white !no-underline p-6 cursor-pointer relative overflow-hidden hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-md",{"hover:bg-[#669DCB] border-[#669DCB] dark:hover:bg-[#004A87] dark:border-[#004A87]":m.startsWith("/terminal")||m.startsWith("/pro"),"hover:bg-[#b186bb] border-[#b186bb] dark:hover:bg-[#3a204f] dark:border-[#3a204f]":m.startsWith("/bot"),"hover:bg-[#F5B166] border-[#F5B166] dark:hover:bg-[#511d11] dark:border-[#511d11]":m.startsWith("/sdk")||m.startsWith("/cli")||m.startsWith("/platform"),"hover:bg-[#16A34A] border-[#16A34A] dark:hover:bg-[#14532D] dark:border-[#14532D]":m.startsWith("/excel"),header_docs:!(m.startsWith("/terminal")||m.startsWith("/pro")||m.startsWith("/excel")||m.startsWith("/sdk")||m.startsWith("/platform")||m.startsWith("/bot")||m.startsWith("/cli"))}),to:t,children:[(0,a.jsx)("div",{className:"absolute top-0 right-0 left-0 bottom-0"}),(0,a.jsxs)("div",{className:"flex items-center",children:[(0,a.jsxs)("p",{className:"py-2 font-bold text-lg my-0",children:[r,""]}),p&&(0,a.jsx)(i.A,{className:"ml-auto mr-4"})]}),c?(0,a.jsx)("p",{className:"text-grey-900 dark:text-grey-200 text-xs font-medium mt-2 mb-0",children:c}):null]})}},28453:(e,r,t)=>{t.d(r,{R:()=>i,x:()=>a});var o=t(96540);const s={},n=o.createContext(s);function i(e){const r=o.useContext(n);return o.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function a(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),o.createElement(n.Provider,{value:r},e.children)}}}]);

assets/js/04377248.a006e1d0.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52498],{89928:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>d,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var n=r(74848),s=r(28453),a=r(94331);const i={title:"spread",description:"A documentation page detailing how to use the spread measurement tool. The page includes parameters, usage, and visuals to guide the user.",keywords:["spread measurement","rolling spread","usage","parameters","n_window","window length"]},d=void 0,o={id:"terminal/reference/forex/qa/spread",title:"spread",description:"A documentation page detailing how to use the spread measurement tool. The page includes parameters, usage, and visuals to guide the user.",source:"@site/content/terminal/reference/forex/qa/spread.md",sourceDirName:"terminal/reference/forex/qa",slug:"/terminal/reference/forex/qa/spread",permalink:"/terminal/reference/forex/qa/spread",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/terminal/reference/forex/qa/spread.md",tags:[],version:"current",lastUpdatedBy:"Henrique Joaquim",lastUpdatedAt:1718799515e3,frontMatter:{title:"spread",description:"A documentation page detailing how to use the spread measurement tool. The page includes parameters, usage, and visuals to guide the user.",keywords:["spread measurement","rolling spread","usage","parameters","n_window","window length"]},sidebar:"tutorialSidebar",previous:{title:"skew",permalink:"/terminal/reference/forex/qa/skew"},next:{title:"summary",permalink:"/terminal/reference/forex/qa/summary"}},l={},c=[{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:2}];function u(e){const t={code:"code",h2:"h2",h3:"h3",hr:"hr",img:"img",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(a.A,{title:"forex/qa/spread - Reference | OpenBB Terminal Docs"}),"\n",(0,n.jsx)(t.p,{children:"Shows rolling spread measurement"}),"\n",(0,n.jsx)(t.h3,{id:"usage",children:"Usage"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-python",children:"spread [-w N_WINDOW]\n"})}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Name"}),(0,n.jsx)(t.th,{children:"Description"}),(0,n.jsx)(t.th,{children:"Default"}),(0,n.jsx)(t.th,{children:"Optional"}),(0,n.jsx)(t.th,{children:"Choices"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"n_window"}),(0,n.jsx)(t.td,{children:"Window length"}),(0,n.jsx)(t.td,{children:"14"}),(0,n.jsx)(t.td,{children:"True"}),(0,n.jsx)(t.td,{children:"range(5, 100)"})]})})]}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.img,{src:"https://user-images.githubusercontent.com/46355364/154308406-f20812a4-fa04-4937-b8de-dc27042f7462.png",alt:"spread"})}),"\n",(0,n.jsx)(t.hr,{})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},94331:(e,t,r)=>{r.d(t,{A:()=>a});r(96540);var n=r(5260),s=r(74848);function a(e){let{title:t}=e;return(0,s.jsx)(n.A,{children:(0,s.jsx)("title",{children:t})})}},28453:(e,t,r)=>{r.d(t,{R:()=>i,x:()=>d});var n=r(96540);const s={},a=n.createContext(s);function i(e){const t=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),n.createElement(a.Provider,{value:t},e.children)}}}]);

assets/js/04377248.ef21cc8d.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52498],{89928:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>d,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var n=r(74848),s=r(28453),a=r(94331);const i={title:"spread",description:"A documentation page detailing how to use the spread measurement tool. The page includes parameters, usage, and visuals to guide the user.",keywords:["spread measurement","rolling spread","usage","parameters","n_window","window length"]},d=void 0,o={id:"terminal/reference/forex/qa/spread",title:"spread",description:"A documentation page detailing how to use the spread measurement tool. The page includes parameters, usage, and visuals to guide the user.",source:"@site/content/terminal/reference/forex/qa/spread.md",sourceDirName:"terminal/reference/forex/qa",slug:"/terminal/reference/forex/qa/spread",permalink:"/terminal/reference/forex/qa/spread",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/terminal/reference/forex/qa/spread.md",tags:[],version:"current",lastUpdatedBy:"montezdesousa",lastUpdatedAt:1718403738e3,frontMatter:{title:"spread",description:"A documentation page detailing how to use the spread measurement tool. The page includes parameters, usage, and visuals to guide the user.",keywords:["spread measurement","rolling spread","usage","parameters","n_window","window length"]},sidebar:"tutorialSidebar",previous:{title:"skew",permalink:"/terminal/reference/forex/qa/skew"},next:{title:"summary",permalink:"/terminal/reference/forex/qa/summary"}},l={},c=[{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:2}];function u(e){const t={code:"code",h2:"h2",h3:"h3",hr:"hr",img:"img",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(a.A,{title:"forex/qa/spread - Reference | OpenBB Terminal Docs"}),"\n",(0,n.jsx)(t.p,{children:"Shows rolling spread measurement"}),"\n",(0,n.jsx)(t.h3,{id:"usage",children:"Usage"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-python",children:"spread [-w N_WINDOW]\n"})}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Name"}),(0,n.jsx)(t.th,{children:"Description"}),(0,n.jsx)(t.th,{children:"Default"}),(0,n.jsx)(t.th,{children:"Optional"}),(0,n.jsx)(t.th,{children:"Choices"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"n_window"}),(0,n.jsx)(t.td,{children:"Window length"}),(0,n.jsx)(t.td,{children:"14"}),(0,n.jsx)(t.td,{children:"True"}),(0,n.jsx)(t.td,{children:"range(5, 100)"})]})})]}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.img,{src:"https://user-images.githubusercontent.com/46355364/154308406-f20812a4-fa04-4937-b8de-dc27042f7462.png",alt:"spread"})}),"\n",(0,n.jsx)(t.hr,{})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},94331:(e,t,r)=>{r.d(t,{A:()=>a});r(96540);var n=r(5260),s=r(74848);function a(e){let{title:t}=e;return(0,s.jsx)(n.A,{children:(0,s.jsx)("title",{children:t})})}},28453:(e,t,r)=>{r.d(t,{R:()=>i,x:()=>d});var n=r(96540);const s={},a=n.createContext(s);function i(e){const t=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),n.createElement(a.Provider,{value:t},e.children)}}}]);

assets/js/0443c489.4ad2ae93.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[98968],{14266:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var n=r(74848),s=r(28453),a=r(94331);const i={title:"vsurf",description:"Learn the usage of vsurf, a Python tool for plotting a 3D volatility surface. Understand the parameters and see a sample representation.",keywords:["vsurf","3D volatility surface","IV","OI","LP","data visualization"]},o=void 0,l={id:"terminal/reference/stocks/options/vsurf",title:"vsurf",description:"Learn the usage of vsurf, a Python tool for plotting a 3D volatility surface. Understand the parameters and see a sample representation.",source:"@site/content/terminal/reference/stocks/options/vsurf.md",sourceDirName:"terminal/reference/stocks/options",slug:"/terminal/reference/stocks/options/vsurf",permalink:"/terminal/reference/stocks/options/vsurf",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/terminal/reference/stocks/options/vsurf.md",tags:[],version:"current",lastUpdatedBy:"Henrique Joaquim",lastUpdatedAt:1718799515e3,frontMatter:{title:"vsurf",description:"Learn the usage of vsurf, a Python tool for plotting a 3D volatility surface. Understand the parameters and see a sample representation.",keywords:["vsurf","3D volatility surface","IV","OI","LP","data visualization"]},sidebar:"tutorialSidebar",previous:{title:"vol",permalink:"/terminal/reference/stocks/options/vol"},next:{title:"acf",permalink:"/terminal/reference/stocks/qa/acf"}},c={},d=[{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:2}];function u(e){const t={code:"code",h2:"h2",h3:"h3",hr:"hr",img:"img",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(a.A,{title:"stocks/options/vsurf - Reference | OpenBB Terminal Docs"}),"\n",(0,n.jsx)(t.p,{children:"Plot 3D volatility surface."}),"\n",(0,n.jsx)(t.h3,{id:"usage",children:"Usage"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-python",children:"vsurf [-z {IV,OI,LP}]\n"})}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Name"}),(0,n.jsx)(t.th,{children:"Description"}),(0,n.jsx)(t.th,{children:"Default"}),(0,n.jsx)(t.th,{children:"Optional"}),(0,n.jsx)(t.th,{children:"Choices"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"z"}),(0,n.jsx)(t.td,{children:"The data for the Z axis"}),(0,n.jsx)(t.td,{children:"IV"}),(0,n.jsx)(t.td,{children:"True"}),(0,n.jsx)(t.td,{children:"IV, OI, LP"})]})})]}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.img,{src:"https://user-images.githubusercontent.com/46355364/154290744-1e427337-1a9a-4b84-a85a-9f07571882ba.png",alt:"vsurf"})}),"\n",(0,n.jsx)(t.hr,{})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},94331:(e,t,r)=>{r.d(t,{A:()=>a});r(96540);var n=r(5260),s=r(74848);function a(e){let{title:t}=e;return(0,s.jsx)(n.A,{children:(0,s.jsx)("title",{children:t})})}},28453:(e,t,r)=>{r.d(t,{R:()=>i,x:()=>o});var n=r(96540);const s={},a=n.createContext(s);function i(e){const t=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),n.createElement(a.Provider,{value:t},e.children)}}}]);

assets/js/0443c489.ec2bfaca.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[98968],{14266:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var n=r(74848),s=r(28453),a=r(94331);const i={title:"vsurf",description:"Learn the usage of vsurf, a Python tool for plotting a 3D volatility surface. Understand the parameters and see a sample representation.",keywords:["vsurf","3D volatility surface","IV","OI","LP","data visualization"]},o=void 0,l={id:"terminal/reference/stocks/options/vsurf",title:"vsurf",description:"Learn the usage of vsurf, a Python tool for plotting a 3D volatility surface. Understand the parameters and see a sample representation.",source:"@site/content/terminal/reference/stocks/options/vsurf.md",sourceDirName:"terminal/reference/stocks/options",slug:"/terminal/reference/stocks/options/vsurf",permalink:"/terminal/reference/stocks/options/vsurf",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/terminal/reference/stocks/options/vsurf.md",tags:[],version:"current",lastUpdatedBy:"montezdesousa",lastUpdatedAt:1718403738e3,frontMatter:{title:"vsurf",description:"Learn the usage of vsurf, a Python tool for plotting a 3D volatility surface. Understand the parameters and see a sample representation.",keywords:["vsurf","3D volatility surface","IV","OI","LP","data visualization"]},sidebar:"tutorialSidebar",previous:{title:"vol",permalink:"/terminal/reference/stocks/options/vol"},next:{title:"acf",permalink:"/terminal/reference/stocks/qa/acf"}},c={},d=[{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:2}];function u(e){const t={code:"code",h2:"h2",h3:"h3",hr:"hr",img:"img",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(a.A,{title:"stocks/options/vsurf - Reference | OpenBB Terminal Docs"}),"\n",(0,n.jsx)(t.p,{children:"Plot 3D volatility surface."}),"\n",(0,n.jsx)(t.h3,{id:"usage",children:"Usage"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-python",children:"vsurf [-z {IV,OI,LP}]\n"})}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Name"}),(0,n.jsx)(t.th,{children:"Description"}),(0,n.jsx)(t.th,{children:"Default"}),(0,n.jsx)(t.th,{children:"Optional"}),(0,n.jsx)(t.th,{children:"Choices"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"z"}),(0,n.jsx)(t.td,{children:"The data for the Z axis"}),(0,n.jsx)(t.td,{children:"IV"}),(0,n.jsx)(t.td,{children:"True"}),(0,n.jsx)(t.td,{children:"IV, OI, LP"})]})})]}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.img,{src:"https://user-images.githubusercontent.com/46355364/154290744-1e427337-1a9a-4b84-a85a-9f07571882ba.png",alt:"vsurf"})}),"\n",(0,n.jsx)(t.hr,{})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},94331:(e,t,r)=>{r.d(t,{A:()=>a});r(96540);var n=r(5260),s=r(74848);function a(e){let{title:t}=e;return(0,s.jsx)(n.A,{children:(0,s.jsx)("title",{children:t})})}},28453:(e,t,r)=>{r.d(t,{R:()=>i,x:()=>o});var n=r(96540);const s={},a=n.createContext(s);function i(e){const t=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),n.createElement(a.Provider,{value:t},e.children)}}}]);

assets/js/051be787.111b3c39.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41064],{9956:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>h,frontMatter:()=>a,metadata:()=>d,toc:()=>c});var n=r(74848),s=r(28453),o=r(77968);const a={},i="News",d={id:"platform/reference/news/index",title:"News",description:"Commands",source:"@site/content/platform/reference/news/index.mdx",sourceDirName:"platform/reference/news",slug:"/platform/reference/news/",permalink:"/platform/reference/news/",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/platform/reference/news/index.mdx",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"lbma_fixing",permalink:"/platform/reference/commodity/lbma_fixing"},next:{title:"company",permalink:"/platform/reference/news/company"}},l={},c=[{value:"Commands",id:"commands",level:3}];function m(e){const t={h1:"h1",h3:"h3",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"news",children:"News"}),"\n","\n",(0,n.jsx)(t.h3,{id:"commands",children:"Commands"}),"\n",(0,n.jsxs)("ul",{className:"grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6",children:[(0,n.jsx)(o.A,{title:"world",description:"World News",url:"/platform/reference/news/world"}),(0,n.jsx)(o.A,{title:"company",description:"Company News",url:"/platform/reference/news/company"})]})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(m,{...e})}):m(e)}},77968:(e,t,r)=>{r.d(t,{A:()=>d});var n=r(28774),s=r(34164),o=(r(96540),r(56347)),a=r(51820),i=r(74848);function d(e){let{title:t,url:r,description:d,command:l}=e;const{pathname:c}=(0,o.zy)(),m=c.replace(/\/v\d+/,""),h=!m.includes("/reference")&&!m.includes("/widgets-library/")&&!m.includes("/data_models");return(0,i.jsxs)(n.A,{className:(0,s.A)("rounded border-2 hover:!text-black dark:hover:!text-white !no-underline p-6 cursor-pointer relative overflow-hidden hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-md",{"hover:bg-[#669DCB] border-[#669DCB] dark:hover:bg-[#004A87] dark:border-[#004A87]":m.startsWith("/terminal")||m.startsWith("/pro"),"hover:bg-[#b186bb] border-[#b186bb] dark:hover:bg-[#3a204f] dark:border-[#3a204f]":m.startsWith("/bot"),"hover:bg-[#F5B166] border-[#F5B166] dark:hover:bg-[#511d11] dark:border-[#511d11]":m.startsWith("/sdk")||m.startsWith("/cli")||m.startsWith("/platform"),"hover:bg-[#16A34A] border-[#16A34A] dark:hover:bg-[#14532D] dark:border-[#14532D]":m.startsWith("/excel"),header_docs:!(m.startsWith("/terminal")||m.startsWith("/pro")||m.startsWith("/excel")||m.startsWith("/sdk")||m.startsWith("/platform")||m.startsWith("/bot")||m.startsWith("/cli"))}),to:r,children:[(0,i.jsx)("div",{className:"absolute top-0 right-0 left-0 bottom-0"}),(0,i.jsxs)("div",{className:"flex items-center",children:[(0,i.jsxs)("p",{className:"py-2 font-bold text-lg my-0",children:[t,""]}),h&&(0,i.jsx)(a.A,{className:"ml-auto mr-4"})]}),d?(0,i.jsx)("p",{className:"text-grey-900 dark:text-grey-200 text-xs font-medium mt-2 mb-0",children:d}):null]})}},28453:(e,t,r)=>{r.d(t,{R:()=>a,x:()=>i});var n=r(96540);const s={},o=n.createContext(s);function a(e){const t=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),n.createElement(o.Provider,{value:t},e.children)}}}]);

assets/js/051be787.beab9540.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41064],{9956:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>h,frontMatter:()=>a,metadata:()=>d,toc:()=>c});var s=r(74848),n=r(28453),o=r(77968);const a={},i="News",d={id:"platform/reference/news/index",title:"News",description:"Commands",source:"@site/content/platform/reference/news/index.mdx",sourceDirName:"platform/reference/news",slug:"/platform/reference/news/",permalink:"/platform/reference/news/",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/platform/reference/news/index.mdx",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"historical",permalink:"/platform/reference/derivatives/futures/historical"},next:{title:"company",permalink:"/platform/reference/news/company"}},l={},c=[{value:"Commands",id:"commands",level:3}];function m(e){const t={h1:"h1",h3:"h3",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"news",children:"News"}),"\n","\n",(0,s.jsx)(t.h3,{id:"commands",children:"Commands"}),"\n",(0,s.jsxs)("ul",{className:"grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6",children:[(0,s.jsx)(o.A,{title:"company",description:"Company News",url:"/platform/reference/news/company"}),(0,s.jsx)(o.A,{title:"world",description:"World News",url:"/platform/reference/news/world"})]})]})}function h(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(m,{...e})}):m(e)}},77968:(e,t,r)=>{r.d(t,{A:()=>d});var s=r(28774),n=r(34164),o=(r(96540),r(56347)),a=r(51820),i=r(74848);function d(e){let{title:t,url:r,description:d,command:l}=e;const{pathname:c}=(0,o.zy)(),m=c.replace(/\/v\d+/,""),h=!m.includes("/reference")&&!m.includes("/widgets-library/")&&!m.includes("/data_models");return(0,i.jsxs)(s.A,{className:(0,n.A)("rounded border-2 hover:!text-black dark:hover:!text-white !no-underline p-6 cursor-pointer relative overflow-hidden hover:-translate-y-2 transform transition-all duration-300 ease-in-out font-bold shadow-md",{"hover:bg-[#669DCB] border-[#669DCB] dark:hover:bg-[#004A87] dark:border-[#004A87]":m.startsWith("/terminal")||m.startsWith("/pro"),"hover:bg-[#b186bb] border-[#b186bb] dark:hover:bg-[#3a204f] dark:border-[#3a204f]":m.startsWith("/bot"),"hover:bg-[#F5B166] border-[#F5B166] dark:hover:bg-[#511d11] dark:border-[#511d11]":m.startsWith("/sdk")||m.startsWith("/cli")||m.startsWith("/platform"),"hover:bg-[#16A34A] border-[#16A34A] dark:hover:bg-[#14532D] dark:border-[#14532D]":m.startsWith("/excel"),header_docs:!(m.startsWith("/terminal")||m.startsWith("/pro")||m.startsWith("/excel")||m.startsWith("/sdk")||m.startsWith("/platform")||m.startsWith("/bot")||m.startsWith("/cli"))}),to:r,children:[(0,i.jsx)("div",{className:"absolute top-0 right-0 left-0 bottom-0"}),(0,i.jsxs)("div",{className:"flex items-center",children:[(0,i.jsxs)("p",{className:"py-2 font-bold text-lg my-0",children:[t,""]}),h&&(0,i.jsx)(a.A,{className:"ml-auto mr-4"})]}),d?(0,i.jsx)("p",{className:"text-grey-900 dark:text-grey-200 text-xs font-medium mt-2 mb-0",children:d}):null]})}},28453:(e,t,r)=>{r.d(t,{R:()=>a,x:()=>i});var s=r(96540);const n={},o=s.createContext(n);function a(e){const t=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),s.createElement(o.Provider,{value:t},e.children)}}}]);

assets/js/0523b9c3.4ac3c22c.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[15366],{83759:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var o=t(74848),r=t(28453),s=t(94331);const a={title:"glbonds",description:"Webpage on 'glbonds' function - a data scraping tool for global bonds information. It returns name, coupon rate, yield and change in yield.",keywords:["glbonds","data scraping","global bonds","yield","rate","change"]},d=void 0,i={id:"sdk/reference/economy/glbonds",title:"glbonds",description:"Webpage on 'glbonds' function - a data scraping tool for global bonds information. It returns name, coupon rate, yield and change in yield.",source:"@site/content/sdk/reference/economy/glbonds.md",sourceDirName:"sdk/reference/economy",slug:"/sdk/reference/economy/glbonds",permalink:"/sdk/reference/economy/glbonds",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/sdk/reference/economy/glbonds.md",tags:[],version:"current",lastUpdatedBy:"Henrique Joaquim",lastUpdatedAt:1718799515e3,frontMatter:{title:"glbonds",description:"Webpage on 'glbonds' function - a data scraping tool for global bonds information. It returns name, coupon rate, yield and change in yield.",keywords:["glbonds","data scraping","global bonds","yield","rate","change"]},sidebar:"tutorialSidebar",previous:{title:"get_groups",permalink:"/sdk/reference/economy/get_groups"},next:{title:"index",permalink:"/sdk/reference/economy/index_cmd"}},c={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2}];function p(e){const n={a:"a",code:"code",h2:"h2",hr:"hr",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(s.A,{title:"economy.glbonds - Reference | OpenBB SDK Docs"}),"\n",(0,o.jsx)(n.p,{children:"Scrape data for global bonds"}),"\n",(0,o.jsxs)(n.p,{children:["Source Code: [",(0,o.jsx)(n.a,{href:"https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/wsj_model.py#L204",children:"link"}),"]"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-python",children:"openbb.economy.glbonds()\n"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsx)(n.p,{children:"This function does not take any parameters."}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.table,{children:[(0,o.jsx)(n.thead,{children:(0,o.jsxs)(n.tr,{children:[(0,o.jsx)(n.th,{children:"Type"}),(0,o.jsx)(n.th,{children:"Description"})]})}),(0,o.jsx)(n.tbody,{children:(0,o.jsxs)(n.tr,{children:[(0,o.jsx)(n.td,{children:"pd.DataFrame"}),(0,o.jsx)(n.td,{children:"Dataframe containing name, coupon rate, yield and change in yield"})]})})]}),"\n",(0,o.jsx)(n.hr,{})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},94331:(e,n,t)=>{t.d(n,{A:()=>s});t(96540);var o=t(5260),r=t(74848);function s(e){let{title:n}=e;return(0,r.jsx)(o.A,{children:(0,r.jsx)("title",{children:n})})}},28453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>d});var o=t(96540);const r={},s=o.createContext(r);function a(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]);

assets/js/0523b9c3.9e34ed92.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[15366],{83759:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var o=t(74848),r=t(28453),s=t(94331);const a={title:"glbonds",description:"Webpage on 'glbonds' function - a data scraping tool for global bonds information. It returns name, coupon rate, yield and change in yield.",keywords:["glbonds","data scraping","global bonds","yield","rate","change"]},d=void 0,i={id:"sdk/reference/economy/glbonds",title:"glbonds",description:"Webpage on 'glbonds' function - a data scraping tool for global bonds information. It returns name, coupon rate, yield and change in yield.",source:"@site/content/sdk/reference/economy/glbonds.md",sourceDirName:"sdk/reference/economy",slug:"/sdk/reference/economy/glbonds",permalink:"/sdk/reference/economy/glbonds",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/sdk/reference/economy/glbonds.md",tags:[],version:"current",lastUpdatedBy:"montezdesousa",lastUpdatedAt:1718403738e3,frontMatter:{title:"glbonds",description:"Webpage on 'glbonds' function - a data scraping tool for global bonds information. It returns name, coupon rate, yield and change in yield.",keywords:["glbonds","data scraping","global bonds","yield","rate","change"]},sidebar:"tutorialSidebar",previous:{title:"get_groups",permalink:"/sdk/reference/economy/get_groups"},next:{title:"index",permalink:"/sdk/reference/economy/index_cmd"}},c={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2}];function p(e){const n={a:"a",code:"code",h2:"h2",hr:"hr",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(s.A,{title:"economy.glbonds - Reference | OpenBB SDK Docs"}),"\n",(0,o.jsx)(n.p,{children:"Scrape data for global bonds"}),"\n",(0,o.jsxs)(n.p,{children:["Source Code: [",(0,o.jsx)(n.a,{href:"https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/wsj_model.py#L204",children:"link"}),"]"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-python",children:"openbb.economy.glbonds()\n"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsx)(n.p,{children:"This function does not take any parameters."}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.table,{children:[(0,o.jsx)(n.thead,{children:(0,o.jsxs)(n.tr,{children:[(0,o.jsx)(n.th,{children:"Type"}),(0,o.jsx)(n.th,{children:"Description"})]})}),(0,o.jsx)(n.tbody,{children:(0,o.jsxs)(n.tr,{children:[(0,o.jsx)(n.td,{children:"pd.DataFrame"}),(0,o.jsx)(n.td,{children:"Dataframe containing name, coupon rate, yield and change in yield"})]})})]}),"\n",(0,o.jsx)(n.hr,{})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},94331:(e,n,t)=>{t.d(n,{A:()=>s});t(96540);var o=t(5260),r=t(74848);function s(e){let{title:n}=e;return(0,r.jsx)(o.A,{children:(0,r.jsx)("title",{children:n})})}},28453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>d});var o=t(96540);const r={},s=o.createContext(r);function a(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]);

assets/js/056352a1.ddb021ac.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76720],{82611:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>l});var r=t(74848),s=t(28453),o=t(94331);const i={title:"indices",description:"This page provides a command for a real-time overview of major US stock indices like the Dow Jones Industrial Average, S&P 500, and NASDAQ Composite. It shows current index values with percentage changes.",keywords:["indices","US stock indices","Dow Jones Industrial Average","S&P 500","NASDAQ Composite","index values","percentage change","real-time overview"]},c=void 0,a={id:"bot/reference/discord/economy/indices",title:"indices",description:"This page provides a command for a real-time overview of major US stock indices like the Dow Jones Industrial Average, S&P 500, and NASDAQ Composite. It shows current index values with percentage changes.",source:"@site/content/bot/reference/discord/economy/indices.md",sourceDirName:"bot/reference/discord/economy",slug:"/bot/reference/discord/economy/indices",permalink:"/bot/reference/discord/economy/indices",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/bot/reference/discord/economy/indices.md",tags:[],version:"current",lastUpdatedBy:"montezdesousa",lastUpdatedAt:1718403738e3,frontMatter:{title:"indices",description:"This page provides a command for a real-time overview of major US stock indices like the Dow Jones Industrial Average, S&P 500, and NASDAQ Composite. It shows current index values with percentage changes.",keywords:["indices","US stock indices","Dow Jones Industrial Average","S&P 500","NASDAQ Composite","index values","percentage change","real-time overview"]},sidebar:"tutorialSidebar",previous:{title:"glbonds",permalink:"/bot/reference/discord/economy/glbonds"},next:{title:"revrepo",permalink:"/bot/reference/discord/economy/revrepo"}},d={},l=[{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:2},{value:"Examples",id:"examples",level:2}];function m(e){const n={code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(o.A,{title:"economy: indices - Discord Reference | OpenBB Bot Docs"}),"\n",(0,r.jsx)(n.p,{children:"This command provides a real-time overview of the major US stock indices, such as the Dow Jones Industrial Average, the S&P 500, and the NASDAQ Composite. It displays the most current index values, as well as the percentage change from the previous day."}),"\n",(0,r.jsx)(n.h3,{id:"usage",children:"Usage"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-python",metastring:"wordwrap",children:"/econ indices\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsx)(n.p,{children:"This command has no parameters"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"examples",children:"Examples"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"/econ indices\n"})}),"\n",(0,r.jsx)(n.hr,{})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(m,{...e})}):m(e)}},94331:(e,n,t)=>{t.d(n,{A:()=>o});t(96540);var r=t(5260),s=t(74848);function o(e){let{title:n}=e;return(0,s.jsx)(r.A,{children:(0,s.jsx)("title",{children:n})})}},28453:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>c});var r=t(96540);const s={},o=r.createContext(s);function i(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]);

assets/js/056352a1.f3c64a53.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76720],{82611:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>l});var t=r(74848),o=r(28453),s=r(94331);const i={title:"indices",description:"This page provides a command for a real-time overview of major US stock indices like the Dow Jones Industrial Average, S&P 500, and NASDAQ Composite. It shows current index values with percentage changes.",keywords:["indices","US stock indices","Dow Jones Industrial Average","S&P 500","NASDAQ Composite","index values","percentage change","real-time overview"]},c=void 0,a={id:"bot/reference/discord/economy/indices",title:"indices",description:"This page provides a command for a real-time overview of major US stock indices like the Dow Jones Industrial Average, S&P 500, and NASDAQ Composite. It shows current index values with percentage changes.",source:"@site/content/bot/reference/discord/economy/indices.md",sourceDirName:"bot/reference/discord/economy",slug:"/bot/reference/discord/economy/indices",permalink:"/bot/reference/discord/economy/indices",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/bot/reference/discord/economy/indices.md",tags:[],version:"current",lastUpdatedBy:"Henrique Joaquim",lastUpdatedAt:1718799515e3,frontMatter:{title:"indices",description:"This page provides a command for a real-time overview of major US stock indices like the Dow Jones Industrial Average, S&P 500, and NASDAQ Composite. It shows current index values with percentage changes.",keywords:["indices","US stock indices","Dow Jones Industrial Average","S&P 500","NASDAQ Composite","index values","percentage change","real-time overview"]},sidebar:"tutorialSidebar",previous:{title:"glbonds",permalink:"/bot/reference/discord/economy/glbonds"},next:{title:"revrepo",permalink:"/bot/reference/discord/economy/revrepo"}},d={},l=[{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:2},{value:"Examples",id:"examples",level:2}];function m(e){const n={code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.A,{title:"economy: indices - Discord Reference | OpenBB Bot Docs"}),"\n",(0,t.jsx)(n.p,{children:"This command provides a real-time overview of the major US stock indices, such as the Dow Jones Industrial Average, the S&P 500, and the NASDAQ Composite. It displays the most current index values, as well as the percentage change from the previous day."}),"\n",(0,t.jsx)(n.h3,{id:"usage",children:"Usage"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-python",metastring:"wordwrap",children:"/econ indices\n"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsx)(n.p,{children:"This command has no parameters"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"examples",children:"Examples"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"/econ indices\n"})}),"\n",(0,t.jsx)(n.hr,{})]})}function p(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(m,{...e})}):m(e)}},94331:(e,n,r)=>{r.d(n,{A:()=>s});r(96540);var t=r(5260),o=r(74848);function s(e){let{title:n}=e;return(0,o.jsx)(t.A,{children:(0,o.jsx)("title",{children:n})})}},28453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>c});var t=r(96540);const o={},s=t.createContext(o);function i(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]);