Yelp Reviews API
A GET request to our /api/getter/?platform="yelp_reviews" endpoint allows you to scrape Yelp reviews for any Yelp listing URL.
Example
To scrape Yelp reviews for Caesar's Palace in Las Vegas, you can pass its listing URL to our endpoint as showcased below:
1 | |
Note
When using curl, it is necessary to add the option -L to get the data back. This is because in some cases our server responds with a 301 and curl does not follow the redirect by default.
Query Parameters
As you can see in the example above, our endpoint needs the following query parameters:
Review Query
url
Required
Business listing's URL on Yelp. Remove unnecessary query parameters and encode the URL.
page
Optional
The page number for which you want the results. Default value is 1.
Other Required Parameters
platform
Required
Specifies the scraping engine you wish to invoke. In this case, the value should be yelp_reviews.
api_key
Required
Your account's token—which can be obtained by signing up here.
Note
The value of the query parameter url must be URL or percent encoded. If you're using Python, this can be done with the function urlencode.
Results
The response will include the following attirbutes for each review present in the response:
| Attributes Returned | Data Type | Information Represented |
|---|---|---|
| id | string | Yelp's ID of the review |
| date | string | Date when review was published |
| rating | int | Rating by reviewer |
| review_text | string | Review's text content |
| review_url | string | Link to review |
| lang | string | Two letter language code for the review |
| author_avatar | string | Link to reviewer's avatar |
| author_name | string | Reviewer's name |
| author_url | string | Reviewer's Yelp profile link |
| review_imgs | list | Links to reviewer's images, if any |
| meta_data | dict | Info on number of useful, funny and cool votes. |
| location | string | City / State level location of the user |
| response | dict | Info on business' response to the reviewer |
Response Example
Here's the response you can expect for the request showcased above:
{
"success": true,
"url": "https://www.yelp.com/biz/geller-law-san-francisco-3",
"page": 1,
"total_results": 98,
"no_of_pages": 10,
"result_count": 10,
"reviews": [
{
"id": "aPcQVtUw9x--LJoKoqDYnw",
"date": "2022-04-01",
"rating": 5,
"review_title": "",
"review_text": "Best lawyer. Hands down. My go-to guy, recommend him to everyone. He knows his stuff and always responds quickly and eases any anxiety. Don't be a fool and call Geller Law.",
"review_url": "https://www.yelp.com?hrid=aPcQVtUw9x--LJoKoqDYnw",
"lang": "en",
"author_avatar": "https://s3-media0.fl.yelpcdn.com/assets/srv0/yelp_styleguide/514f6997a318/assets/img/default_avatars/user_60_square.png",
"author_url": "https://www.yelp.com/user_details?userid=PicdSURm75jR2PkpXtIgxA",
"author_name": "Maria M.",
"meta_data": {
"author_contributions": 25,
"feedback": {
"useful": 0,
"funny": 0,
"cool": 0
}
},
"location": "Lafayette, CA",
"response": null
},
{
"id": "O5-filEJKKah2pCl_NW8nw",
"date": "2022-03-29",
"rating": 5,
"review_title": "",
"review_text": "Sam is so knowledgeable, patient, and kind. I am currently dealing with a situation and Sam put my anxiety at ease and let me know all the possible scenarios. Could not recommend enough.",
"review_url": "https://www.yelp.com?hrid=O5-filEJKKah2pCl_NW8nw",
"lang": "en",
"author_avatar": "https://s3-media0.fl.yelpcdn.com/assets/srv0/yelp_styleguide/514f6997a318/assets/img/default_avatars/user_60_square.png",
"author_url": "https://www.yelp.com/user_details?userid=jqRmHfLcJYaOn6vd7z5Xsw",
"author_name": "Reza B.",
"meta_data": {
"author_contributions": 208,
"feedback": {
"useful": 0,
"funny": 0,
"cool": 0
}
},
"location": "San Francisco, CA",
"response": {
"text": "Thank you so much. Best of luck",
"name": "Samuel G.",
"role": "Business Owner",
"date": "2022-03-29"
}
},
...
{
"id": "4LnQXEr4G6uhlSdLAnfFuw",
"date": "2021-12-15",
"rating": 5,
"review_title": "",
"review_text": "Sam has been handling my case in a very professional way and gave me all the possible choices to get a successful outcome. He is efficient and I am recommending him.",
"review_url": "https://www.yelp.com?hrid=4LnQXEr4G6uhlSdLAnfFuw",
"lang": "en",
"author_avatar": "https://s3-media0.fl.yelpcdn.com/photo/vVKYSzLmiSe2XdP_xIOPZg/60s.jpg",
"author_url": "https://www.yelp.com/user_details?userid=qqB_duyqFn3pYEkiZuxj6w",
"author_name": "Joel D.",
"meta_data": {
"author_contributions": 9,
"feedback": {
"useful": 1,
"funny": 0,
"cool": 1
}
},
"location": "Sunnyvale, CA",
"response": {
"text": "Thank you for the opportunity to work on your matter and taking the time to leave me a review.",
"name": "Samuel G.",
"role": "Business Owner",
"date": "2022-02-27"
}
}
],
"meta_data": {
"lang": "en",
"lang_stats": [
{
"code": "en",
"count": 98
}
]
}
}
Request Cost
Each request returns up to 10 reviews and costs 10 credits.
Support
If you want to add a parameter to our response, or have any question or feedback, please write to us at support@unwrangle.com