{ "openapi": "3.0.1", "info": { "title": "YellowPages Scraper - USA", "description": "Collect public business listings from YellowPages.com, YellowPages.ca, and Gelbe Seiten. Export available contact details, addresses, ratings, reviews, hours, and profile links.", "version": "1.0", "x-build-id": "pkUqGeicIGSnh7oED" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~yellowpages-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-yellowpages-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/maximedupre~yellowpages-scraper/runs": { "post": { "operationId": "runs-sync-maximedupre-yellowpages-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/maximedupre~yellowpages-scraper/run-sync": { "post": { "operationId": "run-sync-maximedupre-yellowpages-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": [ "target" ], "properties": { "target": { "title": "Find businesses by", "enum": [ "search", "urls", "germany" ], "type": "string", "description": "Search YellowPages.com by keyword, use YellowPages.com or YellowPages.ca URLs, or search Gelbe Seiten in Germany by keyword." }, "startUrls": { "title": "Yellow Pages URLs", "type": "array", "description": "Add complete public YellowPages.com search-results or business-listing URLs, or YellowPages.ca search URLs. Each business is saved once across all URLs.", "items": { "type": "object", "required": [ "url" ], "additionalProperties": false, "properties": { "url": { "title": "URL", "description": "A complete public YellowPages.com search-results or business-listing URL, or a YellowPages.ca search URL.", "type": "string", "minLength": 1 } } } }, "nationwide": { "title": "Search all of Germany", "type": "boolean", "description": "Search Gelbe Seiten across Germany and ignore Location and Search radius. Used only for German business search.", "default": false }, "radiusKm": { "title": "Search radius in kilometres", "minimum": 1, "maximum": 50, "type": "integer", "description": "For a local German business search, choose a radius up to 50 kilometres around Location. Leave empty to use the local search area." }, "searchTerms": { "title": "Business keywords or categories", "minItems": 1, "type": "array", "description": "Enter one or more business types, services, or keywords, such as dentist or plumber. Each entry is searched in the same location. Used for Keyword search and German business search.", "items": { "type": "string", "minLength": 1 }, "default": [ "dentist" ] }, "location": { "title": "Location", "minLength": 1, "type": "string", "description": "For Keyword search, enter a US city and state or ZIP code. For German business search, enter a German city or postal code, unless searching nationwide.", "default": "Los Angeles, CA" }, "sortBy": { "title": "Sort results by", "enum": [ "relevance", "distance", "rating", "name" ], "type": "string", "description": "Choose the order for Keyword search or German business search. German business search supports Relevance and Highest rated only. Distance and Business name apply only to Keyword search. The Yellow Pages URLs choice ignores this field.", "default": "relevance" }, "includeClosedBusinesses": { "title": "Include closed businesses", "type": "boolean", "description": "Include businesses that Yellow Pages marks as closed when that status is available.", "default": false }, "maxResults": { "title": "Maximum businesses", "minimum": 0, "type": "integer", "description": "Enter 0 or leave this empty to collect every available business. A positive number stops after that many unique businesses, or sooner when no more are available." } } }, "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 } } } } } } } } } }