{ "openapi": "3.0.1", "info": { "title": "Company Registry Scraper — UK Companies House & Singapore ACRA", "description": "Search official company registries and enrich records with officers, PSC data, SIC codes, and addresses. Monitor newly incorporated UK companies on a schedule. Official government sources only — the legal alternative to scraped B2B databases.", "version": "0.0", "x-build-id": "2vedYcqLt2eNsoeQZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kaz_kakyo~company-registry-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kaz_kakyo-company-registry-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/kaz_kakyo~company-registry-scraper/runs": { "post": { "operationId": "runs-sync-kaz_kakyo-company-registry-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/kaz_kakyo~company-registry-scraper/run-sync": { "post": { "operationId": "run-sync-kaz_kakyo-company-registry-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "sg-search", "sg-lookup", "uk-search", "uk-enrich", "uk-new-incorporations" ], "type": "string", "description": "`sg-search` and `sg-lookup` use Singapore's open ACRA data (no key needed). UK modes use the official Companies House API and work with zero setup on the built-in key (or bring your own free key for the discounted rate). `uk-new-incorporations` finds companies registered in a date range, ideal for scheduled lead generation.", "default": "sg-search" }, "query": { "title": "Search query", "type": "string", "description": "Company name or keyword. Used by `sg-search` and `uk-search`." }, "uens": { "title": "Singapore UENs", "type": "array", "description": "Unique Entity Numbers for `sg-lookup` mode (e.g. `201812345K`).", "items": { "type": "string" } }, "companyNumbers": { "title": "UK company numbers", "type": "array", "description": "Companies House numbers for `uk-enrich` mode (e.g. `09876543`).", "items": { "type": "string" } }, "incorporatedFrom": { "title": "Incorporated from (UK)", "type": "string", "description": "Start date `YYYY-MM-DD` for `uk-new-incorporations` mode. Defaults to 7 days ago." }, "incorporatedTo": { "title": "Incorporated to (UK)", "type": "string", "description": "End date `YYYY-MM-DD` for `uk-new-incorporations` mode. Defaults to today." }, "sicCodes": { "title": "SIC codes filter (UK)", "type": "array", "description": "Optional UK SIC codes to filter `uk-new-incorporations` (e.g. `62012` = business software development).", "items": { "type": "string" } }, "activeOnly": { "title": "Active companies only", "type": "boolean", "description": "Filter out terminated / struck-off / dissolved entities.", "default": true }, "sgFullSweep": { "title": "SG: always sweep all shards", "type": "boolean", "description": "sg-search only. ACRA data is sharded by the first letter of the entity name. By default the search checks the shard matching your query's first letter and returns early when it already fills Max results (seconds instead of ~1.5 min). Enable this to always merge matches from all 27 shards — use for keyword queries where matches can start with any letter.", "default": false }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum companies returned per query/lookup batch. Keeps cost predictable.", "default": 100 }, "includeOfficers": { "title": "Include officers (UK enrich)", "type": "boolean", "description": "`uk-enrich`: attach current officers (directors, secretaries) to each company.", "default": true }, "includePsc": { "title": "Include PSC (UK enrich)", "type": "boolean", "description": "`uk-enrich`: attach persons with significant control (beneficial owners).", "default": false }, "includeFilings": { "title": "Include filing history (UK enrich)", "type": "boolean", "description": "`uk-enrich`: attach the latest 25 filings (accounts, confirmation statements, officer changes) — a quick company-health timeline.", "default": false }, "companiesHouseApiKey": { "title": "Companies House API key (optional — cheaper UK runs)", "type": "string", "description": "Leave empty for zero setup — UK modes run on the built-in key at the standard rate. Or bring your own free key for the discounted rate: developer.company-information.service.gov.uk → create an application → copy the REST API key. Stored encrypted, sent only to the official Companies House API. Singapore modes never need a key." } } }, "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 } } } } } } } } } }