{ "openapi": "3.0.1", "info": { "title": "Yelp Reviews Scraper - Ratings, Owner Replies & Photos", "description": "Scrape every public Yelp review of any business by URL, alias, id or Yelp search: star rating, full text, date, reviewer, reactions, owner reply, photos and the business. All languages, keyword, date and star filters, monitor mode. No login. $0.047 per 1,000 reviews.", "version": "0.1", "x-build-id": "Me7HshBzz3H9hlsDa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/topapi~yelp-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-topapi-yelp-reviews-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/topapi~yelp-reviews-scraper/runs": { "post": { "operationId": "runs-sync-topapi-yelp-reviews-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/topapi~yelp-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-topapi-yelp-reviews-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": { "businesses": { "title": "Businesses", "type": "array", "description": "One per line: a business URL from any Yelp domain (https://www.yelp.com/biz/franklin-barbecue-austin), an alias (franklin-barbecue-austin), a business id (MGzro82Fi4LYvc86acoONQ) or a Yelp search URL.", "items": { "type": "string" } }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Find businesses with a Yelp search and scrape their reviews, e.g. \"pizza\", \"dentist\", \"auto repair\". Needs a search location.", "default": [], "items": { "type": "string" } }, "searchLocation": { "title": "Search location", "type": "string", "description": "City, ZIP or neighborhood for the search terms, e.g. \"Austin, TX\", \"10001\", \"Mission, San Francisco\"." }, "maxBusinessesPerSearch": { "title": "Businesses per search", "minimum": 1, "maximum": 240, "type": "integer", "description": "How many businesses each search adds (sponsored results skipped). Yelp shows at most 240 per search.", "default": 10 }, "searchSort": { "title": "Search order", "enum": [ "recommended", "rating", "review_count" ], "type": "string", "description": "Which businesses a search picks first. For price or feature filters, paste a Yelp search URL into Businesses instead.", "default": "recommended" }, "reviewsSort": { "title": "Sort reviews by", "enum": [ "newest", "oldest", "recommended", "highest", "lowest", "elites" ], "type": "string", "description": "The order Yelp returns reviews in. Date limits stop early with Newest first. Keyword searches always come in Yelp's relevance order.", "default": "newest" }, "reviewRatings": { "title": "Star ratings", "type": "array", "description": "Only reviews with these star ratings. Empty = all ratings.", "items": { "type": "string", "enum": [ "5", "4", "3", "2", "1" ], "enumTitles": [ "5 stars", "4 stars", "3 stars", "2 stars", "1 star" ] }, "default": [] }, "reviewLanguage": { "title": "Review language", "enum": [ "all", "en", "es", "fr", "de", "it", "nl", "pt", "ja", "zh", "zh_TW", "ko", "sv", "da", "fi", "no", "pl", "cs", "tr", "ru" ], "type": "string", "description": "All languages walks every language the business has reviews in, largest first. Pick one to get only that language. Does not apply to not-recommended reviews (they carry no language).", "default": "all" }, "keywords": { "title": "Keywords", "type": "array", "description": "Only reviews that mention these words, searched by Yelp itself, e.g. \"parking\", \"wait time\". One search per keyword (max 10). Not-recommended reviews are kept only when their text contains one of the keywords.", "default": [], "items": { "type": "string" } }, "translateTo": { "title": "Translate reviews to", "enum": [ "none", "en", "es", "fr", "de", "it", "nl", "pt", "ja", "zh" ], "type": "string", "description": "Adds Yelp's own translation of each review in translatedText.", "default": "none" }, "reviewsNewerThan": { "title": "Reviews newer than", "type": "string", "description": "Only reviews posted after this date: \"2026-09-01\" or a relative \"30 days\", \"6 months\". Pairs with Newest first." }, "reviewsOlderThan": { "title": "Reviews older than", "type": "string", "description": "Only reviews posted before this date: \"2025-12-31\" or \"1 year\"." }, "withPhotosOnly": { "title": "Only reviews with photos", "type": "boolean", "description": "Keep only reviews that include photos or videos.", "default": false }, "withOwnerReplyOnly": { "title": "Only reviews with an owner reply", "type": "boolean", "description": "Keep only reviews the business answered publicly.", "default": false }, "includePersonalData": { "title": "Include reviewer details", "type": "boolean", "description": "Reviewer name, Yelp profile link, location, review/friend/photo counts, profile photo, Elite and expert badges, and the reviewer's earlier reviews of the business. Off = those fields are null.", "default": true }, "includeNotRecommended": { "title": "Include not-recommended reviews", "type": "boolean", "description": "Also scrape the reviews Yelp does not recommend (isRecommended: false; own per-business limit). The review-language pick does not apply to not-recommended reviews, and those rows carry no language, reactions, Useful/Funny/Cool votes or review tags (null). Keywords: kept if the text has one.", "default": false }, "monitorMode": { "title": "Only new reviews", "type": "boolean", "description": "Return only reviews posted since the newest one earlier runs saw with the same filters (same store name), plus any not-recommended review not delivered before. A review is never delivered twice through one store. The first run delivers up to Max reviews per business.", "default": false }, "monitorStoreName": { "title": "Monitor store name", "type": "string", "description": "Named key-value store that remembers delivered reviews. Use one name per schedule. Changing the language, star-rating, keyword or not-recommended settings starts a new baseline; reviews already delivered through the store are still skipped.", "default": "yelp-reviews-monitor" }, "maxReviewsPerBusiness": { "title": "Max reviews per business", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Stop each business after this many reviews. 0 = every review Yelp lists (some businesses have 10,000+).", "default": 100 }, "maxReviews": { "title": "Max reviews per run", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Stop the whole run after this many reviews across all businesses. 0 = no run-wide limit.", "default": 0 }, "compact": { "title": "Compact output", "type": "boolean", "description": "Core fields only (review id, URL, rating, text, date, reviewer name, owner reply, business) - sized for AI agents and MCP. author keeps only name and publicReply only text.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "The actor connects directly first and switches to this proxy only if Yelp stops answering. A named proxy group is used from the first request. Useful/funny/cool votes are left empty on proxied pages.", "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 } } } } } } } } } }