Screen companies
screen_companiesScreen the companies of the coverage as the Screener page of Annalist does, or rank them by one measure. With screen, the conditions of the page joined by commas: roic.gt.12 (latest value above 12; lt below), roic.gt.12.y5 (above 12 in each of the last 5 fiscal years), om.up.3 (higher than the year before in each of the last 3 fiscal years; dn lower), dte.chg.gt.0.5.y1 (change over the last fiscal year above 0.5), roic.top.25 (among the highest 25% of the companies screened; bot the lowest; .s within the sector) and band.in.minimal-modest (credit and quality signals: band, cover, netdebt, fcf, backing, altman, piotroski, beneish). start runs a starting screen such as rising-debt or high-returns. Each company comes with the figures behind each condition and its page, and page links the same screen for a person. Without screen, where and sort filter and rank by the latest value of ratio ids with a frequency, as corp.roic@ttm or corp.current_ratio@quarterly; an amount such as corp.net_debt is ranked within its currency. Call without arguments to list the measures and the starting screens.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "screen_companies"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | the measure to rank by, for example corp.operating_margin@ttm | |
| basis | No | with screen: latest (default) for the last 4 quarters where reported, fy for the latest fiscal year of every company | |
| limit | No | maximum companies (default 20) | |
| order | No | desc (default) for the highest first | |
| start | No | a starting screen of the Screener page, for example high-returns, rising-debt or credit-watch | |
| where | No | conditions that every company meets, for example [{"measure": "corp.roic@ttm", "min": 15}] | |
| screen | No | the conditions of a screen, for example roic.gt.12.y5,nde.lt.2 or band.in.significant-aggressive | |
| sector | No | part of a sector name, for example Technology or Health care | |
| country | No | ISO 3166 country code, for example US, GB, ID or HK | |
| markets | No | with screen: ISO country codes, for example ["SG", "ID"] | |
| currency | No | keep the companies that report in one currency, for example USD | |
| industry | No | part of an industry name, for example Semiconductors or Banks | |
| template | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | ||
| page | No | ||
| basis | No | ||
| start | No | ||
| screen | No | ||
| filters | No | ||
| matched | Yes | ||
| measures | Yes | ||
| screened | No | ||
| companies | Yes | ||
| truncated | Yes | ||
| conditions | No | ||
| rules_version | No | ||
| without_value | No | ||
| screens_available | No | ||
| measures_available | No |