{ "openapi": "3.0.1", "info": { "title": "Companies House Scraper - UK Company Data & New Companies", "description": "Scrape UK Companies House company data without an API key. Filter by SIC code, incorporation date, location, status and type, get new company leads, registered office addresses and SIC codes as JSON, CSV or Excel.", "version": "1.0", "x-build-id": "wq6OLpHTBeZ1DfD6X" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kamerozkan~companies-house-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kamerozkan-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/kamerozkan~companies-house-scraper/runs": { "post": { "operationId": "runs-sync-kamerozkan-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/kamerozkan~companies-house-scraper/run-sync": { "post": { "operationId": "run-sync-kamerozkan-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": { "sicCodes": { "title": "SIC codes", "type": "array", "description": "UK SIC 2007 industry codes, for example 56101 (licensed restaurants), 62012 (software development), 41100 (property development). Companies with any of these codes are returned.", "default": [ "62012" ], "items": { "type": "string" } }, "location": { "title": "Registered office location", "type": "string", "description": "Full or partial registered office address: a town, county or postcode, for example 'Manchester' or 'EC2A'. This is a text match on the address, not a radius search.", "default": "London" }, "incorporatedWithinDays": { "title": "Incorporated in the last N days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Only companies incorporated in the last N days (new company leads). Ignored when 'Incorporated from' is set.", "default": 30 }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "Earliest incorporation date, YYYY-MM-DD." }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "Latest incorporation date, YYYY-MM-DD." }, "companyStatus": { "title": "Company status", "type": "array", "description": "Leave empty for every status.", "items": { "type": "string", "enum": [ "active", "dissolved", "open", "closed", "converted-closed", "removed", "receivership", "liquidation", "administration", "insolvency-proceedings", "voluntary-arrangement" ], "enumTitles": [ "Active", "Dissolved", "Open", "Closed", "Converted / closed", "Removed", "Receivership", "Liquidation", "Administration", "Insolvency proceedings", "Voluntary arrangement" ] }, "default": [ "active" ] }, "companyTypes": { "title": "Company types", "type": "array", "description": "Leave empty for every type.", "items": { "type": "string", "enum": [ "ltd", "plc", "llp", "limited-partnership", "private-limited-guarant-nsc", "private-unlimited", "community-interest-company", "charitable-incorporated-organisation", "registered-society-non-jurisdictional", "oversea-company", "registered-overseas-entity", "uk-establishment" ], "enumTitles": [ "Private limited company (Ltd)", "Public limited company (PLC)", "Limited liability partnership (LLP)", "Limited partnership", "Company limited by guarantee", "Private unlimited company", "Community interest company (CIC)", "Charitable incorporated organisation", "Registered society", "Overseas company", "Registered overseas entity", "UK establishment" ] } }, "companyNames": { "title": "Company name contains", "type": "array", "description": "Optional. One search per entry for companies whose name contains this text, combined with the filters above, for example 'bakery'.", "items": { "type": "string" } }, "nameExcludes": { "title": "Exclude names containing", "type": "string", "description": "Optional. Skip companies whose name contains this text, for example 'holdings'." }, "companyNumbers": { "title": "Company numbers", "type": "array", "description": "Optional. Exact company numbers to look up, for example 00445790 or SC123456. Each number returns one full company profile. When numbers are given, the search filters above are not run (unless you also enter names).", "items": { "type": "string" } }, "includeDetails": { "title": "Add accounts and filing deadlines", "type": "boolean", "description": "Also read each company's overview page: next accounts and confirmation statement dates, overdue flags, SIC descriptions and previous names. Slower (one extra page per company), same price.", "default": false }, "onlyNewCompanies": { "title": "Only companies not delivered in earlier runs", "type": "boolean", "description": "For scheduled runs: skip companies this input already returned in a previous run, so you pay only for new ones. The memory is kept per input in a named key-value store in your account.", "default": false }, "maxItems": { "title": "Max companies", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Stop after this many companies. You are charged per company, so this also caps the cost of the run.", "default": 100 } } }, "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 } } } } } } } } } }