{ "openapi": "3.0.1", "info": { "title": "Uk Companies House Advanced Search", "description": "Search UK Companies House advanced company search for companies matching user-specified name/status/incorporation-date criteria and return structured company records (company name, company number, status, incorporation date, registered office address).", "version": "0.0", "x-build-id": "XLRkijYvC7ButdcpZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gettingtechnicl~uk-companies-house-advanced-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gettingtechnicl-uk-companies-house-advanced-search", "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/gettingtechnicl~uk-companies-house-advanced-search/runs": { "post": { "operationId": "runs-sync-gettingtechnicl-uk-companies-house-advanced-search", "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/gettingtechnicl~uk-companies-house-advanced-search/run-sync": { "post": { "operationId": "run-sync-gettingtechnicl-uk-companies-house-advanced-search", "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": { "company_name_includes": { "title": "Company name includes", "type": "string", "description": "Return companies whose name contains this text (partial match supported)." }, "company_name_excludes": { "title": "Company name excludes", "type": "string", "description": "Exclude companies whose name contains this text." }, "registered_office_address": { "title": "Registered office address", "type": "string", "description": "Full or partial registered office address to filter by." }, "incorporation_date_from": { "title": "Incorporation date from", "type": "string", "description": "Earliest incorporation date to include, in YYYY-MM-DD format." }, "incorporation_date_to": { "title": "Incorporation date to", "type": "string", "description": "Latest incorporation date to include, in YYYY-MM-DD format." }, "dissolved_date_from": { "title": "Dissolved date from", "type": "string", "description": "Earliest dissolution date to include, in YYYY-MM-DD format." }, "dissolved_date_to": { "title": "Dissolved date to", "type": "string", "description": "Latest dissolution date to include, in YYYY-MM-DD format." }, "status": { "title": "Company status", "type": "array", "description": "Filter by one or more company statuses; leave empty to include all.", "items": { "type": "string", "enum": [ "activeCompanies", "dissolvedCompanies", "openCompanies", "closedCompanies", "convertedClosedCompanies", "removedCompanies", "receivershipCompanies", "liquidationCompanies", "administrationCompanies", "insolvencyProceedingsCompanies", "voluntaryArrangementCompanies" ], "enumTitles": [ "Active", "Dissolved", "Open", "Closed", "Converted closed", "Removed", "Receivership", "Liquidation", "Administration", "Insolvency proceedings", "Voluntary arrangement" ] }, "default": [] }, "company_type": { "title": "Company type", "type": "array", "description": "Filter by one or more company types; leave empty to include all.", "items": { "type": "string", "enum": [ "assurance-company", "charitable-incorporated-organisation", "converted-or-closed", "eeig", "european-public-limited-liability-company-se", "further-education-or-sixth-form-college-corporation", "industrial-and-provident-society", "icvc", "llp", "limited-partnership", "old-public-company", "oversea-company", "registered-overseas-entity", "private-limited-guarant-nsc", "ltd", "private-limited-guarant-nsc-limited-exemption", "private-limited-shares-section-30-exemption", "private-unlimited", "private-unlimited-nsc", "protected-cell-company", "plc", "registered-society-non-jurisdictional", "royal-charter", "scottish-charitable-incorporated-organisation", "scottish-partnership", "uk-establishment", "unregistered-company" ], "enumTitles": [ "Assurance company", "Charitable incorporated organisation", "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", "Limited liability partnership", "Limited partnership", "Old public company", "Overseas company", "Overseas entity", "Private limited by guarantee without share capital", "Private limited company", "Private Limited Company by guarantee without share capital, use of 'Limited' exemption", "Private Limited Company, use of 'Limited' exemption", "Private unlimited company", "Private unlimited company without share capital", "Protected cell company", "Public limited company", "Registered society", "Royal charter company", "Scottish charitable incorporated organisation", "Scottish qualifying partnership", "UK establishment company", "Unregistered company" ] }, "default": [] }, "company_subtype": { "title": "Company subtype", "type": "array", "description": "Filter by one or more company subtypes; leave empty to include all.", "items": { "type": "string", "enum": [ "community-interest-company", "private-fund-limited-partnership" ], "enumTitles": [ "Community interest company", "Private fund limited partnership" ] }, "default": [] }, "sic_codes": { "title": "SIC codes", "type": "array", "description": "One or more Standard Industrial Classification (SIC) codes to filter by nature of business.", "items": { "type": "string" } }, "max_items": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Hard cap on the total number of company records saved.", "default": 100 }, "deep_crawl": { "title": "Deep crawl", "type": "boolean", "description": "Visit each result's detail page to extract additional fields such as registered address and SIC codes.", "default": true }, "max_detail_pages": { "title": "Max detail pages", "type": "integer", "description": "Cap on the number of detail pages visited when deep crawl is enabled.", "default": 25 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Optional Apify Proxy configuration. Leave unset to run without a proxy (default: no proxy, no extra traffic cost)." } } }, "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 } } } } } } } } } }