GET /api/v1/screener/universe
Last verified
Auto-generated. This article is rebuilt from FastAPI route introspection by
scripts/build_api_kb.py. Edit the route docstring inapp/and re-run the script — do not edit this file directly.
GET /api/v1/screener/universe
Handler: app.screener.routes.get_screener_universe
Methods: GET
Description
Current screener universe membership (tier-aware).
Returns the set of tickers that are universe members for the configured
tier (sp500 → S&P 500 only, ~503; sp900 → S&P 500 + S&P 400,
~903; configured in screener_config.json universe.tier) as of
as_of_date (defaults to today ET). Point-in-time semantics: for
each ticker, the most recent effective_date on or before
as_of_date determines membership.
Returns an empty tickers list (HTTP 200) when the universe table
has not yet been seeded — check scripts/backfill_universe.py --help
to backfill.
The response includes the resolved tier string for the UI to display
the correct label (e.g., “S&P 900 members” vs “S&P 500 members”).
Parameters
| In | Name | Type | Default | Description |
|---|---|---|---|---|
| query | as_of_date |
Optional[str] |
Point-in-time date YYYY-MM-DD ET. Defaults to today ET. |
Curl
curl -s https://bigclawd.com/api/v1/screener/universe