Skip to main content

BuildingType

Used in search filters (buildingType parameter) and returned in listing/building responses. buildingType is null when the source did not report one.
MULTIFAMILY (no underscore) is accepted as an input alias for MULTI_FAMILY on the buildingType and excludeBuildingType filters. Responses always return the canonical spelling MULTI_FAMILY.
Pass one or more values as a comma-separated string:

ListingStatus

Returned in the status field of listing responses.
Stored listings and search results carry ACTIVE or OFF_MARKET only, so listings transition directly from ACTIVE to OFF_MARKET when they leave the market. IN_CONTRACT can appear only in live data: Business live-first responses from GET /v1/property/{id} and /v1/property/by-url, live events on the listing stream, and listing-watcher change events (newValue), when the live listing reports it. Match on it if present, but do not rely on it for in-contract detection.
Search endpoints return only ACTIVE listings; there is no status filter on search. Cached property detail (/v1/property/{id}) returns ACTIVE or OFF_MARKET listings. Building listings accept a status filter (for example /v1/building/{id}/listings?status=OFF_MARKET); status=IN_CONTRACT returns no listings, because that status is never stored.

SaleType

Used as a filter on /v1/search/sales only (not applicable to rentals). saleType is null when the source did not report one.

Usage in search