---
title: "Screen the Hub-Equity universe by criteria"
method: GET
path: "/api/v1/companies/screen"
tags: ["Companies"]
---

# Screen the Hub-Equity universe by criteria

`GET /api/v1/companies/screen`

## Request

- Base URL: `https://api.hub-equity.com`
- URL: `https://api.hub-equity.com/api/v1/companies/screen`
- Auth: HTTP bearer

Filters the company universe: 'European tech companies with revenue > 1B audited by Big 4' in one call. All filters are optional ; results carry the matched `applied_filters` back.

Query params : `country` (ISO-2), `sector` (substring), `gics_sector`, `min_revenue` / `max_revenue` (USD, ECB spot rate), `min_employees` / `max_employees`, `revenue_year`, `auditor_name` (substring), `bankruptcy_flag`, `min_quality_grade` (A+/A/B/C/D), `sort_by` ∈ {revenue_desc, revenue_asc, employees_desc, employees_asc, quality_desc, name_asc}, `limit` (1-50).

Free plan: `limit` up to 20 and no `min_quality_grade` filter (beyond that: 401 AUTH_REQUIRED for an anonymous caller, 403 SCOPE_MISSING for a Free key); any paid plan lifts both. Rate limit: the plan of the calling key (Free 120, Builder 300, Team 600, Enterprise 1,000 per minute).

## Query parameters

- `country` string, nullable: ISO-2 country code.
- `sector` string, nullable: Sector substring match.
- `gics_sector` string, nullable: Exact GICS sector.
- `min_revenue` number, nullable: Min revenue (USD, ECB spot rate).
- `max_revenue` number, nullable: Max revenue (USD, ECB spot rate).
- `min_employees` integer, nullable
- `max_employees` integer, nullable
- `min_quality_grade` string, nullable: A+/A/B/C/D minimum grade.
- `auditor_name` string, nullable: Auditor name substring.
- `bankruptcy_flag` boolean, nullable
- `revenue_year` integer, nullable
- `sort_by` string: revenue_desc | revenue_asc | employees_desc | employees_asc | quality_desc | name_asc.
- `limit` integer: Max rows (clamped to 50).

## Response `200`

Screened companies + applied filters.

- ApiResponseScreenCompaniesResult
  - `success` boolean, required
  - `data` ScreenCompaniesResult
    - `rows` ScreenedCompany[], required
      - `entity_id` string, required
      - `name` string, required
      - `name_en` string, nullable
      - `ticker` string, nullable
      - `country` string, nullable
      - `exchange` string, nullable
      - `sector` string, nullable
      - `gics_sector` string, nullable
      - `revenue` number, nullable
      - `revenue_currency` string, nullable
      - `revenue_year` integer, nullable
      - `revenue_usd` number, nullable
      - `revenue_usd_rate_date` string, nullable
      - `number_of_employees` integer, nullable
      - `incorporation_date` string, nullable
      - `bankruptcy_flag` boolean, nullable
      - `auditor_name` string, nullable
      - `quality_grade` string, nullable
      - `avg_confidence` number, nullable
    - `total_count` integer, required: Number of rows returned (capped at limit)
    - `applied_filters` object
    - `notes` string[]
  - `error` ApiError: API error details.
    - `code` string, required
    - `message` string, required
    - `details` object, nullable
  - `meta` ApiMeta: API response metadata. Pagination fields (``page`` / ``per_page`` / ``total``) are populated on collection endpoints only. They are omitted from the payload on single-resource endpoints.
    - `timestamp` string, date-time
    - `request_id` string, nullable
    - `page` integer, nullable
    - `per_page` integer, nullable
    - `total` integer, nullable
  - `links` ApiLinks: HATEOAS-style pagination cursors. Host-relative path + query links for a collection page. Present on collection endpoints, ``null`` fields where a page doesn't exist (``next`` on the last page, ``prev`` on the first). The whole ``links`` object is omitted from single-resource responses (see ``ApiResponse`` serializer).
    - `self` string, nullable
    - `first` string, nullable
    - `prev` string, nullable
    - `next` string, nullable
    - `last` string, nullable

## Other responses

- `422`: Validation Error

---

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