{ "openapi": "3.0.1", "info": { "title": "Europe Company Search: FR, NO, FI, UK by Sector, City, Date", "description": "Search registered companies in France, Norway, Finland and the UK by name, sector code, city, legal form and creation date. Official open registry data.", "version": "1.0", "x-build-id": "N96AubIygsudAYoag" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datacraft-studio~europe-company-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datacraft-studio-europe-company-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/datacraft-studio~europe-company-search/runs": { "post": { "operationId": "runs-sync-datacraft-studio-europe-company-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/datacraft-studio~europe-company-search/run-sync": { "post": { "operationId": "run-sync-datacraft-studio-europe-company-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", "uniqueItems": true, "type": "array", "description": "Registries to search. France, Norway, Finland and the United Kingdom can be combined in one run.", "items": { "type": "string", "enum": [ "FR", "NO", "FI", "UK" ], "enumTitles": [ "France", "Norway", "Finland", "United Kingdom" ] }, "default": [ "FR", "NO", "FI", "UK" ] }, "name": { "title": "Company name", "type": "string", "description": "Optional name or name fragment. France searches the legal name and address. Norway, Finland and the UK search the registered name." }, "naceCodes": { "title": "Sector codes", "type": "array", "description": "Activity prefixes. Each code is applied in the national format: NAF for France, næringskode for Norway, TOL for Finland and SIC 2007 for the UK. 56.10A is exact in France and becomes 56.10, 5610 and 5610x elsewhere. Classifications are not crosswalked: Norway and Finland now use newer restaurant codes (56.110 and 56111).", "items": { "type": "string" } }, "nativeActivityCodes": { "title": "Native activity codes", "type": "object", "description": "Optional exact codes per country. When a country key is set, it replaces naceCodes for that country. Keys are FR, NO, FI and UK.", "default": {} }, "city": { "title": "City", "type": "string", "description": "Commune or city name. France resolves it to postal codes (Lyon covers 69001–69009). Norway resolves it to a municipality number. Finland passes it as location. The UK passes it as the Companies House location." }, "postalCode": { "title": "Postal code", "type": "string", "description": "One postal code applied to every selected country. France and Finland expect 5 digits, Norway 4 digits. A code in the wrong shape skips that country with an error and does not search the whole country." }, "legalForm": { "title": "Legal form", "enum": [ "llc", "plc", "sole_trader", "partnership", "association" ], "type": "string", "description": "Normalised form. Private limited covers SARL/SAS, AS, OY and Ltd. Public limited covers SA, ASA, OYJ and Plc. Sole traders exist in France and Norway only." }, "nativeLegalForms": { "title": "Native legal forms", "type": "object", "description": "Optional registry codes per country. When a country key is set, it replaces legalForm for that country. Example: {\"FR\":[\"5710\"],\"NO\":[\"AS\"]}.", "default": {} }, "createdFrom": { "title": "Created from", "type": "string", "description": "Inclusive start date, YYYY-MM-DD. France has no such API filter: date_creation is applied after download. Norway uses Enhetsregisteret registration date. Finland uses registrationDate. The UK uses incorporation date." }, "createdTo": { "title": "Created to", "type": "string", "description": "Inclusive end date, YYYY-MM-DD." }, "activeOnly": { "title": "Active companies only", "type": "boolean", "description": "Keep companies the registry still treats as active. Closed French establishments in the requested city are dropped. Bankrupt, liquidated and ceased companies are dropped.", "default": true }, "maxResultsPerCountry": { "title": "Max results per country", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop each country after this many delivered companies. The registries themselves cap a query around 10,000 hits.", "default": 100 }, "minRequestIntervalMs": { "title": "Minimum delay between requests (ms)", "minimum": 150, "maximum": 10000, "type": "integer", "description": "Pause between calls to the same registry. France never goes faster than 150 ms (under the 7 requests/second ceiling). Finland never goes faster than 300 ms. Norway uses at least 200 ms. The UK also keeps a 600 requests / 5 minutes token bucket.", "default": 300 }, "companiesHouseApiKey": { "title": "Companies House API key", "type": "string", "description": "Optional. Overrides the COMPANIES_HOUSE_API_KEY secret for this run. Required only when UK is selected. The key is sent as the HTTP Basic username and is not written to the dataset or the log." } } }, "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 } } } } } } } } } }