{ "openapi": "3.0.1", "info": { "title": "Herold.at Scraper", "description": "Scrape Herold.at - Austria's leading business directory (Gelbe Seiten). Search by category and Bundesland/city, or fetch full business profiles with opening hours, ratings, phone, email, and website.", "version": "1.0", "x-build-id": "ssgDS3mBM50ed6KVH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~herold-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-herold-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/crawlerbros~herold-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-herold-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/crawlerbros~herold-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-herold-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "detail" ], "type": "string", "description": "What to fetch: search a category + region/city, or fetch full business profiles from direct Herold.at URLs.", "default": "search" }, "category": { "title": "Category (Branche)", "enum": [ "custom", "installateur", "elektriker", "restaurant", "friseur", "zahnarzt", "rechtsanwalt", "hotel", "dachdecker", "steuerberater", "immobilien", "haarentfernung", "gartencenter", "fahrschule", "garage-parkgarage", "tierarzt", "apotheke", "optiker", "massage", "fensterreinigung", "notar", "versicherungsmakler", "physiotherapie", "bestattungsunternehmen", "maler-anstreicher-u-lackierer", "catering", "campingplatz", "edv-dienstleistung", "facility-management", "buchhaltung", "unternehmensberatung", "bank-sparkasse", "spedition", "tischlerei", "schlosserei", "glaserei", "augenarzt", "hautarzt", "kinderarzt", "frauenarzt" ], "type": "string", "description": "Business category to search for. Pick a common category from the list, or choose 'Custom category' and type your own in the field below (mode=search).", "default": "installateur" }, "customCategory": { "title": "Custom category (overrides selection above)", "type": "string", "description": "Free-text Branche/category not in the curated list above, e.g. 'Tischlerei' or 'Kfz-Werkstatt' (mode=search). Takes priority over 'Category' when set. Best-effort URL match -- if Herold has no page for the exact term, 0 results are returned (no error)." }, "location": { "title": "Region / city (Bundesland or Ort)", "enum": [ "custom", "Wien", "Niederösterreich", "Oberösterreich", "Steiermark", "Tirol", "Kärnten", "Salzburg", "Vorarlberg", "Burgenland", "Dornbirn", "Feldkirch", "Bregenz", "Bludenz", "Graz-Stadt", "Linz-Stadt", "Innsbruck-Stadt", "Klagenfurt-Stadt", "Wels-Stadt", "Villach-Stadt", "St Pölten-Stadt", "Wiener Neustadt-Stadt", "Steyr-Stadt" ], "type": "string", "description": "Austrian federal state (Bundesland) or a city with its own Herold.at page, e.g. 'Wien', 'Salzburg', 'Graz-Stadt'. Herold.at groups most results at the state level, but state capitals and select cities (suffixed '-Stadt') have their own dedicated, narrower listing page (mode=search).", "default": "Wien" }, "customLocation": { "title": "Custom location (overrides selection above)", "type": "string", "description": "Free-text Austrian region, city, or postal code not in the curated list above (mode=search). Takes priority over 'Region / city' when set. Best-effort URL match -- if Herold has no dedicated page for the exact term, 0 results are returned (no error)." }, "fetchDetails": { "title": "Fetch full business profiles", "type": "boolean", "description": "For each search result, also visit its business profile page to collect opening hours per weekday, email, website, Facebook page, and full address details. Slower (mode=search).", "default": false }, "businessUrls": { "title": "Business profile URLs (mode=detail)", "type": "array", "description": "Direct Herold.at business profile URLs to fetch, e.g. https://www.herold.at/gelbe-seiten/wien/<id>/<slug>/. Use the 'sourceUrl' field from search results.", "items": { "type": "object", "properties": { "url": { "title": "URL", "type": "string", "description": "Herold.at business profile URL." } } }, "default": [] }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on the number of business records to return.", "default": 50 } } }, "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 } } } } } } } } } }