---
title: "Filter companies on latest-period fundamentals."
method: GET
path: "/api/v1/screen"
---

# 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

- `q` string
- `sector` string
- `industry` string
- `exchange` string
- `currency` string
- `revenue_min` number
- `revenue_max` number
- `net_income_min` number
- `total_assets_min` number
- `gross_margin_min` number
- `operating_margin_min` number
- `net_margin_min` number
- `roe_min` number
- `revenue_growth_min` number
- `liabilities_to_equity_max` number
- `long_term_debt_to_equity_max` number
- `debt_to_equity_max` number
- `profitable` boolean
- `include_stale` boolean
- `sort` string
- `limit` integer
- `offset` integer

## Response `200`

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

- ScreenResult
  - `applied_filters` object: Applied leverage ceilings, under their canonical names.
  - `count` integer, required
  - `definitions` object
  - `notice` string, required
  - `offset` integer, required: Rows skipped before results.
  - `results` ScreenRow[], required
    - `currency` string, nullable, required
    - `exchange` string, nullable, required
    - `gross_margin` number
    - `gross_margin_note` string
    - `industry` string, nullable, required
    - `liabilities_to_equity` number, nullable
    - `long_term_debt_to_equity` number, nullable
    - `name` string, required
    - `net_income` number
    - `net_margin` number
    - `operating_margin` number
    - `period_end` string, nullable, required
    - `period_start` string, nullable, required
    - `period_year` integer
    - `return_on_equity` number
    - `revenue` number
    - `revenue_growth` number
    - `sector` string
    - `ticker` string, required
    - `total_assets` number
  - `sort` string, required
  - `source` string, required
  - `stale_excluded` integer: Matching companies left out because their latest annual report ended over about 18 months ago; pass include_stale=true.
  - `terms` string, uri, required
  - `total` integer, required
  - `warnings` string[]

## Other responses

- `404`: No such record in this build.

---

[API](https://skmtc.dev/tickerfacts/apis/tickerfacts-json-api.md) · [All operations](https://skmtc.dev/tickerfacts/apis/tickerfacts-json-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tickerfacts/apis/tickerfacts-json-api/revisions/bc6cb5e92b7f?raw)