{ "openapi": "3.0.1", "info": { "title": "Companies House API: UK Company Search, Accounts and SIC", "description": "Search the UK Companies House register by name, SIC code, location, status, type or incorporation date, or look up company numbers. One row per company: registered office, SIC codes, accounts and confirmation statement dates, insolvency and charges flags. No directors or PSC.", "version": "0.1", "x-build-id": "zdWyrVVcsxkhG3dZe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/boubap~uk-companies-house/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-boubap-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/boubap~uk-companies-house/runs": { "post": { "operationId": "runs-sync-boubap-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/boubap~uk-companies-house/run-sync": { "post": { "operationId": "run-sync-boubap-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": { "query": { "title": "Company name contains", "type": "string", "description": "Words the company name must contain, for example bakery or Tesco. Leave empty to search by the other filters only. Set at least one of: this field, company numbers, SIC codes, location, company types or an incorporation date." }, "companyNumbers": { "title": "Company numbers", "type": "array", "description": "Companies House numbers to look up, one per line, for example 00445790 or SC123456. Short numbers are padded with zeros. When set, the search filters below are ignored and each number gives one row.", "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "Town, county or postcode of the registered office, for example Leeds, Kent or EC1A. Matched by Companies House against the registered office address." }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "SIC 2007 activity codes, 5 digits, one per line. Examples: 10710 (bakeries), 62012 (software development), 41100 (property development), 56101 (restaurants). Several codes combine with OR.", "items": { "type": "string" } }, "companyStatus": { "title": "Company status", "type": "array", "description": "Statuses to keep. Default: active. Clear the list to get any status. Pick liquidation or administration to find companies in insolvency.", "items": { "type": "string", "enum": [ "active", "dissolved", "liquidation", "administration", "receivership", "voluntary-arrangement", "insolvency-proceedings", "converted-closed", "open", "closed", "registered", "removed" ], "enumTitles": [ "Active", "Dissolved", "Liquidation", "Administration", "Receivership", "Voluntary arrangement", "Insolvency proceedings", "Converted or closed", "Open", "Closed", "Registered", "Removed" ] }, "default": [ "active" ] }, "companyTypes": { "title": "Company types", "type": "array", "description": "Legal forms to keep, for example Ltd and PLC. Leave empty for any type.", "items": { "type": "string", "enum": [ "ltd", "plc", "llp", "private-limited-guarant-nsc", "private-limited-guarant-nsc-limited-exemption", "private-unlimited", "limited-partnership", "scottish-partnership", "charitable-incorporated-organisation", "scottish-charitable-incorporated-organisation", "registered-society-non-jurisdictional", "uk-establishment", "oversea-company", "registered-overseas-entity", "royal-charter", "investment-company-with-variable-capital" ], "enumTitles": [ "Private limited company (Ltd)", "Public limited company (PLC)", "Limited liability partnership (LLP)", "Private company limited by guarantee", "Private company limited by guarantee, exempt from 'Limited'", "Private unlimited company", "Limited partnership", "Scottish partnership", "Charitable incorporated organisation", "Scottish charitable incorporated organisation", "Registered society", "UK establishment of an overseas company", "Overseas company", "Overseas entity", "Royal charter company", "Investment company with variable capital" ] } }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "Keep companies incorporated on or after this date (YYYY-MM-DD). Use it with the next field to list new companies of a month." }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "Keep companies incorporated on or before this date (YYYY-MM-DD)." }, "fullProfile": { "title": "Full company profile", "type": "boolean", "description": "Adds accounts dates and type, confirmation statement, jurisdiction and the insolvency, charges and liquidation flags. Costs one extra request per company: about 50 companies a minute on the shared key, 100 with your own key. Turn it off for fast lists with name, status, address, SIC codes and dates only. Always on for company numbers.", "default": true }, "includeFilings": { "title": "Latest accounts filings", "type": "boolean", "description": "Adds the last 5 accounts filings of each company: date filed, period end, accounts type, form and page count. No document is downloaded. One extra request per company, same price.", "default": false }, "maxResults": { "title": "Max companies", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Upper limit of companies returned and charged. Default 100. Up to 1,000 per run with the shared key, up to 10,000 with your own API key. For more, split the search by SIC code, location or date.", "default": 100 }, "apiKey": { "title": "Your Companies House API key (optional)", "type": "string", "description": "Optional. Your own REST API key from developer.company-information.service.gov.uk (free). Use it for runs above 1,000 companies or more than 5,000 requests a day (the shared key allows 1,000 companies per run and 5,000 requests a day per account). It is stored encrypted and never written to the logs or the dataset." } } }, "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 } } } } } } } } } }