Screen all SEC filers by a metric or a computed ratio
screen_companiesFind and rank companies across all SEC filers for a calendar-year (optionally quarterly) frame, using SEC's XBRL Frames API. Screen by EITHER:
metric: one reported value (revenue, grossProfit, operatingIncome, netIncome, epsBasic, epsDiluted, totalAssets, currentAssets, totalLiabilities, currentLiabilities, longTermDebt, totalEquity, cashAndEquivalents, operatingCashFlow, capex, rdExpense); or
a ratio: a named preset (grossMargin, operatingMargin, netMargin, rdIntensity, capexIntensity, fcfMargin, currentRatio, debtToEquity, returnOnAssets, returnOnEquity, cashToAssets, assetTurnover) or a custom numerator/denominator from the same metric list. Ratio inputs are joined only when all source metrics share the same periodEnd, denominators must be positive, and unusually large ratios carry a dataQualityFlags warning. Revenue uses the preferred tag and two known US-GAAP synonyms; the response lists tags queried and each result reports the tag selected. SEC calendar-year frames can contain an issuer's closest fiscal period rather than one ending December 31, so compare periodEnd (and sourceAccessionNumbers) across results. Ask for a min/max threshold when one is needed rather than guessing.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"year": "<year>"
},
"name": "screen_companies"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| max | No | Maximum value (metric) or ratio filter | |
| min | No | Minimum value (metric) or ratio filter | |
| sort | No | desc | |
| year | Yes | Calendar year for the frame period | |
| limit | No | ||
| ratio | No | A named preset ratio | |
| metric | No | Screen by one reported metric. Do not combine with ratio/numerator/denominator. | |
| quarter | No | Omit for full fiscal year (duration metrics) or a Q4 year-end snapshot (balance-sheet metrics) | |
| numerator | No | Custom ratio numerator metric, if not using a preset | |
| denominator | No | Custom ratio denominator metric, if not using a preset |