/apartmentlist/listings/search

POST /api/apartmentlist/listings/search

Price: 20 credits

Search Apartment List rental listings by location ({state}/{city}): for each result returns name, geo, per-bedroom starting price and photo. Supports filters by bedrooms, bathrooms, price range, amenities, housing type, curated collection and move-in date.

How to use it

Search live Apartment List rental listings in a {state}/{city} location (e.g. co/denver). Returns listings with id, url, alias, name, geo and per-bedroom starting price (price_studio/price_1br/price_2br/price_3br). Use the returned alias/url with apartmentlist/listings for full details. Filter by beds, baths, min_price/max_price, amenities, occupancy_type and collection.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• location string required — Location as an Apartment List city URL or {state}/{city} slug (examples: "co/denver", "tx/austin", "https://www.apartmentlist.com/il/chicago"; minLength: 1)
• count integer required — Max number of listings to return (min: 1)
• beds array nullable — Filter by bedroom counts (one of: "studio", "1", "2", "3")
• baths string nullable — Filter by minimum number of bathrooms (one of: "1", "2", "3")
• min_price integer nullable — Minimum monthly rent (min: 0)
• max_price integer nullable — Maximum monthly rent (min: 0)
• amenities array nullable — Filter by required amenities (one of: "accessible", "air_conditioning", "bbq", "balcony", "bathtub", "business_center", "carpet", "cat_friendly", "ceiling_fan", "dishwasher", "dog_friendly", "pet_friendly", "pickleball", "doorman", "elevator", "fireplace", "furnished", "garage", "garbage_disposal", "granite_counter", "gym", "hardwood_floors", "heat", "hot_tub", "ice_maker", "in_unit_laundry", "on_site_laundry", "parking", "pool", "stainless_steel", "walk_in_closet", "laundry_connections")
• occupancy_type string nullable — Filter by housing type (default is conventional) (one of: "student", "senior")
• collection string nullable — Curated listing collection (one of: "most_popular", "best_rent_specials", "luxury", "best_in_budget")
• move_in_date string nullable — Desired move-in date (YYYY-MM-DD)

Response

• @type string (default: "ApartmentlistSearchListing")
• id string required
• url string nullable
• alias string nullable
• name string nullable
• latitude number nullable
• longitude number nullable
• price_studio number nullable
• price_1br number nullable
• price_2br number nullable
• price_3br number nullable
• show_price boolean nullable
• rank 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.