Skip to main content

BuildingType

buildingType is null when the source did not report a type.The buildingType and excludeBuildingType filters match case- and punctuation-insensitively and accept common alias spellings, for example MULTIFAMILY for MULTI_FAMILY, COOP for CO_OP, CONDOMINIUM for CONDO, and 2FAMILY for TWOFAMILY. Responses always return the canonical spelling.

ListingStatus

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.

SaleType

saleType is null when the source did not report one. The saleType filter also accepts alias spellings such as SPONSOR and SHORTSALE.

Sort

SortDirection

The default direction is DESC for every sort, so sort=PRICE without sortDir returns the highest price first. Ties are broken by listing ID, ascending.

PriceEvent

The event field returned by /property/{id}/history and /market/rentals/trends.

ErrorCode

Watcher rules (Business): creating a watcher past the active-watcher cap (50 in total, of which at most 5 may be listing watchers) returns 429 QUOTA_EXCEEDED, and resuming one past a cap with PATCH active: true returns 400 INVALID_PARAMS. A pollInterval below the minimum (3600 seconds for listing watchers, 300 for building and search watchers) returns 400 INVALID_PARAMS, as does a search watcher whose filters match more than 500 active listings, checked when it is created and when it is resumed. A running search watcher whose matches later grow past 500 is paused.

WebhookEvent