{
"openapi": "3.0.1",
"info": {
"title": "Kompass Company Scraper - B2B Company Data & Firmographics",
"description": "Extract B2B company data from the Kompass directory: name, phone, website, address, employee size, turnover, and industry. Filter by country, industry, and size to build targeted company lists.",
"version": "0.0",
"x-build-id": "PSrRbgAegYx9YWAMr"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/zen-studio~kompass-company-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-zen-studio-kompass-company-scraper",
"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/zen-studio~kompass-company-scraper/runs": {
"post": {
"operationId": "runs-sync-zen-studio-kompass-company-scraper",
"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/zen-studio~kompass-company-scraper/run-sync": {
"post": {
"operationId": "run-sync-zen-studio-kompass-company-scraper",
"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": {
"query": {
"title": "Search term",
"type": "string",
"description": "What to search for, e.g. metal finishing services or packaging machinery. Combined with the country below."
},
"country": {
"title": "Country",
"enum": [
"IN",
"DE",
"FR",
"IT",
"ES",
"NL",
"BE",
"PL"
],
"type": "string",
"description": "Which country's companies to return. Applies to the search term and to the category below. When you paste your own URLs instead, the country comes from the URL."
},
"maxResults": {
"title": "Maximum companies",
"minimum": 1,
"type": "integer",
"description": "Stop after this many companies.",
"default": 100
},
"widerCoverage": {
"title": "Cover the whole industry",
"type": "boolean",
"description": "Keeps going after the search itself runs out, through the directory's own industry listings for your search term, then region by region and city by city. This is what reaches large result sets: a search on its own returns about 100 companies, however many exist. Leave it on for anything larger. Turn it off only when you want those first matches and nothing else. Every row tells you where it came from."
},
"excludeIds": {
"title": "Skip companies you already have",
"type": "array",
"description": "Kompass IDs to leave out, so you are not charged again for companies already in your database. Paste the IDs (IN489736) or the company links they came from. Skipped companies are never fetched and never billed. Up to 500,000.",
"items": {
"type": "string"
}
},
"category": {
"title": "Browse a category instead",
"type": "string",
"description": "Browse a whole industry or region without a search term. Matches the directory's own tree, so it accepts a broad sector (transport logistics, agriculture), a specific activity (metal finishing) or a region (Gujarat, Bavaria). Towns and cities are not listed separately, so use the state or province they sit in. Used only when no search term or URL is given."
},
"searchUrls": {
"title": "Search result URLs",
"type": "array",
"description": "Paste Kompass search or category URLs to scrape directly. Takes priority over the search term and category. Works on the Kompass directories for India, Germany, France, Italy, Spain, Netherlands, Belgium and Poland.",
"items": {
"type": "string"
}
},
"profileUrls": {
"title": "Company URLs",
"type": "array",
"description": "Scrape specific companies by their Kompass profile URL. Takes priority over everything else, and always returns full profiles. Works on the Kompass directories for India, Germany, France, Italy, Spain, Netherlands, Belgium and Poland.",
"items": {
"type": "string"
}
}
}
},
"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
}
}
}
}
}
}
}
}
}
}