{ "openapi": "3.0.1", "info": { "title": "UK Companies House - Company Register", "description": "The whole UK company register from Companies House's official open bulk data (~5.7M live companies, OGL v3): name, number, status, category, registered address, incorporation date, SIC codes, previous names, accounts and confirmation-statement dates, mortgages. Search, look up, or aggregate.", "version": "0.0", "x-build-id": "uQMpsReoyE2g31DKP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/j0401~uk-companies-house/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-j0401-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/j0401~uk-companies-house/runs": { "post": { "operationId": "runs-sync-j0401-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/j0401~uk-companies-house/run-sync": { "post": { "operationId": "run-sync-j0401-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": { "mode": { "title": "Mode", "enum": [ "", "search", "company", "aggregate" ], "type": "string", "description": "search = filter the register. company = one exact company number. aggregate = one row per group. Leave blank to auto-route: filters -> search, a bare companyNumber -> company, no filters -> aggregate." }, "companyNumber": { "title": "Company number", "type": "string", "description": "Exact Companies House company number, e.g. \"08209948\", \"SC123456\" or \"OC123456\"." }, "companyName": { "title": "Company name", "type": "string", "description": "Company name substring, case-insensitive (e.g. \"TESCO\" or \"PROPERTY CHEST\")." }, "status": { "title": "Company status", "type": "string", "description": "Exact status, e.g. \"Active\", \"Active - Proposal to Strike off\", \"Liquidation\" or \"In Administration\"." }, "category": { "title": "Company category", "type": "string", "description": "Exact company category, e.g. \"Private Limited Company\", \"Limited Liability Partnership\" or \"Public Limited Company\"." }, "sicCode": { "title": "SIC code", "type": "string", "description": "SIC code or prefix, matched against any of the company's four SIC codes. Digits only: \"62020\" (IT consultancy) or \"62\" (information and communication)." }, "postcode": { "title": "Postcode prefix", "type": "string", "description": "Registered-office postcode prefix (must contain at least one digit), e.g. \"HG1\" or \"EC2A\"." }, "countryOfOrigin": { "title": "Country of origin", "type": "string", "description": "Exact country of origin, e.g. \"United Kingdom\" (the value carried by most companies on the register)." }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "Earliest incorporation date (YYYY-MM-DD), inclusive." }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "Latest incorporation date (YYYY-MM-DD), inclusive." }, "activeOnly": { "title": "Active companies only", "type": "boolean", "description": "When on, keeps statuses starting with \"Active\" (including \"Active - Proposal to Strike off\"). Off adds no predicate.", "default": false }, "aggregate": { "title": "Aggregate instead of records", "type": "boolean", "description": "When on, returns one summary record per group with count, instead of individual companies.", "default": false }, "groupBy": { "title": "Aggregate by", "enum": [ "status", "category", "sicSection", "incorporationYear", "countryOfOrigin", "accountsCategory" ], "type": "string", "description": "status -> live vs strike-off vs liquidation; category -> legal form; sicSection -> first two SIC digits; incorporationYear -> registrations by year; countryOfOrigin; accountsCategory -> accounts type.", "default": "status" }, "maxResults": { "title": "Max records", "minimum": 0, "type": "integer", "description": "Cap the number of search records pushed (0 = the default ceiling of 50, maximum 5000). Aggregate returns every group.", "default": 50 } } }, "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 } } } } } } } } } }