platform---property-sourcing

Search properties

Structured search of the property graph: one request body for every country. Name the places with location_ids (find them with GET /v1/locations/search), then filter by property type, price, price per m², bedrooms, bathrooms, living and plot area and features, and sort. Each result is one property, however many listings advertise it, with an opaque prop_ id. next is a URL for the following page (valid for one hour, bound to your account) or null. Plain-language phrases go to POST /v1/property-sourcing/searches/describe. 100 tokens per page.

post/v1/property-sourcing/searches

Request

  • Base URL: https://platform.casafari.com
  • URL: https://platform.casafari.com/v1/property-sourcing/searches
  • Auth: HTTP bearer

Request body

location_idsinteger[] required

1 to 100 location ids, from GET /v1/locations/search?query=<place>.

countrystring

ISO 3166-1 alpha-2 code, e.g. "ES". Needed when the location ids do not include the country's own id and the account covers more than one country.

operation'sale' | 'rent'

For sale or for rent.

typesstring[]

Property type names in lower case, e.g. "apartment", "house", "villa".

featuresstring[]

Features every result must have.

exclude_featuresstring[]

Features no result may have.

sort'newest' | 'oldest' | 'recently_updated' | 'price_asc' | 'price_desc' | 'price_per_sqm_asc' | 'price_per_sqm_desc' | 'largest'

Order of the results.

page_sizeinteger

Results per page: up to 100 (25 on Free).

Response

One page of properties.

totalinteger nullable

How many properties match, when known.

nextstring nullable

URL of the next page (valid one hour), or null.

Changes

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