{ "openapi": "3.0.1", "info": { "title": "Companies House API & Company Registry – UK, France, LEI", "description": "Search and monitor companies in official registers: UK Companies House, France SIRENE (with revenue) and the global LEI database. KYB risk score, filing health, new companies daily. Clean English data, pay per company.", "version": "0.3", "x-build-id": "CB3JgXy6Wgv8NnGKa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ram1eal~company-registry-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ram1eal-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/ram1eal~company-registry-search/runs": { "post": { "operationId": "runs-sync-ram1eal-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/ram1eal~company-registry-search/run-sync": { "post": { "operationId": "run-sync-ram1eal-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", "properties": { "searchQuery": { "title": "Company name or keyword", "type": "string", "description": "Company name or keyword, e.g. \"airbus\" or \"bakery\"." }, "registryIds": { "title": "Or look up registry IDs", "type": "array", "description": "French SIREN/SIRET/VAT numbers, UK company numbers (e.g. 00445790, SC123456) or LEI codes, one per line. Each is looked up directly.", "items": { "type": "string" } }, "sources": { "title": "Registers", "type": "array", "description": "Which official registers to search.", "items": { "type": "string", "enum": [ "france", "uk", "gleif" ], "enumTitles": [ "France (SIRENE, with revenue)", "United Kingdom (Companies House)", "Global LEI register (all countries)" ] }, "default": [ "france", "uk", "gleif" ] }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many companies. You pay per company.", "default": 100 }, "onlyNew": { "title": "Only new or changed companies", "type": "boolean", "description": "For scheduled runs: return (and pay for) only companies that are new or changed since your previous run with the same search.", "default": false }, "country": { "title": "Country (LEI register)", "type": "string", "description": "Two-letter country code to filter the global LEI register, e.g. DE or US." }, "industryCode": { "title": "Industry code (France, UK)", "type": "string", "description": "NACE code like 62.01, a UK SIC code like 62012, or a section letter like J. With the UK register you can search by industry alone." }, "location": { "title": "Location (France, UK)", "type": "string", "description": "French postal code (75008) or department (75), or a UK town or postcode (Leeds, M1). A location limits the search to that country." }, "status": { "title": "Status", "enum": [ "active", "all" ], "type": "string", "description": "Include closed companies or not.", "default": "active" }, "newSince": { "title": "Registered since (France, UK, LEI)", "type": "string", "description": "Only companies created on or after this date, or within a relative period like \"7 days\". Ideal for scheduled \"new companies\" lead lists in France and the UK." }, "includeFinancials": { "title": "Include financial details", "type": "boolean", "description": "France: latest revenue and net income with USD conversion. UK name searches: SIC codes, accounts and insolvency flags (slower: one extra lookup per company).", "default": true }, "stateKey": { "title": "History name", "type": "string", "description": "Runs with the same history name share what was already delivered. Leave empty to use one history per search." }, "companiesHouseApiKey": { "title": "Your Companies House API key (optional)", "type": "string", "description": "Only for very large UK runs: a free key from developer.company-information.service.gov.uk gives you your own rate limit. Never logged or stored in results." } } }, "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 } } } } } } } } } }