{ "openapi": "3.0.1", "info": { "title": "🏢 Yellow Pages US Scraper", "description": null, "version": "1.0", "x-build-id": "AWCOSTqndhVCSxWIi" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/api-empire~yellow-pages-us-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-api-empire-yellow-pages-us-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/api-empire~yellow-pages-us-scraper/runs": { "post": { "operationId": "runs-sync-api-empire-yellow-pages-us-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/api-empire~yellow-pages-us-scraper/run-sync": { "post": { "operationId": "run-sync-api-empire-yellow-pages-us-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": { "search": { "title": "Search", "type": "string", "description": "What to look for on Yellow Pages — a business type, category or company name. Examples: `Dentist`, `Plumber`, `Coffee Shop`, `Law Firm`. Combine it with the Location field below. Leave both empty if you are pasting Start URLs instead." }, "location": { "title": "Location", "type": "string", "description": "Where to search — a US city, `City, ST`, or ZIP code. Examples: `New York`, `Austin, TX`, `90210`. Loose input is auto-corrected to the Yellow Pages canonical form via their location autosuggest." }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Optional. Yellow Pages search-result URLs to crawl directly — e.g. `https://www.yellowpages.com/search?search_terms=plumber&geo_location_terms=New+York%2C+NY`. Use this instead of (or alongside) the Search + Location fields above. Pagination is followed automatically for every URL.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max items", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Cap the total number of business listings returned across all searches. Set to `0` for unlimited (Yellow Pages itself caps each search to roughly 30 pages).", "default": 10 }, "debugMode": { "title": "Debug Mode", "type": "boolean", "description": "Turn on verbose debug logging — every page fetch, HTTP status, proxy escalation and pagination step is written to the run log. Use it to troubleshoot empty results or blocks; leave it off for normal runs.", "default": false }, "requestDelay": { "title": "Delay between requests (seconds)", "minimum": 0, "maximum": 15, "type": "number", "description": "Base pause between page requests. A random jitter is added on top to look human and stay under Yellow Pages' rate limits. Raise it if you see blocks; lower it for speed.", "default": 1 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "By default the scraper sends requests **direct (no proxy)** and only escalates to a **datacenter** proxy — then a US **residential** proxy — if Yellow Pages blocks a request. Once it escalates to residential it stays there for the rest of the run. Leave this as-is for the default behaviour, or expand it to force Apify Proxy on from the start.", "default": { "useApifyProxy": 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 } } } } } } } } } }