Coverage and ETF search
list_etfsUse this when the user asks whether a US ETF is covered, wants to find an ETF by name or ticker, or asks how many ETFs the data covers and how recent it is. Returns the date of the data and the count of covered ETFs by source: the issuers' own holdings files, SEC Form N-PORT filings, trusts' filings, sponsors' files and prospectuses, and how many of the US-listed ETFs that is. With query, it returns up to 50 matching ETFs with their names, sources and categories; without query, it also lists every covered ticker by source unless include_tickers is false, a long answer. Mutual funds, closed-end funds and funds listed outside the US are not covered. Not for an ETF's holdings or figures (get_etf_holdings).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | A ticker or words from an ETF's name, for example VOO or semiconductor. Case does not matter. | |
| source | No | Only the ETFs read from the issuers' own files, only the stock ETFs from SEC filings, only the fixed income ETFs, only the multi-asset ETFs, only the derivative-based ETFs, only the trusts and pools, only the ETFs from their sponsors' files, or only the ETFs with only a prospectus file. | |
| include_tickers | No | Whether an answer without query lists every covered ticker, by source, and only those of source when it is given. true or left out adds the lists, a long answer; false returns the counts and dates alone. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| as_of | No | ||
| source | Yes | ||
| issuers | Yes | ||
| matches | No | ||
| match_count | No | ||
| funds_covered | Yes | ||
| us_listed_etfs | No | ||
| funds_by_source | Yes |