{ "openapi": "3.0.1", "info": { "title": "Yelp Scraper: Business Search & Category Coverage — $4/1k", "description": "Yelp Scraper for business search by city and service: ratings, phone, website, hours, claimed status, plus a coverage mode counting businesses per city and service to find market gaps. Yelp caps counts at 240. No login or cookies. MCP-ready for AI agents. $4 per 1,000 records.", "version": "1.0", "x-build-id": "GfTKyiooLaSuEaGjr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/chimerical_quicklime~yelp-business-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-chimerical_quicklime-yelp-business-search-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/chimerical_quicklime~yelp-business-search-scraper/runs": { "post": { "operationId": "runs-sync-chimerical_quicklime-yelp-business-search-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/chimerical_quicklime~yelp-business-search-scraper/run-sync": { "post": { "operationId": "run-sync-chimerical_quicklime-yelp-business-search-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": { "mode": { "title": "Mode", "enum": [ "coverage", "listings" ], "type": "string", "description": "coverage = one row per city x service with Yelp's result count and the top 3 businesses (cheap supply check). listings = one row per business from each search. Leave empty: listings when you give inputs, a coverage sample when you give none." }, "cities": { "title": "Cities / locations", "type": "array", "description": "Where to search, e.g. \"San Diego, CA\", \"Austin, TX\", \"10001\". Every service is searched in every city.", "items": { "type": "string" } }, "services": { "title": "Services / search terms", "type": "array", "description": "What to search for, e.g. \"dog grooming\", \"plumbers\", \"pizza\".", "items": { "type": "string" } }, "listUrl": { "title": "Bulk list (CSV or Google Sheet URL)", "type": "string", "description": "A CSV or a Google Sheet shared as \"anyone with the link\". Each row is either city,service (two columns) or a Yelp search/business URL. A header row is skipped." }, "searchUrls": { "title": "Yelp search URLs", "type": "array", "description": "Yelp search pages with your own filters, e.g. https://www.yelp.com/search?find_desc=Plumbers&find_loc=Austin%2C+TX", "items": { "type": "string" } }, "bizUrls": { "title": "Yelp business URLs", "type": "array", "description": "Business pages (https://www.yelp.com/biz/...). Each returns one full row: phone, website, address, hours, claimed status, coordinates.", "items": { "type": "string" } }, "maxItems": { "title": "Max businesses per search", "minimum": 1, "maximum": 240, "type": "integer", "description": "Listings mode: businesses to return per search (Yelp shows at most 240 per search).", "default": 10 }, "includeDetails": { "title": "Add business page details", "type": "boolean", "description": "Listings mode: also open each business page for phone, website, full address, coordinates, hours, claimed status, photo count and health score. One extra page per business.", "default": false }, "includeAds": { "title": "Include sponsored results", "type": "boolean", "description": "Listings mode: also return Yelp's sponsored rows (flagged isAd). Coverage counts never include them.", "default": false }, "concurrency": { "title": "Parallel searches", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many searches run at once.", "default": 4 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Leave empty: the actor uses Apify's UNBLOCKER proxy, which is what gets past Yelp's bot wall." } } }, "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 } } } } } } } } } }