Get screener filters
Every field, operator and label you can use in Screen companies.
How it works
-
Use field names exactly as listed. They're qualified by statement:
accounting_metrics.net_margin, notnet_margin. -
Any numeric field can also be a screen's
sort_by, as canend_date. -
Domicile country, sector and industry take the labels listed here. Matching ignores case, but
domicile_countrytakes uppercase ISO codes likeGB.
Request
GET /api/v1/screener/filters with your API key. AI assistants call it as the get_screener_filters tool, with the same parameters.
Parameters
include_sourcesboolean
Include available source documents and supporting evidence. Omit for data only.
Default: false
Response
JSON with these fields. A field the source doesn't report is null or left out.
metadataobjectrequired
Show child attributes
domicile_countryarray
Available domicile country codes
sectorarray
Available sector labels
industryarray
Available industry labels
fieldsarray of objectsrequired
Show child attributes
fieldQualified field name
descriptionMeaning of the field
operatorsarrayrequired
Allowed comparison operator
Errors
| Status | Meaning |
|---|---|
| 400 | Missing, unknown or invalid parameter, or an identifier that can't be looked up |
| 401 | Missing, unknown or revoked API key |
| 402 | No active plan or trial, or the included request allowance is used |
| 403 | API access of the account is suspended |
| 404 | The identifier matches nothing or is ambiguous. The match field identifies the outcome |
| 429 | Over the plan's rate limit; Retry-After says when to retry |
| 500 | Internal error; the same request is unlikely to succeed on retry |
| 503 | The data couldn't be loaded right now; Retry-After says when to retry, when known |
Errors are JSON with an error message saying what to fix. Errors are free. See Errors and limits.