{ "openapi": "3.0.1", "info": { "title": "Company Registry Lookup (UK, France, Norway, Singapore, LEI)", "description": "Look up companies by name or registry number, or pull whole lists for one country in bulk mode: status, legal form, incorporation date, industry codes, town, LEI, websites and employees where stated. From official registers in 14 countries and the global LEI register.", "version": "0.1", "x-build-id": "r7WbQbG8dgJdqTbqo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/locaihost~company-registry/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-locaihost-company-registry", "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/locaihost~company-registry/runs": { "post": { "operationId": "runs-sync-locaihost-company-registry", "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/locaihost~company-registry/run-sync": { "post": { "operationId": "run-sync-locaihost-company-registry", "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": [ "lookup", "bulk" ], "type": "string", "description": "Lookup: find the companies you list by name or registry number. Bulk: a whole list for one country, set up in the \"Whole lists (bulk mode)\" section below.", "default": "lookup" }, "companies": { "title": "Companies", "type": "array", "description": "Company names (for example \"Octopus Energy\") or registry numbers from any register we hold: UK, France (SIREN or SIRET), Norway, Singapore, Finland, Estonia, Czechia, Australia (ABN), Canada (federal), Japan (corporate number), Sweden, Ireland, Latvia, the US (SEC CIK; New York, Colorado, Connecticut, Oregon), or an LEI. Ids with a prefix work too: GB-CH-09263424, SE-ORG-5593061459, JP-CN-1180301018771, LEI-…. To give one line its own country, put it after a bar: \"559306-1459 | SE\" or \"Toyota Motor | JP\".", "items": { "type": "string" } }, "country": { "title": "Country", "pattern": "^([A-Za-z]{2})?$", "type": "string", "description": "Lookup: search names in one country only, and read bare numbers as that country's registry numbers (GB, FR, NO, SG, FI, EE, CZ, AU, CA, US, JP, SE, IE or LV). A country after a bar on one line wins over this. Empty = all countries. From the API, bulk mode reads its country from here too.", "default": "" }, "matchesPerName": { "title": "Matches per name", "minimum": 1, "maximum": 25, "type": "integer", "description": "How many companies to return for each name you search (best matches first). Registry numbers always return one company.", "default": 1 }, "activeOnly": { "title": "Active companies only", "type": "boolean", "description": "Skip dissolved, struck-off and ceased companies (they become free rows).", "default": false }, "maxResults": { "title": "Max companies", "minimum": 0, "type": "integer", "description": "Lookup: stop after this many companies. 0 = no limit. From the API, bulk mode reads its cap from here too (0 there means the bulk default, 1,000).", "default": 0 }, "bulkCountry": { "title": "Country", "pattern": "^([A-Za-z]{2})?$", "type": "string", "description": "One ISO country code. Registers: GB, FR, NO, SG, FI, EE, CZ, AU, CA, JP, SE, IE, LV, US. Any other code gives that country's LEI holders." }, "segment": { "title": "Segment", "enum": [ "active-with-website", "active", "all", "with-lei" ], "type": "string", "description": "Which companies: every one we hold, active ones, active ones with a matched website, or ones with an LEI.", "default": "active-with-website" }, "industry": { "title": "Industry code", "type": "string", "description": "Optional. A code or the start of one, in the country's own system: 62 matches every UK SIC code starting 62, 62.01 every French NAF code starting 62.01. Matches any of a company's codes." }, "city": { "title": "Town or city", "type": "string", "description": "Optional. The registered office's town, as the register writes it (case and accents don't matter), e.g. Leeds or Tromsø." }, "incorporatedSince": { "title": "Incorporated since", "type": "string", "description": "Optional. Only companies incorporated on or after this date: a date like 2026-10-01, or a span back from today like \"30 days\", \"2 weeks\" or \"3 months\". Companies whose register states no incorporation date are left out (Australia and Japan state none). With a date, the newest come first." }, "incorporatedBefore": { "title": "Incorporated before", "type": "string", "description": "Optional. Only companies incorporated before this date (the date itself is not included). Same formats as above." }, "order": { "title": "Order", "enum": [ "id", "newest" ], "type": "string", "description": "Id order (the default without a date), or the newest incorporations first (the default with a date)." }, "bulkMaxResults": { "title": "Max companies", "minimum": 1, "maximum": 2000000, "type": "integer", "description": "Stop after this many companies (1 to 2,000,000). Empty = 1,000." }, "onlyNew": { "title": "Only new companies", "type": "boolean", "description": "Skip companies this account already got from an earlier run of the same list (same country, segment, industry and town). Skipped companies are free. Turn it on to fetch a big list over several runs, or to get only newly registered companies each month.", "default": false } } }, "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 } } } } } } } } } }