A written comparison

One of the 15 written comparisons, the pairs listed in index.json written_comparisons: overlap measured three ways, correlation over one, three and five years, and a summary of each fund. The file is written in the order listed there (voo-vs-vti); the other order answers 301 to it. Any other pair answers 404, reason no_written_comparison, with the two fund files. From them, compute the overlap by weight: the sum, over the tickers both hold, of the smaller of the two weights, as the overlap example does.

get/compare/{a}-vs-{b}.json

Request

  • Base URL: https://tickerinside.com/api/v1
  • URL: https://tickerinside.com/api/v1/compare/{a}-vs-{b}.json
  • Auth: none required

Path parameters

astring required

The first fund of a written comparison, lower case, in the order of index.json written_comparisons.

bstring required

The second fund, lower case.

Response

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

pairstring[] nullable required

The two tickers, in the order of the file's address and of index.json written_comparisons: this file is /compare/{a}-vs-{b}.json with a first. The other order answers 301 to this file.

as_ofstring nullable required

The price date.

holdings_as_ofobject nullable required

The date of each fund's holdings file, keyed by ticker. The two are often weeks apart.

fundsobject required

A summary of each fund, keyed by ticker, as the comparison page shows it; its fields are described below. The full file of each fund, with its holdings, is /api/v1/fund/{ticker}.json.

page_urlstring nullable required

The written comparison's page, to link when you quote a figure.

cite_asstring nullable required

A citation line for a quoted figure: the pair, both holdings file dates, the page, and the licence.

cite_htmlstring nullable required

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

sourcestring nullable required

The written comparison's page, which this data belongs to.

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.

Changes

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