platform---property-sourcing

Search properties by description

Plain-language search: say what you look for as tags (up to 20 phrases) or one description (split into phrases at commas, semicolons and "and"), in the places named by location_ids, optionally within a price or price-per-m² range. Each result lists the phrases it matched in matched_tags. Structured filters (types, bedrooms, features) belong to POST /v1/property-sourcing/searches. 100 tokens per page.

post/v1/property-sourcing/searches/describe

Request

  • Base URL: https://platform.casafari.com
  • URL: https://platform.casafari.com/v1/property-sourcing/searches/describe
  • 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".

operation'sale' | 'rent'

For sale or for rent.

tagsstring[]

Up to 20 phrases, e.g. ["close to the beach", "sea views"]. Send tags or description, not both.

descriptionstring

What you look for in plain words, split into phrases at commas, semicolons and "and" (at most 20).

page_sizeinteger

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

Response

One page of properties, each with the phrases it matched.

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.