platform---property-sourcing

Get a property

One property by its prop_ id: the search result's fields plus bathrooms, areas, construction year, energy rating, condition, features, address, description and status. expand=listings adds every listing merged into the property (where it is advertised, by which agency, at what price, its references) and listings_count; expand=history adds its dated price and status changes. A seller's contact details are never returned. 10 tokens.

get/v1/property-sourcing/properties/{property_id}

Request

  • Base URL: https://platform.casafari.com
  • URL: https://platform.casafari.com/v1/property-sourcing/properties/{property_id}
  • Auth: HTTP bearer

Path parameters

property_idstring required
Example:prop_7Hq2pZk1vY0sW4nB8cR3tL

A prop_ id from a search or from resolve.

Query parameters

expandstring
Example:listings,history

Comma-separated: listings, history, or both.

operation'sale' | 'rent'

sale or rent: which price and status to show. Default: sale, or rent when the property is only for rent.

Response

The property.

idstring

Opaque property id, prop_....

typestring nullable

Property type.

operation'sale' | 'rent'
bedroomsnumber nullable
living_area_sqmnumber nullable
first_seenstring nullable

When the property came on the market for this operation.

listings_countinteger nullable

How many listings advertise it; known on a property read with expand=listings, null in search results.

matched_tagsstring[] nullable

The phrases of a plain-language search this property matched; null for structured searches.

bathroomsnumber nullable
total_area_sqmnumber nullable
plot_area_sqmnumber nullable
construction_yearnumber nullable
energy_ratingstring nullable
conditionstring nullable
featuresstring[]
addressstring nullable
descriptionstring nullable
statusstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.