Index constituents
Members of one index snapshot with each member's weight, as a ratio, and member_since, the date it last joined the index. Weights are given for the S&P 500, 400 and 600 and the Dow and are null for the Nasdaq-100, the Russell indices and most indices outside the US; member_since is given for most S&P 500 and S&P 400 members and is otherwise null. A snapshot is taken from the connected source's current membership and weights Tuesday to Saturday mornings (New York time) for the major US indices and weekly for the others, and the newest 20 snapshots of each index are kept, so effective_date reaches back about four weeks for the US indices and about twenty for the others; earlier membership is not reconstructed. Every page stays on the same snapshot. Members that do not resolve to a listing OHLC carries are left out, so a snapshot can list slightly fewer members than the index has; an index with fewer than half its members resolved is not published. An instrument that is not an index returns 404 identifier-not-found, as an unknown ID does, and so does an index level of the INDEX venue whose constituents are not published (such as INDEX:N225); /v1/indices lists those that are. Default order: snapshot_date ascending, id ascending. Results are limited to the entitled scope. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key.
/v1/indices/{instrument_id}/constituents- Required capability
- indices.read
- Data timing
- As published by the source
- Credits
- 50 credits per request.
Parameters
instrument_idstringrequired · path- Stable public identifier.
effective_datestringoptional · query- Effective date, defaults to the UTC date of as_of. Returns the latest eligible snapshot on or before this date; response retains its actual snapshot date.
as_ofstringoptional · query- Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.
known_fromstringoptional · query- First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.
known_tostringoptional · query- Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.
orderstringoptional · query- Direction on snapshot_date; ties use ID ascending.
Default:ascdescasc limitintegeroptional · query- Maximum records per page.Default:
100 cursorstringoptional · query- Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.
formatstringoptional · query- Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.
jsoncsv
Response fields
Returns data as an array of records. All example values are illustrative.
idstring- Record identifier, stable across revisions.
index_idstring- Opaque stable public identifier; never an internal database key.
snapshot_datestring- snapshot date
constituentobject- constituent
weightstring · null- Dimensionless ratio; 0.05 means 5%.
member_sincestring · null- member since
Response metadata
Responses include meta.timezone. Dataset responses include next_cursor; health and exports have their own metadata. Request tracing uses the X-Request-ID header.
When something goes wrong
An empty data: [] is a successful query with no matching records. Invalid symbols, permissions and malformed parameters produce an RFC 9457 problem with an actionable detail.
Plans
Requires indices.read. Access, recency and history depth come from the plan definitions the API enforces.
| Plan | Access | Recency | History |
|---|---|---|---|
| Free | Not included | — | — |
| Developer | Not included | — | — |
| Pro | Included | As published | 15 years |
| Commercial | Included | As published | Full history |
| Scale | Included | As published | Full history |
History is how far back a plan may request. How far records actually go for a symbol is history_from in dataset coverage. Nothing is real-time. Compare plans