---
title: "Spacious API: Search | Perceptlayer"
description: "Search from Spacious as JSON. 1 credit per successful call."
url: https://perceptlayer.com/apis/spacious/search
---

[APIs](https://perceptlayer.com/apis) / [Spacious](https://perceptlayer.com/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.

| Parameter | Type | Required | Allowed values |
| --- | --- | --- | --- |
| `mode` | string | Required | buy, rent |
| `page` | integer | Optional | Any |
| `locale` | string | Optional | en, zh-tw |
| `bedrooms` | integer | Optional | 0, 1, 2, 3, 4 |
| `min_bedrooms` | integer | Optional | 1, 2, 3, 4 |
| `bathrooms` | integer | Optional | 1, 2 |
| `min_bathrooms` | integer | Optional | 1, 2 |
| `price_min` | integer | Optional | Any |
| `price_max` | integer | Optional | Any |
| `area_min` | integer | Optional | Any |
| `area_max` | integer | Optional | Any |
| `area_type` | string | Optional | net, gross |
| `property_type` | string | Optional | village\_house, detached\_house |
| `neighbourhood_id` | string | Optional | Any |
| `building_id` | string | Optional | Any |
| `sort` | string | Optional | relevance, latest, price\_low, price\_high, area\_low, area\_high, unit\_price\_low, unit\_price\_high |

## Example request

cURL shell 

```
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](https://perceptlayer.com/apis/spacious?try=search#playground) with your own parameters. 1 credit per successful call; failed calls are free.