{ "openapi": "3.0.1", "info": { "title": "New UK Companies Scraper - Companies House Incorporations", "description": "Every company Companies House registered on the days you pick: name, number, status, type, incorporation date, SIC codes with descriptions, and the full registered office address with its postcode. Filter by SIC code, town, company type or status. No API key or login.", "version": "0.1", "x-build-id": "wenfeoZQYSW7poKHG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dami_studio~companies-house-new-companies-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dami_studio-companies-house-new-companies-scraper", "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/dami_studio~companies-house-new-companies-scraper/runs": { "post": { "operationId": "runs-sync-dami_studio-companies-house-new-companies-scraper", "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/dami_studio~companies-house-new-companies-scraper/run-sync": { "post": { "operationId": "run-sync-dami_studio-companies-house-new-companies-scraper", "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": { "incorporatedFrom": { "title": "Incorporated from", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "The first day, as YYYY-MM-DD. Leave it empty to use Last days instead." }, "incorporatedTo": { "title": "Incorporated to", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "The last day. Leave it empty to run up to today. Today's list keeps growing while Companies House registers new companies, so end at yesterday if you only want complete days." }, "lastDays": { "title": "Last days", "minimum": 1, "maximum": 366, "type": "integer", "description": "Used when Incorporated from is empty: the last N full days, ending yesterday. 1 means yesterday only, which suits a daily schedule." }, "companyNameIncludes": { "title": "Company name contains", "type": "string", "description": "Whole words, like consulting or property management. A name has to hold every word, in any order, and capitals don't matter. Part of a word doesn't count, so consult won't find CONSULTING." }, "companyNameExcludes": { "title": "Leave out names containing", "type": "string", "description": "Drops any company whose name has one of these words, for example ltd or holdings. Whole words again: tech leaves out DELTA TECH LTD but keeps DELTA TECHNOLOGIES LTD." }, "sicCodes": { "title": "SIC codes", "maxItems": 20, "type": "array", "description": "Only companies registered under one of these five-digit codes, for example 62012 for software development. Leave it empty for every trade. Each code is a separate search on Companies House, and a company listed under two of your codes comes back once.", "items": { "type": "string" } }, "location": { "title": "Registered office address contains", "type": "string", "description": "A town or county, such as Manchester. Companies House matches it against the whole registered office address, county included, so Salford companies show up for Manchester." }, "companyTypes": { "title": "Company types", "type": "array", "description": "Leave it empty for all types. Nearly every new company is a private limited company.", "items": { "type": "string", "enum": [ "ltd", "llp", "plc", "private-limited-guarant-nsc", "private-limited-guarant-nsc-limited-exemption", "private-limited-shares-section-30-exemption", "private-unlimited", "private-unlimited-nsc", "limited-partnership", "scottish-partnership", "charitable-incorporated-organisation", "scottish-charitable-incorporated-organisation", "registered-overseas-entity", "oversea-company", "uk-establishment", "assurance-company", "converted-or-closed", "eeig", "european-public-limited-liability-company-se", "further-education-or-sixth-form-college-corporation", "industrial-and-provident-society", "icvc", "old-public-company", "protected-cell-company", "registered-society-non-jurisdictional", "royal-charter", "unregistered-company" ], "enumTitles": [ "Private limited company", "Limited liability partnership", "Public limited company", "Private limited by guarantee without share capital", "Private limited by guarantee without share capital, using the 'Limited' exemption", "Private limited company, using the 'Limited' exemption", "Private unlimited company", "Private unlimited company without share capital", "Limited partnership", "Scottish qualifying partnership", "Charitable incorporated organisation", "Scottish charitable incorporated organisation", "Overseas entity", "Overseas company", "UK establishment company", "Assurance company", "Converted or closed", "European Economic Interest Grouping (EEIG)", "European public limited liability company (SE)", "Further education or sixth form college corporation", "Industrial and Provident society", "Investment company with variable capital", "Old public company", "Protected cell company", "Registered society", "Royal charter company", "Unregistered company" ] } }, "companySubtypes": { "title": "Company subtype", "type": "array", "description": "Leave it empty for any subtype. Most companies have none. These are the two Companies House lets you search by.", "items": { "type": "string", "enum": [ "community-interest-company", "private-fund-limited-partnership" ], "enumTitles": [ "Community interest company (CIC)", "Private fund limited partnership (PFLP)" ] } }, "companyStatus": { "title": "Company status", "type": "array", "description": "Leave it empty for any status. Almost every company in a recent range is active; older ranges also hold dissolved ones.", "items": { "type": "string", "enum": [ "active", "dissolved", "liquidation", "administration", "receivership", "insolvency-proceedings", "voluntary-arrangement", "open", "closed", "converted-closed", "removed" ], "enumTitles": [ "Active", "Dissolved", "Liquidation", "Administration", "Receivership", "Insolvency proceedings", "Voluntary arrangement", "Open", "Closed", "Converted closed", "Removed" ] } }, "dissolvedFrom": { "title": "Dissolved from", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "Only companies dissolved on or after this day, out of those incorporated on your days. Companies House lists dissolutions from 1 January 2010 on." }, "dissolvedTo": { "title": "Dissolved to", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "Only companies dissolved on or before this day. A company dissolved in your range and restored to the register since comes back too, with its current status and no dissolution date." }, "maxCompanies": { "title": "Maximum companies", "minimum": 1, "maximum": 50000, "type": "integer", "description": "The most companies returned in one run, across all days. Each company returned is one charge.", "default": 1000 } } }, "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 } } }, "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 } } } } } } } } } }