Skip to main content
GET
Get advertised units and floor plans
Available after a successful HotPads building detail request in the same account. Each stored page costs 1 credit; failures and idempotent replay cost zero. This route makes no fresh source call.
Use the building_id from the original rental search after calling building details. Returns only explicit floor plans with kind=floor_plan, model labels, source-reported monthly USD rent or ranges, bedrooms, bathrooms and area. Availability dates and portal-native model identities remain unknown. Unit-like records without explicit floor-plan evidence are omitted. These are advertised models, not verified physical units. Pagination totals count retained floor plans only. No occupancy, complete unit inventory, current availability or all-in booking quote is implied. Observations expire after 24 hours; missing, expired or unrelated-account observations return 404. Use limit from 1–100 (default 20) and the returned opaque cursor with the same page size. Cursors are tied to the account and retained observation. See coverage for scope.
Check live capabilities before calling this operation. Coverage is source and country specific.

Authorizations

x-api-key
string
header
required

Path Parameters

building_id
string
required
Minimum string length: 1

Query Parameters

limit
integer
default:20
Required range: 1 <= x <= 100
cursor
string

Response

Successful response; meta discloses source completeness

data
object[]
required
meta
object
required