{ "openapi": "3.0.1", "info": { "title": "Yelp Business & Reviews Scraper", "description": "Export Yelp business names, ratings, exact review counts, addresses, phones, websites and up to 100 unique reviews per business. Search by query and location or provide business URLs. Includes optional rule-based sentiment and lead scores.", "version": "1.0", "x-build-id": "sav2wplRUPfK61l2G" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/benthepythondev~yelp-intelligence-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-benthepythondev-yelp-intelligence-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/benthepythondev~yelp-intelligence-scraper/runs": { "post": { "operationId": "runs-sync-benthepythondev-yelp-intelligence-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/benthepythondev~yelp-intelligence-scraper/run-sync": { "post": { "operationId": "run-sync-benthepythondev-yelp-intelligence-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": "Scraping Mode", "enum": [ "search", "direct_urls" ], "type": "string", "description": "Choose how to find businesses on Yelp", "default": "direct_urls" }, "searchQuery": { "title": "Search Query", "type": "string", "description": "What to search for (e.g., 'pizza', 'dentist', 'coffee shops')", "default": "pizza" }, "location": { "title": "Location", "type": "string", "description": "City, state, or zip code", "default": "San Francisco, CA" }, "businessUrls": { "title": "Business URLs", "type": "array", "description": "Direct Yelp business URLs to scrape", "default": [ "https://www.yelp.com/biz/tonys-pizza-napoletana-san-francisco", "https://www.yelp.com/biz/golden-boy-pizza-san-francisco" ], "items": { "type": "string" } }, "maxBusinesses": { "title": "Max Businesses", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum distinct businesses to inspect (1–500), subject to Yelp’s available results and your charge limit. Rating filters can reduce the saved row count.", "default": 50 }, "maxReviewsPerBusiness": { "title": "Max Reviews Per Business", "minimum": 0, "maximum": 100, "type": "integer", "description": "Maximum unique reviews per business (0–100). Paginates Yelp’s recommended review feed; nested reviews are included in the business result price.", "default": 20 }, "minRating": { "title": "Minimum Rating", "minimum": 1, "maximum": 5, "type": "number", "description": "Filter businesses with rating >= this value (1.0-5.0)" }, "maxRating": { "title": "Maximum Rating", "minimum": 1, "maximum": 5, "type": "number", "description": "Filter businesses with rating <= this value (1.0-5.0)" }, "includeSentiment": { "title": "Include Sentiment Analysis", "type": "boolean", "description": "Add sentiment labels using star ratings and keyword rules.", "default": true }, "includeLeadScore": { "title": "Include Lead Score", "type": "boolean", "description": "Calculate lead quality score (rating + reviews + sentiment)", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Unblocker handles Yelp page access by default. Existing residential overrides may fail; remove them to use the default. No separate service key is needed.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "UNBLOCKER" ] } } } }, "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 } } } } } } } } } }