Skip to main content
POST
/
homestars-com
/
reviews
cURL
curl --request POST \
  --url https://api.hobbo.ai/homestars-com/reviews \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "sort_type": "recent",
  "reviews_to_fetch": 123,
  "is_text_formatted": true,
  "sync_date": "<string>"
}
'
{
  "all_reviews": [
    {
      "author_id": "<string>",
      "author_location": "<string>",
      "author_name": "<string>",
      "external_consumer_name": "<string>",
      "query": "<string>",
      "review_date": "<string>",
      "review_id": "<string>",
      "review_image_urls": [
        "<string>"
      ],
      "review_rating": 123,
      "review_reply": {
        "reply_date": "<string>",
        "reply_id": "<string>",
        "reply_image_urls": [
          "<string>"
        ],
        "reply_text": "<string>",
        "reply_update_date": "<string>"
      },
      "review_text": "<string>",
      "review_title": "<string>",
      "review_unique_id": "<string>",
      "review_update_date": "<string>",
      "service_id": "<string>",
      "service_slug": "<string>",
      "status": "<string>",
      "title": "<string>"
    }
  ],
  "extra_information": {
    "extra_information": {},
    "total_review_count": 123,
    "total_review_count_list": [
      123
    ]
  },
  "message": "<string>"
}

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