{ "openapi": "3.0.1", "info": { "title": "Company Registry Search API - Companies House, SIRENE, LEI", "description": "Search three official company registers at once and get one flat table: UK Companies House, French SIRENE and the global LEI register. A company lookup API returning name, registration number, status, incorporation date, registered address, SIC code and LEI per row. 54 columns per record.", "version": "0.1", "x-build-id": "ZwOJleYRkw0kJwbQe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/captainhandsome~company-registry-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-captainhandsome-company-registry-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/captainhandsome~company-registry-search/runs": { "post": { "operationId": "runs-sync-captainhandsome-company-registry-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/captainhandsome~company-registry-search/run-sync": { "post": { "operationId": "run-sync-captainhandsome-company-registry-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", "required": [ "search_terms" ], "properties": { "search_terms": { "title": "Company names", "minItems": 1, "maxItems": 25, "type": "array", "description": "One or more full or partial company names. Each name is searched in every selected registry.", "items": { "type": "string", "minLength": 2 }, "default": [ "Tesco" ] }, "sources": { "title": "Registries", "minItems": 1, "uniqueItems": true, "type": "array", "description": "Which official registers to search. All three work without any setup of your own; deselect the ones you do not need to cut run time and cost.", "items": { "type": "string", "enum": [ "uk", "france", "global" ], "enumTitles": [ "United Kingdom - Companies House", "France - SIRENE", "Global - GLEIF LEI register" ] }, "default": [ "uk", "france", "global" ] }, "companies_house_key": { "title": "Your Companies House API key (optional)", "type": "string", "description": "Leave blank to use the shared key, whose 600-requests-per-5-minutes quota is shared by everyone running this Actor. For large or time-critical UK runs, get a free key of your own at developer.company-information.service.gov.uk and paste it here." }, "include_details": { "title": "Fetch full detail records", "type": "boolean", "description": "Add the columns that only per-company endpoints publish: UK accounts and confirmation-statement due dates, mortgage charges, insolvency history, previous names and current directors, plus direct and ultimate parent for LEI rows. Costs two extra requests per UK record and two per LEI record, so runs take noticeably longer. France needs no extra requests and is unaffected.", "default": false }, "active_only": { "title": "Active companies only", "type": "boolean", "description": "Skip dissolved, ceased and lapsed entities. Turn off to include them.", "default": true }, "max_items": { "title": "Max items", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on records returned, split evenly across registries and search terms. Also caps your spend.", "default": 50 } } }, "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 } } } } } } } } } }