/hotpads/listings/search

POST /api/hotpads/listings/search

Price: 20 credits

Search HotPads rental listings by location (city and state) with optional filters: rental category (apartments, houses, condos, townhomes, rooms, sublets, corporate housing), property type, price range, bedrooms, bathrooms, pets, amenities, laundry, furnished, square footage, keywords, restricted housing programs, promotions and sort order. Returns listings with address, coordinates, price and beds/baths/sqft ranges, property type, images, amenity highlights and posting dates.

How to use it

Search HotPads rentals in a US city (location='Austin, TX' or 'austin-tx'). Optional filters: category, home_type, price_min/price_max, beds, baths, pets, amenities, laundry, furnished, sqft_min/sqft_max, keywords, restricted_housing, has_promotions, sort. Each item has id, url, address, neighborhood, latitude/longitude, price_min/price_max, bed_min/bed_max, bath_min/bath_max, sqft_min/sqft_max, property_type, image (thumbnail; full gallery via the listings/buildings detail endpoints), amenity_highlights, has_special_offers and activated_at/updated_at.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• location string required — City and two-letter state ('Austin, TX') or a HotPads location slug ('austin-tx') (examples: "Austin, TX", "san-francisco-ca"; minLength: 1)
• category string — Rental category (default: "apartments"; one of: "apartments", "houses", "condos", "townhomes", "rooms", "sublets", "corporate_housing")
• home_type array nullable — Property type filter (one of: "apartment", "condo", "duplex", "house", "townhouse")
• price_min integer nullable — Minimum monthly rent (min: 0)
• price_max integer nullable — Maximum monthly rent (min: 0)
• beds string nullable — Bedroom count filter (one of: "studio", "one_plus", "two_plus", "three_plus", "four_plus")
• baths string nullable — Minimum bathrooms filter (one of: "one_plus", "one_half_plus", "two_plus", "three_plus", "four_plus")
• pets array nullable — Pets allowed filter (one of: "cats", "dogs")
• amenities array nullable — Required amenities (one of: "cooling", "heating", "parking", "gated_entry", "doorman", "fitness_center", "swimming_pool", "dishwasher")
• laundry array nullable — Laundry availability (one of: "in_unit", "shared")
• furnished boolean nullable — Only furnished rentals
• sqft_min integer nullable — Minimum square footage (min: 0)
• sqft_max integer nullable — Maximum square footage (min: 0)
• keywords string nullable — Free-text keyword filter
• restricted_housing string nullable — Restricted housing program filter (one of: "income", "senior", "student", "military")
• has_promotions boolean nullable — Only listings with special offers
• sort string — Result ordering (default: "newest"; one of: "recommended", "newest")
• count integer required — Max number of listings to return (min: 1)

Response

• @type string (default: "HotpadsSearchListing")
• id string required
• url string required
• property_type string nullable
• listing_type string nullable
• alias string nullable
• name string nullable
• address object nullable
  • @type string (default: "HotpadsAddress")
  • street string nullable
  • city string nullable
  • state string nullable
  • zip_code string nullable
• neighborhood string nullable
• latitude number nullable
• longitude number nullable
• price_min number nullable
• price_max number nullable
• bed_min number nullable
• bed_max number nullable
• bath_min number nullable
• bath_max number nullable
• sqft_min number nullable
• sqft_max number nullable
• image string nullable
• photo_count integer nullable
• has_special_offers boolean nullable
• income_restricted boolean nullable
• senior_housing boolean nullable
• student_housing boolean nullable
• military_housing boolean nullable
• amenity_highlights array (default: [])
• activated_at integer nullable
• updated_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.