{ "openapi": "3.0.1", "info": { "title": "UK Companies House Data by SIC Code & Postcode (Unofficial)", "description": "Unofficial tool. Build UK company lists from the Companies House Free Company Data Product: 5.7 million live companies. Filter by SIC code, postcode, town, county, incorporation date or company number. Company-level data only: no officers, no PSC, no street addresses. Updated monthly.", "version": "0.2", "x-build-id": "KGLvUfl3X0hab9eBa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/syntrovia~uk-company-register-companies-house/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-syntrovia-uk-company-register-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/syntrovia~uk-company-register-companies-house/runs": { "post": { "operationId": "runs-sync-syntrovia-uk-company-register-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/syntrovia~uk-company-register-companies-house/run-sync": { "post": { "operationId": "run-sync-syntrovia-uk-company-register-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": { "sicCodes": { "title": "SIC codes", "type": "array", "description": "SIC 2007 codes or code prefixes (2 to 5 digits). \"62012\" matches one code, \"620\" every code starting with 620, \"62\" the whole division. A company matches when any of its up to 4 codes matches.", "default": [], "items": { "type": "string" } }, "postcodeDistricts": { "title": "Postcode areas or districts", "type": "array", "description": "Registered office postcode area (letters only, for example \"M\" for Manchester or \"SW\") or district (outward code, for example \"SW1A\" or \"M1\"). Area \"M\" does not include \"ME\" or \"MK\".", "default": [], "items": { "type": "string" } }, "postTowns": { "title": "Post towns", "type": "array", "description": "Registered office post town as written in the register, for example \"MANCHESTER\" (not case sensitive). Towns shared by fewer than 10 companies are not published.", "default": [], "items": { "type": "string" } }, "counties": { "title": "Counties", "type": "array", "description": "Registered office county as written in the register, for example \"GREATER MANCHESTER\" (not case sensitive). Many companies leave the county empty, so a county filter finds fewer companies than a postcode area.", "default": [], "items": { "type": "string" } }, "incorporatedWithinDays": { "title": "Incorporated in the last N days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Companies incorporated in the N days before the snapshot date (the register is a monthly snapshot, see snapshotDate in the results). Use this or the two dates below, not both." }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "Earliest incorporation date, YYYY-MM-DD." }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "Latest incorporation date, YYYY-MM-DD." }, "companyNumbers": { "title": "Company numbers", "type": "array", "description": "Look up these companies (up to 5,000). Short numbers are padded: \"445790\" becomes \"00445790\", \"SC1234\" becomes \"SC001234\". Dissolved companies are not in the register snapshot.", "default": [], "items": { "type": "string" } }, "nameContains": { "title": "Company name contains", "type": "array", "description": "Keep companies whose name contains any of these words or phrases (not case sensitive).", "default": [], "items": { "type": "string" } }, "companyStatuses": { "title": "Company statuses", "type": "array", "description": "Exact statuses as published, for example \"Active\", \"Active - Proposal to Strike off\", \"Liquidation\", \"In Administration\". Empty keeps all.", "default": [], "items": { "type": "string" } }, "companyCategories": { "title": "Company types", "type": "array", "description": "Exact company categories as published, for example \"Private Limited Company\", \"Limited Liability Partnership\", \"Community Interest Company\", \"Public Limited Company\". Empty keeps all.", "default": [], "items": { "type": "string" } }, "accountsCategories": { "title": "Accounts categories", "type": "array", "description": "Category of the last accounts filed, for example \"MICRO ENTITY\", \"TOTAL EXEMPTION FULL\", \"SMALL\", \"FULL\", \"GROUP\", \"NO ACCOUNTS FILED\". Empty keeps all.", "default": [], "items": { "type": "string" } }, "excludeDormant": { "title": "Leave out dormant companies", "type": "boolean", "description": "Drops companies whose last accounts were filed as DORMANT.", "default": false }, "maxItems": { "title": "Maximum companies", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "The run stops after saving this many companies.", "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 }, "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 } } } } } } } } } }