{ "openapi": "3.0.1", "info": { "title": "UK Companies House Search: New Companies by SIC & Postcode", "description": "🇬🇧 Fresh UK business leads every month. Search all 5.5 million live companies in the official Companies House data and pull new companies by SIC code, postcode or town, with registered address, accounts due dates and previous names. Get only companies you haven't seen yet.", "version": "0.1", "x-build-id": "ORcpekzKUJDFiye8N" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yodeling_november~uk-companies-house-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yodeling_november-uk-companies-house-search", "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/yodeling_november~uk-companies-house-search/runs": { "post": { "operationId": "runs-sync-yodeling_november-uk-companies-house-search", "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/yodeling_november~uk-companies-house-search/run-sync": { "post": { "operationId": "run-sync-yodeling_november-uk-companies-house-search", "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": { "incorporatedWithinDays": { "title": "Incorporated within (days)", "minimum": 0, "type": "integer", "description": "Companies incorporated in this many days before the snapshot date. The snapshot covers the register up to the end of the previous month. 0 means any date, unless you set the dates below.", "default": 31 }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "Optional (YYYY-MM-DD). Replaces 'Incorporated within'." }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "Optional (YYYY-MM-DD)." }, "sicCodes": { "title": "SIC codes (prefixes)", "type": "array", "description": "Optional. SIC 2007 codes or prefixes: 62 (IT), 56101 (restaurants), 41 (construction of buildings), 68 (real estate).", "items": { "type": "string" } }, "postcodePrefixes": { "title": "Postcodes", "type": "array", "description": "Optional. Postcode area (SW, M), district (SW1, M1, EC1A) or full postcode of the registered office.", "items": { "type": "string" } }, "postTowns": { "title": "Post towns", "type": "array", "description": "Optional. E.g. London, Manchester, Edinburgh.", "items": { "type": "string" } }, "statuses": { "title": "Statuses", "type": "array", "description": "Default Active. Others: Active - Proposal to Strike off, Liquidation, In Administration, Voluntary Arrangement. Empty means every live company.", "default": [ "Active" ], "items": { "type": "string" } }, "categories": { "title": "Company categories", "type": "array", "description": "Optional. Partial match, e.g. Private Limited Company, Public Limited Company, Limited Liability Partnership, Community Interest Company.", "items": { "type": "string" } }, "nameKeywords": { "title": "Name contains", "type": "array", "description": "Optional. Words in the company name.", "items": { "type": "string" } }, "maxResults": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Newest incorporations first. 0 means no cap.", "default": 1000 }, "mode": { "title": "Mode", "enum": [ "snapshot", "new" ], "type": "string", "description": "New returns only companies not delivered before for the same Monitor ID. Schedule it monthly (the snapshot is refreshed within 5 working days of each month end).", "default": "snapshot" }, "monitorId": { "title": "Monitor ID", "type": "string", "description": "Name for the saved state in New mode.", "default": "default" } } }, "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 } } } } } } } } } }