/apartmentlist/listings/similar

POST /api/apartmentlist/listings/similar

Price: 10 credits

Get listings similar to a given Apartment List rental (by listing URL or /{state}/{city}/{slug} path): each result returns name, address, neighborhood, geo, phone, bed counts, price range, available unit count and soonest availability, rent-special flag, amenities, photos and the community summary with its rating where Apartment List has one.

How to use it

Fetch listings similar to a given Apartment List rental (input its URL or /{state}/{city}/{slug} path). Each result is a community card: identity and alias (feed it back to apartmentlist/listings for the full record), address and geo, bed counts and price range, availability, amenities and photos. rating, value_rating, review_snippet and standout_category are served only for communities with verified ratings.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• listing string required — Apartment List listing URL or /{state}/{city}/{slug} path (examples: "/co/denver/ladora-modern-apartments"; minLength: 1)
• count integer required — Max number of similar listings to return (min: 1)

Response

• @type string (default: "ApartmentlistSimilarListing")
• id string required
• url string nullable
• alias string nullable
• name string nullable
• street_address string nullable
• city string nullable
• state string nullable
• zip string nullable
• neighborhood string nullable
• latitude number nullable
• longitude number nullable
• phone string nullable
• beds array (default: [])
• lowest_price number nullable
• highest_price number nullable
• available_unit_count integer nullable
• available_on string nullable
• has_rent_special boolean nullable
• show_price boolean nullable
• has_unit_level_availability boolean nullable
• occupancy_types array (default: [])
• updated_at integer nullable
• summary string nullable
• rating number nullable
• value_rating number nullable
• review_snippet string nullable
• standout_category string nullable
• image string nullable
• images array (default: [])
• community_amenities array (default: [])
• unit_amenities array (default: [])

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 — Listing not found (well-formed but nonexistent listing URL/slug) 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.