{ "openapi": "3.0.1", "info": { "title": "Yellow Pages Scraper", "description": "Scrape US local business listings from Yellow Pages: name, phone, address, categories, rating, review count, opening hours and website, from any search term and location.", "version": "0.1", "x-build-id": "D5sqxVRtifv53jlBx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/juanoox~yellowpages-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-juanoox-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/juanoox~yellowpages-scraper/runs": { "post": { "operationId": "runs-sync-juanoox-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/juanoox~yellowpages-scraper/run-sync": { "post": { "operationId": "run-sync-juanoox-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", "properties": { "searchTerms": { "title": "Search terms", "type": "array", "description": "What to look for, e.g. plumber, italian restaurant, dentist. Each term is searched in the location below.", "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "City and state, e.g. Austin, TX. Yellow Pages searches by city, never nationwide, so this is required when you use search terms.", "default": "Austin, TX" }, "startUrls": { "title": "Result URLs", "type": "array", "description": "Paste Yellow Pages result pages you already filtered on the site. Use this instead of search terms when you want their exact filters.", "items": { "type": "string" } }, "maxPagesPerSearch": { "title": "Max pages per search", "minimum": 1, "maximum": 100, "type": "integer", "description": "Each page holds 30 businesses.", "default": 5 }, "minRating": { "title": "Minimum rating", "type": "string", "description": "Drop businesses rated below this, e.g. 4 or 4.5. Businesses with no rating are dropped too, since it cannot be claimed they pass. Leave empty for no filter." }, "minReviews": { "title": "Minimum reviews", "minimum": 0, "type": "integer", "description": "Drop businesses with fewer reviews than this." }, "onlyWithPhone": { "title": "Only with phone", "type": "boolean", "description": "Drop listings with no phone number.", "default": false }, "onlyWithWebsite": { "title": "Only with website", "type": "boolean", "description": "Drop listings with no website. Useful to separate businesses that already have an online presence from those that do not.", "default": false }, "categoryKeywords": { "title": "Categories", "type": "array", "description": "Only businesses whose Yellow Pages categories mention any of these. Ignores case and accents.", "items": { "type": "string" } }, "maxItems": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Total cap for the run. 0 = no cap.", "default": 300 }, "includeSeen": { "title": "Include businesses already seen", "type": "boolean", "description": "Turn it off to skip businesses returned by previous runs.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Parallel requests.", "default": 3 }, "maxRequestsPerMinute": { "title": "Requests per minute", "minimum": 1, "maximum": 600, "type": "integer", "description": "Rate ceiling. Yellow Pages shows a captcha to traffic that goes too fast.", "default": 30 }, "maxRequestRetries": { "title": "Retries per request", "minimum": 0, "maximum": 10, "type": "integer", "description": "How many times to retry a failed request before dropping it.", "default": 3 } } }, "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 } } } } } } } } } }