{ "openapi": "3.0.1", "info": { "title": "UK New Company Incorporations Companies House", "description": "Monitor newly incorporated UK companies straight from the official Companies House register. Filter by industry (SIC code), location, and date window. Get back clean, structured company records with registered office addresses and, optionally, full director details.", "version": "0.1", "x-build-id": "NDKtLoXffvFqvmBeB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/devon_gtme~uk-new-company-incorporations-uk-companies-house-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-devon_gtme-uk-new-company-incorporations-uk-companies-house-data", "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/devon_gtme~uk-new-company-incorporations-uk-companies-house-data/runs": { "post": { "operationId": "runs-sync-devon_gtme-uk-new-company-incorporations-uk-companies-house-data", "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/devon_gtme~uk-new-company-incorporations-uk-companies-house-data/run-sync": { "post": { "operationId": "run-sync-devon_gtme-uk-new-company-incorporations-uk-companies-house-data", "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", "required": [ "apiKey" ], "properties": { "apiKey": { "title": "Companies House API Key", "type": "string", "description": "Your free Companies House API key. Create one in 2 minutes at https://developer.company-information.service.gov.uk/ — register, create an application, copy the REST API key." }, "daysBack": { "title": "Days Back", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Find companies incorporated in the last N days. Ignored if you set explicit dates below.", "default": 7 }, "incorporatedFrom": { "title": "Incorporated From (YYYY-MM-DD)", "type": "string", "description": "Explicit start date. Overrides Days Back when set." }, "incorporatedTo": { "title": "Incorporated To (YYYY-MM-DD)", "type": "string", "description": "Explicit end date. Defaults to today." }, "sicCodes": { "title": "SIC Codes (industry filter)", "type": "array", "description": "Filter by industry SIC codes, e.g. 43999 (specialised construction), 56101 (restaurants), 62012 (software). Leave empty for all industries. Full list: resources.companieshouse.gov.uk/sic/", "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "Filter by registered office location, e.g. 'Manchester', 'London', or a postcode area. Matches against the registered office address." }, "companyStatuses": { "title": "Company Status", "type": "array", "description": "Company statuses to include. New incorporations are almost always 'active'.", "items": { "type": "string", "enum": [ "active", "dissolved", "liquidation", "administration", "voluntary-arrangement", "receivership" ] }, "default": [ "active" ] }, "includeOfficers": { "title": "Include Officers (directors)", "type": "boolean", "description": "Fetch the officer list (directors) for each company — names, roles, appointment dates, nationality, occupation. Slower: one extra API call per company.", "default": false }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum companies to return. The Companies House search API can return at most 10,000 results per query — narrow with SIC codes or location if you hit that.", "default": 500 } } }, "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 } } } } } } } } } }