{ "openapi": "3.0.1", "info": { "title": "Yelp Reviews Scraper", "description": "Scrape Yelp reviews from business URLs, IDs or a Yelp search (keyword × location): text, stars, date, owner reply, photos, translation, reviewer. Filters, monitoring of new reviews, full business details. Export to JSON, CSV or Excel.", "version": "0.0", "x-build-id": "QHzIyY7YHfWX9KAIr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nice_dev~yelp-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nice_dev-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/nice_dev~yelp-reviews-scraper/runs": { "post": { "operationId": "runs-sync-nice_dev-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/nice_dev~yelp-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-nice_dev-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": { "startUrls": { "title": "Yelp URLs", "maxItems": 1000, "type": "array", "description": "Yelp business pages (`https://www.yelp.com/biz/golden-boy-pizza-san-francisco`, any Yelp country domain: yelp.co.uk, yelp.fr, yelp.ca…) or Yelp search pages (`https://www.yelp.com/search?find_desc=pizza&find_loc=San+Francisco`: the keyword and location are read from the URL). Max 1 000 URLs.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "businessIds": { "title": "Business ids or aliases", "maxItems": 1000, "uniqueItems": true, "type": "array", "description": "Yelp business ids (22 characters, e.g. `PTFxtXS47ZVRCdZIrEWvGw`) or aliases, the last part of a business URL (e.g. `golden-boy-pizza-san-francisco`). Up to 1 000 entries, each up to 200 characters.", "default": [], "items": { "type": "string" } }, "query": { "title": "Search keyword", "maxLength": 200, "type": "string", "description": "What to search on Yelp, as typed in its search box (e.g. `pizza`, `plumber`, `dentist`). Needs a **Location**. Each search returns up to 25 businesses per search order (up to 75 with **Search order** = all three)." }, "searchQueries": { "title": "More search keywords", "maxItems": 100, "uniqueItems": true, "type": "array", "description": "Several keywords in one run: one search per keyword and per location. Added to **Search keyword**; a business found by several searches is read once. Up to 100 entries, each up to 200 characters.", "default": [], "items": { "type": "string" } }, "location": { "title": "Location", "maxLength": 200, "type": "string", "description": "City, neighborhood or ZIP code, as typed on Yelp (e.g. `San Francisco, CA`, `94133`, `London`). Tip: several ZIP codes or neighborhoods find many more businesses than one city." }, "locations": { "title": "More locations", "maxItems": 100, "uniqueItems": true, "type": "array", "description": "Several locations in one run: every keyword is searched in every location (3 keywords × 4 locations = 12 searches, max 500). Added to **Location**. Up to 100 entries, each up to 200 characters.", "default": [], "items": { "type": "string" } }, "latitude": { "title": "Latitude (search around a point)", "minimum": -90, "maximum": 90, "type": "number", "description": "With **Longitude**: also searches around this GPS point, e.g. `37.7998`. You can also type `37.7998,-122.4081` directly in **Location**." }, "longitude": { "title": "Longitude (search around a point)", "minimum": -180, "maximum": 180, "type": "number", "description": "With **Latitude**, e.g. `-122.4081`." }, "searchSortBy": { "title": "Search order", "enum": [ "all", "recommended", "highest_rated", "most_reviewed" ], "type": "string", "description": "Order of the Yelp search. Yelp returns at most 25 businesses per search and order: `All three orders` merges recommended, highest rated and most reviewed (up to 75 different businesses per keyword and location).", "default": "all" }, "maxBusinessesPerSearch": { "title": "Max businesses per search", "minimum": 0, "maximum": 75, "type": "integer", "description": "Businesses kept from each search (keyword × location, or search URL), in Yelp's order. 0 = all the search returns (up to 75).", "default": 0 }, "includeReviews": { "title": "Scrape reviews", "type": "boolean", "description": "On = one result per review. Off = businesses only: one result per business with its full details (phone, website, address, GPS, hours, amenities, health inspections, popular dishes, star and language breakdown) and no review.", "default": true }, "maxItems": { "title": "Max results", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Maximum number of results for the whole run (reviews, or businesses when **Scrape reviews** is off), after filters. 0 = no limit.", "default": 100 }, "maxItemsPerQuery": { "title": "Max reviews per business", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Cap for EACH business, so that the first business cannot use up the whole **Max results**. With **Scrape reviews** off: cap of businesses per search. 0 = no cap (every review Yelp shows: all of them can be read).", "default": 0 }, "sortBy": { "title": "Review order", "enum": [ "newest", "oldest", "relevance", "highest_rating", "lowest_rating", "elites" ], "type": "string", "description": "Order in which Yelp returns the reviews (and in which the caps above keep them). `Newest first` is the fastest with **Posted after** and with monitoring: reading stops at the first older or already delivered review.", "default": "newest" }, "translateTo": { "title": "Translate reviews to", "pattern": "^([a-z]{2})?$", "maxLength": 2, "type": "string", "description": "Two-letter language code (e.g. `en`, `fr`, `es`, `de`, `ja`): Yelp's own translation of each review is added in `translatedText` (free, original text kept). Empty = no translation." }, "includeReviewerDetails": { "title": "Include reviewer details", "type": "boolean", "description": "Reviewer's display name, location, profile link and photo, review / friend / photo counts and Elite status. Off = the `reviewer` field is null (same columns, no personal data). You are responsible for how you use personal data (GDPR, CCPA).", "default": true }, "includeBusinessDetails": { "title": "Add full business details", "type": "boolean", "description": "Adds to each review its business's `details`: phone, website, full address, GPS, price range, opening hours, open now / closed, claimed, Yelp summary, year established, history, specialties, owner, attributes, amenities (~30), health inspections, popular dishes, review highlights, menu link, licenses, photo count, questions and answers (small extra requests per business, charged once per business; see Pricing). Always included with **Scrape reviews** off.", "default": false }, "maxBusinessPhotos": { "title": "Business photos per business", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Business photo gallery (full-size URL + caption), read 30 per page, charged per page read (see Pricing). The gallery is written on the first row of each business (`businessPhotos`); its other rows say null. 0 = none (the main photo is always included).", "default": 0 }, "enrichEmails": { "title": "Find e-mails on business websites", "type": "boolean", "description": "Visits each business's own website (home page + contact / legal pages, 3 pages max, once per business) and adds the e-mail addresses published there to `emails`, and the Facebook, Instagram, X, TikTok, YouTube, LinkedIn and Pinterest links of its home page to `socialLinks`. Slower. Charged as a separate `email-enriched` event, once per business where at least one e-mail is found.", "default": false }, "starRatings": { "title": "Star ratings", "uniqueItems": true, "type": "array", "description": "Only reviews with these stars (several allowed). Empty = all.", "items": { "type": "string", "enum": [ "5", "4", "3", "2", "1" ], "enumTitles": [ "5 stars", "4 stars", "3 stars", "2 stars", "1 star" ] }, "default": [] }, "postedAfter": { "title": "Posted after", "type": "string", "description": "Only reviews posted on or after this date: `2026-09-01` (the day as Yelp prints it on the review, in the business's own time zone), or a period before now such as `7 days`, `2 weeks`, `1 month` (API: `24 hours` and full ISO date-times work too)." }, "postedBefore": { "title": "Posted before", "type": "string", "description": "Only reviews posted on or before this date (the whole day is included, as Yelp prints it on the review, in the business's own time zone), or older than a period such as `30 days`." }, "reviewLanguages": { "title": "Review languages", "maxItems": 50, "uniqueItems": true, "type": "array", "description": "Only reviews written in these languages, as two-letter codes (`en`, `es`, `fr`…). Empty = all languages.", "default": [], "items": { "type": "string" } }, "keywords": { "title": "Keywords", "maxItems": 50, "uniqueItems": true, "type": "array", "description": "Only reviews whose text contains at least one of these words or phrases (whole words, case and accents ignored; the text is the review as its author wrote it, not its translation). Empty = all. Up to 50 entries, each up to 100 characters.", "default": [], "items": { "type": "string" } }, "excludeKeywords": { "title": "Exclude keywords", "maxItems": 50, "uniqueItems": true, "type": "array", "description": "Drop the reviews whose text contains one of these words or phrases (whole words, case and accents ignored; the text is the review as its author wrote it, not its translation). Up to 50 entries, each up to 100 characters.", "default": [], "items": { "type": "string" } }, "withResponseOnly": { "title": "Only reviews with an owner reply", "type": "boolean", "description": "Keep only the reviews the business owner or manager has publicly answered.", "default": false }, "withPhotosOnly": { "title": "Only reviews with photos", "type": "boolean", "description": "Keep only the reviews that include at least one photo or video.", "default": false }, "minRating": { "title": "Min business rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Skip the businesses whose overall Yelp rating is below this (e.g. `4`). Checked on the first page of reviews, before reading the others. Empty = all businesses." }, "minReviewCount": { "title": "Min business review count", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Skip the businesses with fewer reviews than this on Yelp. Empty = all businesses." }, "requirePhone": { "title": "Only businesses with a phone", "type": "boolean", "description": "Skip the businesses that show no phone number on Yelp (checked with 1 small extra request per business, not charged).", "default": false }, "requireWebsite": { "title": "Only businesses with a website", "type": "boolean", "description": "Skip the businesses that show no website on Yelp (same check as above).", "default": false }, "priceLevels": { "title": "Price range", "uniqueItems": true, "type": "array", "description": "Only businesses with one of these Yelp price ranges (several allowed). Businesses with no price range on Yelp are skipped when this is set. Checked for 25 businesses at a time with 1 small request, not charged. Empty = all.", "items": { "type": "string", "enum": [ "$", "$$", "$$$", "$$$$" ], "enumTitles": [ "$ (inexpensive)", "$$ (moderate)", "$$$ (pricey)", "$$$$ (ultra high-end)" ] }, "default": [] }, "openNow": { "title": "Only businesses open now", "type": "boolean", "description": "Skip the businesses that are closed at the time of the run (Yelp's opening hours this week, in the business's own time zone; same small request as **Price range**, not charged).", "default": false }, "features": { "title": "Required amenities", "maxItems": 20, "uniqueItems": true, "type": "array", "description": "Only businesses that show ALL these amenities on Yelp, as written on the business page (e.g. `Outdoor seating`, `Offers delivery`, `Wheelchair accessible`, `Dogs allowed`; case ignored). Checked with 1 small extra request per business, not charged; a business that lacks one is skipped. Empty = all. Up to 20 entries, each up to 100 characters.", "default": [], "items": { "type": "string" } }, "onlyNew": { "title": "Only new reviews", "type": "boolean", "description": "Skip the reviews (or businesses, with **Scrape reviews** off) that a previous run with the same **Memory key** already delivered: they are not saved and not charged. With `Newest first`, reading a business stops at its first known review. First run = everything is new.", "default": false }, "stateKey": { "title": "Memory key", "pattern": "^[a-zA-Z0-9_-]{1,64}$", "maxLength": 64, "type": "string", "description": "Name of the memory used by **Only new reviews**. Give each schedule / task its own key (e.g. `my-restaurants`) so that they do not share their memory. Letters, digits, `-` and `_`.", "default": "default" }, "resetState": { "title": "Reset the memory", "type": "boolean", "description": "Forget everything remembered under this **Memory key** before the run: this run returns (and charges) every review again. Untick it afterwards.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy or your own proxies. Keep the default: it is included in the price. The residential Apify proxy is not available in this Actor (not needed for Yelp).", "default": { "useApifyProxy": true } }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of requests processed in parallel.", "default": 4 }, "maxRequestsPerMinute": { "title": "Max requests per minute", "minimum": 10, "maximum": 1000, "type": "integer", "description": "Most requests to Yelp in any 60 seconds, all of them counted (searches, review pages of 10 reviews, business details, photo pages). A budget, not an even pace: spread them with the minimum delay below. Lower it if Yelp answers HTTP 429 / 403 in the log.", "default": 120 }, "minRequestIntervalMs": { "title": "Min delay between requests", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Smallest gap between two requests, in milliseconds. Unlike the per-minute rate, this spreads the requests evenly instead of letting them go out in a burst. 0 = no gap.", "default": 0 }, "maxRequestRetries": { "title": "Max request retries", "minimum": 0, "maximum": 20, "type": "integer", "description": "Retries per request before it is marked as failed. Behind a proxy, a request Yelp turns away is also retried on a new proxy session up to 10 times without using up these retries.", "default": 5 }, "debugLog": { "title": "Debug log", "type": "boolean", "description": "Include debug messages in the run log.", "default": false }, "searchTerm": { "title": "searchTerm", "type": "string", "description": "Same as Search keyword." }, "searchQuery": { "title": "searchQuery", "type": "string", "description": "Same as Search keyword." }, "searchLocation": { "title": "searchLocation", "type": "string", "description": "Same as Location." }, "search_location": { "title": "search_location", "type": "string", "description": "Same as Location." }, "search_sort": { "title": "search_sort", "type": "string", "description": "Same as Search order." }, "searchLimit": { "title": "searchLimit", "type": "integer", "description": "Same as Max businesses per search." }, "maxResults": { "title": "maxResults", "type": "integer", "description": "Same as Max results." }, "maxReviewsPerBusiness": { "title": "maxReviewsPerBusiness", "type": "integer", "description": "Same as Max reviews per business." }, "maxReviewsPerUrl": { "title": "maxReviewsPerUrl", "type": "integer", "description": "Same as Max reviews per business." }, "maxReviews": { "title": "maxReviews", "type": "integer", "description": "Same as Max reviews per business." }, "reviews_limit": { "title": "reviews_limit", "type": "integer", "description": "Same as Max reviews per business." }, "reviews_sort": { "title": "reviews_sort", "type": "string", "description": "Same as Review order." }, "reviewsSort": { "title": "reviewsSort", "type": "string", "description": "Same as Review order." }, "date_from": { "title": "date_from", "type": "string", "description": "Same as Posted after." }, "dateFrom": { "title": "dateFrom", "type": "string", "description": "Same as Posted after." }, "dateTo": { "title": "dateTo", "type": "string", "description": "Same as Posted before." }, "language": { "title": "language", "type": "string", "description": "Same as Review languages (one code)." }, "reviews_translate": { "title": "reviews_translate", "type": "string", "description": "Same as Translate reviews to." }, "include_personal_data": { "title": "include_personal_data", "type": "boolean", "description": "Same as Include reviewer details." }, "fetchBusinessDetails": { "title": "fetchBusinessDetails", "type": "boolean", "description": "Same as Add full business details." }, "scrapeReviews": { "title": "scrapeReviews", "type": "boolean", "description": "Same as Scrape reviews." }, "maxImages": { "title": "maxImages", "type": "integer", "description": "Same as Business photos per business." }, "incremental": { "title": "incremental", "type": "boolean", "description": "Same as Only new reviews." }, "monitorKey": { "title": "monitorKey", "type": "string", "description": "Same as Memory key." }, "open_now": { "title": "open_now", "type": "boolean", "description": "Same as Only businesses open now." }, "priceLevel": { "title": "priceLevel", "type": "string", "description": "Same as Price range (`$$`, or `1,2`)." }, "searchPrice": { "title": "searchPrice", "type": "string", "description": "Same as Price range (`$$`, or `1,2`)." }, "minPrice": { "title": "minPrice", "type": "integer", "description": "Lowest price range, 1 ($) to 4 ($$$$): same as Price range." }, "maxPrice": { "title": "maxPrice", "type": "integer", "description": "Highest price range, 1 ($) to 4 ($$$$): same as Price range." }, "lat": { "title": "lat", "type": "number", "description": "Same as Latitude." }, "lon": { "title": "lon", "type": "number", "description": "Same as Longitude." }, "lng": { "title": "lng", "type": "number", "description": "Same as Longitude." } } }, "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 } } } } } } } } } }