Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.secapi.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Index Constituents

​
What this utility is for

  • expose index rosters only when OMNI has a documented public-source right to share them
  • map constituent symbols into OMNI’s canonical entity graph when local coverage exists
  • keep the broader index universe visible in the source inventory without pretending unsupported families are production-ready

​
Current support posture

  • NDX is fully supported — OMNI parses the public Nasdaq-100 companies page published by Nasdaq
  • OMNI returns company name, ticker, rank order, rights metadata, provenance, and any canonical entity match already available in the local graph
  • OMNI does not return weights for NDX because the public source page does not publish them

​
Operator-only indices

The following indices are available to principals with admin:operator scope. They are derived from ClickHouse market_reference_history data and are approximate — not official committee selections.
  • SPX — S&P 500 approximation, derived from top ~500 US stocks by market cap
  • DJIA — Dow Jones Industrial Average, static 30-component list maintained in code
  • RUT — Russell 2000 approximation, derived from market cap rank 1001-3000
  • XNAS_COMP — Nasdaq Composite approximation, all active tickers with primary_exchange = 'XNAS'
Operator-only indices appear in /v1/market/indices but return a 400 error from /v1/market/indices/constituents unless the caller has operator scope.

​
Inventory-only indices

  • UKX and SX5E are tracked in the source inventory, but rights and extraction posture are still under review
  • inventory-only indices are intentionally visible in ops artifacts before they are exposed through the public API

​
Internal mapping versus public export

  • these are separate decisions on purpose
  • Datastream can prove strong internal mapping coverage for SPX, NDX, DJIA, and RUT without implying that every one of those rosters is public
  • public export remains constrained by rights posture, not by the current quality of the entity graph

​
Rights model

  • public_source_documented means the source page and public-shareability posture are documented
  • public_source_review_required means OMNI tracks the official source but has not yet cleared public constituent export
  • licensed_index_not_supported means OMNI will not expose the constituent roster until explicit licensing is in place

​
Sync posture

  • NDX is the only public constituent roster today, and its export is generated from Datastream’s checked-in source definition
  • inventory exports are generated from services/datastream-api/src/lib/index-constituents.ts with bun run ops:index-source-inventory
  • syncCadence values describe source-review posture and intended refresh cadence; they do not imply that every inventory-only benchmark family is already auto-synced into a public roster

​
Example

curl -H "x-api-key: $OMNI_DATASTREAM_API_KEY" \
  "https://api.secapi.ai/v1/market/indices/constituents?index=NDX&limit=10"