APIs / Property Finder / Search

Property Finder: Search

Search from Property Finder as JSON. 1 credit per successful call.

GET /v1/property-finder/search

Parameters

Send parameters in the query string.

ParameterTypeRequiredAllowed values
category_idintegerOptional1, 2, 3, 4
location_idsstringOptionalUp to 512 characters
bedroomsintegerOptionalAny
property_type_idsstringOptionalUp to 512 characters
keywordsstringOptionalUp to 128 characters
price_typestringOptionaldaily, weekly, monthly, yearly
min_priceintegerOptionalAny
max_priceintegerOptionalAny
sortstringOptionalfeatured, newest, priceAsc, priceDesc, bedroomAsc
pageintegerOptionalAny
limitintegerOptionalAny
localestringOptionalen, ar
countrystringOptionalae, sa, qa, bh, eg

Example request

cURLshell
curl "https://api.perceptlayer.com/v1/property-finder/search?category_id=1&location_ids=3811&page=1&limit=10" \
  -H "X-API-Key: $API_KEY"