KB / api
GET /api/v1/screener/candidates
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/candidates
Handler: app.screener.routes.get_screener_candidates
Methods: GET
Description
Ranked screener candidate board.
Returns candidates from screener_candidates for the requested
trade_date (defaults to today ET), sorted and filtered per params.
Default sort: confluence desc → blended_score_norm desc → ticker asc (per §7.2 dashboard spec).
Filters available:
archetype— archetype ID string (e.g.A1,A2).status— lifecycle status string.min_confluence— minimum confluence count (integer ≥ 1).sector— GICS sector string, case-insensitive (Session 2.2: enriched from sp500_companies.json at response time; tickers not in the map have sector=None and are excluded when this filter is set).
Sort options: confluence (default), score_norm,
days_on_list, ticker, status.
Parameters
| In | Name | Type | Default | Description |
|---|---|---|---|---|
| query | archetype | Optional[str] | Filter by archetype: canonical descriptive ID (e.g. ‘oversold_sympathy’) or short code (e.g. ‘A2’, back-compat — translated to the descriptive ID). | |
| query | status | Optional[str] | Filter by lifecycle status: new, persisting, decayed, exited, promoted. | |
| query | sector | Optional[str] | Filter by GICS sector string (case-insensitive; derived from sp500_companies.json current-GICS map — Session 2.2). | |
| query | min_confluence | Optional[int] | Minimum confluence_count (integer >= 1). | |
| query | sort | str | 'confluence' | Sort order: confluence (default), score_norm, days_on_list, ticker, status. |
| query | trade_date | Optional[str] | Snapshot date YYYY-MM-DD ET. Defaults to today ET. | |
| query | limit | int | 200 | Maximum rows to return. |
| query | active_only | bool | False | When true, return only rows with status in (new, persisting), using point-in-time latest row per (ticker, archetype). |
Curl
curl -s https://bigclawd.com/api/v1/screener/candidates