Screen the market
screen_marketFilter and rank market instruments from live snapshots by performance, volume, valuation, sector, index, or preset to identify stocks matching your criteria.
Instructions
Egypt only: filter and rank every instrument of the market using the live snapshot — e.g. top gainers (sortBy=changePercent), top losers (order=asc), most active (sortBy=value), unusual volume (minRelativeVolume=200), value stocks (maxPeRatio, minDividendYield), a sector, the members of an index (index=EGX30), one of ThndrX's built-in screeners (preset=momentum-movers, breakout-radar, value-yield, steady-performers, reversal-watch) or one of the user's saved screeners (screenerId, see get_screeners). All given filters apply together. Index rows are never returned.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| index | No | Only members of this index, e.g. "EGX30", "EGX70 EWI", "SHARIAH" (see get_index_constituents) | |
| limit | No | ||
| order | No | desc | |
| market | No | Market: "egypt" (EGX, default), "us" (NYSE/Nasdaq via Alpaca), "uae" (ADX) or "simulator" (paper trading) | egypt |
| preset | No | Apply one of ThndrX's built-in screeners (see get_screeners), evaluated as ThndrX does | |
| sector | No | Sector name or part of it, e.g. "Banks", "Real Estate" | |
| sortBy | No | changePercent | |
| maxPrice | No | ||
| minPrice | No | ||
| minValue | No | Minimum traded value today (EGP) | |
| maxPeRatio | No | ||
| screenerId | No | Apply one of the user's saved Thndr screeners by id (see get_screeners) | |
| includeSuspended | No | ||
| maxChangePercent | No | ||
| minChangePercent | No | ||
| minDividendYield | No | Percent | |
| minRelativeVolume | No | Volume as % of the 30-day average |