Look-through of a portfolio, computed

The companies under a portfolio, as the MCP tool get_etf_portfolio_lookthrough gives them. 1 to 6 funds, whose files weigh at most 30 KB, a file of the other layers a third of its size, and hold at most 1,100 lines between them. The portfolios whose x-ray the site writes, listed under pages in /og/answers.json, answer past these limits, in any order of their funds, with the weights written as listed there, top up to 25 and currency as given.

get/lookthrough

Request

  • Base URL: https://tickerinside.com/api/v1
  • URL: https://tickerinside.com/api/v1/lookthrough
  • Auth: none required

Query parameters

portfoliostring required

Funds separated by commas, each with its weight or amount after a colon, or none for equal weights; a weight for every fund or for none.

topinteger

How many companies, 1 to 200; 25 by default.

currencystring

The currency of the amounts, three letters, echoed and never converted.

format'json' | 'csv'

json, the default, or csv for the CSV twin, which the path with .csv also gives.

Response

The answer, computed when asked and kept in the edge cache for up to a day. The example is a real answer, shortened.

page_urlstring nullable

The web page whose HTML, as the server sends it, prints the answer's figure, so that it reads without JavaScript: for a pair, its written comparison when there is one, else its "Does it diversify me?" answer within that answer's limits; for three funds or more, the x-ray the site wrote of the same funds; for a look-through, the x-ray the site wrote of the portfolio at the same weights (listed under pages in /og/answers.json), or for one fund, its page. Null where no page prints the figure yet: any other overlap of three funds or more or look-through of two funds or more, a pair past those limits, a pair of bond funds.

share_urlstring

The address whose HTML reproduces the whole answer on the site: for a pair, its "Does it diversify me?" answer within that answer's limits; for three funds or more and for a portfolio, the x-ray the site wrote of the same funds (listed under pages in /og/answers.json), each weight in percent to 0.01 point and never an amount, in the order of the funds the site wrote it in. Absent where no page prints the answer.

pricedboolean

true when the portfolio gives each fund a weight or an amount; false when every fund counts equally.

portfolio_valuenumber nullable

The sum of the weights or amounts of the funds looked through: the funds under not_looked_through and skipped are left out of it, as they are left out of the percentages. Null when none is given.

currencystring nullable

The currency given, upper case, echoed and never converted; unstated when amounts are given without one. Null when none is given.

prices_as_ofstring nullable

The price date of the figures read from weekly returns. Null when no fund has prices.

fundsinteger nullable

How many funds are looked through.

distinct_companiesinteger nullable

How many distinct holdings they hold between them, counted by ticker: two share classes of one company (GOOGL and GOOG) count as two.

top_10_weight_pctnumber nullable

The weight of the ten largest companies, in percent of what is looked through, summed unrounded and rounded once.

looked_through_pctnumber nullable

The part of the portfolio its covered funds make up that the funds looked through are, in percent, by amount or in equal parts: weight_pct and top_10_weight_pct are of that part, and not_looked_through names the rest.

holdings_as_ofobject

Each fund's holdings date, by ticker: the date of its issuer file, or the quarter end its SEC filing describes.

holdings_sourceobject

Each fund's source, by ticker: issuer file, SEC Form N-PORT, trust's own SEC filing, sponsor's own holdings file, or prospectus, no holdings yet.

same_ticker_two_companiesobject

The tickers listed twice: once for the US company of that ticker, once, marked listed_abroad, for the foreign company whose local code it is in another fund, with a note. Absent when there is none.

coveredboolean

true when the funds are covered but the answer has no figures (see comparable or computed).

computedboolean

false when none of the funds holds shares that can be looked through (see reason).

reasonstring

Why nothing is computed, when computed is false.

renamedobject

Each ticker asked that a fund had before it was renamed, with its ticker now, under which the answer reads and names it. Absent when there is none.

notestring required

Measurement, not investment advice.

licensestring required

The licence the data is published under.

attributionstring required

How to credit the data: a link to the page of a fund the figure comes from, or to this address, where the medium allows one, the name where it does not.

docsstring required

The reference of this endpoint.

Changes

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