{ "openapi": "3.0.1", "info": { "title": "UK Companies House Scraper — Company Status, SIC & Address", "description": "UK companies by name or company number from Companies House: status, type, incorporation date, registered office, SIC codes, accounts and confirmation deadlines. Run it again or on a schedule to see status and address changes since the last run. Companies only. No login.", "version": "0.1", "x-build-id": "tO94aODiFQdkVJ8wB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/northbell~companies-house-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-northbell-companies-house-search", "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/northbell~companies-house-search/runs": { "post": { "operationId": "runs-sync-northbell-companies-house-search", "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/northbell~companies-house-search/run-sync": { "post": { "operationId": "run-sync-northbell-companies-house-search", "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": { "queries": { "title": "Company names or numbers", "type": "array", "description": "One per line. A company name (Companies House search, which also matches previous names) or a company number such as 00445790, SC045551 or OC300001. A number reads that exact company; leading zeros are added if a spreadsheet dropped them. Leave it empty to use only the search below.", "items": { "type": "string" } }, "maxResultsPerQuery": { "title": "Max companies per name", "minimum": 1, "maximum": 200, "type": "integer", "description": "How many search results to return for each company name, in Companies House's own order (20 per page). Does not apply to company numbers, which always return one company. Raise it to list every company with a similar name.", "default": 20 }, "includeDetails": { "title": "Read each company page", "type": "boolean", "description": "On (default): opens every company's page to add SIC codes, company type, previous names, accounts and confirmation-statement deadlines, and any status detail such as a proposal to strike off. Off: much faster, but keeps only what the search list shows (name, number, status in its short form, dates, registered office); the list does not show a strike-off proposal.", "default": true }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "One per line, 4 or 5 digits, e.g. 62012 (software development), 56101 (restaurants), 41100 (property development). A company matches if any of its SIC codes is in the list.", "items": { "type": "string" } }, "incorporatedWithinDays": { "title": "Incorporated in the last N days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Counted back from today. When no date is set the search covers the last 30 days. Ignored when you set the dates below." }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "YYYY-MM-DD, optional." }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "YYYY-MM-DD, optional." }, "companyStatus": { "title": "Company status", "type": "array", "description": "Keep only these statuses. Empty = any.", "items": { "type": "string", "enum": [ "active", "dissolved", "open", "closed", "converted-closed", "removed", "receivership", "liquidation", "administration", "insolvency-proceedings", "voluntary-arrangement" ] } }, "companyType": { "title": "Company type", "type": "array", "description": "Keep only these types. Empty = any.", "items": { "type": "string", "enum": [ "ltd", "llp", "plc", "limited-partnership", "private-unlimited", "private-limited-guarant-nsc", "charitable-incorporated-organisation", "registered-overseas-entity", "uk-establishment" ], "enumTitles": [ "Private limited company", "Limited liability partnership", "Public limited company", "Limited partnership", "Private unlimited company", "Private limited by guarantee", "Charitable incorporated organisation", "Overseas entity", "UK establishment of an overseas company" ] } }, "location": { "title": "Registered office contains", "type": "string", "description": "A town, county or postcode, e.g. Manchester or LS1. Matches the registered office address." }, "nameIncludes": { "title": "Company name contains", "type": "string", "description": "A word in the company name, e.g. solar." }, "onlyNew": { "title": "Only companies new since the last run", "type": "boolean", "description": "For a schedule: the first run returns every match and remembers it; each later run of the same search returns only the companies it has not returned before, and you pay only for those.", "default": false }, "maxResults": { "title": "Max companies from the search", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Newest first. Companies House gives up to 5,000 per date range; a bigger result is split by date automatically.", "default": 1000 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }