Screener API

Auto-generated from openapi-snapshot.json. Do not edit by hand — changes are overwritten by scripts/docs/generate_api_reference.py.

8 endpoints in this group.

POST /api/screener

Run Screener

Request body: application/json

Responses

POST /api/screener/ai-build

Ai Build Screen

Build a screener spec from a natural-language prompt.

Gated by the master stock_screener_ai flag (503 when off). The LLM engine is a separate opt-in flag; when off/unreachable the service falls back to keyword rules and returns degraded=True.

Request body: application/json

Responses

POST /api/screener/export.csv

Export Screener Csv

Request body: application/json

Responses

GET /api/screener/filters

Screener Filters

Responses

POST /api/screener/run

Run Screener

Request body: application/json

Responses

GET /api/screener/saved

List Saved Screens

Responses

POST /api/screener/saved

Save Screen

Request body: application/json

Responses

DELETE /api/screener/saved/{screen_id}

Delete Saved Screen

Parameters

Responses