{ "openapi": "3.0.1", "info": { "title": "UK Companies House Scraper", "description": "Scrape UK companies from Companies House without an API key: number, name, status, type, registered address, SIC codes, incorporation and dissolution dates, accounts and confirmation statement dates, overdue flags, previous names, filings and charges. Bulk filters. Error rows are free.", "version": "0.1", "x-build-id": "r7vYidvKDIYWEBmXE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapewise~companies-house-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapewise-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/scrapewise~companies-house-scraper/runs": { "post": { "operationId": "runs-sync-scrapewise-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/scrapewise~companies-house-scraper/run-sync": { "post": { "operationId": "run-sync-scrapewise-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": { "searchTerms": { "title": "Company name or keyword", "type": "array", "description": "One per line, such as 'bakery' or 'Tesco'. Without filters, each term runs the Companies House name search in its own relevance order (up to 1,980 companies per term). With any filter below, each term must appear in the company name and the filters apply.", "items": { "type": "string" } }, "companyNumbers": { "title": "Company numbers or links", "type": "array", "description": "One per line: a company number (00445790, SC241685, OC300001) or a Companies House page link. Each one returns the full company record.", "items": { "type": "string" } }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "Filter by nature of business, 5-digit SIC 2007 codes, such as 62020 (IT consultancy) or 56101 (restaurants). A company matches if it has any of them.", "items": { "type": "string" } }, "location": { "title": "Registered office location", "type": "string", "description": "Town, county or postcode of the registered office, such as Manchester or SW1A." }, "companyStatus": { "title": "Company status", "type": "array", "description": "Any of: active, dissolved, liquidation, receivership, administration, voluntary-arrangement, converted-closed, insolvency-proceedings, open, closed, removed. Empty = every status.", "items": { "type": "string" } }, "companyType": { "title": "Company type", "type": "array", "description": "Any of the Companies House type codes, such as ltd, plc, llp, limited-partnership, oversea-company or community-interest-company. Empty = every type.", "items": { "type": "string" } }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "Only companies incorporated on or after this date (YYYY-MM-DD) or in the last N days (for example 7). Good for new company leads." }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "Only companies incorporated on or before this date (YYYY-MM-DD)." }, "dissolvedFrom": { "title": "Dissolved from", "type": "string", "description": "Only companies dissolved on or after this date (YYYY-MM-DD) or in the last N days." }, "dissolvedTo": { "title": "Dissolved to", "type": "string", "description": "Only companies dissolved on or before this date (YYYY-MM-DD)." }, "nameExcludes": { "title": "Name must not contain", "type": "string", "description": "Leave out companies whose name contains this word. Works together with the filters above." }, "maxResults": { "title": "Max companies per search", "minimum": 0, "type": "integer", "description": "Stop after this many companies for each search term (or for the filter set). 0 = every match. Filtered searches have no ceiling: large result sets are split by incorporation date automatically.", "default": 50 }, "includeDetails": { "title": "Add accounts, confirmation statement and SIC descriptions", "type": "boolean", "description": "Opens each company's page for status detail (such as 'proposal to strike off'), last and next accounts dates, confirmation statement dates, overdue flags, SIC descriptions and previous names. Always on for company numbers. Same price per company.", "default": false }, "includeFilingHistory": { "title": "Add latest filings", "type": "boolean", "description": "Adds the 25 most recent filings (date, form type, description, PDF link). Director and PSC appointment filings are left out. Same price per company.", "default": false }, "includeCharges": { "title": "Add charges (mortgages)", "type": "boolean", "description": "Adds the count of charges registered, outstanding and satisfied, and each charge's title, dates and status. Same price per company.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "The default Apify Proxy (datacenter) works; tested with 48 of 48 requests and bulk exports without a block.", "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 } } } } } } } } } }