{ "openapi": "3.0.1", "info": { "title": "Gelbe Seiten (German Yellow Pages) Scraper", "description": "Scrape German business listings from Gelbe Seiten with flexible detail levels. This Apify Actor supports fast, basic, and deep search modes, rate limiting, proxy rotation, and index control. Ideal for lead gen, SEO, and market research. Outputs structured data to Apify datasets.", "version": "1.2", "x-build-id": "5n24gqr6tgPa2P9bw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dominic-quaiser~gelbe-seiten-german-yellow-pages-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dominic-quaiser-gelbe-seiten-german-yellow-pages-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/dominic-quaiser~gelbe-seiten-german-yellow-pages-scraper/runs": { "post": { "operationId": "runs-sync-dominic-quaiser-gelbe-seiten-german-yellow-pages-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/dominic-quaiser~gelbe-seiten-german-yellow-pages-scraper/run-sync": { "post": { "operationId": "run-sync-dominic-quaiser-gelbe-seiten-german-yellow-pages-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": [ "search_what", "search_where" ], "properties": { "search_what": { "title": "What to Search", "type": "string", "description": "Enter the type of business, profession, or service you want to find (e.g., 'Restaurant', 'Arzt', 'Hotel', 'Kreditvermittlung').", "default": "posterdruck" }, "search_where": { "title": "Search Location", "type": "string", "description": "Specify the geographic location for your search. Use city names (e.g., 'Berlin', 'München'), regions, or 'bundesweit' for nationwide results.", "default": "bundesweit" }, "search_mode": { "title": "Search Mode", "enum": [ "fast_search", "basic_search", "deep_search" ], "type": "string", "description": "Select the level of detail for scraped listings:\n- Fast Search: Only extracts basic info from listing page (quickest)\n- Basic Search: Extracts name, phoneNumber, email, website, description, industry, and address fields (recommended)\n- Deep Search: Extracts all available details including additional business attributes (most comprehensive)", "default": "basic_search" }, "sorting": { "title": "Sorting", "enum": [ "relevance", "rating" ], "type": "string", "description": "Choose how to sort the search results. Relevance sorts by how well listings match your search terms, while Rating sorts by user reviews and ratings.", "default": "relevance" }, "perimeter": { "title": "Perimeter (km)", "minimum": 0, "maximum": 50, "type": "integer", "description": "Set the search radius around your specified location in kilometers. Only applies when searching in a specific city or area (not for 'bundesweit'). Range: 0-50 km.", "default": 0 }, "max_businesses": { "title": "Maximum Businesses", "type": "integer", "description": "Maximum number of business listings to extract. Set to 0 for unlimited (will scrape all available results).", "default": 0 }, "start_index": { "title": "Start Index", "minimum": 1, "type": "integer", "description": "Begin extraction from this listing number (1-based indexing, where 1 is the first result). Useful for resuming interrupted runs or pagination.", "default": 1 }, "end_index": { "title": "End Index", "minimum": 0, "maximum": 30000, "type": "integer", "description": "1-based index of the last listing to save (inclusive). Set 0 to ignore this limit and rely solely on max_businesses. The website loops after 30,000 listings, making this the effective maximum.", "default": 0 }, "requests_per_second": { "title": "Requests Per Second", "type": "integer", "description": "Rate limit for API requests. Lower values minimize blocking risk but run slower. Higher values run faster but may trigger rate limiting. Applied to all search modes.", "default": 12 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Specifies proxy servers that will be used by the scraper in order to hide its origin.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "DE" } } } }, "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 } } } } } } } } } }