{ "openapi": "3.0.1", "info": { "title": "European Company Data API - Firmographics", "description": "Search a European company database by country, registry id, industry code, website keywords, detected technologies, employee count and filed financials such as turnover and profit. Pay per result. Bring your own API key.", "version": "0.1", "x-build-id": "9I0ZiJqGD6fiaagNK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~european-company-data-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-european-company-data-api", "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/nabeelbaghoor~european-company-data-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-european-company-data-api", "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/nabeelbaghoor~european-company-data-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-european-company-data-api", "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": { "country": { "title": "Country", "type": "array", "description": "Two-letter country codes, for example FI, SE, NO, DK, NL. The provider recommends always setting a country, because a search without one is much slower.", "items": { "type": "string" } }, "companyName": { "title": "Company name (exact)", "type": "string", "description": "Match this company name exactly." }, "companyNameContains": { "title": "Company name contains", "type": "string", "description": "Match company names containing this text, ignoring case." }, "businessId": { "title": "Business ids", "type": "array", "description": "National registration numbers to look up directly.", "items": { "type": "string" } }, "domain": { "title": "Domains", "type": "array", "description": "Company website domains to look up directly.", "items": { "type": "string" } }, "vid": { "title": "Provider company ids", "type": "array", "description": "The provider's own company identifiers.", "items": { "type": "string" } }, "city": { "title": "Cities", "type": "array", "description": "Registered city names.", "items": { "type": "string" } }, "municipality": { "title": "Municipalities", "type": "array", "description": "Municipality names.", "items": { "type": "string" } }, "region": { "title": "Regions", "type": "array", "description": "Region names.", "items": { "type": "string" } }, "postal": { "title": "Postal codes", "type": "array", "description": "Postal codes.", "items": { "type": "string" } }, "visitingCity": { "title": "Visiting cities", "type": "array", "description": "Cities of the visiting address, which differs from the registered address for many companies.", "items": { "type": "string" } }, "industryCodes": { "title": "Industry codes", "type": "array", "description": "Official industry classification codes, for example NACE codes.", "items": { "type": "string" } }, "customIndustry": { "title": "Provider industry labels", "type": "array", "description": "The provider's own industry labels, which are more granular than official codes.", "items": { "type": "string" } }, "companyKeywords": { "title": "Company keywords", "type": "array", "description": "Keywords describing what the company does.", "items": { "type": "string" } }, "websiteKeywords": { "title": "Website keywords", "type": "array", "description": "Keywords found on the company website.", "items": { "type": "string" } }, "webTechnologies": { "title": "Web technologies", "type": "array", "description": "Technologies detected on the company website.", "items": { "type": "string" } }, "financialStatementKeywords": { "title": "Financial statement keywords", "type": "array", "description": "Keywords found in filed financial statements.", "items": { "type": "string" } }, "formOfCompany": { "title": "Legal forms", "type": "array", "description": "Legal form of the company, for example a limited company or a partnership.", "items": { "type": "string" } }, "status": { "title": "Statuses", "type": "array", "description": "Registry status values to include, for example active.", "items": { "type": "string" } }, "registrationDateFrom": { "title": "Registered on or after", "type": "string", "description": "Only companies registered on or after this date, as YYYY-MM-DD." }, "registrationDateTo": { "title": "Registered on or before", "type": "string", "description": "Only companies registered on or before this date, as YYYY-MM-DD." }, "modifiedSince": { "title": "Changed since", "type": "string", "description": "Only companies whose core data changed on or after this date, as YYYY-MM-DD. Use this to pull an incremental update instead of a full list." }, "staffNumberMin": { "title": "Minimum employees", "minimum": 0, "type": "integer", "description": "Only companies with at least this many employees." }, "staffNumberMax": { "title": "Maximum employees", "minimum": 0, "type": "integer", "description": "Only companies with at most this many employees." }, "staffNumberGrowthMin": { "title": "Minimum employee growth", "minimum": 0, "type": "integer", "description": "Only companies whose employee count grew by at least this much." }, "turnOverMin": { "title": "Minimum turnover", "minimum": 0, "type": "integer", "description": "Only companies with at least this much annual turnover." }, "turnOverMax": { "title": "Maximum turnover", "minimum": 0, "type": "integer", "description": "Only companies with at most this much annual turnover." }, "turnOverGrowthMin": { "title": "Minimum turnover growth", "minimum": 0, "type": "integer", "description": "Only companies whose turnover grew by at least this much." }, "profitMin": { "title": "Minimum profit", "type": "integer", "description": "Only companies reporting at least this much profit." }, "profitMax": { "title": "Maximum profit", "type": "integer", "description": "Only companies reporting at most this much profit." }, "rawFilters": { "title": "Extra filters", "type": "object", "description": "Any additional filter, merged over the ones above, written as the provider's field name plus an operator suffix. Use this for the decimal scores, which cannot be entered as whole numbers above: {\"digitality__gte\": 0.8}, {\"marketility__gte\": 0.5}, {\"sociality__gte\": 0.5}. Other examples: {\"turn_over__gt\": 500000}, {\"city__startswith\": \"Hel\"}, {\"alexa_rank_global__lte\": 100000}. Operators are __gt, __gte, __lt, __lte, __ne, __in, __contains, __icontains, __startswith and __geo_within_sphere." }, "fields": { "title": "Fields to return", "type": "array", "description": "Restrict the response to these provider field names, which makes large exports faster. Leave empty for the provider's default field set.", "items": { "type": "string" } }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Stop after this many company records (1 to 50,000). You are charged per result returned." }, "pageSize": { "title": "Results per request", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many companies to request per API call (1 to 100). Larger pages mean fewer calls." }, "apiKey": { "title": "API token", "type": "string", "description": "Your own API token for the data provider. Required. This is the long-lived refresh token, which the actor exchanges for a short-lived access token automatically. Stored securely and never logged." }, "apiKeyIsAccessToken": { "title": "Token is already an access token", "type": "boolean", "description": "Turn this on if the value above is already a short-lived access token rather than a refresh token. The actor will then use it as is and skip the exchange.", "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 } } }, "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 } } } } } } } } } }