Find buildings or neighbourhoods by name, in English or Chinese. A building result has the id, both names, address, position, developer, neighbourhood id, build year and a public housing flag. A neighbourhood result has the id, both names and the position. Use the building `id` as `building_id` together with its `neighbourhood_id` in the search. Use a neighbourhood `id` as `neighbourhood_id`. A query without a match returns an empty list.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
1 required parameter needed before sending a request.
2 optional filters available.
string
Required
Building or neighbourhood name, at least 2 characters, e.g. imperial.
coffee shops
string
Optional
building (default) or neighbourhood.
example
integer
Optional
Number of results, 1 to 25. Default 10.
10
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"type": "building",
"query": "imperial",
"results": [
{
"id": 66551,
"name": "Imperial Kennedy",
"type": "building",
"address": "68, Belcher's Street",
"name_zh": "Imperial Kennedy",
"latitude": 22.282676,
"longitude": 114.12869,
"built_year": 2016,
"neighbourhood": "Kennedy Town",
"public_housing": false,
"neighbourhood_id": 41
}
]
},
"meta": {
"billable": true,
"endpoint_family": "autocomplete"
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
HTTP 404
The listing, building or agency does not exist or is no longer online. This response is not billable.
HTTP 422
A parameter is missing or invalid. This response is not billable.
HTTP 503
Spacious HK is temporarily unavailable, or its answer did not match the request, for example another page or an ignored filter. Retry the request. This response is not billable.
Generate Code with AI
Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.
Try It Live
Test this endpoint in our interactive playground with real data.