{ "openapi": "3.0.1", "info": { "title": "UK Companies House Scraper — Company Profiles, No API Key", "description": "UK Companies House scraper without an API key: search by name, SIC code, status, type, address or incorporation date and get company number, status, registered office, SIC, accounts and confirmation due dates, previous names. Optional filing history.", "version": "0.1", "x-build-id": "b4XcUXqgO3TbvCiQf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fabrikit~uk-companies-house-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fabrikit-uk-companies-house-scraper", "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/fabrikit~uk-companies-house-scraper/runs": { "post": { "operationId": "runs-sync-fabrikit-uk-companies-house-scraper", "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/fabrikit~uk-companies-house-scraper/run-sync": { "post": { "operationId": "run-sync-fabrikit-uk-companies-house-scraper", "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": { "query": { "title": "Company name contains", "type": "string", "description": "Search text. With no other filter and status \"Any\" it runs the site's fuzzy name search (also matches previous names, up to 1,000 results); otherwise it is used as a 'name includes' filter." }, "companyNumbers": { "title": "Company numbers", "type": "array", "description": "Look up specific companies, e.g. 00445790, SC083026, OC301540. When set, search filters are ignored.", "items": { "type": "string" } }, "status": { "title": "Status", "enum": [ "active", "dissolved", "open", "closed", "liquidation", "administration", "receivership", "voluntary-arrangement", "insolvency-proceedings", "converted-closed", "all" ], "type": "string", "description": "Company status filter.", "default": "active" }, "companyType": { "title": "Company type", "type": "string", "description": "Optional company type, e.g. ltd (private limited), plc, llp, limited-partnership, private-unlimited, royal-charter, charitable-incorporated-organisation, oversea-company. Empty = any." }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "5-digit UK SIC 2007 codes, e.g. 62012 (software), 47110 (retail), 68209 (letting). Each code is searched separately.", "items": { "type": "string" } }, "addressIncludes": { "title": "Registered office contains", "type": "string", "description": "Town, postcode or street fragment, e.g. SW1A or Manchester." }, "nameExcludes": { "title": "Name does not contain", "type": "string", "description": "Exclude companies whose name contains this word." }, "incorporatedFrom": { "title": "Incorporated from", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "YYYY-MM-DD" }, "incorporatedTo": { "title": "Incorporated to", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "YYYY-MM-DD" }, "dissolvedFrom": { "title": "Dissolved from", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "YYYY-MM-DD (use with status dissolved)" }, "dissolvedTo": { "title": "Dissolved to", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "YYYY-MM-DD" }, "includeProfile": { "title": "Fetch full company profile", "type": "boolean", "description": "Open each company's overview page to get accounts / confirmation-statement due dates and previous names (1 request per company, about 2 companies per second). Off = fast list data only (20 companies per request).", "default": true }, "includeFilingHistory": { "title": "Add filing history (add-on)", "type": "boolean", "description": "Attach the company's filing history list (date, type, title, document link). Entries that name individuals (officer appointments, persons with significant control) are left out. Charged as the filing-history add-on.", "default": false }, "maxFilingsPerCompany": { "title": "Max filings per company", "minimum": 1, "maximum": 500, "type": "integer", "description": "Newest first.", "default": 20 }, "maxItems": { "title": "Max companies", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Total companies saved (each is charged). Default run is 50.", "default": 50 }, "maxRequests": { "title": "Max requests", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Safety cap on page requests.", "default": 20000 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "The Actor requests at most 2 pages per second. Proxy is a fallback if Companies House throttles the IP (residential UK after repeated blocks).", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }