{ "openapi": "3.0.1", "info": { "title": "UK Companies House Scraper: New Company Incorporations", "description": "Returns new UK company incorporations from Companies House: company number, name, status, type, incorporation date, registered office address and SIC codes. Filter by date, SIC code, postcode and company type. Add your own free API key for live daily data and filing events.", "version": "1.0", "x-build-id": "dxkO8iStlucREDQJk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/agents001~uk-companies-house-feed/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-agents001-uk-companies-house-feed", "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/agents001~uk-companies-house-feed/runs": { "post": { "operationId": "runs-sync-agents001-uk-companies-house-feed", "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/agents001~uk-companies-house-feed/run-sync": { "post": { "operationId": "run-sync-agents001-uk-companies-house-feed", "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": "What to return", "enum": [ "companies", "filings" ], "type": "string", "description": "'companies' returns one record per company (new incorporations, or the companies you list). 'filings' returns one record per filing event (accounts, confirmation statements, charges, insolvency, strike-off notices and more) and needs your API key.", "default": "companies" }, "incorporatedWithinDays": { "title": "Incorporated in the last N days", "minimum": 0, "maximum": 36500, "type": "integer", "description": "Only companies incorporated within this many days. With an API key the days count back from today. Without a key they count back from the date of the monthly snapshot. 0 means any date. Ignored when you set the dates below or list company numbers.", "default": 30 }, "incorporatedFrom": { "title": "Incorporated from (date)", "type": "string", "description": "Start of a fixed incorporation date range, YYYY-MM-DD. Overrides 'last N days'." }, "incorporatedTo": { "title": "Incorporated to (date)", "type": "string", "description": "End of a fixed incorporation date range, YYYY-MM-DD." }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "Only companies with any of these SIC 2007 codes. Give a full 5-digit code (62012) or a shorter prefix for a whole group (62 matches every computer programming and consultancy code).", "items": { "type": "string" } }, "postcodePrefixes": { "title": "Registered office postcode starts with", "type": "array", "description": "Only companies whose registered office postcode is in any of these areas, districts or sectors. 'M' is all Manchester postcodes, 'EC1' is EC1 and its sub-districts (EC1A, EC1M, EC1V), 'SW1A 1' is one sector. 'M1' does not match M14.", "items": { "type": "string" } }, "companyTypes": { "title": "Company types", "type": "array", "description": "Only these company types. Leave empty for all types.", "items": { "type": "string", "enum": [ "private-unlimited", "ltd", "plc", "old-public-company", "private-limited-guarant-nsc-limited-exemption", "limited-partnership", "private-limited-guarant-nsc", "converted-or-closed", "private-unlimited-nsc", "private-limited-shares-section-30-exemption", "protected-cell-company", "assurance-company", "oversea-company", "eeig-establishment", "icvc-securities", "icvc-warrant", "icvc-umbrella", "registered-society-non-jurisdictional", "industrial-and-provident-society", "northern-ireland", "northern-ireland-other", "llp", "royal-charter", "investment-company-with-variable-capital", "unregistered-company", "other", "european-public-limited-liability-company-se", "united-kingdom-societas", "uk-establishment", "scottish-partnership", "charitable-incorporated-organisation", "scottish-charitable-incorporated-organisation", "further-education-or-sixth-form-college-corporation", "eeig", "ukeig", "registered-overseas-entity", "community-interest-company" ], "enumTitles": [ "Private unlimited company (private-unlimited)", "Private limited company (ltd)", "Public limited company (plc)", "Old public company (old-public-company)", "Private Limited Company by guarantee without share capital, use of 'Limited' exemption (private-limited-guarant-nsc-limited-exemption)", "Limited partnership (limited-partnership)", "Private limited by guarantee without share capital (private-limited-guarant-nsc)", "Converted / closed (converted-or-closed)", "Private unlimited company without share capital (private-unlimited-nsc)", "Private Limited Company, use of 'Limited' exemption (private-limited-shares-section-30-exemption)", "Protected cell company (protected-cell-company)", "Assurance company (assurance-company)", "Overseas company (oversea-company)", "European Economic Interest Grouping Establishment (EEIG) (eeig-establishment)", "Investment company with variable capital (icvc-securities)", "Investment company with variable capital (icvc-warrant)", "Investment company with variable capital (icvc-umbrella)", "Registered society (registered-society-non-jurisdictional)", "Industrial and Provident society (industrial-and-provident-society)", "Northern Ireland company (northern-ireland)", "Credit union (Northern Ireland) (northern-ireland-other)", "Limited liability partnership (llp)", "Royal charter company (royal-charter)", "Investment company with variable capital (investment-company-with-variable-capital)", "Unregistered company (unregistered-company)", "Other company type (other)", "European public limited liability company (SE) (european-public-limited-liability-company-se)", "United Kingdom Societas (united-kingdom-societas)", "UK establishment company (uk-establishment)", "Scottish qualifying partnership (scottish-partnership)", "Charitable incorporated organisation (charitable-incorporated-organisation)", "Scottish charitable incorporated organisation (scottish-charitable-incorporated-organisation)", "Further education or sixth form college corporation (further-education-or-sixth-form-college-corporation)", "European Economic Interest Grouping (EEIG) (eeig)", "United Kingdom Economic Interest Grouping (ukeig)", "Overseas entity (registered-overseas-entity)", "Community interest company (CIC) (community-interest-company)" ] } }, "companyStatuses": { "title": "Company status", "type": "array", "description": "Only companies with these statuses. Leave empty for all. The monthly snapshot holds live companies only, so 'dissolved' needs an API key.", "items": { "type": "string", "enum": [ "active", "liquidation", "administration", "receivership", "voluntary-arrangement", "insolvency-proceedings", "dissolved" ], "enumTitles": [ "Active", "Liquidation", "In Administration", "Receiver Action", "Voluntary Arrangement", "Insolvency Proceedings", "Dissolved" ] } }, "companyNumbers": { "title": "Company numbers", "type": "array", "description": "Look up these companies by number instead of searching (for example 00445790 or SC123456). The other company filters are then ignored. In filings mode these are the companies whose filings you get. Without an API key, up to 500 numbers per run.", "items": { "type": "string" } }, "filingCategories": { "title": "Filing categories", "type": "array", "description": "Filings mode only. Leave empty for every category. Officer and PSC filings are never returned because they are about individuals.", "items": { "type": "string", "enum": [ "accounts", "confirmation-statement", "annual-return", "incorporation", "change-of-name", "address", "capital", "mortgage", "resolution", "liquidation", "insolvency", "gazette", "auditors", "change-of-constitution", "miscellaneous" ], "enumTitles": [ "Accounts", "Confirmation statements", "Annual returns (before 2016)", "Incorporation", "Change of name", "Registered office address changes", "Share capital", "Charges (mortgages)", "Resolutions", "Liquidation", "Insolvency", "Gazette notices (strike-off)", "Auditors", "Change of constitution", "Miscellaneous" ] } }, "filedWithinDays": { "title": "Filed in the last N days", "minimum": 0, "maximum": 36500, "type": "integer", "description": "Filings mode only. Only filings made within this many days. 0 means all filings.", "default": 30 }, "maxCompaniesForFilings": { "title": "Maximum companies to check for filings", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Filings mode without company numbers: how many companies from the search to read filings for. Each company is one or more API requests.", "default": 100 }, "apiKey": { "title": "Your Companies House API key", "type": "string", "description": "Optional. A free REST API key from the Companies House Developer Hub (developer.company-information.service.gov.uk). With a key you get live data, dissolved companies and filing events. Without it the Actor uses the free monthly snapshot of live companies. The key is stored encrypted and only sent to the Companies House API." }, "onlyNew": { "title": "Only records not seen in previous runs", "type": "boolean", "description": "Remember which companies or filings were already returned for this exact input and only return new ones. The first run returns everything that matches. Ideal for scheduled daily runs. Changing the filters starts a fresh history.", "default": false }, "maxItems": { "title": "Maximum records", "minimum": 0, "type": "integer", "description": "Stop after this many records. 0 means no limit. You pay per record returned.", "default": 1000 }, "stateStoreName": { "title": "State store name", "pattern": "^[a-zA-Z0-9-]{1,63}$", "type": "string", "description": "Only used when 'Only records not seen in previous runs' is on. Name of the key-value store in your account that keeps the onlyNew history. Each different input gets its own record inside it. If a run reports that it cannot open the store, enter a different name here.", "default": "agents001-uk-companies-house-feed-state" }, "requestDelaySecs": { "title": "Delay between API requests", "minimum": 0.5, "maximum": 10, "type": "number", "description": "Minimum seconds between Companies House API requests. The API allows 600 requests per 5 minutes per key, so keep this at 0.5 or more.", "default": 0.55 } } }, "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 } } } } } } } } } }