Yelp Reviews API
Last updated
Last updated
EndpointGET https://serpapi.abcproxy.com/search
Description
Our Yelp Reviews API allows you to scrape results from the Yelp Place search page. The API is accessed through the following endpoint:
/search?engine=yelp_reviews
. A user may query the following:https://serpapi.abcproxy.com/search?engine=yelp_reviews
utilizing aGET
request. Head to the for a live and interactive demo.
Search Query
place_id
String
Yes
MGzro82Fi4LYvc86acoONQ
Localization
yelp_domain
String
No
price_low
hl
String
No
en
Advanced Yelp Parameters
q
string
No
Parameter defines the query you want to use to search through Yelp Reviews.
123
sortby
string
No
Parameter is used for sorting results. Available options:
relevance_desc
- Yelp Sort (default)
date_desc
- Newest First
date_asc
- Oldest Rated
rating_desc
- Highest Rated
rating_asc
- Lowest Rated
elites_desc
- Elites
-
rating
string
No
Parameter filters out the results by rating. Possible values are 5
, 4
, 3
, 2
, and 1
. All results are included by default.
To only show results with the five star rating, the value should be set to 5
To include results with multiple ratings, the value should for example be set to 5,4,3
(each rating separated by comma ,
).
5
not_recommended
boolean
No
Parameter fetches reviews that are not recommended by Yelp. It can be set to true
to only show not recommended reviews, or false
to show recommended reviews. By default, only recommended reviews are shown.
true
orfalse
Pagination
start
String
No
Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., 0
(default) is the first page of results, 49
is the 2nd page of results, 98
is the 3rd page of results, etc.).
1
num
String
No
Parameter defines the maximum number of results to return. 49
(default) returns 49 results. Maximum number of results to return is 49
.
49
not_recommended_start
String
No
Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., 0
(default) is the first page of results, 10
is the 2nd page of results, 20
is the 3rd page of results, etc.).
1
Serpapi Parameters
engine
String
Yes
Set parameter to yelp_reviews
to use the Google Finance API engine.
yelp_reviews
no_cache
boolean
No
Parameter will force SerpApi to fetch the results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to false
(default) to allow results from the cache, or true
to disallow results from the cache.
true
orfalse
api_key
string
Yes
Parameter defines the SerpApi private key to use.
123
Response Body
Response Fields
search_parameters
Object
Contains query parameters and search context
search_metadata
Object
Contains timing and status information
ReviewLanguages[]
Object[]
Review Languages Information Parameters
Reviews[]
Object[]
Review Information Parameters
SerpapiPagination
string
SerpapiPagination Information Parameters
Common Errors
200
400
API Key can not be empty
200
401
Param error
200
402
API Key error
200
403
Insufficient Balance
200
404
Deduction failed
200
405
Failed to record usage count
200
406
Unsupported engine
200
407
Network error
200
408
File not found
200
409
Limit param error
200
410
Build url error
200
411
Failed to QueryRecentRecord
200
412
Failed to find json
200
413
Get html error
200
414
HTML is empty
200
429
Too many request
Error Example
Parameter defines the Yelp ID of a place. Each place has two unique IDs (e.g. ED7A7vDdg8yLNKJTSVHHmg
and arabica-brooklyn
). Only the first ID type is supported (e.g. ED7A7vDdg8yLNKJTSVHHmg
). To extract the ID of a place, you can use our .
Parameter defines the Yelp domain to use. It defaults to yelp.com
. Head to the for a full list of supported Yelp domains.
Parameter defines the language to use for sorting Yelp Reviews. It's a two-letter language code. (e.g., en
for English, es
for Spanish, or fr
for French) Head to the Yelp Reviews languages for a full list of supported .