{ "openapi": "3.0.1", "info": { "title": "Yellow Pages Business Listings Scraper", "description": "Yellow Pages Business Listings Scraper SD - Yellow Pages Business Listings Scraper is a local business data tool that extracts listings from Yellow Pages US, Canada and UAE: name, phone, website, address, categories, rating, reviews, hours, years in business and profile URL.", "version": "1.0", "x-build-id": "NauDmjRAGo0blzHBb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/neuro-scraper~yellow-pages-business-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-neuro-scraper-yellow-pages-business-listings-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/neuro-scraper~yellow-pages-business-listings-scraper/runs": { "post": { "operationId": "runs-sync-neuro-scraper-yellow-pages-business-listings-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/neuro-scraper~yellow-pages-business-listings-scraper/run-sync": { "post": { "operationId": "run-sync-neuro-scraper-yellow-pages-business-listings-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", "properties": { "searchTerms": { "title": "Search terms", "type": "array", "description": "What to look for, one per line, e.g. plumber, pizza, dentist. Each term is searched in every location. For the UAE site this is the category name (plumbing -> /uae/plumbing).", "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "Where to search, one per line: 'City, ST' or a ZIP for the US (Austin, TX / 90210), 'City PR' for Canada (Toronto ON). Required for US searches. For the UAE site an emirate/city (Dubai, Abu Dhabi) filters the category's listings by city.", "items": { "type": "string" } }, "startUrls": { "title": "Yellow Pages URLs", "type": "array", "description": "Result pages copied from the browser, e.g. https://www.yellowpages.com/search?search_terms=dentist&geo_location_terms=Miami%2C+FL, https://www.yellowpages.com/los-angeles-ca/plumbers, a business page https://www.yellowpages.com/austin-tx/mip/-, https://www.yellowpages.ca/search/si/1/plumber/Toronto+ON or https://www.yellowpages-uae.com/uae/plumbing.", "items": { "type": "string" } }, "country": { "title": "Yellow Pages site", "enum": [ "US", "CA", "AE" ], "type": "string", "description": "Which Yellow Pages the search terms are run on. URLs always use their own site.", "default": "US" }, "language": { "title": "Canada site language", "enum": [ "en", "fr" ], "type": "string", "description": "Canada searches only: yellowpages.ca (English) or pagesjaunes.ca (French).", "default": "en" }, "sortBy": { "title": "Sort businesses", "enum": [ "default", "distance", "rating", "name" ], "type": "string", "description": "US searches: Yellow Pages' own sort menu (checked against the page's menu on every run).", "default": "default" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Total businesses to return across all searches. The Actor follows Yellow Pages' result pages (US 30, UAE 20 per page) until this number or the last page.", "default": 50 }, "maxPages": { "title": "Max pages per search", "minimum": 0, "type": "integer", "description": "Stop each search after this many result pages (0 = no page limit; Max items still applies). Yellow Pages US shows about 100 pages (~3,000 listings) per search - split big searches by city or ZIP.", "default": 0 }, "scrapeDetails": { "title": "Open each business profile", "type": "boolean", "description": "US listings: also open each business page for GPS coordinates, opening hours, description, services, payment methods, year established, languages, social links, photos and the full 'More Info' section. One extra request per business.", "default": false }, "includeReviews": { "title": "Include review text", "type": "boolean", "description": "US listings: add the business's reviews (author, date, rating, text, source) from its profile page, paging 10 reviews at a time up to Max reviews per business. Opens the profile page like the option above.", "default": false }, "maxReviews": { "title": "Max reviews per business", "minimum": 1, "maximum": 1000, "type": "integer", "description": "With 'Include review text': reviews per business (10 per review page).", "default": 20 }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many business profiles are opened at the same time (each on its own proxy session).", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "RESIDENTIAL is recommended: yellowpages.com (Cloudflare) and yellowpages.ca (CloudFront) block datacenter and foreign IPs. When the country is left at US, Canada and UAE searches switch the exit to CA / AE automatically.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }