--- title: "What exists" method: GET path: "/index.json" --- # What exists `GET /index.json` ## Request - Base URL: `https://tickerinside.com/api/v1` - URL: `https://tickerinside.com/api/v1/index.json` - Auth: none required What exists, and the date of the data. Start here if you are pulling the whole set. ## Response `200` The file. The example is a real answer, shortened: long lists and maps keep their first entries. - Index - `as_of` string, nullable, required: The price date across the whole site. - `coverage` object, required: The coverage counts. funds: the issuer-layer funds. securities_held: the distinct securities they hold. what: the universe in words. sec_nport: the SEC-layer funds, with the oldest and newest quarter end their filings describe in sec_nport_periods, and how old their holdings are on the day of the build in sec_nport_age (the 10th to the 90th percentile in whole months, low_months to high_months, and in words, text); sec_nport_bonds, sec_nport_multi_asset, sec_nport_derivatives, trust_filings, sponsor_files and prospectus, the other layers. Then the figures every page prints: funds_total, every layer, the US ETFs covered; universe, the coverage measured against the US-listed ETFs (see universe.json); stocks_with_file, the stocks with a file under /sec/, and stocks_with_weekly_series, those whose file carries the weekly series, at least 110 of the 156 weekly returns; pages, the funds and stocks with a page; issuers, the issuers whose files are read, largest first. - `funds` integer, nullable - `securities_held` integer, nullable - `what` string, nullable - `sec_nport` integer, nullable - `sec_nport_periods` object - `oldest` string, nullable - `newest` string, nullable - `sec_nport_age` object - `low_months` number, nullable - `high_months` number, nullable - `text` string, nullable - `sec_nport_bonds` number, nullable - `sec_nport_multi_asset` number, nullable - `sec_nport_derivatives` number, nullable - `trust_filings` number, nullable - `sponsor_files` number, nullable - `prospectus` number, nullable - `funds_total` integer, nullable - `universe` object - `etfs` number, nullable - `covered` number, nullable - `pct` number, nullable - `by_layer` object - `issuer_files` number, nullable - `sec_nport` number, nullable - `sec_nport_derivatives` number, nullable - `sec_nport_bonds` number, nullable - `sec_nport_multi_asset` number, nullable - `trust_filings` number, nullable - `sponsor_files` number, nullable - `prospectus` number, nullable - `with_file` number, nullable - `with_objective` number, nullable - `not_covered` object - `no_prospectus_found` number, nullable - `no_filing_yet` number, nullable - `not_in_sec_list` number, nullable - `other_fund` number, nullable - `stale_filing` number, nullable - `etns` number, nullable - `other_products` number, nullable - `outside_universe` number, nullable - `file_date` string, nullable - `available` boolean, nullable - `source` string, nullable - `sentence` string, nullable - `all_us_etfs` boolean, nullable - `headline` string, nullable - `claim` string, nullable - `assets` object - `net_assets_b` number, nullable - `with_holdings_b` number, nullable - `pct` number, nullable - `funds_sized` number, nullable - `funds_unsized` number, nullable - `unsized_with_holdings` number, nullable - `basis` string, nullable - `sentence` string, nullable - `stocks_with_file` integer, nullable - `stocks_with_weekly_series` integer, nullable - `pages` object - `funds` integer, nullable - `stocks` integer, nullable - `issuers` string[], nullable - `endpoints` object, required: The endpoints as URL templates, so a client can find them without reading the reference. fund answers for every fund; etf is the file of a fund listed under tickers_derivative, tickers_trust, tickers_bond, tickers_multi_asset, tickers_sponsor or tickers_prospectus. holders_shard is the template of the holders shards, {c} being the key's first character in lower case, a to z, or 0 for any other. It also gives the OpenAPI description (openapi), the reference in Markdown (docs_markdown), the nightly report (status) and the live checks (uptime). - `funds` string, nullable - `fund` string, nullable - `etf` string, nullable - `security` string, nullable - `holders` string, nullable - `holders_shard` string, nullable - `securities` string, nullable - `identifiers` string, nullable - `universe` string, nullable - `compare` string, nullable - `overlap` string, nullable - `lookthrough` string, nullable - `batch` string, nullable - `screen` string, nullable - `diversify` string, nullable - `ownership` string, nullable - `methods` string, nullable - `history` string, nullable - `fund_history` string, nullable - `status` string, nullable - `uptime` string, nullable - `manifest` string, nullable - `changelog` string, nullable - `deprecations` string, nullable - `corrections` string, nullable - `openapi` string, nullable - `docs_markdown` string, nullable - `tickers` string[], nullable, required: Every issuer-layer fund, as a sorted list: the funds read from their issuers' own files. This is the universe the census of pairs and the file ages count over; a stock page counts these funds and the funds of tickers_sec. - `tickers_sec` string[], nullable, required: Every SEC-layer fund, as a sorted list: the other US stock ETFs, served from their latest SEC Form N-PORT filing. Each has a fund file like the funds above, dated to the quarter end its filing describes, and a page only in a published cohort. - `tickers_derivative` string[], nullable, required: Every derivative-based fund, sorted. Its file is under /etf/. - `tickers_trust` string[], nullable, required: Every trust and commodity pool that files no Form N-PORT, sorted. Its file is under /etf/. - `tickers_bond` string[], nullable, required: Every fixed income fund, sorted. Its file is under /etf/. - `tickers_multi_asset` string[], nullable, required: Every multi-asset fund, sorted. Its file is under /etf/. - `tickers_sponsor` string[], nullable, required: Every sponsor-file fund, sorted. - `tickers_prospectus` string[], nullable, required: Every prospectus-file fund, sorted. - `written_comparisons` object[], nullable, required: The written comparisons: the pairs with a page written by hand, each with the URL of its JSON. A pair's file exists only in the order listed here. Any two tickers above can still be compared from their two fund files. - `pair` string[], nullable - `url` string, nullable - `without_file` object: The directory's tickers with no file, by the reason a fund address's 404 gives. - `docs` string, nullable, required: The reference for these endpoints. - `license` string, nullable, required: The licence the data is published under. - `attribution` string, nullable, required: How to credit the data: a link to this file where the medium allows one, the name where it does not. - `terms` string, nullable, required: The legal notice: who publishes, the licence of the current snapshots served here, and the separate terms of the historical archive. ## Other responses - `304`: Not modified: the ETag of your copy, sent in If-None-Match, is still current. Files are cached five minutes. - `503`: The file could not be served just then: retry after a minute. uptime says whether the site fails its own checks. --- [API](https://skmtc.dev/tickerinside/apis/tickerinside-api.md) · [All operations](https://skmtc.dev/tickerinside/apis/tickerinside-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tickerinside/apis/tickerinside-api/revisions/66a3e0d66a02?raw)