{
"openapi": "3.0.1",
"info": {
"title": "Yellow Pages US Scraper",
"description": "Scrape Yellow Pages US listings: business name, phone, address, website, hours, categories, rating, and emails when the listing or its site has one. Keyword + city or yellowpages.com URLs in. Pure HTTP, no browser. JSON or CSV out. $2.50/1k listings; contact emails billed only when found.",
"version": "1.0",
"x-build-id": "P1SMK0TKpX3o7KoeJ"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/memo23~yellow-pages-us-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-memo23-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/memo23~yellow-pages-us-scraper/runs": {
"post": {
"operationId": "runs-sync-memo23-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/memo23~yellow-pages-us-scraper/run-sync": {
"post": {
"operationId": "run-sync-memo23-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": {
"searchTerms": {
"title": "🔍 Search term(s)",
"type": "array",
"description": "What you would type into the Yellow Pages search box, e.g. pizza, plumber, dentist. One row per term. Every term is searched in every location below.",
"items": {
"type": "string"
}
},
"locations": {
"title": "📍 Location(s)",
"type": "array",
"description": "US city and state, e.g. Los Angeles, CA. One row per city. Coordinates as lat,lon also work. ZIP codes alone do not.",
"items": {
"type": "string"
}
},
"maxItems": {
"title": "💯 Number of businesses",
"minimum": 1,
"type": "integer",
"description": "Stop after this many unique businesses across the whole run. Free plan is capped at 50.",
"default": 50
},
"startUrls": {
"title": "Yellow Pages URLs",
"type": "array",
"description": "Examples: https://www.yellowpages.com/los-angeles-ca/pizza, a search-box URL like https://www.yellowpages.com/search?search_terms=plumber&geo_location_terms=Austin%2C+TX, or a /mip/ profile link.",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"enrichEmails": {
"title": "Find emails on the company website ($)",
"type": "boolean",
"description": "When Yellow Pages shows no email, open the business website and look for one. $0.05 per email found, misses are free.",
"default": false
},
"scrapeDetails": {
"title": "Open each business profile",
"type": "boolean",
"description": "Loads the profile page for extra phones, hours, year established, and the native Yellow Pages email. Leave on unless you only need names and one phone.",
"default": true
},
"includeReviews": {
"title": "Include review text",
"type": "boolean",
"description": "Adds a reviews list to each row with author, stars, title, text, and date. Rating and review count are always included.",
"default": false
},
"maxReviews": {
"title": "Max reviews per business",
"minimum": 0,
"type": "integer",
"description": "Only used when review text is on.",
"default": 25
},
"sortBy": {
"title": "Sort businesses",
"enum": [
"default",
"rating",
"name",
"distance"
],
"type": "string",
"description": "Order of businesses inside each map area that is searched. Yellow Pages itself has no global sort for this API.",
"default": "default"
},
"maxConcurrency": {
"title": "Parallel requests",
"minimum": 1,
"maximum": 32,
"type": "integer",
"description": "How many business profiles to load at the same time. Higher is faster.",
"default": 8
},
"proxy": {
"title": "Proxy",
"type": "object",
"description": "Only used when you run the actor on your own machine. Yellow Pages refuses requests sent straight from Apify servers, so every run on Apify goes through our residential proxy and ignores this setting.",
"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
},
"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
}
}
}
}
}
}
}
}
}
}