Docs/Reference/Screening/Screen Companies
GET/v1/screenTier · Developer

Screen Companies

Screen listed companies on financial metrics. ROE, ROA, revenue, margins, P/E.

Returns one row per company matching every filter, with the company's latest annual filing's financials and computed metrics (metrics.roe, metrics.roa, metrics.operating_margin, metrics.net_margin, metrics.equity_ratio, metrics.pe_ratio).

Sort via sort=<field>_<asc|desc> (e.g. roe_desc). Pass fiscal_year= to screen against a specific year instead of the latest filing. By default uses a pre-computed wide table for instant response on the latest year.

Query parameters · 15

Optional filters and modifiers. Pass as URL-encoded ?key=value.

roe_minnumber | nulloptional
roe_maxnumber | nulloptional
roa_minnumber | nulloptional
roa_maxnumber | nulloptional
revenue_mininteger | nulloptional
revenue_maxinteger | nulloptional
net_income_mininteger | nulloptional
net_income_maxinteger | nulloptional
operating_income_mininteger | nulloptional
operating_income_maxinteger | nulloptional
sectorstring | nulloptional
sortstringoptional
default revenue_desc
fiscal_yearinteger | nulloptional
limitintegeroptional
default 50
offsetintegeroptional
default 0

Request headers · 1

Authentication.

Authorizationstringrequired

Production API key. Pass it as Bearer ax_live_…

Returns · 200

The standard { data, meta } envelope. data contains an array of ScreenResultOut.

Envelope

dataScreenResultOut[]

Array of result objects.

metaMeta

Pagination and request metadata, including request_id, data_as_of, and ontology_version.

ontology_version 2.1.0replay meta.as_of · ?as_of=<token>

ScreenResultOut

companyCompanyOut

Company details.

financialsScreenFinancials

Latest financial data.

metricsScreenMetrics

Computed financial ratios.

Errors

Standard HTTP status codes plus a typed error.code in the { error: { code, message } } envelope.

Every endpoint returns the same typed error envelope ({ error: { code, message } }). For the full list of codes, see the Errors reference.