Files
OpenBB/terminal/reference/forex/load.html
github-actions[bot] faa2748686 deploy: 707ae7e317
2023-03-01 14:02:35 +00:00

16 lines
53 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-reference/forex/load">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v2.3.1">
<title data-rh="true">load | OpenBB Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://docs.openbb.co/img/banner.png"><meta data-rh="true" name="twitter:image" content="https://docs.openbb.co/img/banner.png"><meta data-rh="true" property="og:url" content="https://docs.openbb.co/terminal/reference/forex/load"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="load | OpenBB Docs"><meta data-rh="true" name="description" content="OpenBB Terminal Function"><meta data-rh="true" property="og:description" content="OpenBB Terminal Function"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openbb.co/terminal/reference/forex/load"><link data-rh="true" rel="alternate" href="https://docs.openbb.co/terminal/reference/forex/load" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openbb.co/terminal/reference/forex/load" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://7D1HQ0IXAS-dsn.algolia.net" crossorigin="anonymous"><script data-rh="true" defer="true" src="https://static.cloudflareinsights.com/beacon.min.js" data-cf-beacon="{&quot;token&quot;: &quot;100eb319cb954b9ea86aa757652c0958&quot;}"></script><link rel="search" type="application/opensearchdescription+xml" title="OpenBB Docs" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.8ab06543.css">
<link rel="preload" href="/assets/js/runtime~main.8fc2e5b2.js" as="script">
<link rel="preload" href="/assets/js/main.b3705552.js" as="script">
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"dark")}()</script><div id="__docusaurus">
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav class="border-b border-grey-600 lg:px-12 header_docs_terminal navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><div class="flex items-center gap-x-[56px]"><a class="ml-5 mb-1 md:mb-0 md:ml-0" href="/"><svg viewBox="0 0 170 17" width="170" height="17" fill="none" xmlns="http://www.w3.org/2000/svg" class="text-white"><path d="M106.107 1.889v11.334l-.961-.946-.959-.945-.962-.943-.959-.946-.961-.943-.962-.945-.959-.944-.961-.945-.96-.943-.961-.946-.96-.943-.96-.945H92.66V17H94.582V4.723l.96.943.96.945.961.944.96.945.961.943.959.946.962.943.961.945.959.946.962.943.959.945.961.944.96.945h.961V1.889H106.107ZM137.03 7.557h-1.921V1.889h-11.524V17h15.37V7.546h-1.92l-.005.01Zm-11.524-.946V3.773h7.683v3.78h-7.683V6.61Zm11.524 3.778v4.727h-11.524v-5.67h11.524v.943ZM168.901 7.557h-2.88V1.889h-11.526V0h-1.921v1.889h1.921V17h15.365V7.546l-.959.01Zm-12.485-.946V3.773h7.684v3.78h-7.684V6.61Zm11.526 3.778v4.727h-11.526v-5.67h11.526v.943ZM75.314 1.889H61.867V17H77.23V15.111H63.787V11.332h11.521V9.443H63.788V3.777H77.23V1.89h-1.916ZM13.444 1.889H0V17h15.367V1.889h-1.922Zm0 2.834V15.11H1.918V3.773h11.527v.95ZM44.397 1.889H30.952V17h1.92v-5.666h13.445V1.88h-1.92v.009Zm0 2.834V9.45H32.873V3.773h11.524v.95Z" fill="currentColor"></path></svg></a><div class="hidden p-2 border border-grey-400 rounded h-[34px] items-center bg-grey-900 gap-3 md:flex"><a class="text-xs rounded px-2 py-1 hover:text-white hover:no-underline text-grey-100 bg-grey-800" href="/terminal">Terminal</a><a class="text-xs px-2 py-1 rounded hover:text-white hover:no-underline text-grey-500 hover:bg-grey-800" href="/sdk">SDK</a></div></div></div><div class="navbar__items navbar__items--right"><div class="flex gap-4 mr-12 md:mr-0"><button type="button" aria-haspopup="dialog" aria-expanded="false" aria-controls="" data-state="closed" class="bg-grey-900 radix-state-open:text-white hover:border-grey-200 hover:text-grey-200 radix-state-open:border-white border -mt-[0.6px] h-[34px] w-[34px] text-grey-400 border-grey-400 rounded flex items-center justify-center"><svg viewBox="0 0 24 24" width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="w-4 h-4"><path d="M21 12.79A9 9 0 1 1 11.21 3 7 7 0 0 0 21 12.79Z" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path></svg></button></div><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav class="menu thin-scrollbar mt-[40px] !px-10 text-sm !pb-10 menu_Y1UP"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/terminal">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/terminal/quickstart/requirements">Getting Started</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/terminal/guides/basics">Using OpenBB Terminal</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" aria-expanded="true" href="/terminal/reference">Terminal Reference</a><button aria-label="Toggle the collapsible sidebar category &#x27;Terminal Reference&#x27;" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/terminal/reference/account/delete">Account</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/terminal/reference/alt/covid/cases">Alternative</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/terminal/reference/crypto/candle">Cryptocurrency</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/terminal/reference/econometrics/add">Econometrics</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/terminal/reference/economy/bigmac">Economy</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/terminal/reference/etf/candle">ETFs</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/terminal/reference/fixedincome/ameribor">Fixedincome</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/terminal/reference/forecast/anom">Forecasting</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" tabindex="0" href="/terminal/reference/forex/candle">Forex</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/terminal/reference/forex/candle">candle</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/terminal/reference/forex/fwd">fwd</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/terminal/reference/forex/load">load</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/terminal/reference/forex/oanda/calendar">Oanda</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/terminal/reference/forex/qa/acf">Quantitative Analysis</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/terminal/reference/forex/quote">quote</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/terminal/reference/forex/ta/ad">Technical Analysis</a></div></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/terminal/reference/funds/alswe">Mutual Funds</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/terminal/reference/futures/curve">Futures</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/terminal/reference/portfolio/alloc">Portfolio</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/terminal/reference/reports/run">Reports</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/terminal/reference/stocks/ba/bullbear">Stocks</a></div></li></ul></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/terminal/reference"><span itemprop="name">Terminal Reference</span></a><meta itemprop="position" content="1"></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Forex</span><meta itemprop="position" content="2"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">load</span><meta itemprop="position" content="3"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_bxCs"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><h1>load</h1><p>Load historical exchange rate data.Available data sources are Alpha Advantage and YahooFinanceBy default main source used for analysis is YahooFinance (yf). To change it use --source av</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="usage">Usage<a href="#usage" class="hash-link" aria-label="Direct link to Usage" title="Direct link to Usage">​</a></h3><div class="language-python codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#9CDCFE;--prism-background-color:#1E1E1E"><div class="codeBlockContent_m3Ux"><pre tabindex="0" class="prism-code language-python codeBlock_qGQc thin-scrollbar"><code style="white-space:pre-wrap;overflow-wrap:anywhere" class="codeBlockLines_p187"><span class="token-line" style="color:#9CDCFE"><span class="token plain">load </span><span class="token punctuation" style="color:rgb(212, 212, 212)">[</span><span class="token operator" style="color:rgb(212, 212, 212)">-</span><span class="token plain">t TICKER</span><span class="token punctuation" style="color:rgb(212, 212, 212)">]</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(212, 212, 212)">[</span><span class="token operator" style="color:rgb(212, 212, 212)">-</span><span class="token plain">r </span><span class="token punctuation" style="color:rgb(212, 212, 212)">{</span><span class="token plain">i</span><span class="token punctuation" style="color:rgb(212, 212, 212)">,</span><span class="token plain">d</span><span class="token punctuation" style="color:rgb(212, 212, 212)">,</span><span class="token plain">w</span><span class="token punctuation" style="color:rgb(212, 212, 212)">,</span><span class="token plain">m</span><span class="token punctuation" style="color:rgb(212, 212, 212)">}</span><span class="token punctuation" style="color:rgb(212, 212, 212)">]</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(212, 212, 212)">[</span><span class="token operator" style="color:rgb(212, 212, 212)">-</span><span class="token plain">i </span><span class="token punctuation" style="color:rgb(212, 212, 212)">{</span><span class="token plain">1min</span><span class="token punctuation" style="color:rgb(212, 212, 212)">,</span><span class="token plain">5min</span><span class="token punctuation" style="color:rgb(212, 212, 212)">,</span><span class="token plain">15min</span><span class="token punctuation" style="color:rgb(212, 212, 212)">,</span><span class="token plain">30min</span><span class="token punctuation" style="color:rgb(212, 212, 212)">,</span><span class="token plain">60min</span><span class="token punctuation" style="color:rgb(212, 212, 212)">,</span><span class="token plain">90min</span><span class="token punctuation" style="color:rgb(212, 212, 212)">,</span><span class="token plain">1hour</span><span class="token punctuation" style="color:rgb(212, 212, 212)">,</span><span class="token plain">1day</span><span class="token punctuation" style="color:rgb(212, 212, 212)">,</span><span class="token plain">5day</span><span class="token punctuation" style="color:rgb(212, 212, 212)">,</span><span class="token plain">1week</span><span class="token punctuation" style="color:rgb(212, 212, 212)">,</span><span class="token plain">1month</span><span class="token punctuation" style="color:rgb(212, 212, 212)">,</span><span class="token plain">3month</span><span class="token punctuation" style="color:rgb(212, 212, 212)">}</span><span class="token punctuation" style="color:rgb(212, 212, 212)">]</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(212, 212, 212)">[</span><span class="token operator" style="color:rgb(212, 212, 212)">-</span><span class="token plain">s START_DATE</span><span class="token punctuation" style="color:rgb(212, 212, 212)">]</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(212, 212, 212)">[</span><span class="token operator" style="color:rgb(212, 212, 212)">-</span><span class="token plain">e END</span><span class="token punctuation" style="color:rgb(212, 212, 212)">]</span><br></span></code></pre><div class="buttonGroup_6DOT"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><hr><h2 class="anchor anchorWithStickyNavbar_LWe7" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters">​</a></h2><table><thead><tr><th>Name</th><th>Parameter</th><th>Description</th><th>Default</th><th>Optional</th><th>Choices</th></tr></thead><tbody><tr><td>ticker</td><td>-t --ticker</td><td>Currency pair to load.</td><td>None</td><td>True</td><td>GBPYER, GBPBRL, BDTEUR, INRGBP, BIFUSD, EURMYR, AEDPKR, USDDKK, AUDILS, RUBPLN, IDRZAR, IDRTWD, XAUHKD, BAMUSD, CHFDKK, NZDTWD, GBPGYD, EURZAR, BGNAUD, USDLKR, GBPQAR, USDMXN, SGDJPY, USDHNL, GBPAMD, INRJPY, EURDZD, JODILS, NZDZAR, GBPJOD, EURUYU, KWDEUR, PLNILS, KYDUSD, HKDCHF, INRTWD, COPBRL, USDMUR, THBCAD, BGNEUR, MXNCAD, USDUGX, EURCHF, EURZMW, BRLCAD, MXNEUR, INRSGD, JPYNZD, GBPTWD, MADGBP, CNYKRW, USDSGD, TRYXAU, MUREUR, PLNNZD, RSDBRL, AMDGBP, HUFGBP, EURETB, USDNOK, ZARCYP, AEDZAR, CHFBWP, GBPDZD, MXNARS, AEDSAR, EURTZS, TRYZAR, COPGBP, GBPMWK, EURMXN, NOKGBP, ZARXAU, USDAUD, EURSCR, RWFUSD, USDBDT, BRLZAR, KRWTWD, PKRAED, GBPMYR, GBPSAR, AEDSEK, MYRAUD, THBCNY, CZKSEK, USDZMW, USDBBD, EURKYD, SDGUSD, GBPILS, EURDJF, CZKMXN, GBPXPD, BRLXAU, ZARSEK, QAREUR, USDZAR, EURHKD, AUDHKD, USDDJF, XAGUSD, PLNGBP, HKDAUD, DKKAED, PYGEUR, ZARDKK, EURNGN, GYDGBP, JODEUR, EURINR, IDRCHF, JPYBDT, CADXAG, HKDZAR, RSDJPY, PENUSD, EURBOB, UAHDKK, NBLCHF, EURGNF, GBPCLP, NZDPKR, BRIUSD, AUDHRK, EURBGN, USDRSD, JPYILS, EURGTQ, GBPHTG, NOKNZD, KRWINR, EURBBD, SEKNOK, JPYSGD, TWDCNY, AUDEUR, GBPKZT, MOPUSD, THBINR, DKKJPY, GBPPAB, ARSMXN, AEDJPY, MYRDKK, JMDUSD, XPTEUR, USDBND, GBPETB, GBPSCR, EURSZL, DZDUSD, PKREUR, GBPMDL, SEKPLN, LYDEUR, NADEUR, ZARTRY, EURKWD, GBPNZD, AEDEUR, CHFRUB, IQDUSD, BGNGBP, USDCZK, PKRKWD, BGNCNY, GBPCHF, GNFUSD, AUDCLP, GTQGBP, GBPGHS, UZSEUR, JPYMXN, USDCVE, EURUZS, CHFEUR, THBSGD, USDGBP, DKKNOK, CZKNZD, SGDDKK, JPYPKR, KYDEUR, EURBSD, UGXEUR, EURCZK, AUDZAR, TWDINR, TZSZAR, JPYVND, USDOSO, PLNUSD, PLNRUB, TWDTHB, HUFPLN, CLPPEN, USDKHR, AUDCNH, AUDCNY, EURCUP, THBMYR, HTGUSD, ZARZMW, USDBHD, MYRUSD, MKDEUR, TRYPLN, PLNJPY, CHFNOK, USDCNY, DJFUSD, SEKUSD, SEKNZD, ILSJOD, JPYCLP, BRLGBP, ZARPLN, MYRKRW, HKDGBP, RUBDKK, USDLYD, PGKUSD, KMFGBP, EURMWK, SGDBRL, MYRGBP, GBPBAM, NADUSD, KRWMYR, IDRMYR, VNDGBP, SGDCAD, RSDUSD, GBPGTQ, CNHGBP, HKDIDR, ZAREGP, XAGZAR, HKDMXN, GBPKHR, INRCHF, EURLKR, AUNCHF, IDRNZD, TWDEUR, SGDKRW, EURMUR, GBPARS, XAGARS, GBPTND, LKRGBP, USDHRK, CUPGBP, ZARPHP, BHDGBP, HKDMYR, EURMOP, KWDUSD, JPYPLN, MURUSD, GBPMOP, ZARUGX, GBPBGN, AEDINR, GYDEUR, MXNUSD, DKKISK, CNYAUD, GBPMMK, PKRTWD, BHDAED, NZDTHB, BTNGBP, DKKBGN, GBPBIF, CADSGD, EURLAK, EURXPT, XAGBRL, USDXPF, BGNDKK, EURKZT, ZARPKR, MKDGBP, IDREUR, AUDTRY, SEKRUB, NZDKRW, JPYHUF, MYRPKR, JPYIDR, JPYTWD, AUDRUB, ARSXAG, GBPXPT, DZDEUR, LAKGBP, MVRGBP, EURGYD, USDKYD, ZARMAD, IQDGBP, ZARBRL, GBPBZD, CADPEN, ZAROMR, NZDAUD, XAGKRW, HKDARS, EURHNL, SARXAG, USDLAK, BOBUSD, BDTGBP, EURIDR, EURTRY, GBPAED, CHFNBL, PLNZAR, BMDGBP, BRLSGD, EGPEUR, USDEGP, THBHKD, KMFUSD, CADSEK, EURXPD, SGDMYR, USDTJS, RUBCHF, SCRGBP, MYRSGD, ETBEUR, XAUEUR, OMRGBP, ARSEUR, LSLUSD, TNDZAR, BWPUSD, BZDGBP, SZLUSD, MYREUR, DJFEUR, CHFTHB, ARSCHF, EURRSD, RONEUR, JPYPHP, ZARRWF, SGDINR, JPYEGP, TWDSEK, CADBGN, ZARTZS, RONCHF, USDBWP, RUBXAG, AWGGBP, USDTTD, EURLBP, XAUCNY, CADGBP, HUFNZD, AMDEUR, GBPKYD, EUROMR, PHPUSD, KHRUSD, JPYAED, BRLRSD, ZAREUR, USDMAD, RUBEUR, AFNEUR, MXNNZD, XAUMXN, TWDAUD, CNYNZD, RUBZAR, RUBKRW, ALLEUR, BIFGBP, MDLUSD, EURKES, XAUINR, XPDEUR, USDBSD, EURCNY, RUBGBP, AUDXAU, CHFHKD, NZDSEK, QARUSD, ZARRON, HKDCNY, AEDOMR, MYRCAD, EGPJPY, UGXGBP, JPYRSD, ZARMYR, PKRTHB, SEKAED, UAHUSD, CHFBRI, EURARS, BMDCAD, KRWEUR, EURKHR, ZARNOK, BWPCHF, FJDUSD, SGDAUD, AFNGBP, TWDMYR, USDARS, NADZAR, MWKEUR, MURGBP, AUDDKK, XAGMXN, ILSCHF, VRLCHF, CHFMAL, CZKZAR, PENGBP, XPDUSD, EURCDF, ARSZAR, MXNCHF, USDRWF, ILSUSD, USDXAU, GBPMAD, USDBGN, JPYCZK, LKRZAR, NZDHUF, HTGEUR, QARPKR, SGDNZD, LBPEUR, CDFUSD, CLPMXN, ZARCAD, THBUSD, USDPYG, EURQAR, GBPNGN, MXNCLP, JPYSAR, CDFGBP, KWDSAR, XAUUSD, ILSZAR, ZARLKR, GBPAFN, USDJPY, CADHUF, NZDCNY, NOKILS, GBPJMD, DOPUSD, INRHKD, THBIDR, USDCUP, INRMYR, GBPPHP, MVRUSD, XAGAUD, GBPZAR, AEDKWD, USDTRY, GBPPEN, INRUSD, KYDGBP, EURDKK, GBPCOP, BWPGBP, JPYTHB, EURNIO, CHFDOE, GHSGBP, SGDZAR, VRNCHF, BBDBMD, CNHEUR, SARAED, KHREUR, ZARGBP, USDNIO, USDNGN, DKKTRY, SGDNOK, AUDBGN, AEDCAD, SEKINR, BNDUSD, AEDAUD, EURAFN, PKREGP, SLLUSD, DJFGBP, MYRCHF, COPPEN, GBPMVR, CHFNZD, XAUSAR, XAUBRL, CHFSZL, USDKWD, USDIDR, JPYARS, GHSEUR, NZDNOK, THBTWD, KRWXAU, NZDHKD, CHFKRU, GBPBND, EURUAH, INRCNY, CHFMYR, CHFRON, GBPLKR, GBPXAG, JPYXAU, AEDILS, BRLMXN, GTQUSD, EURSLL, PKRJPY, SEKKRW, PENCLP, EURDOP, KWDAED, KESEUR, USDKZT, SEKILS, GBPRUB, SEKGBP, USDNBL, EURHRK, BWPEUR, USDPLN, USDXAG, HKDUSD, USDKRU, CADBMD, ZARCZK, NGNUSD, EURSOS, USDCHF, ARSGBP, INRIDR, PHPEUR, DKKCHF, TRYUSD, INRXAG, LSLEUR, ZARHUF, USDSAR, MXNBRL, JPYCAD, HUFZAR, LRDGBP, SEKCAD, ILSEUR, KRWHKD, ZARBWP, ZMWZAR, SCRUSD, TNDEUR, GBPGNF, IDRKRW, XPDGBP, NOKJPY, BRLKRW, XPTUSD, HKDEUR, ZARUSD, EURILS, BNDEUR, GBPMKD, USDGTQ, MADUSD, HNLEUR, USDUYU, XPFGBP, UAHEUR, CHFTRY, VNDCAD, CNYZAR, DKKHUF, LAKUSD, USDIQD, CNYMYR, TWDIDR, SARGBP, UYUUSD, EURMAD, ILSCAD, XAGINR, GBPXAU, IDRAUD, MOPGBP, HRKEUR, USDTZS, OSOCHF, USDCNH, JODUSD, EURPYG, USDMYR, IDRGBP, KZTUSD, EURBTN, JPYAUD, CHFARE, SEKJPY, CADZAR, AEDNZD, AEDDKK, AEDSGD, USDKMF, MDLGBP, CHFNSO, HUFCAD, USDPHP, TNDUSD, BOBEUR, USDSLL, GBPBMD, DKKINR, CADTWD, TNDGBP, CADMYR, SARXAU, KRWAUD, CHFOSO, ARSSGD, ILSGBP, PLNSGD, HRKUSD, PKRSAR, EURRUB, THBNZD, NIOEUR, NOKPLN, PKRNZD, PHPJPY, AEDQAR, EURSGD, ZARHKD, KRWTHB, ILSAED, USDDZD, INRKRW, AUDNZD, SARKWD, BTNEUR, NZDCHF, COPEUR, MYRINR, GBPKES, ZARCHF, OSOUSD, NBLUSD, PENCAD, ILSAUD, USDXPT, GBPBTN, THBGBP, GNFGBP, INRNOK, MZNEUR, HKDXAU, SGDPLN, GBPXPF, NGNJPY, SEKZAR, XAUZAR, DKKSEK, NZDUSD, SGDGBP, CADKRW, XPFUSD, USDEUR, RONZAR, TRYNZD, ZMWUSD, SEKEUR, AUDTWD, INRSEK, USDMOP, MYRHKD, CHFVRN, TMTUSD, GBPSZL, USDRON, IDRCNY, SEKAUD, CHFISK, TRYEUR, HNLGBP, GBPINR, GBPDJF, USDNZD, RUBNOK, CADHKD, CADAED, HKDSGD, JPYMYR, CNYDKK, ZARILS, KRWSGD, EGPGBP, EURBWP, GBPXCD, KRWJPY, RUBUSD, GBPHUF, IDRINR, CADARS, GBPCZK, UGXUSD, IDRUSD, USDAED, CHFHUF, USDQAR, USDTMT, HKDKRW, JPYCNY, GNFEUR, CNHUSD, XAGSAR, XAGGBP, GBPMXN, USDPGK, GHSUSD, HKDINR, SGDHKD, SVCGBP, RSDGBP, EURTHB, PLNHUF, SOSUSD, CNYUSD, TZSUSD, NOKSEK, AUNUSD, NZDCAD, USDDOP, DKKHKD, KRUCHF, CHFSGD, MWKUSD, HUFJPY, KZTEUR, CADXAU, TTDUSD, GBPPKR, SDGEUR, JPYCHF, JODAED, ZARIDR, BRLUSD, CHFPLN, HUFEUR, ZARARS, CADINR, EURBDT, GBPPLN, JPYGBP, GBPSVC, AUDFJD, ZARRUB, EURGHS, SARPKR, CADBRL, EURALL, CNYXAG, BDTJPY, SGDTWD, EURYER, BRLJPY, BRLCHF, CADDKK, CUPEUR, RWFEUR, PLNHKD, CNYSGD, RWFZAR, MXNXAG, MMKUSD, SOSEUR, CLPARS, GTQEUR, MXNPEN, TWDKRW, JPYHKD, NZDSGD, CADTHB, ARSUSD, EURAMD, GBPNPR, AUDSGD, MYRCNY, RONGBP, SZLEUR, PLNAUD, EURLRD, MWKZAR, CHFIDR, NOKINR, NOKRUB, BRLHKD, USDSOS, USDVND, SARJPY, GBPHNL, PLNNOK, RUBXAU, UAHGBP, OMRZAR, SGDAED, NZDAED, EURBMD, EURSEK, KRWUSD, PGKEUR, DKKUSD, EURAED, USDUZS, PABGBP, USDLBP, LTLAUD, BRLEUR, BBDUSD, GBPLAK, BRLCOP, KRWBRL, CHFZAR, TWDSGD, NIOUSD, DKKRUB, MYRNZD, PLNCHF, GBPNIO, CZKUSD, MYRIDR, EURMDL, SOSGBP, GBPMGA, NZDINR, SZLZAR, MALUSD, BRLPEN, GBPIDR, HKDTWD, TWDHKD, KESUSD, CLPEUR, EURFJD, ILSPLN, BZDUSD, KRWGBP, CHFSEK, DKKZAR, MGAUSD, ARSBRL, ISKUSD, CNYTHB, HUFDKK, TWDCAD, MXNDKK, RUBMXN, CADUSD, MXNCOP, EURKRW, XAGTRY, KRWCAD, USDFJD, GHSZAR, USDDOE, NZDCZK, USDISK, ZARMXN, HUFCHF, KRWXAG, KRWZAR, DKKSGD, EURXAG, CNYINR, BOBGBP, ZARSGD, PABUSD, BRLAUD, DKKTHB, USDMKD, EURHUF, CHFFRN, USDAUN, INREUR, SGDEUR, RSDEUR, THBJPY, USDHKD, USDILS, AUDLTL, YEREUR, ZARJPY, PENMXN, HKDPKR, EURPGK, ARSCLP, ETBUSD, FJDAUD, GBPRSD, DKKPKR, CNYEUR, CNHAUD, AUDPLN, PENCOP, THBXAU, PYGUSD, PLNHRK, GBPCNH, FJDGBP, EURRON, COPUSD, THBPKR, AUDARS, GBPCUP, USDSHP, MOPEUR, HKDBRL, LKREUR, NZDMYR, EURXAU, TTDEUR, GBPEGP, PKRQAR, VNDJPY, USDOMR, GBPNOK, CHFARS, EURMZN, OMREUR, SEKHKD, HKDPLN, MYRTWD, KRWSEK, USDBIF, NZDPLN, TZSEUR, PKRDKK, ISKCHF, EURBHD, KESZAR, GBPBDT, AUDCZK, BIFEUR, EURMKD, CHFINR, AEDGBP, ALLGBP, ISKGBP, RUBJPY, AUDKRW, BNDGBP, CHFILS, GBPLYD, HRKCAD, CLPBRL, GBPTTD, LRDEUR, USDRUB, UGXZAR, USDYER, ZMWEUR, ZARGHS, PKRHKD, NOKAED, DOPGBP, CZKAUD, BRLXAG, USDSCR, AEDUSD, NOKSGD, EURGBP, UZSUSD, DKKPLN, INRAED, USDJMD, JPYINR, HUFUSD, UYUGBP, CADJPY, LYDUSD, ARSPEN, TWDCHF, XAUARS, GBPAWG, AWGUSD, USDSEK, AEDNOK, HTGGBP, VNDEUR, TWDPKR, GBPSEK, DKKAUD, NGNZAR, INRZAR, USDPEN, RONUSD, MYRZAR, NOKEUR, PHPGBP, DKKCZK, AUDHUF, NOKCHF, YERUSD, USDTWD, EURCOP, USDKRW, GBPIQD, GBPKWD, MGAEUR, MXNPLN, NSOCHF, GBPBBD, GBPJPY, QARAED, ZARINR, AUDCAD, GBPALL, CLPAUD, AUDAED, BBDEUR, GBPSOS, THBZAR, PENARS, AEDBHD, EURLYD, JPYNOK, PKRSGD, PLNMXN, EGPUSD, XAURUB, SLLEUR, SGDTHB, CZKPLN, USDBAM, LRDUSD, KWDGBP, USDGYD, LSLGBP, BBDGBP, TRYDKK, COPZAR, BRLCLP, CADIDR, USDCOP, ISKEUR, AUDSEK, GBPUYU, LBPUSD, USDMAL, CADNZD, CHFGBP, BAMGBP, PGKGBP, MXNSGD, MXNGBP, GBPCNY, GBPAUD, NZDGBP, BHDEUR, KRWRUB, KRWCNY, USDPAB, RWFGBP, ARSCAD, CLPJPY, ISKDKK, CHFUSD, AUDBRL, ARECHF, OMRUSD, JPYDKK, ZARCNY, CHFKRW, SEKDKK, BSDGBP, DKKPHP, HRKGBP, VNDUSD, PHPAUD, USDCAD, USDLSL, CHFAUN, JMDGBP, GBPBSD, CNYXAU, AUDXAG, KESGBP, USDMWK, INRAUD, HRKAUD, HRKPLN, CLPGBP, TWDUSD, EUREGP, DKKMXN, BHDUSD, HKDXAG, CZKGBP, MALCHF, TWDZAR, USDGNF, CNYGBP, PKRZAR, CHFJPY, ZARMWK, EURCLP, BRLARS, GBPFJD, BRLSEK, EURIQD, USDKES, GBPRON, GBPDOP, KRWNZD, GYDUSD, DKKCNY, BWPZAR, PLNEUR, COPARS, USDHTG, ZARTND, EURBRL, NPREUR, PLNDKK, ARSAUD, MYRJPY, USDNPR, EURCAD, SVCUSD, AUDTHB, TWDDKK, CHFBRL, USDGHS, JPYXAG, MADEUR, TWDJPY, XPTGBP, MXNRUB, EURJPY, GBPEUR, AUDMYR, PLNTRY, TRYGBP, ZARNGN, DKKTWD, ZARCOP, BHDPKR, ARSHKD, NOKUSD, DKKCOP, GBPOMR, MYRTHB, NPRUSD, YERGBP, EURMVR, EURBIF, NPRGBP, AUDPKR, CADEUR, GBPHRK, CNYBGN, XAUAUD, XAUJPY, ARSXAU, CHFTWD, SGDCNY, USDSDG, XAGHKD, DKKMYR, LYDGBP, ZARNAD, MWKGBP, PLNCZK, AUDPGK, THBKRW, EURAUD, EURMMK, BMDEUR, GBPLRD, IDRHKD, EURSAR, JPYKRW, NIOGBP, DZDGBP, USDSVC, USDMVR, IDRTHB, MADAUD, ARSJPY, KRWCHF, CYPZAR, ILSJPY, GBPCAD, DKKGBP, CNYTWD, EURPKR, BMDBBD, SZLGBP, EURUGX, EURTTD, CZKDKK, TRYCHF, BMDKYD, CADILS, MDLEUR, ZARTWD, AUDJPY, USDMDL, NGNGBP, ZARXAG, QARZAR, BSDEUR, GBPSLL, UYUEUR, IDRCAD, ARSCOP, SGDPKR, EURTJS, EURVND, JPYRUB, SGDUSD, ALLUSD, AUDNOK, NZDEUR, CNYIDR, XAGCAD, HKDJPY, EURPAB, EURNAD, PYGGBP, XAUKRW, GBPUAH, GBPKMF, NOKAUD, EURNPR, AUDCHF, LBPGBP, XAUTRY, USDMMK, FRNCHF, JPYNGN, USDBZD, AUDINR, TJSUSD, HKDDKK, AUDMAD, CADHRK, USDXPD, SLLGBP, CVEUSD, SGDCHF, KWDPKR, SGDARS, PHPZAR, JMDEUR, CNYJPY, TRYJPY, GBPVND, MXNXAU, EURBND, USDTND, JPYUSD, EURTND, BZDEUR, XCDGBP, TWDGBP, EURNZD, DKKEUR, GBPUSD, SAREUR, DOEUSD, KRUUSD, TJSEUR, MADZAR, BDTUSD, DKKNZD, GBPHKD, USDMGA, BGNUSD, KRWIDR, INRDKK, IQDEUR, PKRMYR, NZDJPY, AUDGBP, CHFAUD, DKKUAH, EURISK, PKRUSD, EURLSL, THBEUR, KHRGBP, JPYSEK, JPYTRY, CUPUSD, CADVND, GBPSGD, MXNCZK, DKKCAD, TTDGBP, ILSSEK, XAUCAD, SCREUR, EURJOD, GBPCDF, DOPEUR, CZKJPY, PLNSEK, AUDIDR, USDPKR, LAKEUR, USDBOB, LKRUSD, USDJOD, COPMXN, HKDTHB, EURCNH, INRNZD, GBPISK, CHFAED, NZDIDR, AEDJOD, KZTGBP, CHFVRL, NZDMXN, PKRAUD, PENBRL, RUBAUD, AUDUSD, KYDBMD, EURPEN, SARUSD, RUBSEK, ZARKRW, GBPBWP, HNLUSD, ZARTHB, NOKZAR, COPDKK, SZLCHF, EGPZAR, SGDMXN, GBPDKK, ZARQAR, EURUSD, EURPHP, CADAUD, BRICHF, INRTHB, USDLRD, JPYEUR, GBPBOB, USDUAH, MMKEUR, CADMXN, AUDPHP, JPYBRL, ZARAED, BSDUSD, EURHTG, THBCHF, GBPUGX, EURPLN, SGDSEK, PENEUR, EURSDG, SHPUSD, SEKSGD, GBPBHD, BGNCAD, ZARKES, EURJMD, TRYSGD, HUFAUD, GBPLSL, NGNEUR, JODGBP, FJDEUR, GBPPYG, EURTWD, CDFEUR, DOECHF, EURNOK, XAGEUR, ILSNOK, PHPDKK, MKDUSD, NZDTRY, CZKEUR, CLPUSD, MXNJPY, IDRSGD, MXNZAR, USDTHB, JPYZAR, INRXAU, XAGRUB, TRYAUD, GBPKRW, ZARSZL, XAUGBP, USDCLP, SGDTRY, USDCDF, EURBZD, SEKBRL, TWDNZD, INRCAD, PGKAUD, PABEUR, ZARNZD, NSOUSD, OMRAED, EURRWF, HKDNZD, CNYHKD, PKRGBP, USDHUF, USDINR, USDETB, MXNHKD, USDBRI, CADKYD, HKDSEK, USDAWG, SEKCZK, GBPTRY, HKDCAD, GBPLBP, THBDKK, IDRJPY, USDBRL, ZARAUD, EGPPKR, GBPRWF, NOKDKK, MVREUR, SGDIDR, PKRBHD, NZDDKK, TRYXAG, GBPTHB, CHFMXN, USDNAD, SEKTWD, XAUTHB, XAGCNY, SEKCHF, AUDMXN, GBPPGK, GBPMUR, XAGJPY, USDNSO, MMKGBP, ETBGBP, EURMGA, KYDCAD, USDALL, AEDCHF, QARGBP, USDSZL, THBAUD, MXNAUD, MGAGBP</td></tr><tr><td>resolution</td><td>-r --resolution</td><td>[Alphavantage only]<!-- --> Resolution of data. Can be intraday, daily, weekly or monthly</td><td>d</td><td>True</td><td>i, d, w, m</td></tr><tr><td>interval</td><td>-i --interval</td><td>Interval of intraday data. Options: <!-- -->[YahooFinance]<!-- --> 1min, 2min, 5min, 15min, 30min, 60min, 90min, 1hour, 1day, 5day, 1week, 1month, 3month. <!-- -->[AlphaVantage]<!-- --> 1min, 5min, 15min, 30min, 60min</td><td>1day</td><td>True</td><td>1min, 5min, 15min, 30min, 60min, 90min, 1hour, 1day, 5day, 1week, 1month, 3month</td></tr><tr><td>start_date</td><td>-s --start</td><td>The starting date (format YYYY-MM-DD) of the forex pair</td><td>datetime.now() - timedelta(days=365)</td><td>True</td><td>None</td></tr><tr><td>end</td><td>-e --end</td><td>The ending date (format YYYY-MM-DD) of the forex pair</td><td>2023-03-01</td><td>True</td><td>None</td></tr></tbody></table><hr></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/content/terminal/reference/forex/load.md" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><a class="pagination-nav__link pagination-nav__link--prev" href="/terminal/reference/forex/fwd"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">fwd</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/terminal/reference/forex/oanda/calendar"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">calendar</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_jeP5 thin-scrollbar text-sm mt-[48px] xl:max-w-[216px] theme-doc-toc-desktop"><p class="uppercase text-sm font-bold text-grey-600 dark:text-grey-200 tracking-widest mb-2">On this page</p><ul class="border-l border-grey-300 dark:border-grey-600 list-none pl-4"><li class="pb-1"><a href="#usage" class="text-grey-400 capitalize !no-underline">Usage</a></li><li class="py-1"><a href="#parameters" class="text-grey-400 capitalize !no-underline">Parameters</a></li></ul></div></div></div></div></main></div></div><footer class="px-4 border-t dark:border-grey-600/50 lg:px-12 py-14 bg-white dark:bg-grey-900 z-10 overflow-hidden"><div class="flex w-full flex-col justify-between gap-10 md:flex-row md:items-start"><div class="ml-2 mb-2 space-y-10 md:m-0"><a aria-label="Home" class="hover:text-grey-700 dark:text-white dark:hover:text-gray-50" href="/"><svg viewBox="0 0 170 17" width="170" height="17" fill="none" xmlns="http://www.w3.org/2000/svg" class="h-[14px] w-[140px]"><path d="M106.107 1.889v11.334l-.961-.946-.959-.945-.962-.943-.959-.946-.961-.943-.962-.945-.959-.944-.961-.945-.96-.943-.961-.946-.96-.943-.96-.945H92.66V17H94.582V4.723l.96.943.96.945.961.944.96.945.961.943.959.946.962.943.961.945.959.946.962.943.959.945.961.944.96.945h.961V1.889H106.107ZM137.03 7.557h-1.921V1.889h-11.524V17h15.37V7.546h-1.92l-.005.01Zm-11.524-.946V3.773h7.683v3.78h-7.683V6.61Zm11.524 3.778v4.727h-11.524v-5.67h11.524v.943ZM168.901 7.557h-2.88V1.889h-11.526V0h-1.921v1.889h1.921V17h15.365V7.546l-.959.01Zm-12.485-.946V3.773h7.684v3.78h-7.684V6.61Zm11.526 3.778v4.727h-11.526v-5.67h11.526v.943ZM75.314 1.889H61.867V17H77.23V15.111H63.787V11.332h11.521V9.443H63.788V3.777H77.23V1.89h-1.916ZM13.444 1.889H0V17h15.367V1.889h-1.922Zm0 2.834V15.11H1.918V3.773h11.527v.95ZM44.397 1.889H30.952V17h1.92v-5.666h13.445V1.88h-1.92v.009Zm0 2.834V9.45H32.873V3.773h11.524v.95Z" fill="currentColor"></path></svg></a><a class="flex h-[32px] w-[172px] rounded-md border border-grey-300 hover:bg-grey-100 dark:border-white bg-grey-100 dark:bg-white text-xs hover:no-underline" href="https://github.com/OpenBB-finance/OpenBBTerminal" target="_blank" rel="noreferrer"><span class="inline-flex w-[60%] items-center gap-x-[6px] px-3 py-2 text-grey-800"><svg viewBox="0 0 24 24" width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" style="margin-bottom:3px" class="h-[14.67px] w-[14.67px]"><path d="m12 1 3.263 7.439L23 9.403l-5.72 5.562L18.798 23 12 18.999 5.202 23l1.518-8.035L1 9.403l7.737-.964L12 1Z" stroke="currentColor" stroke-width="1.5" stroke-linejoin="round"></path></svg>Star us</span><span class="inline-flex w-[40%] items-center justify-center rounded-r-md bg-grey-900 text-grey-500">0</span></a></div><div class="grid grid-cols-1 gap-6 sm:gap-16 md:w-2/3 md:grid-cols-4 lg:w-[68%]"><div><div class="w-full md:hidden"><button class="flex w-full items-center justify-between rounded-sm p-2 font-semibold">Company<svg viewBox="0 0 24 24" width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="tw-transition"><path d="m9 18 6-6-6-6" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"></path></svg></button><div class="ml-6 mt-2 flex-col items-start gap-4 hidden"><a class="flex w-full cursor-pointer gap-x-2 p-2 font-semibold whitespace-nowrap" target="_blank" rel="noreferrer" href="https://openbb.co/why-openbb">Why OpenBB?</a><a class="flex w-full cursor-pointer gap-x-2 p-2 font-semibold whitespace-nowrap" target="_blank" rel="noreferrer" href="https://openbb.co/community">Community</a><a class="flex w-full cursor-pointer gap-x-2 p-2 font-semibold whitespace-nowrap" target="_blank" rel="noreferrer" href="https://openbb.co/company">About us</a><a class="flex w-full cursor-pointer gap-x-2 p-2 font-semibold whitespace-nowrap" target="_blank" rel="noreferrer" href="https://openbb.co/company/careers">Careers</a><a class="flex w-full cursor-pointer gap-x-2 p-2 font-semibold whitespace-nowrap" target="_blank" rel="noreferrer" href="https://openbb.co/company/partners">Partners</a></div></div><div class="hidden md:block"><p class="mb-4 text-base font-bold uppercase tracking-widest text-grey-600 dark:text-white">Company</p><ul class="hidden flex-col gap-3 md:flex"><li><a class="whitespace-nowrap inline-flex w-full items-center gap-2 text-sm text-grey-400 dark:hover:text-white" target="_blank" rel="noreferrer" href="https://openbb.co/why-openbb">Why OpenBB?</a></li><li><a class="whitespace-nowrap inline-flex w-full items-center gap-2 text-sm text-grey-400 dark:hover:text-white" target="_blank" rel="noreferrer" href="https://openbb.co/community">Community</a></li><li><a class="whitespace-nowrap inline-flex w-full items-center gap-2 text-sm text-grey-400 dark:hover:text-white" target="_blank" rel="noreferrer" href="https://openbb.co/company">About us</a></li><li><a class="whitespace-nowrap inline-flex w-full items-center gap-2 text-sm text-grey-400 dark:hover:text-white" target="_blank" rel="noreferrer" href="https://openbb.co/company/careers">Careers</a></li><li><a class="whitespace-nowrap inline-flex w-full items-center gap-2 text-sm text-grey-400 dark:hover:text-white" target="_blank" rel="noreferrer" href="https://openbb.co/company/partners">Partners</a></li></ul></div></div><div><div class="w-full md:hidden"><button class="flex w-full items-center justify-between rounded-sm p-2 font-semibold">Products<svg viewBox="0 0 24 24" width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="tw-transition"><path d="m9 18 6-6-6-6" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"></path></svg></button><div class="ml-6 mt-2 flex-col items-start gap-4 hidden"><a class="flex w-full cursor-pointer gap-x-2 p-2 font-semibold whitespace-nowrap" target="_blank" rel="noreferrer" href="https://openbb.co/products/terminal">OpenBB Terminal</a><a class="flex w-full cursor-pointer gap-x-2 p-2 font-semibold whitespace-nowrap" target="_blank" rel="noreferrer" href="https://docs.openbb.co/terminal">Terminal Docs</a><a class="flex w-full cursor-pointer gap-x-2 p-2 font-semibold whitespace-nowrap" target="_blank" rel="noreferrer" href="https://openbb.co/products/bot">OpenBB Bot</a><a class="flex w-full cursor-pointer gap-x-2 p-2 font-semibold whitespace-nowrap" target="_blank" rel="noreferrer" href="https://my.openbb.co/app/docs">Bot Docs</a></div></div><div class="hidden md:block"><p class="mb-4 text-base font-bold uppercase tracking-widest text-grey-600 dark:text-white">Products</p><ul class="hidden flex-col gap-3 md:flex"><li><a class="whitespace-nowrap inline-flex w-full items-center gap-2 text-sm text-grey-400 dark:hover:text-white" target="_blank" rel="noreferrer" href="https://openbb.co/products/terminal">OpenBB Terminal</a></li><li><a class="whitespace-nowrap inline-flex w-full items-center gap-2 text-sm text-grey-400 dark:hover:text-white" target="_blank" rel="noreferrer" href="https://docs.openbb.co/terminal">Terminal Docs</a></li><li><a class="whitespace-nowrap inline-flex w-full items-center gap-2 text-sm text-grey-400 dark:hover:text-white" target="_blank" rel="noreferrer" href="https://openbb.co/products/bot">OpenBB Bot</a></li><li><a class="whitespace-nowrap inline-flex w-full items-center gap-2 text-sm text-grey-400 dark:hover:text-white" target="_blank" rel="noreferrer" href="https://my.openbb.co/app/docs">Bot Docs</a></li></ul></div></div><div><div class="w-full md:hidden"><button class="flex w-full items-center justify-between rounded-sm p-2 font-semibold">Community<svg viewBox="0 0 24 24" width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="tw-transition"><path d="m9 18 6-6-6-6" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"></path></svg></button><div class="ml-6 mt-2 flex-col items-start gap-4 hidden"><a class="flex w-full cursor-pointer gap-x-2 p-2 font-semibold whitespace-nowrap" target="_blank" rel="noreferrer" href="https://openbb.co/community">Contributors</a><a class="flex w-full cursor-pointer gap-x-2 p-2 font-semibold whitespace-nowrap" target="_blank" rel="noreferrer" href="https://openbb.co/blog">Blog &amp; Stories</a><a class="flex w-full cursor-pointer gap-x-2 p-2 font-semibold whitespace-nowrap" target="_blank" rel="noreferrer" href="https://openbb.co/newsletter">Newsletter</a><a class="flex w-full cursor-pointer gap-x-2 p-2 font-semibold whitespace-nowrap" target="_blank" rel="noreferrer" href="https://www.openbb.design">Brand Book</a></div></div><div class="hidden md:block"><p class="mb-4 text-base font-bold uppercase tracking-widest text-grey-600 dark:text-white">Community</p><ul class="hidden flex-col gap-3 md:flex"><li><a class="whitespace-nowrap inline-flex w-full items-center gap-2 text-sm text-grey-400 dark:hover:text-white" target="_blank" rel="noreferrer" href="https://openbb.co/community">Contributors</a></li><li><a class="whitespace-nowrap inline-flex w-full items-center gap-2 text-sm text-grey-400 dark:hover:text-white" target="_blank" rel="noreferrer" href="https://openbb.co/blog">Blog &amp; Stories</a></li><li><a class="whitespace-nowrap inline-flex w-full items-center gap-2 text-sm text-grey-400 dark:hover:text-white" target="_blank" rel="noreferrer" href="https://openbb.co/newsletter">Newsletter</a></li><li><a class="whitespace-nowrap inline-flex w-full items-center gap-2 text-sm text-grey-400 dark:hover:text-white" target="_blank" rel="noreferrer" href="https://www.openbb.design">Brand Book</a></li></ul></div></div><div><div class="w-full md:hidden"><button class="flex w-full items-center justify-between rounded-sm p-2 font-semibold">Others<svg viewBox="0 0 24 24" width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="tw-transition"><path d="m9 18 6-6-6-6" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"></path></svg></button><div class="ml-6 mt-2 flex-col items-start gap-4 hidden"><a class="flex w-full cursor-pointer gap-x-2 p-2 font-semibold whitespace-nowrap" target="_blank" rel="noreferrer" href="https://openbb.co/request-a-feature">Request feature</a><a class="flex w-full cursor-pointer gap-x-2 p-2 font-semibold whitespace-nowrap" target="_blank" rel="noreferrer" href="https://openbb.co/support">Support</a><a class="flex w-full cursor-pointer gap-x-2 p-2 font-semibold whitespace-nowrap" target="_blank" rel="noreferrer" href="https://openbb.co/contact">Contact</a><a class="flex w-full cursor-pointer gap-x-2 p-2 font-semibold whitespace-nowrap" target="_blank" rel="noreferrer" href="https://openbb.co/sitemap">Sitemap</a></div></div><div class="hidden md:block"><p class="mb-4 text-base font-bold uppercase tracking-widest text-grey-600 dark:text-white">Others</p><ul class="hidden flex-col gap-3 md:flex"><li><a class="whitespace-nowrap inline-flex w-full items-center gap-2 text-sm text-grey-400 dark:hover:text-white" target="_blank" rel="noreferrer" href="https://openbb.co/request-a-feature">Request feature</a></li><li><a class="whitespace-nowrap inline-flex w-full items-center gap-2 text-sm text-grey-400 dark:hover:text-white" target="_blank" rel="noreferrer" href="https://openbb.co/support">Support</a></li><li><a class="whitespace-nowrap inline-flex w-full items-center gap-2 text-sm text-grey-400 dark:hover:text-white" target="_blank" rel="noreferrer" href="https://openbb.co/contact">Contact</a></li><li><a class="whitespace-nowrap inline-flex w-full items-center gap-2 text-sm text-grey-400 dark:hover:text-white" target="_blank" rel="noreferrer" href="https://openbb.co/sitemap">Sitemap</a></li></ul></div></div></div></div><hr><div class="flex w-full flex-col items-center justify-between gap-4 md:flex-row md:gap-0"><div class="flex flex-col items-start justify-end gap-4 self-start font-light text-grey-500 md:flex-row md:items-center"><p class="text-sm">© 2023 OpenBB</p><div class="_divider-x hidden h-[20px] border-[0.5px] md:block"></div><a class="text-sm dark:hover:text-white" href="/legal/privacy-policy">Privacy Policy</a><div class="_divider-x hidden h-[20px] border-[0.5px] md:block"></div><a class="text-sm dark:hover:text-white" href="/legal/terms-of-service">Terms</a></div><div class="mt-4 mb-10 grid grid-cols-4 gap-4 self-start md:my-0 md:grid-cols-8 md:self-end"><a aria-label="GitHub Link" class="h-8 w-8 dark:hover:!text-white hover:text-grey-700" target="_blank" rel="noreferrer" href="https://github.com/OpenBB-finance/OpenBBTerminal"><svg width="15" height="16" viewBox="0 0 15 16" fill="none" xmlns="http://www.w3.org/2000/svg" class="h-4 w-4"><path d="M6 12.76c-3.333 1-3.333-1.667-4.667-2l4.667 2Zm4.667 2v-2.58a2.246 2.246 0 0 0-.627-1.74c2.094-.233 4.294-1.027 4.294-4.667 0-.93-.359-1.825-1-2.5a3.38 3.38 0 0 0-.06-2.513s-.787-.233-2.607.987a8.92 8.92 0 0 0-4.667 0C4.18.527 3.393.76 3.393.76a3.38 3.38 0 0 0-.06 2.513 3.627 3.627 0 0 0-1 2.52c0 3.614 2.2 4.407 4.294 4.667A2.248 2.248 0 0 0 6 12.18v2.58" fill="currentColor"></path><path d="M10.667 14.76v-2.58a2.246 2.246 0 0 0-.627-1.74c2.094-.233 4.294-1.027 4.294-4.667 0-.93-.359-1.825-1-2.5a3.38 3.38 0 0 0-.06-2.513s-.787-.233-2.607.987a8.92 8.92 0 0 0-4.667 0C4.18.527 3.393.76 3.393.76a3.38 3.38 0 0 0-.06 2.513 3.627 3.627 0 0 0-1 2.52c0 3.614 2.2 4.407 4.294 4.667A2.248 2.248 0 0 0 6 12.18v2.58m0-2c-3.333 1-3.333-1.667-4.667-2l4.667 2Z" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></a><a aria-label="LinkedIn Link" class="h-8 w-8 dark:hover:!text-white hover:text-grey-700" target="_blank" rel="noreferrer" href="https://www.linkedin.com/company/openbb-finance/"><svg viewBox="0 0 24 24" width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="h-4 w-4"><path d="M13 21H9V9h4v2a4.618 4.618 0 0 1 3.525-1.763A4.5 4.5 0 0 1 21 13.75V21h-4v-6.75a2.265 2.265 0 0 0-2.247-1.944A1.815 1.815 0 0 0 13 14.25V21Zm-6 0H3V9h4v12ZM5 7a2 2 0 1 1 0-4 2 2 0 0 1 0 4Z" fill="currentColor"></path></svg></a><a aria-label="Twitter Link" class="h-8 w-8 dark:hover:!text-white hover:text-grey-700" target="_blank" rel="noreferrer" href="https://twitter.com/openbb_finance"><svg viewBox="0 0 16 14" width="16" height="14" fill="none" xmlns="http://www.w3.org/2000/svg" class="h-4 w-4"><path d="M14.115 2.481A3.36 3.36 0 0 0 15.56.618a6.472 6.472 0 0 1-2.085.817A3.229 3.229 0 0 0 9.532.778c-1.308.718-1.985 2.246-1.654 3.73C5.24 4.37 2.78 3.092 1.114.987c-.87 1.54-.426 3.507 1.015 4.497a3.208 3.208 0 0 1-1.486-.422v.042c0 1.604 1.102 2.985 2.634 3.302-.484.135-.99.155-1.483.058.431 1.372 1.663 2.31 3.067 2.339A6.48 6.48 0 0 1 0 12.199a9.12 9.12 0 0 0 5.032 1.513 9.157 9.157 0 0 0 6.623-2.787 9.644 9.644 0 0 0 2.716-6.795c0-.146-.003-.291-.01-.436A6.767 6.767 0 0 0 16 1.951a6.433 6.433 0 0 1-1.885.53Z" fill="currentColor"></path></svg></a><a aria-label="Tiktok Link" class="h-8 w-8 dark:hover:!text-white hover:text-grey-700" target="_blank" rel="noreferrer" href="https://www.tiktok.com/@openbb"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" class="h-5 w-5 pl-[2.5px]"><path d="M0 0h24v24H0z" stroke="none"></path><path d="M9 12a4 4 0 1 0 4 4V4a5 5 0 0 0 5 5"></path></svg></a><a aria-label="Reddit Link" class="h-8 w-8 dark:hover:!text-white hover:text-grey-700" target="_blank" rel="noreferrer" href="https://www.reddit.com/r/openbb/"><svg viewBox="0 0 16 16" width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg" class="h-4 w-4"><path d="M8 14.667A6.667 6.667 0 1 1 14.667 8 6.674 6.674 0 0 1 8 14.667ZM4.538 7.029a.973.973 0 0 0-.405 1.858 1.707 1.707 0 0 0 0 .292c0 1.494 1.743 2.708 3.886 2.708 2.142 0 3.886-1.214 3.886-2.708a1.857 1.857 0 0 0 0-.292.96.96 0 0 0-.432-1.825h-.035a.97.97 0 0 0-.638.271 4.744 4.744 0 0 0-2.567-.82l.434-2.08 1.425.3a.667.667 0 0 0 .735.591A.667.667 0 1 0 10.685 4a.667.667 0 0 0-.506.328L8.547 4a.207.207 0 0 0-.244.158l-.499 2.315a4.749 4.749 0 0 0-2.6.82.967.967 0 0 0-.666-.264Zm3.582 3.987h-.225a2.568 2.568 0 0 1-1.534-.515.18.18 0 0 1 .139-.294.18.18 0 0 1 .114.04c.374.274.825.421 1.289.42h.216c.457 0 .903-.143 1.274-.41a.187.187 0 0 1 .267 0 .19.19 0 0 1-.003.267v-.027a2.557 2.557 0 0 1-1.537.518v.001Zm1.418-1.63h-.01l.005-.025a.626.626 0 1 1 .49-.188.659.659 0 0 1-.462.214h-.024.001Zm-3.091-.053a.667.667 0 1 1 0-1.333.667.667 0 0 1 0 1.333Z" fill="currentColor"></path></svg></a><a aria-label="Discord Link" class="h-8 w-8 dark:hover:!text-white hover:text-grey-700" target="_blank" rel="noreferrer" href="https://discord.gg/xPHTuHCmuV"><svg viewBox="0 0 16 12" width="16" height="12" fill="none" xmlns="http://www.w3.org/2000/svg" class="h-4 w-4"><path d="M13.38 8.836a4.375 4.375 0 0 1-2.474 1.507c.407.481.897 1.025.901 1.03 1.655.033 3.221-.688 4.193-1.929-.05-2.572-.724-5.1-1.973-7.397A7.139 7.139 0 0 0 10.194.71h-.016l-.192.203a9.52 9.52 0 0 1 3.412 1.61 11.875 11.875 0 0 0-4.125-1.217 12.415 12.415 0 0 0-2.766.025c-.065.001-.13.008-.193.019h-.04a10.98 10.98 0 0 0-3.11.801c-.493.21-.796.362-.809.368-.013.005 0 0 0-.01A10.022 10.022 0 0 1 5.96.866L5.815.714h-.009a7.142 7.142 0 0 0-3.833 1.335A16.003 16.003 0 0 0 0 9.447c.96 1.249 2.528 1.972 4.182 1.929 0 0 .517-.583.92-1.054a4.307 4.307 0 0 1-2.405-1.496c.01.006.153.096.384.213a.17.17 0 0 0 .056.04.409.409 0 0 0 .058.031 8.043 8.043 0 0 0 1.064.462c.653.24 1.33.423 2.019.548.604.106 1.217.16 1.832.16.576 0 1.15-.049 1.717-.146a9.64 9.64 0 0 0 1.986-.546 8.203 8.203 0 0 0 1.566-.752Zm-2.94-.57c-.627.05-1.224-.26-1.502-.784a1.335 1.335 0 0 1 .244-1.581 1.612 1.612 0 0 1 1.68-.363c.586.212.973.735.973 1.319.032.745-.592 1.374-1.396 1.41h.001Zm-5.001 0c-.79-.064-1.395-.676-1.395-1.41 0-.733.606-1.345 1.395-1.408.363 0 .71.138.963.38.286.276.442.645.433 1.027.033.747-.59 1.378-1.396 1.411Z" fill="currentColor"></path></svg></a><a aria-label="Youtube Link" class="h-8 w-8 dark:hover:!text-white hover:text-grey-700" target="_blank" rel="noreferrer noopener" href="https://www.youtube.com/channel/UCaeFEx-W16IuxRsHlM1ywBQ"><svg viewBox="0 0 24 24" width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="h-4 w-4"><path d="M22.54 6.42a2.78 2.78 0 0 0-1.94-2C18.88 4 12 4 12 4s-6.88 0-8.6.46a2.78 2.78 0 0 0-1.94 2A29 29 0 0 0 1 11.75a29 29 0 0 0 .46 5.33A2.78 2.78 0 0 0 3.4 19c1.72.46 8.6.46 8.6.46s6.88 0 8.6-.46a2.78 2.78 0 0 0 1.94-2c.313-1.732.467-3.49.46-5.25a29.005 29.005 0 0 0-.46-5.33v0Z" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="m9.75 15.017 5.75-3.27-5.75-3.27v6.54Z" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path></svg></a></div></div></footer></div>
<script src="/assets/js/runtime~main.8fc2e5b2.js"></script>
<script src="/assets/js/main.b3705552.js"></script>
</body>
</html>