APIs / Spacious / Search

Spacious: Search

Search from Spacious as JSON. 1 credit per successful call.

GET /v1/spacious/search

Parameters

Send parameters in the query string.

ParameterTypeRequiredAllowed values
modestringRequiredbuy, rent
pageintegerOptionalAny
localestringOptionalen, zh-tw
bedroomsintegerOptional0, 1, 2, 3, 4
min_bedroomsintegerOptional1, 2, 3, 4
bathroomsintegerOptional1, 2
min_bathroomsintegerOptional1, 2
price_minintegerOptionalAny
price_maxintegerOptionalAny
area_minintegerOptionalAny
area_maxintegerOptionalAny
area_typestringOptionalnet, gross
property_typestringOptionalvillage_house, detached_house
neighbourhood_idstringOptionalAny
building_idstringOptionalAny
sortstringOptionalrelevance, latest, price_low, price_high, area_low, area_high, unit_price_low, unit_price_high

Example request

cURLshell
curl "https://api.perceptlayer.com/v1/spacious/search?mode=rent&bedrooms=2&price_min=20000&price_max=30000" \
  -H "X-API-Key: $API_KEY"

Run this endpoint in the playground with your own parameters. 1 credit per successful call; failed calls are free.