/apartments/listings/search

POST /api/apartments/listings/search

Price: 10 credits

Search Apartments.com rental listings by location (city-state): for each result returns name, address, geo, rent range, per-bedroom pricing, amenities, move-in specials, photo and phone. Supports free-text keywords and filters by bedrooms, bathrooms, home type, price, size, amenities, pets, housing category, star rating and move-in date.

How to use it

Pass `location` as a city-state slug (`austin-tx`) or any Apartments.com search URL; a bare city name is rejected because the state suffix is what identifies the market. Every filter narrows one city, so there is no nationwide search. `rent_low`/`rent_high` span the whole property, while `bed_rents` gives the advertised starting price per bedroom count, so the two disagree by design. `bedrooms` selects that exact count except for `4`, which the source treats as four-or-more, and `studio` is its own value, not `0`; `min_baths` of `3` likewise means three-or-more. Several `amenities` are combined as AND, not OR. A location yields at most 700 properties whatever `count` asks for, and a narrow filter runs out well before that, so fewer rows than requested is a normal answer rather than a failure.

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 city-state slug (e.g. houston-tx) or a search URL (examples: "houston-tx", "austin-tx", "https://www.apartments.com/chicago-il/"; minLength: 1)
• count integer required — Max number of listings to return (min: 1)
• bedrooms string nullable — Filter by number of bedrooms (one of: "studio", "1", "2", "3", "4")
• home_type string nullable — Filter by home type (one of: "apartments", "houses", "condos", "townhomes")
• min_price integer nullable — Minimum monthly rent (min: 0)
• max_price integer nullable — Maximum monthly rent (min: 0)
• keywords string nullable — Free-text query matched against listing text (examples: "rooftop pool", "loft"; minLength: 1)
• min_baths integer nullable — Minimum number of bathrooms, where 3 means three or more (min: 1; max: 3)
• min_sqft integer nullable — Minimum unit size in square feet (min: 0)
• max_sqft integer nullable — Maximum unit size in square feet (min: 0)
• pets string nullable — Keep only properties allowing these pets (one of: "dogs", "cats", "dogs_and_cats")
• amenities array nullable — Keep only properties offering every listed amenity (one of: "in_unit_washer_dryer", "dishwasher", "air_conditioning", "balcony", "fireplace", "furnished", "fitness_center", "pool", "playground", "parking", "wheelchair_access", "elevator", "washer_dryer_hookups", "laundry_facilities", "utilities_included", "lofts", "doorman", "gated", "concierge", "clubhouse", "controlled_access", "business_center", "garage", "patio", "hardwood_floors", "den", "office", "yard", "walk_in_closets", "basement", "ev_charging", "storage_units", "high_ceilings", "dog_park"; examples: ["pool","garage"])
• specialty string nullable — Keep only properties of this housing category (one of: "senior", "military", "student", "corporate", "short_term", "income_restricted", "luxury", "cheap", "rent_specials")
• min_rating integer nullable — Minimum star rating published by the source, 4 or 5 (min: 4; max: 5)
• move_in_date string nullable — Keep only properties available on this date, as YYYY-MM-DD (examples: "2026-12-01")

Response

• @type string (default: "ApartmentsSearchListing")
• id string required
• url string required
• name string nullable
• phone string nullable
• address object nullable
  • @type string (default: "ApartmentsAddress")
  • street string nullable
  • city string nullable
  • region string nullable
  • postal_code string nullable
  • country string nullable
• geo object nullable
  • @type string (default: "ApartmentsGeo")
  • latitude number nullable
  • longitude number nullable
• rent_low integer nullable
• rent_high integer nullable
• currency string nullable
• availability string nullable
• image string nullable
• amenities array (default: [])
• specials array (default: [])
• bed_rents array (default: [])
  • @type string (default: "ApartmentsSearchBedRent")
  • beds string nullable
  • price 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.