Filter companies on latest-period fundamentals.

get/api/v1/screen

Request

  • Base URL: https://tickerfacts.com
  • URL: https://tickerfacts.com/api/v1/screen
  • Auth: one of:
    • none
    • HTTP bearer

Query parameters

qstring

Match ticker prefix, company name, industry or sector.

sectorstring
industrystring
exchangestring
currencystring
revenue_minnumber
revenue_maxnumber
net_income_minnumber
total_assets_minnumber
gross_margin_minnumber
operating_margin_minnumber
net_margin_minnumber
roe_minnumber
revenue_growth_minnumber
liabilities_to_equity_maxnumber

Maximum total liabilities / year-end equity.

long_term_debt_to_equity_maxnumber

Maximum long-term debt including current maturities / year-end equity; excludes short-term borrowings and leases.

debt_to_equity_maxnumber

Deprecated alias for liabilities_to_equity_max; returns a warning and cannot be combined with the canonical parameter.

profitableboolean
include_staleboolean

Include companies whose latest annual report ended more than about 18 months ago.

sortstring
limitinteger
offsetinteger

Response

Ranked companies with their key figures and a total count; ignored_parameters lists any parameter the screen does not know.

applied_filtersobject

Applied leverage ceilings, under their canonical names.

countinteger required
definitionsobject
noticestring required
offsetinteger required

Rows skipped before results.

sortstring required
sourcestring required
stale_excludedinteger

Matching companies left out because their latest annual report ended over about 18 months ago; pass include_stale=true.

termsstring uri required
totalinteger required
warningsstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.