{ "openapi": "3.0.1", "info": { "title": "European Company Registry Search: France, Norway, Finland, UK", "description": "Search official company registers of France (SIRENE), Norway (Brønnøysund), Finland (PRH) and UK (Companies House): status, address, industry, officers. Open data APIs, no login.", "version": "0.1", "x-build-id": "o9s6LRzn44NOLaKeX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maxforreal~eu-company-registry-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maxforreal-eu-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/maxforreal~eu-company-registry-search/runs": { "post": { "operationId": "runs-sync-maxforreal-eu-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/maxforreal~eu-company-registry-search/run-sync": { "post": { "operationId": "run-sync-maxforreal-eu-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": { "countries": { "title": "Countries", "type": "array", "description": "Which national registers to search. The UK needs a free Companies House API key (see below); without one the UK is skipped.", "items": { "type": "string", "enum": [ "FR", "NO", "FI", "UK" ], "enumTitles": [ "France (SIRENE / RNE)", "Norway (Brønnøysund)", "Finland (PRH / YTJ)", "United Kingdom (Companies House)" ] }, "default": [ "FR", "NO", "FI", "UK" ] }, "searchTerms": { "title": "Company names", "type": "array", "description": "Company names or keywords to search for. Each term is searched in every selected country.", "items": { "type": "string" } }, "companyIds": { "title": "Company IDs", "type": "array", "description": "Look up exact companies by registry number: French SIREN (9 digits) or SIRET (14 digits), Norwegian organisation number (9 digits), Finnish Business ID / Y-tunnus (1234567-8) or UK company number (8 characters, e.g. 00445790 or SC123456). The country is detected from the format; add a prefix like \"NO:\" or \"FR:\" to force one.", "items": { "type": "string" } }, "industryCodes": { "title": "Industry codes", "type": "array", "description": "Optional. A 2-digit NACE division such as \"62\" (IT services) works in every country. You can also give national codes: NAF like \"62.01Z\" (France), SN like \"62.010\" (Norway), TOL like \"62010\" (Finland) or SIC like \"62012\" (UK). Prefix with a country (\"FR:62.01Z\") to apply a code to one country only.", "items": { "type": "string" } }, "postalCodes": { "title": "Postal codes", "type": "array", "description": "Optional. Only companies whose registered address has one of these postal codes, for example 75008 (Paris) or 0150 (Oslo).", "items": { "type": "string" } }, "city": { "title": "City", "type": "string", "description": "Optional. Only companies registered in this town or city, for example Oslo, Helsinki or Manchester." }, "activeOnly": { "title": "Active companies only", "type": "boolean", "description": "Skip companies that are dissolved, ceased, bankrupt or in liquidation.", "default": true }, "incorporatedAfter": { "title": "Incorporated after", "type": "string", "description": "Optional. Only companies registered on or after this date (YYYY-MM-DD). Good for new-company lead lists. Leave the company names empty to get the newest registrations matching your other filters." }, "includeOfficers": { "title": "Include officers", "type": "boolean", "description": "Add the current directors and board members where the register publishes them (France, Norway, UK). Finland's open data API does not publish officers. Adds one request per company in Norway and the UK.", "default": false }, "maxItems": { "title": "Max companies per search term", "minimum": 1, "type": "integer", "description": "Maximum number of companies saved for each search term in each country (or for the filters, if you give no names). Company ID lookups always return their company.", "default": 50 }, "companiesHouseApiKey": { "title": "Companies House API key (UK)", "type": "string", "description": "Needed for UK results only. Get a free key in a few minutes at https://developer.company-information.service.gov.uk/ (create an application, then a REST API key). Without a key the UK is skipped." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. These are official open APIs and work without a proxy.", "default": { "useApifyProxy": 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 } } } } } } } } } }