{ "openapi": "3.0.1", "info": { "title": "UK Companies House New Companies Scraper & Monitor", "description": "Daily feed of newly incorporated UK companies from the official Companies House API. Filter by SIC code, location, company type and keywords; get only companies new since your last run. Bring your own free Companies House API key.", "version": "0.0", "x-build-id": "7C17SWH3CzIRBwv4N" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vocal_rhapsody~companies-house-new-companies/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vocal_rhapsody-companies-house-new-companies", "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/vocal_rhapsody~companies-house-new-companies/runs": { "post": { "operationId": "runs-sync-vocal_rhapsody-companies-house-new-companies", "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/vocal_rhapsody~companies-house-new-companies/run-sync": { "post": { "operationId": "run-sync-vocal_rhapsody-companies-house-new-companies", "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": { "apiKey": { "title": "Companies House API key", "type": "string", "description": "Your free API key from developer.company-information.service.gov.uk (register an application, choose a REST key). Optional if the Actor's environment already provides one." }, "sicCodes": { "title": "SIC codes (prefix match)", "type": "array", "description": "UK SIC 2007 codes. \"62\" matches every code starting with 62 (IT services); a full code such as \"62012\" matches exactly. Leave empty to include all industries. Prefixes are expanded to exact codes and sent to the API.", "items": { "type": "string" } }, "locations": { "title": "Registered office locations", "type": "array", "description": "Text such as \"London\", \"Manchester\" or a postcode district such as \"SL1\". A company is kept if its registered office address contains any entry. Leave empty for all of the UK.", "items": { "type": "string" } }, "companyTypes": { "title": "Company types", "type": "array", "description": "Companies House type codes, for example ltd, llp, plc, private-limited-guarant-nsc, limited-partnership. Leave empty for all types.", "items": { "type": "string" } }, "companyStatus": { "title": "Company status", "enum": [ "active", "dissolved", "liquidation", "administration", "any" ], "type": "string", "description": "Only companies with this status. Newly incorporated companies are normally active.", "default": "active" }, "keywords": { "title": "Name keywords", "type": "array", "description": "Case-insensitive text match on the company name. A company is kept if its name contains any entry. Leave empty to include all.", "items": { "type": "string" } }, "lookbackDays": { "title": "Incorporated in the last N days", "minimum": 1, "maximum": 90, "type": "integer", "description": "Companies incorporated from N days ago up to today. Maximum 90.", "default": 7 }, "onlyNew": { "title": "Only new since last run (turn on for scheduled monitoring)", "type": "boolean", "description": "Turn this on in your scheduled task to return only companies not seen in earlier runs with the same filters. The list of seen companies is kept per filter combination in the named key-value store \"companies-house-new-companies-state\" in your account. Off (the default) returns all matches in the window on every run.", "default": false }, "resetState": { "title": "Reset saved state", "type": "boolean", "description": "Forget which companies were already seen for these filters and treat this run as a first run. Only applies when \"Only new since last run\" is on.", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Stop after this many results. You are charged per result, so this keeps the cost of a run predictable. Newest incorporations come first; companies beyond the cap are returned on the next run when \"Only new since last run\" is on.", "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 } } } } } } } } } }