{ "openapi": "3.0.1", "info": { "title": "Kompass Scraper | B2B Companies, Contacts & Products", "description": "Extract companies and products from Kompass country sites, with public phones, emails, addresses and executives when available. Search by keyword or browse company, product, region and sector pages. Billed per delivered row plus a start fee.", "version": "0.2", "x-build-id": "POnftobgQTHs6VGjc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~kompass-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-kompass-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/lentic_clockss~kompass-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-kompass-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/lentic_clockss~kompass-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-kompass-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": { "mode": { "title": "Mode", "enum": [ "auto", "company_search", "product_search", "company", "company_products", "product", "region", "sector" ], "type": "string", "description": "Leave on Auto to select the mode from the target field you fill. Select Product search or Company product list explicitly when you want those modes.", "default": "auto" }, "country": { "title": "Country subdomain", "enum": [ "ae", "ar", "at", "au", "az", "be", "bg", "br", "ca", "ch", "cl", "cn", "co", "cz", "de", "dk", "dz", "ec", "ee", "eg", "es", "fi", "fr", "gb", "ge", "gr", "hk", "hr", "hu", "id", "ie", "il", "in", "it", "jp", "kr", "kz", "lb", "lt", "lu", "lv", "ma", "md", "mx", "my", "nl", "no", "nz", "pe", "ph", "pk", "pl", "pt", "ro", "rs", "ru", "sa", "se", "sg", "si", "sk", "th", "tn", "tr", "tw", "ua", "us", "uy", "vn", "za" ], "type": "string", "description": "Country subdomain for searches, such as au for au.kompass.com. The default and example use fr; www is a country-selection gateway.", "default": "fr" }, "query": { "title": "Query", "type": "string", "description": "One company or product search keyword, such as machinery. This input has its own maxResults row allowance." }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Several search keywords instead of query. Each keyword has its own maxResults row allowance.", "items": { "type": "string" } }, "companyUrl": { "title": "Company URL", "pattern": "^\\s*$|^\\s*(https?://)?([A-Za-z0-9-]+\\.)*kompass\\.com/.*", "type": "string", "description": "A Kompass company page URL, or its product-list URL for Company product list mode. This target takes priority over a keyword." }, "productUrl": { "title": "Product URL", "pattern": "^\\s*$|^\\s*(https?://)?([A-Za-z0-9-]+\\.)*kompass\\.com/.*", "type": "string", "description": "A complete Kompass product-page URL whose path starts with /p/." }, "detailUrls": { "title": "Detail URLs", "type": "array", "description": "Several company, product, region or sector URLs of the same kind; each has its own maxResults allowance. This list replaces individual target URLs, and region or sector mode requires matching /r/ or /a/ list URLs.", "items": { "type": "string" } }, "regionUrl": { "title": "Region URL", "pattern": "^\\s*$|^\\s*(https?://)?([A-Za-z0-9-]+\\.)*kompass\\.com/.*", "type": "string", "description": "A Kompass region directory URL whose path starts with /r/. This takes priority over a region name." }, "regionCode": { "title": "Region code", "type": "string", "description": "A region code, such as au_vic, when no region URL is supplied." }, "region": { "title": "Region name", "type": "string", "description": "A recognized region name, such as victoria, ile-de-france or new-york. Use a full region URL when the name is not recognized." }, "sectorUrl": { "title": "Sector URL", "pattern": "^\\s*$|^\\s*(https?://)?([A-Za-z0-9-]+\\.)*kompass\\.com/.*", "type": "string", "description": "A Kompass sector directory URL whose path starts with /a/. This takes priority over a sector name." }, "sectorId": { "title": "Sector ID", "type": "string", "description": "A numeric sector ID entered as text when no sector URL is supplied." }, "sector": { "title": "Sector name", "type": "string", "description": "A recognized sector name, such as agriculture, or a numeric sector ID. Use a full sector URL when the name is not recognized." }, "maxResults": { "title": "Max results per input", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Most company or product rows for each keyword or URL. Default 70; larger numbers are collected in parts of 70. The whole run stops at your maximum total charge. Free Apify plan: up to 200 rows per run and 10 runs of this Actor (limits set by the Actor developer).", "default": 70 }, "maxPages": { "title": "Max pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "Page setting from 1 to 50, used to limit region, sector and company product-list pages. Search sources handle page depth differently; use maxResults to limit delivered rows.", "default": 1 }, "page": { "title": "Start page", "minimum": 1, "maximum": 100, "type": "integer", "description": "Search start-page setting, beginning at 1. Not every search source uses this setting.", "default": 1 }, "enrichDetails": { "title": "Add company contact details", "type": "boolean", "description": "Read company pages to add available phones, emails, street addresses, websites and executives to the same row. Enabled by default; product rows do not inherit supplier contacts.", "default": true }, "includeSponsored": { "title": "Include sponsored results", "type": "boolean", "description": "Keep sponsored rows when enabled; they count toward maxResults and are billed like other rows. Disabled by default; RUN_SUMMARY.sponsoredSkipped counts excluded sponsored rows.", "default": false }, "workerBaseUrl": { "title": "Developer testing", "type": "string", "description": "Leave empty. Used only by the developer for testing." } } }, "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 } } } } } } } } } }