Skip to main content
POST
/
apartments_com
/
reviews
cURL
curl --request POST \
  --url https://py-api.hobbo.ai/apartments_com/reviews \
  --header 'Content-Type: application/json' \
  --data '{
  "query": "<string>",
  "sort_type": "1",
  "reviews_to_fetch": 123,
  "is_text_formatted": true,
  "sync_date": "<string>"
}'
{
  "all_reviews": [],
  "extra_information": {},
  "message": "<string>"
}

Body

application/json

Apartments.com review scraping parameters

​
query
string
required

Provide proper apartment page URL or apartment_slug

​
sort_type
enum<string>
default:1

Order in which reviews should be sorted

Available options:
1,
2,
4,
8
​
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