{ "openapi": "3.0.1", "info": { "title": "YellowPages USA Lead Generator", "description": "Scrape business listings from YellowPages.com. Extract names, phone numbers, emails, addresses, ratings, reviews, hours, categories, and websites. Search any industry and US city. Listing and detail modes with Pay-per-event pricing.", "version": "1.4", "x-build-id": "Gj4KDxVTuyEYsZ0ew" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parsebird~yellowpages-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parsebird-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/parsebird~yellowpages-scraper/runs": { "post": { "operationId": "runs-sync-parsebird-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/parsebird~yellowpages-scraper/run-sync": { "post": { "operationId": "run-sync-parsebird-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": [ "location" ], "properties": { "searchQuery": { "title": "Search Query", "type": "string", "description": "Business type, name, or keyword to search for (e.g. \"plumbers\", \"Italian restaurants\", \"dentists\"). Ignored when Category is selected. Defaults to \"restaurants\" if both are empty.", "default": "" }, "location": { "title": "Location", "type": "string", "description": "City and state (e.g. \"Los Angeles, CA\", \"New York, NY\") or ZIP code (e.g. \"90210\"). Required.", "default": "Los Angeles, CA" }, "category": { "title": "Category", "enum": [ "", "restaurants", "plumbers", "attorneys", "dentists", "electricians", "contractors", "auto-repair", "roofing", "hotels", "insurance", "real-estate-agents", "accountants", "air-conditioning-contractors-systems", "auto-body-shops", "auto-dealers-new-cars", "auto-dealers-used-cars", "banks", "beauty-salons", "carpet-cleaning", "chiropractors", "cleaning-services", "computer-repair", "concrete-contractors", "counseling-services", "day-care-centers-child-care", "divorce-attorneys", "dry-cleaners", "employment-agencies", "fencing", "financial-planners", "florists", "funeral-directors", "garage-doors", "general-contractors", "gyms", "hair-salons", "handyman-services", "heating-contractors", "home-builders", "home-health-services", "hospitals", "hvac-contractors", "landscape-contractors", "lawn-maintenance", "locksmiths", "massage-therapists", "movers", "nail-salons", "optometrists", "orthodontists", "painters", "pest-control", "pet-grooming", "pharmacies", "photographers", "physical-therapists", "pizza", "printing-services", "property-management", "psychiatrists", "real-estate-appraisers", "restaurants-chinese", "restaurants-italian", "restaurants-japanese", "restaurants-mexican", "restaurants-thai", "self-storage", "spas", "storage", "towing", "tree-service", "urgent-care", "veterinarians", "water-damage-restoration", "windows" ], "type": "string", "description": "Pre-defined YellowPages category slug. When set, overrides Search Query and uses the direct category URL for more reliable results. Leave empty to use Search Query instead.", "default": "" }, "maxPages": { "title": "Max Pages", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of search result pages to scrape. Each page has up to 30 listings.", "default": 5 }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of business listings to return. Useful for controlling costs.", "default": 100 }, "includeDetails": { "title": "Include Detail Pages", "type": "boolean", "description": "Fetch each business's detail page for emails, hours, full description, amenities, payment methods, and more. Slower but provides richer data.", "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 } } }, "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 } } } } } } } } } }