scraper
Back to API docs

Overview

  • Overview

APIs

  • POSTReviews

Yelp Reviews

1 credit

Get reviews for a local business from Yelp.

POST/api/v1/tools/yelp/reviews

Parameters

businessstringrequired

Business alias or Yelp URL. Accepts a plain alias like "gary-danko-san-francisco" or a full URL like "https://www.yelp.com/biz/gary-danko-san-francisco".

sortBystring

Sort order for reviews. One of "DATE_DESC" (newest first), "DATE_ASC" (oldest first), "RATING_DESC" (highest first), "RATING_ASC" (lowest first), "ELITES_DESC" (elite reviewers first). Defaults to "DATE_DESC".

ratingsnumber[]

Filter by star rating. Array of integers from 1 to 5. Defaults to [1, 2, 3, 4, 5] (all ratings).

maxReviewsnumber

Maximum number of reviews to return. Must be a positive integer. Defaults to 20. Upper bound is determined by your plan.

languageCodestring

Language code for reviews. Defaults to "en".

querystring

Keyword search within review text. Matching terms are wrapped in [[HIGHLIGHT]]...[[ENDHIGHLIGHT]] markers. Omit or leave empty to skip keyword filtering.

includeBusinessDataboolean

Include the full business data object in the response. Defaults to true.

fieldsstring[]

Fields to include per review. Omit for defaults: id, rating, text, language, createdAt, author, feedback, ownerReply. Use ["*"] for all fields. Available fields: id, rating, text, language, createdAt, author, feedback, ownerReply, businessAlias, businessName, businessEncId, translatedText, localDateTime, reactions, photos, videos, previousReviewIds, tags, expertRecognition, userSpecifiedTimeOfExperience, scrapedAt.

Response Schema

dataobject

Yelp reviews result

businessobject | null

Business data. Included when includeBusinessData is true (the default). Null otherwise.

reviewsobject[]

Array of review objects. Fields depend on the fields parameter. Default fields: id, rating, text, language, createdAt, author, feedback, ownerReply.

countnumber

Number of reviews returned

totalReviewsnumber

Total number of reviews matching the filters

truncatedboolean

True if results were cut short due to a timeout. Only present when truncation occurred.

metaobject

Request metadata

toolstring

Tool name (yelp-reviews)

creditsUsednumber

Credits consumed (1)

requestIdstring

Unique request ID

Request

curl -X POST https://scraper.run/api/v1/tools/yelp/reviews \
  -H "Authorization: Bearer sc_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "business": "https://www.yelp.com/biz/gary-danko-san-francisco",
    "maxReviews": 10,
    "ratings": [4, 5],
    "sortBy": "DATE_DESC"
  }'

Response Example

{
  "data": {
    "business": {
      "id": "WavvLdfdP6g8aZTtbBQHTw",
      "alias": "gary-danko-san-francisco",
      "name": "Gary Danko",
      "rating": 4.5,
      "reviewCount": 5842
    },
    "reviews": [
      {
        "id": "xAG4O7l-t1ubbwVAlPnDKg",
        "rating": 5,
        "text": "Outstanding dining experience from start to finish. The tasting menu was creative and every course was perfectly executed.",
        "language": "en",
        "createdAt": "2026-04-08T21:15:00.000Z",
        "author": {
          "id": "hizGc5W1tBHPghM5YKCAtg",
          "displayName": "Anna S.",
          "displayLocation": "San Francisco, CA",
          "reviewCount": 87,
          "friendCount": 42,
          "photoCount": 15,
          "eliteYear": "2026",
          "profilePhotoUrl": null,
          "isEliteAllStar": false
        },
        "feedback": {
          "usefulCount": 3,
          "funnyCount": 0,
          "coolCount": 1
        },
        "ownerReply": "Thank you for the wonderful review, Anna! We look forward to welcoming you back."
      },
      {
        "id": "SIoiwGkYB7aOm30yBqFsaw",
        "rating": 4,
        "text": "Great food and ambiance. Service was attentive but the wait for a table was longer than expected.",
        "language": "en",
        "createdAt": "2026-04-05T18:30:00.000Z",
        "author": {
          "id": "n6-Gk65cPZL6Uz8qRm3NYw",
          "displayName": "Mike R.",
          "displayLocation": "Oakland, CA",
          "reviewCount": 34,
          "friendCount": 12,
          "photoCount": 5,
          "eliteYear": null,
          "profilePhotoUrl": null,
          "isEliteAllStar": false
        },
        "feedback": {
          "usefulCount": 1,
          "funnyCount": 0,
          "coolCount": 0
        },
        "ownerReply": null
      }
    ],
    "count": 2,
    "totalReviews": 5842
  },
  "meta": {
    "tool": "yelp-reviews",
    "creditsUsed": 1,
    "requestId": "req_abc123"
  }
}