One fund

The holdings with their weights and the date of their source, then cost, returns, risk and weekly returns over 156 weeks where the data has them. A figure the data lacks is null, and so is a week without a return; with fewer than 110 weekly returns, weekly is an empty list, or null for a fund from SEC filings. This is the endpoint most things are built from. The funds no issuer file covers are served in the same shape from their latest SEC filing, with eight more fields: report_date, filed, filing_url, net_assets, multi_class, stock_pct, unmapped_pct and abroad. A fund of the other layers answers too, from its /etf/ file. The holdings map and the weekly series make this file enough on its own. The overlap of any two stock ETFs is a walk over two holdings maps, and a covariance matrix for any basket is a walk over their weekly series.

get/fund/{ticker}.json

Request

  • Base URL: https://tickerinside.com/api/v1
  • URL: https://tickerinside.com/api/v1/fund/{ticker}.json
  • Auth: none required

Path parameters

tickerstring required

The ticker in lower case, for example voo. An upper case ticker is answered with a 301 to the lower case path.

Response

The file. The example is a real answer, shortened: long lists and maps keep their first entries.

tickerstring nullable required

The fund's ticker, upper case.

namestring nullable required

The fund's name.

page_urlstring nullable required

The fund's page on the site, or null when it has none yet. Link it when you quote a figure.

cite_asstring nullable required

A citation line for a quoted figure: the fund, its source file and that file's date, a URL to check it, and the licence.

cite_htmlstring nullable required

The credit as HTML: a link to the page cite_as names, then its address.

source_layer'issuer' | 'sec_nport' | 'sec_nport_derivatives' | 'sec_nport_bonds' | 'sec_nport_multi_asset' | 'trust_filings' | 'sponsor_files' | 'prospectus' nullable required

Where the holdings come from. issuer: the issuer's own file (the issuer layer). sec_nport: the fund's latest public SEC Form N-PORT filing (the SEC layer), whose holdings are the portfolio at the quarter end it describes (report_date), not on the day you read them; index.json coverage.sec_nport_age says how old the layer's holdings are on the day of the build. sec_nport_derivatives: a derivative-based fund, with its contracts apart from its holdings. sec_nport_bonds: a fixed income fund. sec_nport_multi_asset: a fund of funds or of several asset classes. trust_filings: a trust or commodity pool that files no Form N-PORT, from its own SEC filing. sponsor_files, prospectus: see /api/#sponsor-files.

as_ofstring nullable required

The price date: the date of the price data behind every return and risk figure here. Null for an SEC-layer fund whose weekly is null.

holdings_as_ofstring nullable required

The date of the holdings: the date of the issuer's file, or for an SEC-layer fund the quarter end its filing describes. It is often weeks older than as_of, and often differs from the other fund's in a comparison, so quote it with any holdings figure. It can also be later than as_of, since some issuers date their file with the next business day.

expense_rationumber nullable required

Annual cost as a percentage of assets: 0.03 means three basis points, or $3 a year on $10,000. From the fund's newest SEC filing that states it, after any fee waiver when the filing gives both figures, else from the market data. Null when neither gives one. Never read a null as zero.

expense_ratio_grossnumber nullable required

The total of the filing's fee table before any waiver, in percent, which counts the fees of the funds it holds; expense_ratio when there is no waiver. Null unless expense_ratio is from a filing.

expense_ratio_source'sec_filing' | 'sec_filing_text' | 'market_data' | 'null' nullable required

Where expense_ratio comes from. sec_filing: the fee table the filing tags by share class, from the SEC's risk/return data sets or the filing itself. sec_filing_text: the fee table's text, read in a newer prospectus, where no other figure exists or one agrees with it. market_data: undated, also where the filing read is over a year old and differs, or is not matched to the fund. Null when expense_ratio is null.

expense_ratio_as_ofstring nullable required

The day that filing reached the SEC, or null.

expense_ratio_filing_urlstring nullable required

That filing on EDGAR, or null.

yieldnumber nullable required

Trailing twelve month distribution yield, as a percentage.

aum_bnumber nullable required

Assets under management, in billions of US dollars, rounded to 0.1, from the market data, read on aum_date. For a Vanguard fund it is the whole fund, every share class together; etf_class_net_assets_b is the ETF's own class. Null when the market data gives no size, the usual case for an SEC-layer fund, whose size is then net_assets on report_date.

aum_source'market_data' | 'market_data_kept' | 'null' nullable required

Where aum_b comes from. market_data: read on aum_date. market_data_kept: the latest read gave no size, so the last size known is kept, with the day it was read, for 30 days at most. Null when aum_b is null.

aum_datestring nullable required

The day aum_b was read from the market data. Null when aum_b is null, or for a size read before the day was recorded.

etf_class_net_assets_bunknown required
etf_class_net_assets_as_ofunknown required
positionsinteger nullable required

How many positions the holdings map lists; filing_lines or file_lines count every line of a fund of another layer.

volnumber nullable required

Annualised standard deviation of weekly total returns over three years, as a percentage.

betanumber nullable required

Sensitivity to the S&P 500, from three years of weekly returns. 1.00 means it has moved with the index.

mdd3number nullable required

Largest peak to trough decline over three years, measured on weekly closes. Negative.

r1number nullable required

Cumulative total return over one year, as a percentage. Not annualised.

r3number nullable required

Cumulative total return over three years, as a percentage. Not annualised.

r5number nullable required

Cumulative total return over five years, as a percentage. Not annualised.

last_closenumber nullable required

The last closing price, raw, in the fund's trading currency. Returns use dividend-adjusted closes; this figure is the market close as traded.

last_close_datestring nullable required

The date of that close.

day_change_pctnumber nullable required

The move from the previous close to the last, as a percentage.

high_52wnumber nullable required

The highest raw close over the last 252 trading days.

low_52wnumber nullable required

The lowest raw close over the last 252 trading days.

currencystring nullable required

The trading currency of the price fields.

holdingsobject nullable required

The positions, as a map of key to percentage weight. For the issuer layer, the positions as the issuer publishes them. For an SEC-layer fund, every position the filing lets us key to a ticker; the rest is counted in unmapped_pct. A key is the ticker of a US line (a share class keeps its dot, BRK.B), or a local code and its market for a line listed abroad (7203.JP). Preferred shares filed under their issuer's common ticker are keyed as that ticker and .PFD (JPM.PFD), apart from the common stock. A key of digits and a letter is a code the issuer's file gives in place of a ticker, usually for a line whose ticker changed or was delisted. The overlap between two stock funds is computed from this field. For a fund of another layer, tickers, then other lines in lower case: a bond as issuer, coupon and maturity, else its name; never an identifier or a contract.

weeklynumber[] nullable required

156 weekly total returns as decimals, oldest first, ending at as_of. The weeks are the same in every fund and stock file, so any basket of them can be correlated without matching dates. A week is null when its return cannot be computed, because the fund's prices begin later or a weekly close is missing. An empty list for an issuer-layer fund with fewer than 110 weekly returns in those weeks, and null for a fund of another layer with fewer.

weeks_endstring nullable required

The date the weekly series ends, always as_of. It is set even when weekly is an empty list, and null, like as_of, when weekly is null.

licensestring nullable required

The licence the data is published under.

attributionstring nullable required

How to credit the data: a link to the page cite_as names where the medium allows one, the name where it does not.

sourcestring nullable required

Where the method behind these figures is written down.

report_datestring nullable

The quarter end the filing describes, the end of one of the fund's fiscal quarters. The holdings are the portfolio on that day, not on the day you read them; index.json coverage.sec_nport_age says how old the layer's holdings are on the day of the build. Quote this date with any figure from these holdings.

filedstring nullable

The day the filing reached the SEC, usually about 60 days after report_date.

filing_urlstring nullable

The filing itself on SEC EDGAR, to check any figure against the source.

net_assetsinteger nullable

The fund's net assets on report_date, in US dollars, as filed. For an ETF that is one share class of a larger fund, it covers every class.

multi_classboolean nullable

True when the ETF is one share class of a fund that also has mutual fund classes. The holdings and weights are then the whole fund's, which is the same portfolio, and so is net_assets.

stock_pctnumber nullable

How much of net assets the filing lists as common or preferred stock, long positions only. Cash, bonds, derivatives and collateral make up the rest and are not in holdings.

unmapped_pctnumber nullable

The part of stock_pct that could not be tied to a ticker and is left out of holdings, usually private companies, warrants and thinly traded foreign lines. The holdings add up to stock_pct minus this.

abroadunknown
holdings_kind'stock' | 'bond' | 'derivative' | 'commodity' | 'multi-asset' | 'prospectus' nullable

What the map of a fund of another layer holds: bond, multi-asset, stock, derivative (stocks held outright, never contracts), commodity (a trust's asset) or prospectus (none yet).

listed_pctnumber nullable

The share of net assets the map shows, in percent. Not listed is not the same as not held.

etf_filestring nullable

The /etf/ file this answer is built from, whose fields follow.

Changes

No recorded changes to this operation across all 1 revision of this API.