{ "openapi": "3.0.1", "info": { "title": "UK Companies House Scraper: Directors & PSCs", "description": "Scrape UK Companies House profiles, directors, PSCs (beneficial owners), filings and charges. Search live records, filter monthly bulk data by SIC code or monitor new companies.", "version": "90.10", "x-build-id": "VCCeamEYWSWZ8GpSe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/danthedataman~uk-company-register-ledger/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-danthedataman-uk-company-register-ledger", "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/danthedataman~uk-company-register-ledger/runs": { "post": { "operationId": "runs-sync-danthedataman-uk-company-register-ledger", "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/danthedataman~uk-company-register-ledger/run-sync": { "post": { "operationId": "run-sync-danthedataman-uk-company-register-ledger", "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": "mode", "enum": [ "live", "bulk" ], "type": "string", "description": "Live public register or official monthly bulk snapshot." }, "companyNumbers": { "title": "companyNumbers", "maxItems": 5000, "type": "array", "description": "Exact eight-character company numbers; at most 5000.", "items": { "type": "string" } }, "startUrls": { "title": "startUrls", "type": "array", "description": "Company, keyword search or advanced-search register URLs.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchQueries": { "title": "searchQueries", "type": "array", "description": "Company-name keywords; follows result continuations.", "items": { "type": "string" } }, "sicCodes": { "title": "sicCodes", "type": "array", "description": "Exact SIC codes for live advanced search. In live mode, this also starts an additional register-wide advanced search combined with other selectors and filters all live candidates.", "items": { "type": "string" } }, "companyTypes": { "title": "companyTypes", "type": "array", "description": "Source company type codes, e.g. ltd, plc, llp. In live mode, this also starts an additional register-wide advanced search combined with other selectors and filters all live candidates.", "items": { "type": "string" } }, "companyStatus": { "title": "companyStatus", "type": "array", "description": "Live status codes, e.g. active, dissolved. In live mode, this also starts an additional register-wide advanced search combined with other selectors and filters all live candidates.", "items": { "type": "string" } }, "sicCodePrefixes": { "title": "sicCodePrefixes", "type": "array", "description": "Bulk SIC prefixes, OR within this filter.", "items": { "type": "string" } }, "sicKeywords": { "title": "sicKeywords", "type": "array", "description": "Bulk SIC description substrings, case-insensitive OR.", "items": { "type": "string" } }, "companyStatuses": { "title": "companyStatuses", "type": "array", "description": "Bulk status equality, case-insensitive OR; empty means every status.", "items": { "type": "string" } }, "companyCategories": { "title": "companyCategories", "type": "array", "description": "Bulk legal category equality, case-insensitive OR.", "items": { "type": "string" } }, "postCodePrefixes": { "title": "postCodePrefixes", "type": "array", "description": "Bulk postcode prefixes, case-insensitive OR.", "items": { "type": "string" } }, "postTowns": { "title": "postTowns", "type": "array", "description": "Bulk post town equality, case-insensitive OR.", "items": { "type": "string" } }, "counties": { "title": "counties", "type": "array", "description": "Bulk county substrings, case-insensitive OR.", "items": { "type": "string" } }, "countries": { "title": "countries", "type": "array", "description": "Bulk country substrings, case-insensitive OR.", "items": { "type": "string" } }, "location": { "title": "location", "type": "string", "description": "Live registered office address text. In live mode, this also starts an additional register-wide advanced search combined with other selectors and filters all live candidates." }, "companyNameIncludes": { "title": "companyNameIncludes", "type": "string", "description": "Live name substring to include. In live mode, this also starts an additional register-wide advanced search combined with other selectors and filters all live candidates." }, "companyNameExcludes": { "title": "companyNameExcludes", "type": "string", "description": "Live name substring to exclude. In live mode, this also starts an additional register-wide advanced search combined with other selectors and filters all live candidates." }, "snapshotMonth": { "title": "snapshotMonth", "type": "string", "description": "Bulk month YYYY-MM; empty selects latest official snapshot." }, "nameContains": { "title": "nameContains", "type": "string", "description": "Bulk company name substring, case-insensitive." }, "incorporatedFrom": { "title": "incorporatedFrom", "type": "string", "description": "Live inclusive earliest incorporation date. Use YYYY-MM-DD. In live mode, this also starts an additional register-wide advanced search combined with other selectors and filters all live candidates." }, "incorporatedTo": { "title": "incorporatedTo", "type": "string", "description": "Live inclusive latest incorporation date. Use YYYY-MM-DD. In live mode, this also starts an additional register-wide advanced search combined with other selectors and filters all live candidates." }, "dissolvedFrom": { "title": "dissolvedFrom", "type": "string", "description": "Live inclusive earliest dissolution date. Use YYYY-MM-DD. In live mode, this also starts an additional register-wide advanced search combined with other selectors and filters all live candidates." }, "dissolvedTo": { "title": "dissolvedTo", "type": "string", "description": "Live inclusive latest dissolution date. Use YYYY-MM-DD. In live mode, this also starts an additional register-wide advanced search combined with other selectors and filters all live candidates." }, "incorporatedSince": { "title": "incorporatedSince", "type": "string", "description": "Bulk inclusive earliest incorporation date. Use YYYY-MM-DD." }, "incorporatedBefore": { "title": "incorporatedBefore", "type": "string", "description": "Bulk inclusive latest incorporation date. Use YYYY-MM-DD." }, "includeOfficers": { "title": "includeOfficers", "type": "boolean", "description": "Fetch every available officer page; live enabled when omitted, bulk disabled when omitted." }, "includePSCs": { "title": "includePSCs", "type": "boolean", "description": "Fetch every PSC page, corporate details and statements; live enabled when omitted, bulk disabled when omitted." }, "includeFilingHistory": { "title": "includeFilingHistory", "type": "boolean", "description": "Fetch all available filing-history pages and stable document links; live enabled when omitted, bulk disabled when omitted." }, "includeCharges": { "title": "includeCharges", "type": "boolean", "description": "Fetch all charge pages and particulars; live enabled when omitted, bulk disabled when omitted." }, "emitOfficerRecords": { "title": "emitOfficerRecords", "type": "boolean", "description": "Also emit free flat officer leads with company context; forces officer fetch." }, "monitoringMode": { "title": "monitoringMode", "type": "boolean", "description": "Only emit previously unseen companies, using the Actor's named monitor store; serialize runs sharing a monitor scope." }, "newCompaniesOnly": { "title": "newCompaniesOnly", "type": "boolean", "description": "Only companies incorporated less than 90 days ago." }, "newestFirst": { "title": "newestFirst", "type": "boolean", "description": "Live advanced search by incorporation date descending, company number descending for same-day ties; recursively partitions date windows." }, "activeOnly": { "title": "activeOnly", "type": "boolean", "description": "Only companies with Active status." }, "minGrade": { "title": "minGrade", "enum": [ "A", "B", "C", "D" ], "type": "string", "description": "Keep this grade and better (A, B, C, D); D includes all. Heuristic, not a credit rating." }, "maxResults": { "title": "maxResults", "minimum": 0, "maximum": 5000000, "type": "integer", "description": "Maximum company rows across inputs; 0 means all matching rows. Officer rows do not consume this cap." }, "maxConcurrency": { "title": "maxConcurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum concurrent HTTP requests, with a shared two-requests-per-second pace." }, "maxRetriesPerRequest": { "title": "maxRetriesPerRequest", "minimum": 1, "maximum": 10, "type": "integer", "description": "Classified request attempts, including the first." }, "logEveryNRows": { "title": "logEveryNRows", "minimum": 1000, "maximum": 1000000, "type": "integer", "description": "Bulk progress interval in scanned CSV rows." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Direct anonymous egress when absent; optional Apify proxy settings. Use datacenter first; residential only when necessary." } } }, "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 } } } } } } } } } }