/hotpads/buildings

POST /api/hotpads/buildings

Price: 5 credits

Get full HotPads multi-unit building details by short id (or building URL): building name, address, coordinates, neighborhood, description, price and beds/baths/sqft ranges, unit count, amenities, pet policies, photos, videos, 3D tours, lease terms, special offers, property manager, available units (floor plans and units with beds/baths/price/sqft) and per-bedroom pricing groups.

How to use it

Fetch a single HotPads multi-unit building by short id (e.g. 'skbegf') or a building URL. Returns one building with id, url, name, address, neighborhood, latitude/longitude, price/bed/bath/sqft ranges, unit_count, amenities, amenity_highlights, pet_policies, image and images, videos, tour_urls, special_offers, lease_terms, contact_times, property_manager fields, units (floor plans and units) and bed_groups (per-bedroom pricing).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• building string required — HotPads building short id ('skbegf') or a building URL (examples: "skbegf", "https://hotpads.com/the-seneca-apartments-chicago-il-60611-skbegf/building"; minLength: 1)

Response

• @type string (default: "HotpadsBuilding")
• id string required
• url string required
• name string nullable
• property_type string nullable
• listing_type string nullable
• alias string nullable
• description 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
• unit_count integer nullable
• is_furnished boolean nullable
• lease_terms string nullable
• contact_times string nullable
• amenities array (default: [])
• amenity_highlights array (default: [])
• pet_policies array (default: [])
  • @type string (default: "HotpadsPetPolicy")
  • pet_type string nullable
  • pet_size string nullable
  • allowed boolean nullable
• image string nullable
• images array (default: [])
• photo_count integer nullable
• videos array (default: [])
• tour_urls array (default: [])
• special_offers array (default: [])
• property_manager string nullable
• property_manager_contact string nullable
• property_manager_phone string nullable
• property_manager_website string nullable
• units array (default: [])
  • @type string (default: "HotpadsUnit")
  • id string nullable
  • name string nullable
  • type string nullable
  • model_type string nullable
  • bed_count number nullable
  • bath_count number nullable
  • price_min number nullable
  • price_max number nullable
  • sqft number nullable
  • availability_date string nullable
  • image string nullable
• bed_groups array (default: [])
  • @type string (default: "HotpadsBedGroup")
  • label string required
  • bed_min number nullable
  • bed_max number nullable
  • bath_min number nullable
  • bath_max number nullable
  • price_min number nullable
  • price_max number nullable
  • sqft_min number nullable
  • sqft_max number nullable
  • unit_names array (default: [])
• created_at integer nullable
• updated_at integer nullable
• listed_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 — Building not found (well-formed but nonexistent building short id) 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.