Skip to main content
POST
cURL

Body

application/json

Yelp review scraping parameters

query
string
required

Provide proper item URL.

sort_type
enum<string>
default:RELEVANCE_DESC

Order in which reviews should be sorted

Available options:
DATE_DESC,
DATE_ASC,
RATING_DESC,
RATING_ASC,
ELITES_DESC,
RELEVANCE_DESC
reviews_to_fetch
number

Number of reviews to fetch (default: all reviews, or within 30-second timeout)

review_unique_id
string

The hash ID of the last review up to which you want to fetch the reviews is used in automated fetching

is_text_formatted
boolean

returns the review text with visual formatting preserved

sync_date
string

Fetches reviews posted on a specific date using format: YYYY-MM-DD

Response

Reviews fetched successfully

all_reviews
object[]

Array of fetched reviews

extra_information
object
message
string

Status message about the review extraction