{ "openapi": "3.0.1", "info": { "title": "UK Company Data API - Financials, Employees, Filings", "description": "Search UK and Ireland registered companies by name, status, industry, region, headcount and filed financials including turnover, EBITDA, net assets and post-tax profit, with year-on-year growth filters. Pay per result. Bring your own API key.", "version": "0.1", "x-build-id": "cXc16SbvUvExP7XV4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~uk-company-data-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-uk-company-data-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/nabeelbaghoor~uk-company-data-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-uk-company-data-api", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/nabeelbaghoor~uk-company-data-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-uk-company-data-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "name": { "title": "Company name", "type": "string", "description": "Match the registered company name against this text." }, "countryCodes": { "title": "Country codes", "type": "array", "description": "Two-letter country codes to include, one per line, for example `gb` or `ie`. They are sent in lower case, which is what the provider matches on.", "items": { "type": "string" } }, "simplifiedStatuses": { "title": "Registration statuses", "type": "array", "description": "Simplified registration statuses to include, one per line, for example `Active` or `Closed`.", "items": { "type": "string" } }, "incorporatedMin": { "title": "Incorporated on or after", "type": "string", "description": "Earliest incorporation date, written as `YYYY-MM-DD`." }, "incorporatedMax": { "title": "Incorporated on or before", "type": "string", "description": "Latest incorporation date, written as `YYYY-MM-DD`." }, "industries": { "title": "Industries", "type": "array", "description": "Industry identifiers to include, one per line, using the provider's own industry codes or labels.", "items": { "type": "string" } }, "keywords": { "title": "Keywords", "type": "array", "description": "Keywords to match against a company's description and filings, one per line.", "items": { "type": "string" } }, "domainNames": { "title": "Website domains", "type": "array", "description": "Website domains to match, one per line, for example `example.co.uk`.", "items": { "type": "string" } }, "regions": { "title": "Regions", "type": "array", "description": "Regions to include, one per line, using the provider's region names.", "items": { "type": "string" } }, "employeesMin": { "title": "Minimum employees", "minimum": 0, "type": "integer", "description": "Only return companies with at least this many employees." }, "employeesMax": { "title": "Maximum employees", "minimum": 0, "type": "integer", "description": "Only return companies with at most this many employees." }, "employeesGrowthMin": { "title": "Minimum headcount growth (percent)", "type": "integer", "description": "Only return companies whose headcount grew by at least this percentage. Negative values select companies that shrank." }, "employeesGrowthMax": { "title": "Maximum headcount growth (percent)", "type": "integer", "description": "Only return companies whose headcount grew by at most this percentage." }, "turnoverMin": { "title": "Minimum turnover", "type": "integer", "description": "Only return companies with at least this much turnover, in the filing currency. Plain number, no symbols." }, "turnoverMax": { "title": "Maximum turnover", "type": "integer", "description": "Only return companies with at most this much turnover." }, "turnoverGrowthMin": { "title": "Minimum turnover growth (percent)", "type": "integer", "description": "Only return companies whose turnover grew by at least this percentage." }, "turnoverGrowthMax": { "title": "Maximum turnover growth (percent)", "type": "integer", "description": "Only return companies whose turnover grew by at most this percentage." }, "ebitdaMin": { "title": "Minimum EBITDA", "type": "integer", "description": "Only return companies with at least this much EBITDA." }, "ebitdaMax": { "title": "Maximum EBITDA", "type": "integer", "description": "Only return companies with at most this much EBITDA." }, "ebitdaGrowthMin": { "title": "Minimum EBITDA growth (percent)", "type": "integer", "description": "Only return companies whose EBITDA grew by at least this percentage." }, "ebitdaGrowthMax": { "title": "Maximum EBITDA growth (percent)", "type": "integer", "description": "Only return companies whose EBITDA grew by at most this percentage." }, "netAssetsMin": { "title": "Minimum net assets", "type": "integer", "description": "Only return companies with at least this much in net assets." }, "netAssetsMax": { "title": "Maximum net assets", "type": "integer", "description": "Only return companies with at most this much in net assets." }, "netAssetsGrowthMin": { "title": "Minimum net assets growth (percent)", "type": "integer", "description": "Only return companies whose net assets grew by at least this percentage." }, "netAssetsGrowthMax": { "title": "Maximum net assets growth (percent)", "type": "integer", "description": "Only return companies whose net assets grew by at most this percentage." }, "totalAssetsMin": { "title": "Minimum total assets", "type": "integer", "description": "Only return companies with at least this much in total assets." }, "totalAssetsMax": { "title": "Maximum total assets", "type": "integer", "description": "Only return companies with at most this much in total assets." }, "totalAssetsGrowthMin": { "title": "Minimum total assets growth (percent)", "type": "integer", "description": "Only return companies whose total assets grew by at least this percentage." }, "totalAssetsGrowthMax": { "title": "Maximum total assets growth (percent)", "type": "integer", "description": "Only return companies whose total assets grew by at most this percentage." }, "postTaxProfitMin": { "title": "Minimum post-tax profit", "type": "integer", "description": "Only return companies with at least this much post-tax profit. Negative values select loss-making companies." }, "postTaxProfitMax": { "title": "Maximum post-tax profit", "type": "integer", "description": "Only return companies with at most this much post-tax profit." }, "postTaxProfitGrowthMin": { "title": "Minimum profit growth (percent)", "type": "integer", "description": "Only return companies whose post-tax profit grew by at least this percentage." }, "postTaxProfitGrowthMax": { "title": "Maximum profit growth (percent)", "type": "integer", "description": "Only return companies whose post-tax profit grew by at most this percentage." }, "creditRisk": { "title": "Credit risk bands", "type": "array", "description": "Credit risk bands to include, one per line. This filter is only available on API keys that include the credit report package; without it the provider rejects the request.", "items": { "type": "string" } }, "countryCodesMode": { "title": "Country code match mode", "enum": [ "any", "all" ], "type": "string", "description": "`any` matches a company in at least one of the listed countries. `all` requires every listed value to apply.", "default": "any" }, "industriesMode": { "title": "Industry match mode", "enum": [ "any", "all" ], "type": "string", "description": "`any` matches at least one listed industry, `all` requires every one of them.", "default": "any" }, "keywordsMode": { "title": "Keyword match mode", "enum": [ "any", "all" ], "type": "string", "description": "`any` matches at least one listed keyword, `all` requires every one of them.", "default": "any" }, "rawCriteria": { "title": "Additional criteria", "type": "object", "description": "Advanced. Any extra criterion the data API supports, as a JSON object using the API's own shapes, for example `{\"employeesValue\": {\"min\": 10, \"max\": 500}}`. Merged last, so it also overrides the fields above." }, "usePreviewDataset": { "title": "Use the preview dataset", "type": "boolean", "description": "When enabled, the search runs against the provider's sandbox dataset instead of live company data. Useful for checking your criteria without consuming live quota. Results are a limited demo set, not real search output.", "default": false }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Stop after this many companies (1-20,000). One row is one company." }, "pageSize": { "title": "Results per request", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many companies to fetch per API call (1-100). Larger pages mean fewer calls against your provider quota.", "default": 100 }, "apiKey": { "title": "API key", "type": "string", "description": "Your own API key for the data provider. Required. It is issued in the provider's platform. Stored securely here and never logged." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }