{ "openapi": "3.0.1", "info": { "title": "UK Companies House: Company Search, Directors, Owners", "description": "Search the official UK company register: company profiles, status, SIC codes, registered address, accounts and confirmation deadlines, directors and persons with significant control. Find newly incorporated companies by area and industry.", "version": "1.0", "x-build-id": "9ZHAVWxA8TCfT52Qb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pushbuild~uk-companies-house/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pushbuild-uk-companies-house", "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/pushbuild~uk-companies-house/runs": { "post": { "operationId": "runs-sync-pushbuild-uk-companies-house", "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/pushbuild~uk-companies-house/run-sync": { "post": { "operationId": "run-sync-pushbuild-uk-companies-house", "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": { "companyNumbers": { "title": "Company numbers", "type": "array", "description": "Look up these companies directly, e.g. 00445790. When set, the search fields below are ignored.", "items": { "type": "string" } }, "query": { "title": "Name search", "type": "string", "description": "Free-text company name search ranked by relevance (up to 1,000 results)." }, "nameIncludes": { "title": "Name includes", "type": "string", "description": "Filtered search: company name contains this text." }, "nameExcludes": { "title": "Name excludes", "type": "string", "description": "Filtered search: company name does not contain this text." }, "location": { "title": "Location", "type": "string", "description": "Town, city or postcode of the registered office, e.g. Leeds or M1." }, "statuses": { "title": "Statuses", "type": "array", "description": "e.g. active, dissolved, liquidation, administration.", "items": { "type": "string" } }, "companyTypes": { "title": "Company types", "type": "array", "description": "e.g. ltd, plc, llp, private-limited-guarant-nsc.", "items": { "type": "string" } }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "Industry codes, e.g. 62020 (IT consultancy), 56101 (restaurants).", "items": { "type": "string" } }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "YYYY-MM-DD. Use with Incorporated to for new-company lead lists." }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "YYYY-MM-DD." }, "dissolvedFrom": { "title": "Dissolved from", "type": "string", "description": "YYYY-MM-DD." }, "dissolvedTo": { "title": "Dissolved to", "type": "string", "description": "YYYY-MM-DD." }, "includeDetails": { "title": "Include full details for search results", "type": "boolean", "description": "Fetch profile, directors and owners for every search result (slower). Always on for company numbers.", "default": false }, "includeOfficers": { "title": "Include directors", "type": "boolean", "description": "Current officers with role, appointment date, nationality and occupation.", "default": true }, "includeResignedOfficers": { "title": "Include resigned officers", "type": "boolean", "description": "Also list officers who have resigned.", "default": false }, "includeOwners": { "title": "Include owners", "type": "boolean", "description": "Current persons with significant control and their natures of control.", "default": true }, "includeFilings": { "title": "Include recent filings", "type": "boolean", "description": "The 25 most recent filings.", "default": false }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum companies returned.", "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 } } } } } } } } } }