{ "openapi": "3.0.1", "info": { "title": "Local Business Lists with Contact Routes", "description": "Local businesses by everyday category and town from open map data (Overture Maps, 18 countries), with the public contact route from each business's own website and its source page.", "version": "0.1", "x-build-id": "zYIwGYeJTdPa9Lfqe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/olliolli~open-business-lists/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-olliolli-open-business-lists", "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/olliolli~open-business-lists/runs": { "post": { "operationId": "runs-sync-olliolli-open-business-lists", "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/olliolli~open-business-lists/run-sync": { "post": { "operationId": "run-sync-olliolli-open-business-lists", "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", "required": [ "categories", "location", "country" ], "properties": { "categories": { "title": "What kind of businesses", "minItems": 1, "maxItems": 10, "type": "array", "description": "Everyday words in Dutch, French, English or German, e.g. \"kapper\", \"boulangerie\", \"plumber\", \"Friseur\", \"fiduciaire\". Accents and umlauts are optional. Overture category codes such as \"hair_salon\" also work.", "items": { "type": "string", "maxLength": 60 } }, "location": { "title": "Municipality or city", "type": "string", "description": "Name of the municipality or city, e.g. \"Gent\", \"Pelt\", \"Lille\"." }, "country": { "title": "Country", "enum": [ "BE", "NL", "LU", "FR", "DE", "AT", "CH", "GB", "IE", "DK", "SE", "NO", "FI", "ES", "PT", "IT", "PL", "CZ" ], "type": "string", "description": "Country of the place (ISO code), for example BE, NL, FR, LU or DE.", "default": "BE" }, "maxWebsites": { "title": "Maximum websites to scan", "minimum": 1, "maximum": 500, "type": "integer", "description": "Businesses with their own website are scanned for contact routes, up to this number (highest data confidence first).", "default": 100 }, "includeWithoutWebsite": { "title": "Also list businesses without their own website", "type": "boolean", "description": "Adds rows with the open-data listing for businesses without their own website (name, address, and any phone or social link from the source, marked as not verified). Each such row triggers the small business-listed event; see maxListedRows.", "default": true }, "maxListedRows": { "title": "Maximum listed rows without website", "minimum": 0, "maximum": 3000, "type": "integer", "description": "At most this many businesses without their own website are listed (each triggers business-listed). 0 lists none.", "default": 100 }, "excludeChains": { "title": "Leave out chains and franchises", "type": "boolean", "description": "Off (default): branches of chains are kept and marked in the results (listing.chain = true, with the reason), because their website may give head-office contacts instead of the branch. On: they are left out and not scanned; OUTPUT only counts them. Detection uses the brand field of the open data, branch-page website addresses (store locator or branch pages) and one website shared by 3 or more places in the area. Small chains without these signals are not detected.", "default": false }, "maxPages": { "title": "Maximum pages per website", "minimum": 1, "maximum": 5, "type": "integer", "description": "Includes the homepage. Robots.txt and bounded redirects are separate requests. Lower limits can miss contacts.", "default": 5 }, "maxRunSeconds": { "title": "Maximum processing time (seconds)", "minimum": 30, "maximum": 1800, "type": "integer", "description": "Stops new work at this time budget. Unprocessed URLs are listed in OUTPUT. The platform timeout must leave additional time to save the summary.", "default": 600 }, "maxConcurrency": { "title": "Maximum concurrent websites", "minimum": 1, "maximum": 10, "type": "integer", "description": "Bounded parallel scans. Higher values use more Actor memory/network capacity and may increase target-site load; 5 is the default.", "default": 5 }, "contactPurpose": { "title": "Contact purpose", "enum": [ "any", "sales", "general", "support" ], "type": "string", "description": "Sales prefers sales, then general, never support; general addresses with nearby customer-service phrases are excluded. This is a conservative heuristic, not a guarantee of commercial suitability. General/support only accept their own mailbox category.", "default": "any" }, "emailScope": { "title": "Email categories", "enum": [ "role_person", "all" ], "type": "string", "description": "role_person returns role and named company-domain addresses. all also includes freemail and department addresses; these categories are less validated.", "default": "role_person" }, "channelScope": { "title": "Additional contact channels", "enum": [ "core", "all" ], "type": "string", "description": "Extra social, booking and WhatsApp links are experimental and are not included by default.", "default": "core" }, "conversionRoutes": { "title": "Conversion routes (booking, quote, ordering, prices)", "type": "boolean", "description": "Also look for online booking/appointment and quote-request routes (proven, with evidence) and online ordering and price routes (candidates, with evidence). Opens the page behind each candidate button once (robots.txt respected) and adds a few seconds per website. Proven routes: in a blind test on 660 new SME websites (BE/NL/FR, October 2026), 48 of 50 booking and quote routes were correct. Candidates are not covered by that figure.", "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 }, "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 } } } } } } } } } }