Yelp Scraper

Yelp scraper is an Apify actor able to extract reviews and ratings from Yelp business pages. The scraper is capable of performing Yelp searches, either by querying Yelp with an optional location or by scraping direct URLs pointing to searches. Also, the scraper recognizes Yelp business pages and scrapes reviews from direct business URLs.

The scraper uses Apify SDK and can be run locally or using Apify cloud platform.

Input

When using the scraper on the Apify platform or locally, there are multiple configurable input variables available:

Field	Type	Required	Default	Description
searchTerm	string	see below		Used for searching particular item, service, or business.
location	string	No		Location to search.
searchLimit	number	No	10	Number of search results to crawl from each search results page specified.
directUrls	array	see below	[]	Predefined collection of string URLs to scrape review. Can be search URLs or business pages, other URLs will be ignored.
reviewLimit	number	No	20	Minimum number of reviews to scrape.
proxy	proxy configuration	Yes	{ useApifyProxy: true }	Proxy groups and other proxy related configuration.
maxRequestRetries	number	No	10	How many times a failed request is retried before thrown away. Requests usually failed when blocked by the target site.

One of searchTerm or directUrls is required. If none are specified, nothing will be scrapped.

Output

You'll get your review in the following schema:

{
  "directUrl": "<business url>",
  "bizId": "<business id>",
  "name": "<business id>",
  "description": "<business description>",
  "categories": ["<business categories>"],
  "type": "<business type>",
  "phone": "<business phone>",
  "amenitiesAndMore": ["<amenities"],
  "healthInspections": [
    "score": "<score>",
    "providerName": "<provider name>"
  ],
  "reviewCount": "<business reviewCount>",
  "businessHighlights": ["<highlight>"],
  "aggregatedRating": "<business rating>",
  "priceRange": "<business price range>",
  "cuisine": "<business cuisine>",
  "website": "<business website>",
  "images" : ["<bussiness image URL>"],
  "address": {
    "addressLocality": "<business locality>",
    "addressRegion": "<business city>",
    "streetAddress": "<business address>",
    "postalCode": "<business postal>",
    "addressCountry": "<business country>"
  },
  "reviews": [
    {
      "date": "<review date>",
      "rating": "<rating>",
      "text": "<review text>",
      "photos": [
        "https://<photoURL>",
        //...
      ],
      "isFunnyCount": 0,
      "isUsefulCount": 1,
      "isCoolCount": 1,
      // Not a real name and URL
      "reviewerName": "John Doe",
      "reviewerUrl": "https://www.yelp.com//user_details?userid=12311231231231",
      "reviewerReviewCount": 43,
      "reviewerLocation": "Rowland Heights, CA"
    },
    //...
  ]
}

Usage

If you want to run the actor on the Apify platform, you need to open the actor's page in the Store and then click on Try for free. That will create a task (actor configuration) on your account. When using public actors, you don't need to build them since the author already did everything. You only need to provide input, and then you can run them. But keep in mind that resource usage will always be charged towards the account which runs the actor. You can also use webhooks to let it run automatically after any actor or task.

If you want to run the actor locally, you need to open the actor's github page and clone it to your computer.

Advanced data access

You might want to access the scraped reviews in a flat format. Apify API provides a simple way to do just that. When accessing your dataset through the API, you can tell the API server to provide one review per dataset entry using the unwind GET parameter:

    https://api.apify.com/v2/datasets/<DatasetId>/items?unwind=reviews

This functionality is documented in the Apify API documentation under Datasets -> Item collection -> Get items.

Personal data

Reviews can contain personal data like person name or profile link that can be used to track down the reviewer. Personal data is protected by GDPR in the European Union and by other regulations around the world. You should not scrape personal data unless you have a legitimate reason to do so. If you're unsure whether your reason is legitimate, consult your lawyers. This scraper allows you to granularly select which personal data fields you want to extract from reviews and which not. By default the scraper does not extract those fields.

Integrations and Yelp Scraper

Last but not least, Yelp Scraper can be connected with almost any cloud service or web app thanks to integrations on the Apify platform. You can integrate with Make, Zapier, Slack, Airbyte, GitHub, Google Sheets, Google Drive, and more. Or you can use webhooks to carry out an action whenever an event occurs, e.g. get a notification whenever Yelp Scraper successfully finishes a run.

Using Yelp Scraper with the Apify API

The Apify API gives you programmatic access to the Apify platform. The API is organized around RESTful HTTP endpoints that enable you to manage, schedule, and run Apify actors. The API also lets you access any datasets, monitor actor performance, fetch results, create and update versions, and more.

To access the API using Node.js, use the apify-client NPM package. To access the API using Python, use the apify-client PyPI package.

Check out the Apify API reference docs for full details or click on the API tab for code examples.

Changelog

This scraper is under active development. We are always implementing new features and fixing bugs. If you would like to see a new feature, please submit an issue on GitHub. Check CHANGELOG.md for a list of recent updates.