/apartmentlist/listings/reviews

POST /api/apartmentlist/listings/reviews

Price: 5 credits

Get Apartment List verified-review summaries for every rental in a location ({state}/{city}): for each listing returns overall, amenities and value ratings, review count, and a highlighted review snippet with its author, rating and date.

How to use it

Fetch Apartment List review summaries for all rentals in a {state}/{city} location (e.g. co/denver). Each result carries the listing id, overall/amenities_rating/value_rating, rating_count, best/worst rating and a review snippet (text/author/snippet_rating/created_at). Match id to a listing via apartmentlist/listings/search.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• city string required — Location as an Apartment List city URL or {state}/{city} slug (examples: "co/denver", "tx/austin"; minLength: 1)
• count integer required — Max number of listing review summaries to return (min: 1)

Response

• @type string (default: "ApartmentlistReviewSummary")
• id string required
• overall number nullable
• amenities_rating number nullable
• value_rating number nullable
• rating_count integer nullable
• best_rating number nullable
• worst_rating number nullable
• text string nullable
• author string nullable
• snippet_rating number nullable
• created_at integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.