{ "openapi": "3.0.1", "info": { "title": "Companies House API", "description": "Filter the free Companies House company data snapshot by name, company number, status, SIC code, postcode area and incorporation date. One row per UK company: type, SIC codes, registered office, filing dates. No API key, no officers or directors.", "version": "0.0", "x-build-id": "OeNmSukNwsT0e2sh3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/conserving_celerytop~uk-companies-house-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-conserving_celerytop-uk-companies-house-api", "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/conserving_celerytop~uk-companies-house-api/runs": { "post": { "operationId": "runs-sync-conserving_celerytop-uk-companies-house-api", "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/conserving_celerytop~uk-companies-house-api/run-sync": { "post": { "operationId": "run-sync-conserving_celerytop-uk-companies-house-api", "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": { "companyNames": { "title": "Company names or numbers", "maxItems": 50, "type": "array", "description": "Enter company names or company numbers, one per line. A name matches every company whose name contains all of its words, for example acme software. A number such as 12345678 or SC123456 returns that company. A company that matches any line is returned. Leave empty to use only the other filters.", "items": { "type": "string" } }, "companyStatus": { "title": "Company status", "enum": [ "active", "active_proposal_to_strike_off", "liquidation", "administration", "any" ], "type": "string", "description": "Keep only companies with this status on the register. The monthly snapshot lists live companies, so dissolved companies are not in it.", "default": "active" }, "sicCodes": { "title": "SIC codes", "maxItems": 50, "type": "array", "description": "Enter UK SIC 2007 codes, one per line. Use a full 5-digit code such as 62012 for software development, or a shorter start such as 62 for all computer programming and consultancy. A company matches if any of its listed SIC codes starts with one of your entries.", "items": { "type": "string" } }, "postcodeAreas": { "title": "Postcode areas", "maxItems": 50, "type": "array", "description": "Enter registered office postcode areas, one per line. Letters only, such as EC or SW, match the whole postcode area. An outward code such as EC1 or M1 matches that district only, so M1 does not return M11.", "items": { "type": "string" } }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "Keep only companies incorporated on or after this date. Use the format 2024-01-31." }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "Keep only companies incorporated on or before this date. Use the format 2024-12-31." }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many companies. The run ends as soon as the limit is reached, so small limits finish faster. Each company returned is one charged result.", "default": 25 } } }, "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 } } } } } } } } } }