screen
Filter a multi-symbol basket by indicator-driven conditions.
Parameters
- standard
data: Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray
Long-format multi-symbol data with a symbol column.
conditions: list[ScreenCondition]
Predicates to evaluate against each symbol's indicators.
index: str
Default: date
Index column name in data.
target: str
Default: close
Default target column.
combine: str
Default: and
and returns symbols matching every condition; or returns symbols matching at least one.
as_of_date: date | datetime | str
Anchor date. Defaults to the latest date per symbol when unset.
Returns
results: list[ScreenMatch]
Serializable results.
provider: str
Provider name.
warnings: Optional[list[Warning_]]
List of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
symbol: str
Symbol that matched.
as_of_date: date | datetime | str
Date used for evaluation.
matched_conditions: int
How many conditions fired.
values: dict[str, float]
Latest indicator values that contributed to the match, keyed by "<indicator>.<column>".