Screen companies
screen_companiesFind Japanese listed companies matching financial ratio filters (ROE, ROA, operating margin and others). Supported ratios: roe, roa, operating_margin (fractions, e.g. 0.15 means 15%), current_ratio and debt_to_equity (plain ratios, e.g. 1.5 means 1.5x). Multiple filters are combined with AND logic. Only the latest reported period per company is considered. Companies with negative equity are excluded by default. Banks, insurers and securities firms (statement_format bank, insurance, insurance_life, insurance_nonlife or securities, read from each filing whatever its accounting standard) are excluded by default, because their ratios measure a balance sheet that is the business itself and have no operating margin or current ratio; include_financials: true includes them. ROE and ROA divide net income by the average of the opening and closing balance (the 決算短信 convention); roe_basis and roa_basis are "average", or "year_end" when the opening balance is not available. Companies no longer on the JPX listed-company list are excluded by default; include_delisted: true includes them. Each result carries its statement_format. Source: EDINET (https://disclosure2.edinet-fsa.go.jp/), PDL 1.0 (https://www.digital.go.jp/resources/open_data/public_data_license_v1.0). Data is processed by Kabuken, not raw unprocessed FSA data. Figures are calculated by Kabuken from EDINET filings, not reported directly by EDINET. Not investment advice.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of results to return (1-100, default 20) | |
| cursor | No | Opaque next_cursor from the previous response; send it with the same filters, sort and limit to get the next page. total is returned on the first page only. | |
| filters | Yes | Array of ratio filters. Each filter specifies a metric, a comparison operator (gt, lt, gte, lte), and a numeric threshold value. | |
| sort_by | No | Optional metric to sort results by. Default sort is by entity_code. | |
| industry_id | No | Optional industry filter. Industry ID, e.g. ind_3700. The bare industry code (3700) is also accepted. | |
| sort_direction | No | Sort direction when sort_by is specified. Default: desc. | |
| include_delisted | No | Include companies that are no longer on the JPX listed-company list (delisted), which are excluded by default. Default: false. | |
| include_financials | No | Include banks, insurers and securities firms, which are excluded by default. Their ROE, ROA and debt_to_equity are not comparable with other companies', and operating_margin and current_ratio are null for banks and insurers. Default: false. | |
| exclude_negative_equity | No | Exclude companies with negative equity (inferred from a negative debt_to_equity ratio, since liabilities are never negative) from results. Default: true. |