/yelp/businesses/reviews

POST /api/yelp/businesses/reviews

Price: 20 credits

Get Yelp reviews for a business by alias, business id or business page URL, ordered by relevance, date or rating and optionally narrowed to given star ratings or a text query. Returns review text, rating, timestamp, reviewer profile, attached photos, reaction counts and the business owner reply.

How to use it

Fetch reviews of one Yelp business. business accepts an alias, a business id or a https://www.yelp.com/biz/... URL. sort_by: relevance, newest, oldest, highest_rated, lowest_rated, elites. ratings narrows to given star values (e.g. [1, 2] for negative reviews), query keeps only reviews mentioning a phrase, language selects the language the reviews were written in (English by default; businesses outside English-speaking markets often hold most of their reviews in the local language). Each review has id, text, language, rating, created_at (unix seconds), author (name, location, image, review_count, friend_count, photo_count, elite_year), photos, helpful_count/thanks_count/love_count/oh_no_count, check_in_count, is_first_review, expert_recognition and reply (owner response).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• business string required — Yelp business alias, business id or a business page URL (examples: "molinari-delicatessen-san-francisco", "FmGF1B-Rpsjq1f5b56qMwg"; minLength: 1)
• sort_by string — Review ordering (default: "relevance"; one of: "relevance", "newest", "oldest", "highest_rated", "lowest_rated", "elites")
• ratings array — Star ratings to include (default: []; examples: [5], [1,2])
• query string nullable — Only reviews containing this text (examples: "parking", "delivery")
• language string — Language of the reviews to return, as an ISO 639-1 code (default: "en"; examples: "en", "de", "fr", "es", "it", "ja"; minLength: 2; maxLength: 5)
• count integer required — Max number of reviews to return (min: 1)

Response

• @type string (default: "YelpReview")
• id string required
• text string nullable
• language string nullable
• rating integer nullable
• created_at integer nullable
• author object nullable
  • @type string (default: "YelpReviewAuthor")
  • id string required
  • name string nullable
  • location string nullable
  • image string nullable
  • review_count integer nullable
  • friend_count integer nullable
  • photo_count integer nullable
  • elite_year string nullable
  • is_elite_all_star boolean nullable
• photos array (default: [])
• helpful_count integer nullable
• thanks_count integer nullable
• love_count integer nullable
• oh_no_count integer nullable
• check_in_count integer nullable
• is_first_review boolean nullable
• expert_recognition string nullable
• reply object nullable
  • @type string (default: "YelpReviewReply")
  • text string nullable
  • author_name string nullable
  • author_role string nullable
  • created_at integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Business not found (well-formed identifier but no such Yelp business) Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.