{ "openapi": "3.0.1", "info": { "title": "Yellow Pages Scraper - Most Comprehensive", "description": "🔥 ~$0.1/1K places 🔥 Look up Yellow Pages businesses by link or ID, or search them by term and location. Returns every field Yellow Pages has, with reviews and photos.", "version": "0.1", "x-build-id": "PlowRpUIUZBIqap5j" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kaix~yellowpages-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kaix-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/kaix~yellowpages-scraper/runs": { "post": { "operationId": "runs-sync-kaix-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/kaix~yellowpages-scraper/run-sync": { "post": { "operationId": "run-sync-kaix-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": { "country": { "title": "Country", "enum": [ "us", "uk", "ca" ], "type": "string", "description": "Which Yellow Pages to scrape. The United States is yellowpages.com (Thryv). The United Kingdom is yell.com (Yell). Canada is yellowpages.ca (Yellow Pages Limited). Links, IDs and locations must match the country you pick.", "default": "us" }, "businesses": { "title": "Listing links or IDs", "type": "array", "description": "Listing links or IDs for the country above. US: https://www.yellowpages.com/austin-tx/mip/iii-forks-467675667 or 467675667. UK: https://www.yell.com/biz/the-himalaya-london-901780159/ or 901780159. Canada: https://www.yellowpages.ca/bus/Ontario/Toronto/Bardi-s-Steak-House/156059.html or 156059. You can use this together with a search.", "items": { "type": "string" } }, "searchTerm": { "title": "Search term", "type": "string", "description": "What to search for, e.g. 'plumbers', 'pizza' or a business name. A search also needs a location, or latitude and longitude. Canada needs a location." }, "location": { "title": "Location", "type": "string", "description": "A city, state, ZIP/postcode or address in the country above. US example: 'Austin, TX' or '10001'. UK example: 'Leeds' or 'WC2N'. Canada example: 'Toronto, ON' or 'M5J 1S8'. The US covers only the 50 states and Washington, DC; a place outside it can match a US town with the same name." }, "latitude": { "title": "Latitude", "minimum": -90, "maximum": 90, "type": "number", "description": "Search around a point instead of a location. Use it with Longitude. Not available for Canada: yellowpages.ca reads coordinates as the whole province." }, "longitude": { "title": "Longitude", "minimum": -180, "maximum": 180, "type": "number", "description": "Search around a point instead of a location. Use it with Latitude. Not available for Canada: yellowpages.ca reads coordinates as the whole province." }, "searchSort": { "title": "Sort", "enum": [ "relevance", "distance", "average_rating", "name" ], "type": "string", "description": "The order of the search results. Applies to the United States and Canada.", "default": "relevance" }, "maxSearchResults": { "title": "Max search results", "minimum": 1, "maximum": 3000, "type": "integer", "description": "The most businesses to collect from the search. One search serves about 3,000 results in the US and Canada, and a few hundred in the UK.", "default": 50 }, "includeMedia": { "title": "Include all photos and videos", "type": "boolean", "description": "Load every photo and video, with the cover, logo and thumbnail images. Without it, a business has the photos its details carry, which can be fewer.", "default": true }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Add the reviews and star-only ratings of each business in `businessReviews`.", "default": false }, "maxReviewsPerBusiness": { "title": "Max reviews per business", "minimum": 0, "type": "integer", "description": "The most reviews to collect for each business. Use 0 for all.", "default": 20 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. The default Apify datacenter proxy works.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }