mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-29 13:32:08 +00:00
29 lines
65 KiB
HTML
29 lines
65 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-platform/reference/etf/holdings" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v3.3.2">
|
||
<title data-rh="true">etf/holdings - Reference | OpenBB Platform 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/platform/reference/etf/holdings"><meta data-rh="true" property="og:locale" content="en"><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="holdings | OpenBB Docs"><meta data-rh="true" name="description" content="Learn how to get the holdings data for an individual ETF using the `obb.etf.holdings` method. Understand the parameters like symbol, provider, date, and CIK. Explore the returns, results, warnings, chart, and metadata. Dive into the data fields like symbol, name, LEI, title, CUSIP, ISIN, balance, units, currency, value, weight, payoff profile, asset category, issuer category, country, and more."><meta data-rh="true" property="og:description" content="Learn how to get the holdings data for an individual ETF using the `obb.etf.holdings` method. Understand the parameters like symbol, provider, date, and CIK. Explore the returns, results, warnings, chart, and metadata. Dive into the data fields like symbol, name, LEI, title, CUSIP, ISIN, balance, units, currency, value, weight, payoff profile, asset category, issuer category, country, and more."><meta data-rh="true" name="keywords" content="ETF holdings,individual ETF holdings,holdings data for ETF,symbol,provider,date,CIK,returns,results,warnings,chart,metadata,data,name,LEI,title,CUSIP,ISIN,balance,units,currency,value,weight,payoff profile,asset category,issuer category,country,is restricted,fair value level,is cash collateral,is non-cash collateral,is loan by fund,acceptance datetime"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openbb.co/platform/reference/etf/holdings"><link data-rh="true" rel="alternate" href="https://docs.openbb.co/platform/reference/etf/holdings" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openbb.co/platform/reference/etf/holdings" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://7D1HQ0IXAS-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="OpenBB Docs" href="/opensearch.xml">
|
||
|
||
|
||
<link rel="stylesheet" href="/katex/katex.min.css"><link rel="stylesheet" href="/assets/css/styles.de2dfce3.css">
|
||
<script src="/assets/js/runtime~main.99b31435.js" defer="defer"></script>
|
||
<script src="/assets/js/main.3abd6960.js" defer="defer"></script>
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</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_sdk navbar navbar--fixed-top"><div class="navbar__inner items-center"><div class="navbar__items"><div class="items-center ml-2 flex"><a href="/"><svg viewBox="0 0 271 19" width="271" height="19" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill="#fff" d="M126.316.99V14.33l-1.144-1.11-1.142-1.113-1.144-1.11-1.142-1.114-1.144-1.11-1.145-1.113-1.141-1.11-1.145-1.114-1.142-1.113-1.144-1.11-1.142-1.11-1.144-1.114H110.311v17.788H112.597V4.323l1.144 1.113 1.142 1.113 1.144 1.11 1.142 1.114 1.145 1.11 1.141 1.113 1.145 1.11 1.144 1.114 1.142 1.11 1.144 1.113 1.142 1.113 1.144 1.11 1.142 1.111h1.145V.989h-2.287ZM163.123 7.66h-2.286V.99H147.12v17.79h18.294V7.65h-2.286l-.005.01ZM149.406 6.54V3.213h9.144V7.66h-9.144V6.54Zm13.717 4.447v5.566h-13.717V9.886h13.717v1.102ZM201.057 7.66h-3.427V.99h-13.72v17.79h18.289V7.65l-1.142.01ZM186.196 6.54V3.213h9.148V7.66h-9.148V6.54Zm13.72 4.447v5.566h-13.72V9.886h13.72v1.102ZM89.662.99H73.656v17.787H91.942v-2.22H75.945V12.106H89.656V9.883H75.945V3.213H91.942V.99H89.661ZM16.02.99H.018v17.79h18.291V.99H16.02Zm0 3.336v12.23H2.301V3.213h13.72v1.113ZM52.862.99H36.86v17.79h2.286v-6.673h16.003V.977h-2.287V.99Zm0 3.336v5.565H39.146V3.213h13.716v1.113ZM226.316 10.14h-6.117v8.64h6.141l.992-1v-7l-1.016-.64Zm-.002 1.62v5.94h-5.1v-6.48h5.1v.54ZM240.447 10.14h-7.115v8.64h8.133v-8.64h-1.018Zm0 1.62v5.94h-6.1v-6.48h6.1v.54ZM254.9 10.14H247.465v8.64H255.959V17.7H248.528V11.22H255.959v-1.08H254.9ZM269.404 10.14h-7.444V15h7.448v2.701h-5.853l-1.596.005.001.535v.539h8.505V17.7h-1.061.004H263.555l6.913.066.002-.607-.002-.41-.003-.67.005-1.08h-6.248 6.248l-.002-1.08H263.024v-2.7h7.441v-1.08h-1.061Z"></path></svg></a></div></div><div class="navbar__items navbar__items--right max-sm:hidden"><div class="flex items-center"><div class="flex gap-4 mr-12 md:mr-0 ml-4"><button type="button" aria-haspopup="dialog" aria-expanded="false" aria-controls="radix-:R2d6ah:" 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="navbarSearchContainer_Bca1"><div class="flex gap-2"><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" aria-hidden="true"><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><a href="https://my.openbb.co/" class="_btn-dark text-xs hover:text-black"><span class="md:hidden">Hub</span><span class="hidden md:inline">OpenBB Hub</span></a></div></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd"><nav class="menu thin-scrollbar !px-10 text-sm !pb-10 mt-[40px] menu_Y1UP"><ul class="theme-doc-sidebar-menu menu__list"><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="/platform">OpenBB Platform</a><button aria-label="Toggle the collapsible sidebar category 'OpenBB Platform'" 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-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/platform">Introduction</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/platform/installation">Installation</a></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" aria-expanded="false" tabindex="0" href="/platform/getting_started">Getting Started</a><button aria-label="Toggle the collapsible sidebar category 'Getting Started'" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" tabindex="0" href="/platform/user_guides">User Guides</a><button aria-label="Toggle the collapsible sidebar category 'User Guides'" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" tabindex="0" href="/platform/developer_guide">Developer Guide</a><button aria-label="Toggle the collapsible sidebar category 'Developer Guide'" type="button" class="clean-btn menu__caret"></button></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--active" aria-expanded="true" tabindex="0" href="/platform/reference">Reference</a><button aria-label="Toggle the collapsible sidebar category 'Reference'" 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-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/platform/reference/quantitative">Quantitative</a><button aria-label="Toggle the collapsible sidebar category 'Quantitative'" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" tabindex="0" href="/platform/reference/crypto">Crypto</a><button aria-label="Toggle the collapsible sidebar category 'Crypto'" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" tabindex="0" href="/platform/reference/technical">Technical</a><button aria-label="Toggle the collapsible sidebar category 'Technical'" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" tabindex="0" href="/platform/reference/index">Index</a><button aria-label="Toggle the collapsible sidebar category 'Index'" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" tabindex="0" href="/platform/reference/derivatives">Derivatives</a><button aria-label="Toggle the collapsible sidebar category 'Derivatives'" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" tabindex="0" href="/platform/reference/news">News</a><button aria-label="Toggle the collapsible sidebar category 'News'" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" tabindex="0" href="/platform/reference/econometrics">Econometrics</a><button aria-label="Toggle the collapsible sidebar category 'Econometrics'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" aria-expanded="true" tabindex="0" href="/platform/reference/etf">Etf</a><button aria-label="Toggle the collapsible sidebar category 'Etf'" 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-4 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/platform/reference/etf/discovery">Discovery</a><button aria-label="Toggle the collapsible sidebar category 'Discovery'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/platform/reference/etf/countries">countries</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/platform/reference/etf/equity_exposure">equity_exposure</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/platform/reference/etf/historical">historical</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/platform/reference/etf/holdings">holdings</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/platform/reference/etf/holdings_date">holdings_date</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/platform/reference/etf/info">info</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/platform/reference/etf/price_performance">price_performance</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/platform/reference/etf/search">search</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/platform/reference/etf/sectors">sectors</a></li></ul></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" aria-expanded="false" tabindex="0" href="/platform/reference/currency">Currency</a><button aria-label="Toggle the collapsible sidebar category 'Currency'" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" tabindex="0" href="/platform/reference/commodity">Commodity</a><button aria-label="Toggle the collapsible sidebar category 'Commodity'" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" tabindex="0" href="/platform/reference/fixedincome">Fixedincome</a><button aria-label="Toggle the collapsible sidebar category 'Fixedincome'" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" tabindex="0" href="/platform/reference/regulators">Regulators</a><button aria-label="Toggle the collapsible sidebar category 'Regulators'" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" tabindex="0" href="/platform/reference/economy">Economy</a><button aria-label="Toggle the collapsible sidebar category 'Economy'" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" tabindex="0" href="/platform/reference/equity">Equity</a><button aria-label="Toggle the collapsible sidebar category 'Equity'" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" tabindex="0" href="/platform/data_models">Data Models</a><button aria-label="Toggle the collapsible sidebar category 'Data Models'" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" tabindex="0" href="/platform/faqs">FAQs</a><button aria-label="Toggle the collapsible sidebar category 'FAQs'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/platform/licensing">Licensing</a></li></ul></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" aria-expanded="false" href="/cli">OpenBB Platform CLI</a><button aria-label="Toggle the collapsible sidebar category 'OpenBB Platform CLI'" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" href="/bot">OpenBB Bot</a><button aria-label="Toggle the collapsible sidebar category 'OpenBB Bot'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1"><span class="sidebar-divider"></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_PEWV menu__list-item sidebar-title">LEGACY</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" aria-expanded="false" href="/terminal">OpenBB Terminal</a><button aria-label="Toggle the collapsible sidebar category 'OpenBB Terminal'" type="button" class="clean-btn menu__caret"></button></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 href="#" class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false">OpenBB SDK</a></div></li></ul></nav></div></div></aside><main class="docMainContainer_TBSr"><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 class="breadcrumbs__item"><span class="breadcrumbs__link">OpenBB Platform</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/platform/reference"><span itemprop="name">Reference</span></a><meta itemprop="position" content="2"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/platform/reference/etf"><span itemprop="name">Etf</span></a><meta itemprop="position" content="3"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">holdings</span><meta itemprop="position" content="4"></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"><header><h1>holdings</h1></header>
|
||
<!-- -->
|
||
<p>Get the holdings for an individual ETF.</p>
|
||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="examples">Examples<a href="#examples" class="hash-link" aria-label="Direct link to Examples" title="Direct link to Examples"></a></h2>
|
||
<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 class="codeBlockLines_p187"><span class="token-line" style="color:#9CDCFE"><span class="token keyword" style="color:rgb(86, 156, 214)">from</span><span class="token plain"> openbb </span><span class="token keyword" style="color:rgb(86, 156, 214)">import</span><span class="token plain"> obb</span><br></span><span class="token-line" style="color:#9CDCFE"><span class="token plain">obb</span><span class="token punctuation" style="color:rgb(212, 212, 212)">.</span><span class="token plain">etf</span><span class="token punctuation" style="color:rgb(212, 212, 212)">.</span><span class="token plain">holdings</span><span class="token punctuation" style="color:rgb(212, 212, 212)">(</span><span class="token plain">symbol</span><span class="token operator" style="color:rgb(212, 212, 212)">=</span><span class="token string" style="color:rgb(206, 145, 120)">'XLK'</span><span class="token punctuation" style="color:rgb(212, 212, 212)">,</span><span class="token plain"> provider</span><span class="token operator" style="color:rgb(212, 212, 212)">=</span><span class="token string" style="color:rgb(206, 145, 120)">'fmp'</span><span class="token punctuation" style="color:rgb(212, 212, 212)">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#9CDCFE"><span class="token plain"></span><span class="token comment" style="color:rgb(106, 153, 85)"># Including a date (FMP, SEC) will return the holdings as per NPORT-P filings.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#9CDCFE"><span class="token plain">obb</span><span class="token punctuation" style="color:rgb(212, 212, 212)">.</span><span class="token plain">etf</span><span class="token punctuation" style="color:rgb(212, 212, 212)">.</span><span class="token plain">holdings</span><span class="token punctuation" style="color:rgb(212, 212, 212)">(</span><span class="token plain">symbol</span><span class="token operator" style="color:rgb(212, 212, 212)">=</span><span class="token string" style="color:rgb(206, 145, 120)">'XLK'</span><span class="token punctuation" style="color:rgb(212, 212, 212)">,</span><span class="token plain"> date</span><span class="token operator" style="color:rgb(212, 212, 212)">=</span><span class="token number" style="color:rgb(181, 206, 168)">2022</span><span class="token operator" style="color:rgb(212, 212, 212)">-</span><span class="token number" style="color:rgb(181, 206, 168)">03</span><span class="token operator" style="color:rgb(212, 212, 212)">-</span><span class="token number" style="color:rgb(181, 206, 168)">31</span><span class="token punctuation" style="color:rgb(212, 212, 212)">,</span><span class="token plain"> provider</span><span class="token operator" style="color:rgb(212, 212, 212)">=</span><span class="token string" style="color:rgb(206, 145, 120)">'fmp'</span><span class="token punctuation" style="color:rgb(212, 212, 212)">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#9CDCFE"><span class="token plain"></span><span class="token comment" style="color:rgb(106, 153, 85)"># The same data can be returned from the SEC directly.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#9CDCFE"><span class="token plain">obb</span><span class="token punctuation" style="color:rgb(212, 212, 212)">.</span><span class="token plain">etf</span><span class="token punctuation" style="color:rgb(212, 212, 212)">.</span><span class="token plain">holdings</span><span class="token punctuation" style="color:rgb(212, 212, 212)">(</span><span class="token plain">symbol</span><span class="token operator" style="color:rgb(212, 212, 212)">=</span><span class="token string" style="color:rgb(206, 145, 120)">'XLK'</span><span class="token punctuation" style="color:rgb(212, 212, 212)">,</span><span class="token plain"> date</span><span class="token operator" style="color:rgb(212, 212, 212)">=</span><span class="token number" style="color:rgb(181, 206, 168)">2022</span><span class="token operator" style="color:rgb(212, 212, 212)">-</span><span class="token number" style="color:rgb(181, 206, 168)">03</span><span class="token operator" style="color:rgb(212, 212, 212)">-</span><span class="token number" style="color:rgb(181, 206, 168)">31</span><span class="token punctuation" style="color:rgb(212, 212, 212)">,</span><span class="token plain"> provider</span><span class="token operator" style="color:rgb(212, 212, 212)">=</span><span class="token string" style="color:rgb(206, 145, 120)">'sec'</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 viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" 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 viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" 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>
|
||
<div class="tabs-container tabList_TRJ7"><ul role="tablist" aria-orientation="horizontal" class="_group-tab list-none -ml-7 my-6 overflow-auto"><li role="tab" tabindex="0" aria-selected="true" class="font-bold tracking-widest w-fit px-3 inline-flex py-1 uppercase border-b text-lg cursor-pointer tabItem_hGfb border-b-2 pointer-events-none border-b-2 text-[#FB923C] border-[#FB923C]">standard</li><li role="tab" tabindex="-1" aria-selected="false" class="font-bold tracking-widest w-fit px-3 inline-flex py-1 uppercase border-b text-lg cursor-pointer tabItem_hGfb border-grey-400 text-grey-400 hover:text-[#ffd4b1] hover:border-[#ffd4b1]">fmp</li><li role="tab" tabindex="-1" aria-selected="false" class="font-bold tracking-widest w-fit px-3 inline-flex py-1 uppercase border-b text-lg cursor-pointer tabItem_hGfb border-grey-400 text-grey-400 hover:text-[#ffd4b1] hover:border-[#ffd4b1]">intrinio</li><li role="tab" tabindex="-1" aria-selected="false" class="font-bold tracking-widest w-fit px-3 inline-flex py-1 uppercase border-b text-lg cursor-pointer tabItem_hGfb border-grey-400 text-grey-400 hover:text-[#ffd4b1] hover:border-[#ffd4b1]">sec</li><li role="tab" tabindex="-1" aria-selected="false" class="font-bold tracking-widest w-fit px-3 inline-flex py-1 uppercase border-b text-lg cursor-pointer tabItem_hGfb border-grey-400 text-grey-400 hover:text-[#ffd4b1] hover:border-[#ffd4b1]">tmx</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default</th><th>Optional</th></tr></thead><tbody><tr><td>symbol</td><td>str</td><td>Symbol to get data for. (ETF)</td><td></td><td>False</td></tr><tr><td>provider</td><td>Literal['fmp', 'intrinio', 'sec', 'tmx']</td><td>The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, sec, tmx.</td><td>None</td><td>True</td></tr></tbody></table></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default</th><th>Optional</th></tr></thead><tbody><tr><td>symbol</td><td>str</td><td>Symbol to get data for. (ETF)</td><td></td><td>False</td></tr><tr><td>provider</td><td>Literal['fmp', 'intrinio', 'sec', 'tmx']</td><td>The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, sec, tmx.</td><td>None</td><td>True</td></tr><tr><td>date</td><td>Union[Union[str, date], str]</td><td>A specific date to get data for. Entering a date will attempt to return the NPORT-P filing for the entered date. This needs to be <em>exactly</em> the date of the filing. Use the holdings_date command/endpoint to find available filing dates for the ETF.</td><td>None</td><td>True</td></tr><tr><td>cik</td><td>str</td><td>The CIK of the filing entity. Overrides symbol.</td><td>None</td><td>True</td></tr></tbody></table></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default</th><th>Optional</th></tr></thead><tbody><tr><td>symbol</td><td>str</td><td>Symbol to get data for. (ETF)</td><td></td><td>False</td></tr><tr><td>provider</td><td>Literal['fmp', 'intrinio', 'sec', 'tmx']</td><td>The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, sec, tmx.</td><td>None</td><td>True</td></tr><tr><td>date</td><td>Union[date, str]</td><td>A specific date to get data for.</td><td>None</td><td>True</td></tr></tbody></table></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default</th><th>Optional</th></tr></thead><tbody><tr><td>symbol</td><td>str</td><td>Symbol to get data for. (ETF)</td><td></td><td>False</td></tr><tr><td>provider</td><td>Literal['fmp', 'intrinio', 'sec', 'tmx']</td><td>The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, sec, tmx.</td><td>None</td><td>True</td></tr><tr><td>date</td><td>Union[Union[str, date], str]</td><td>A specific date to get data for. The date represents the period ending. The date entered will return the closest filing.</td><td>None</td><td>True</td></tr><tr><td>use_cache</td><td>bool</td><td>Whether or not to use cache for the request.</td><td>True</td><td>True</td></tr></tbody></table></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default</th><th>Optional</th></tr></thead><tbody><tr><td>symbol</td><td>str</td><td>Symbol to get data for. (ETF)</td><td></td><td>False</td></tr><tr><td>provider</td><td>Literal['fmp', 'intrinio', 'sec', 'tmx']</td><td>The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, sec, tmx.</td><td>None</td><td>True</td></tr><tr><td>use_cache</td><td>bool</td><td>Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours.</td><td>True</td><td>True</td></tr></tbody></table></div></div></div>
|
||
<hr>
|
||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="returns">Returns<a href="#returns" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns"></a></h2>
|
||
<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">OBBject</span><br></span><span class="token-line" style="color:#9CDCFE"><span class="token plain"> results </span><span class="token punctuation" style="color:rgb(212, 212, 212)">:</span><span class="token plain"> List</span><span class="token punctuation" style="color:rgb(212, 212, 212)">[</span><span class="token plain">EtfHoldings</span><span class="token punctuation" style="color:rgb(212, 212, 212)">]</span><span class="token plain"></span><br></span><span class="token-line" style="color:#9CDCFE"><span class="token plain"> Serializable results</span><span class="token punctuation" style="color:rgb(212, 212, 212)">.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#9CDCFE"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#9CDCFE"><span class="token plain"> provider </span><span class="token punctuation" style="color:rgb(212, 212, 212)">:</span><span class="token plain"> Optional</span><span class="token punctuation" style="color:rgb(212, 212, 212)">[</span><span class="token plain">Literal</span><span class="token punctuation" style="color:rgb(212, 212, 212)">[</span><span class="token string" style="color:rgb(206, 145, 120)">'fmp'</span><span class="token punctuation" style="color:rgb(212, 212, 212)">,</span><span class="token plain"> </span><span class="token string" style="color:rgb(206, 145, 120)">'intrinio'</span><span class="token punctuation" style="color:rgb(212, 212, 212)">,</span><span class="token plain"> </span><span class="token string" style="color:rgb(206, 145, 120)">'sec'</span><span class="token punctuation" style="color:rgb(212, 212, 212)">,</span><span class="token plain"> </span><span class="token string" style="color:rgb(206, 145, 120)">'tmx'</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><br></span><span class="token-line" style="color:#9CDCFE"><span class="token plain"> Provider name</span><span class="token punctuation" style="color:rgb(212, 212, 212)">.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#9CDCFE"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#9CDCFE"><span class="token plain"> warnings </span><span class="token punctuation" style="color:rgb(212, 212, 212)">:</span><span class="token plain"> Optional</span><span class="token punctuation" style="color:rgb(212, 212, 212)">[</span><span class="token plain">List</span><span class="token punctuation" style="color:rgb(212, 212, 212)">[</span><span class="token plain">Warning_</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><br></span><span class="token-line" style="color:#9CDCFE"><span class="token plain"> List of warnings</span><span class="token punctuation" style="color:rgb(212, 212, 212)">.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#9CDCFE"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#9CDCFE"><span class="token plain"> chart </span><span class="token punctuation" style="color:rgb(212, 212, 212)">:</span><span class="token plain"> Optional</span><span class="token punctuation" style="color:rgb(212, 212, 212)">[</span><span class="token plain">Chart</span><span class="token punctuation" style="color:rgb(212, 212, 212)">]</span><span class="token plain"></span><br></span><span class="token-line" style="color:#9CDCFE"><span class="token plain"> Chart </span><span class="token builtin" style="color:rgb(86, 156, 214)">object</span><span class="token punctuation" style="color:rgb(212, 212, 212)">.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#9CDCFE"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#9CDCFE"><span class="token plain"> extra </span><span class="token punctuation" style="color:rgb(212, 212, 212)">:</span><span class="token plain"> Dict</span><span class="token punctuation" style="color:rgb(212, 212, 212)">[</span><span class="token builtin" style="color:rgb(86, 156, 214)">str</span><span class="token punctuation" style="color:rgb(212, 212, 212)">,</span><span class="token plain"> Any</span><span class="token punctuation" style="color:rgb(212, 212, 212)">]</span><span class="token plain"></span><br></span><span class="token-line" style="color:#9CDCFE"><span class="token plain"> Extra info</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 viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" 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 viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" 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="data">Data<a href="#data" class="hash-link" aria-label="Direct link to Data" title="Direct link to Data"></a></h2>
|
||
<div class="tabs-container tabList_TRJ7"><ul role="tablist" aria-orientation="horizontal" class="_group-tab list-none -ml-7 my-6 overflow-auto"><li role="tab" tabindex="0" aria-selected="true" class="font-bold tracking-widest w-fit px-3 inline-flex py-1 uppercase border-b text-lg cursor-pointer tabItem_hGfb border-b-2 pointer-events-none border-b-2 text-[#FB923C] border-[#FB923C]">standard</li><li role="tab" tabindex="-1" aria-selected="false" class="font-bold tracking-widest w-fit px-3 inline-flex py-1 uppercase border-b text-lg cursor-pointer tabItem_hGfb border-grey-400 text-grey-400 hover:text-[#ffd4b1] hover:border-[#ffd4b1]">fmp</li><li role="tab" tabindex="-1" aria-selected="false" class="font-bold tracking-widest w-fit px-3 inline-flex py-1 uppercase border-b text-lg cursor-pointer tabItem_hGfb border-grey-400 text-grey-400 hover:text-[#ffd4b1] hover:border-[#ffd4b1]">intrinio</li><li role="tab" tabindex="-1" aria-selected="false" class="font-bold tracking-widest w-fit px-3 inline-flex py-1 uppercase border-b text-lg cursor-pointer tabItem_hGfb border-grey-400 text-grey-400 hover:text-[#ffd4b1] hover:border-[#ffd4b1]">sec</li><li role="tab" tabindex="-1" aria-selected="false" class="font-bold tracking-widest w-fit px-3 inline-flex py-1 uppercase border-b text-lg cursor-pointer tabItem_hGfb border-grey-400 text-grey-400 hover:text-[#ffd4b1] hover:border-[#ffd4b1]">tmx</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>symbol</td><td>str</td><td>Symbol representing the entity requested in the data. (ETF)</td></tr><tr><td>name</td><td>str</td><td>Name of the ETF holding.</td></tr></tbody></table></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>symbol</td><td>str</td><td>Symbol representing the entity requested in the data. (ETF)</td></tr><tr><td>name</td><td>str</td><td>Name of the ETF holding.</td></tr><tr><td>lei</td><td>str</td><td>The LEI of the holding.</td></tr><tr><td>title</td><td>str</td><td>The title of the holding.</td></tr><tr><td>cusip</td><td>str</td><td>The CUSIP of the holding.</td></tr><tr><td>isin</td><td>str</td><td>The ISIN of the holding.</td></tr><tr><td>balance</td><td>int</td><td>The balance of the holding, in shares or units.</td></tr><tr><td>units</td><td>Union[float, str]</td><td>The type of units.</td></tr><tr><td>currency</td><td>str</td><td>The currency of the holding.</td></tr><tr><td>value</td><td>float</td><td>The value of the holding, in dollars.</td></tr><tr><td>weight</td><td>float</td><td>The weight of the holding, as a normalized percent.</td></tr><tr><td>payoff_profile</td><td>str</td><td>The payoff profile of the holding.</td></tr><tr><td>asset_category</td><td>str</td><td>The asset category of the holding.</td></tr><tr><td>issuer_category</td><td>str</td><td>The issuer category of the holding.</td></tr><tr><td>country</td><td>str</td><td>The country of the holding.</td></tr><tr><td>is_restricted</td><td>str</td><td>Whether the holding is restricted.</td></tr><tr><td>fair_value_level</td><td>int</td><td>The fair value level of the holding.</td></tr><tr><td>is_cash_collateral</td><td>str</td><td>Whether the holding is cash collateral.</td></tr><tr><td>is_non_cash_collateral</td><td>str</td><td>Whether the holding is non-cash collateral.</td></tr><tr><td>is_loan_by_fund</td><td>str</td><td>Whether the holding is loan by fund.</td></tr><tr><td>cik</td><td>str</td><td>The CIK of the filing.</td></tr><tr><td>acceptance_datetime</td><td>str</td><td>The acceptance datetime of the filing.</td></tr><tr><td>updated</td><td>Union[date, datetime]</td><td>The date the data was updated.</td></tr></tbody></table></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>symbol</td><td>str</td><td>Symbol representing the entity requested in the data. (ETF)</td></tr><tr><td>name</td><td>str</td><td>The common name for the holding.</td></tr><tr><td>security_type</td><td>str</td><td>The type of instrument for this holding. Examples(Bond='BOND', Equity='EQUI')</td></tr><tr><td>isin</td><td>str</td><td>The International Securities Identification Number.</td></tr><tr><td>ric</td><td>str</td><td>The Reuters Instrument Code.</td></tr><tr><td>sedol</td><td>str</td><td>The Stock Exchange Daily Official List.</td></tr><tr><td>share_class_figi</td><td>str</td><td>The OpenFIGI symbol for the holding.</td></tr><tr><td>country</td><td>str</td><td>The country or region of the holding.</td></tr><tr><td>maturity_date</td><td>date</td><td>The maturity date for the debt security, if available.</td></tr><tr><td>contract_expiry_date</td><td>date</td><td>Expiry date for the futures contract held, if available.</td></tr><tr><td>coupon</td><td>float</td><td>The coupon rate of the debt security, if available.</td></tr><tr><td>balance</td><td>Union[float, int]</td><td>The number of units of the security held, if available.</td></tr><tr><td>unit</td><td>str</td><td>The units of the 'balance' field.</td></tr><tr><td>units_per_share</td><td>float</td><td>Number of units of the security held per share outstanding of the ETF, if available.</td></tr><tr><td>face_value</td><td>float</td><td>The face value of the debt security, if available.</td></tr><tr><td>derivatives_value</td><td>float</td><td>The notional value of derivatives contracts held.</td></tr><tr><td>value</td><td>float</td><td>The market value of the holding, on the 'as_of' date.</td></tr><tr><td>weight</td><td>float</td><td>The weight of the holding, as a normalized percent.</td></tr><tr><td>updated</td><td>date</td><td>The 'as_of' date for the holding.</td></tr></tbody></table></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>symbol</td><td>str</td><td>Symbol representing the entity requested in the data. (ETF)</td></tr><tr><td>name</td><td>str</td><td>Name of the ETF holding.</td></tr><tr><td>lei</td><td>str</td><td>The LEI of the holding.</td></tr><tr><td>cusip</td><td>str</td><td>The CUSIP of the holding.</td></tr><tr><td>isin</td><td>str</td><td>The ISIN of the holding.</td></tr><tr><td>other_id</td><td>str</td><td>Internal identifier for the holding.</td></tr><tr><td>balance</td><td>float</td><td>The balance of the holding.</td></tr><tr><td>weight</td><td>float</td><td>The weight of the holding in ETF in %.</td></tr><tr><td>value</td><td>float</td><td>The value of the holding in USD.</td></tr><tr><td>payoff_profile</td><td>str</td><td>The payoff profile of the holding.</td></tr><tr><td>units</td><td>Union[str, float]</td><td>The units of the holding.</td></tr><tr><td>currency</td><td>str</td><td>The currency of the holding.</td></tr><tr><td>asset_category</td><td>str</td><td>The asset category of the holding.</td></tr><tr><td>issuer_category</td><td>str</td><td>The issuer category of the holding.</td></tr><tr><td>country</td><td>str</td><td>The country of the holding.</td></tr><tr><td>is_restricted</td><td>str</td><td>Whether the holding is restricted.</td></tr><tr><td>fair_value_level</td><td>int</td><td>The fair value level of the holding.</td></tr><tr><td>is_cash_collateral</td><td>str</td><td>Whether the holding is cash collateral.</td></tr><tr><td>is_non_cash_collateral</td><td>str</td><td>Whether the holding is non-cash collateral.</td></tr><tr><td>is_loan_by_fund</td><td>str</td><td>Whether the holding is loan by fund.</td></tr><tr><td>loan_value</td><td>float</td><td>The loan value of the holding.</td></tr><tr><td>issuer_conditional</td><td>str</td><td>The issuer conditions of the holding.</td></tr><tr><td>asset_conditional</td><td>str</td><td>The asset conditions of the holding.</td></tr><tr><td>maturity_date</td><td>date</td><td>The maturity date of the debt security.</td></tr><tr><td>coupon_kind</td><td>str</td><td>The type of coupon for the debt security.</td></tr><tr><td>rate_type</td><td>str</td><td>The type of rate for the debt security, floating or fixed.</td></tr><tr><td>annualized_return</td><td>float</td><td>The annualized return on the debt security.</td></tr><tr><td>is_default</td><td>str</td><td>If the debt security is defaulted.</td></tr><tr><td>in_arrears</td><td>str</td><td>If the debt security is in arrears.</td></tr><tr><td>is_paid_kind</td><td>str</td><td>If the debt security payments are paid in kind.</td></tr><tr><td>derivative_category</td><td>str</td><td>The derivative category of the holding.</td></tr><tr><td>counterparty</td><td>str</td><td>The counterparty of the derivative.</td></tr><tr><td>underlying_name</td><td>str</td><td>The name of the underlying asset associated with the derivative.</td></tr><tr><td>option_type</td><td>str</td><td>The type of option.</td></tr><tr><td>derivative_payoff</td><td>str</td><td>The payoff profile of the derivative.</td></tr><tr><td>expiry_date</td><td>date</td><td>The expiry or termination date of the derivative.</td></tr><tr><td>exercise_price</td><td>float</td><td>The exercise price of the option.</td></tr><tr><td>exercise_currency</td><td>str</td><td>The currency of the option exercise price.</td></tr><tr><td>shares_per_contract</td><td>float</td><td>The number of shares per contract.</td></tr><tr><td>delta</td><td>Union[str, float]</td><td>The delta of the option.</td></tr><tr><td>rate_type_rec</td><td>str</td><td>The type of rate for receivable portion of the swap.</td></tr><tr><td>receive_currency</td><td>str</td><td>The receive currency of the swap.</td></tr><tr><td>upfront_receive</td><td>float</td><td>The upfront amount received of the swap.</td></tr><tr><td>floating_rate_index_rec</td><td>str</td><td>The floating rate index for receivable portion of the swap.</td></tr><tr><td>floating_rate_spread_rec</td><td>float</td><td>The floating rate spread for reveivable portion of the swap.</td></tr><tr><td>rate_tenor_rec</td><td>str</td><td>The rate tenor for receivable portion of the swap.</td></tr><tr><td>rate_tenor_unit_rec</td><td>Union[str, int]</td><td>The rate tenor unit for receivable portion of the swap.</td></tr><tr><td>reset_date_rec</td><td>str</td><td>The reset date for receivable portion of the swap.</td></tr><tr><td>reset_date_unit_rec</td><td>Union[str, int]</td><td>The reset date unit for receivable portion of the swap.</td></tr><tr><td>rate_type_pmnt</td><td>str</td><td>The type of rate for payment portion of the swap.</td></tr><tr><td>payment_currency</td><td>str</td><td>The payment currency of the swap.</td></tr><tr><td>upfront_payment</td><td>float</td><td>The upfront amount received of the swap.</td></tr><tr><td>floating_rate_index_pmnt</td><td>str</td><td>The floating rate index for payment portion of the swap.</td></tr><tr><td>floating_rate_spread_pmnt</td><td>float</td><td>The floating rate spread for payment portion of the swap.</td></tr><tr><td>rate_tenor_pmnt</td><td>str</td><td>The rate tenor for payment portion of the swap.</td></tr><tr><td>rate_tenor_unit_pmnt</td><td>Union[str, int]</td><td>The rate tenor unit for payment portion of the swap.</td></tr><tr><td>reset_date_pmnt</td><td>str</td><td>The reset date for payment portion of the swap.</td></tr><tr><td>reset_date_unit_pmnt</td><td>Union[str, int]</td><td>The reset date unit for payment portion of the swap.</td></tr><tr><td>repo_type</td><td>str</td><td>The type of repo.</td></tr><tr><td>is_cleared</td><td>str</td><td>If the repo is cleared.</td></tr><tr><td>is_tri_party</td><td>str</td><td>If the repo is tri party.</td></tr><tr><td>principal_amount</td><td>float</td><td>The principal amount of the repo.</td></tr><tr><td>principal_currency</td><td>str</td><td>The currency of the principal amount.</td></tr><tr><td>collateral_type</td><td>str</td><td>The collateral type of the repo.</td></tr><tr><td>collateral_amount</td><td>float</td><td>The collateral amount of the repo.</td></tr><tr><td>collateral_currency</td><td>str</td><td>The currency of the collateral amount.</td></tr><tr><td>exchange_currency</td><td>str</td><td>The currency of the exchange rate.</td></tr><tr><td>exchange_rate</td><td>float</td><td>The exchange rate.</td></tr><tr><td>currency_sold</td><td>str</td><td>The currency sold in a Forward Derivative.</td></tr><tr><td>currency_amount_sold</td><td>float</td><td>The amount of currency sold in a Forward Derivative.</td></tr><tr><td>currency_bought</td><td>str</td><td>The currency bought in a Forward Derivative.</td></tr><tr><td>currency_amount_bought</td><td>float</td><td>The amount of currency bought in a Forward Derivative.</td></tr><tr><td>notional_amount</td><td>float</td><td>The notional amount of the derivative.</td></tr><tr><td>notional_currency</td><td>str</td><td>The currency of the derivative's notional amount.</td></tr><tr><td>unrealized_gain</td><td>float</td><td>The unrealized gain or loss on the derivative.</td></tr></tbody></table></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>symbol</td><td>str</td><td>The ticker symbol of the asset.</td></tr><tr><td>name</td><td>str</td><td>The name of the asset.</td></tr><tr><td>weight</td><td>float</td><td>The weight of the asset in the portfolio, as a normalized percentage.</td></tr><tr><td>shares</td><td>Union[str, int]</td><td>The value of the assets under management.</td></tr><tr><td>market_value</td><td>Union[str, float]</td><td>The market value of the holding.</td></tr><tr><td>currency</td><td>str</td><td>The currency of the holding.</td></tr><tr><td>share_percentage</td><td>float</td><td>The share percentage of the holding, as a normalized percentage.</td></tr><tr><td>share_change</td><td>Union[str, float]</td><td>The change in shares of the holding.</td></tr><tr><td>country</td><td>str</td><td>The country of the holding.</td></tr><tr><td>exchange</td><td>str</td><td>The exchange code of the holding.</td></tr><tr><td>type_id</td><td>str</td><td>The holding type ID of the asset.</td></tr><tr><td>fund_id</td><td>str</td><td>The fund ID of the asset.</td></tr></tbody></table></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/platform/reference/etf/historical"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">historical</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/platform/reference/etf/holdings_date"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">holdings_date</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="#examples" class="text-grey-400 capitalize !no-underline">Examples</a></li><li class="py-1"><a href="#parameters" class="text-grey-400 capitalize !no-underline">Parameters</a></li><li class="py-1"><a href="#returns" class="text-grey-400 capitalize !no-underline">Returns</a></li><li class="py-1"><a href="#data" class="text-grey-400 capitalize !no-underline">Data</a></li></ul></div></div></div></div></main></div></div></div><footer class="px-4 border-t dark:border-grey-600/50 lg:px-12 py-14 bg-white dark:bg-grey-850 z-10 overflow-hidden flex flex-col gap-10 items-center justify-center"><div class="flex w-full justify-between md:flex-row"><div class="md:items-start mt-2"><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></div><div class="justify-end"><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-850 text-grey-200">0</span></a></div></div><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">© 2024 OpenBB</p><div class="_divider-x hidden h-[20px] border-[0.5px] md:block"></div><a href="https://openbb.co/legal/privacy-policy" target="_blank" rel="noopener noreferrer" class="text-sm dark:hover:text-white">Privacy Policy</a><div class="_divider-x hidden h-[20px] border-[0.5px] md:block"></div><a href="https://openbb.co/legal/terms-of-service" target="_blank" rel="noopener noreferrer" class="text-sm dark:hover:text-white">Terms</a></div><div class="mt-4 mb-10 grid grid-cols-4 gap-4 self-start md:my-0 md:grid-cols-7 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 24 24" width="10" height="10" xmlns="http://www.w3.org/2000/svg" class="h-4 w-4"><path d="M18.244 2.25h3.308l-7.227 8.26 8.502 11.24H16.17l-5.214-6.817L4.99 21.75H1.68l7.73-8.835L1.254 2.25H8.08l4.713 6.231zm-1.161 17.52h1.833L7.084 4.126H5.117z" fill="#E7E9EA"></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>
|
||
</body>
|
||
</html> |