Skip to main content
POST
cURL

Body

application/json

HomeStars.com review scraping parameters

query
string
required

Provide a proper HomeStars company URL or company_id.

sort_type
enum<string>
default:recent

Order in which reviews should be sorted

Available options:
recent,
relevant,
by_star_reviewers,
with_photos,
highest_first,
lowest_first
reviews_to_fetch
number

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

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