Find districts, estates, buildings, MTR stations, schools, universities, developers, shopping malls and car parks by name in English or Chinese. Each result has a `location` that the search endpoint takes as its `location` parameter, the listing count, the centre position and the Chinese and English names. Pass `listing_type=rent` to get the rental listing counts. A keyword without a match returns empty groups.
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.
3 optional filters available.
string
Required
Place, estate, building, MTR station, school or developer name in English or Chinese.
running shoes
string
Optional
sale (default) or rent. Changes the listing counts.
example
integer
Optional
Results per group, 1 to 20. Default 5.
10
string
Optional
en (default) for English names, hk for Traditional Chinese.
example
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"keyword": "taikoo",
"results": {
"districts": [
{
"code": "19-HMA034",
"name": "Taikoo Shing",
"center": {
"lat": 22.287405,
"lng": 114.217804
},
"name_en": "Taikoo Shing",
"name_zh": "\u592a\u53e4\u57ce",
"location": "eyJ0eXBlQ29kZXMiOlsiMTktSE1BMDM0Il19",
"listing_count": 371
}
],
"mtr_stations": [
{
"code": "58",
"name": "Tai Koo",
"name_en": "Tai Koo",
"name_zh": "\u592a\u53e4",
"location": "eyJtdHJzIjpbIjU4Il0sIm10clN0YXRpb25zIjpbeyJyb3V0ZU5vIjoiMSIsInN0YXRpb25ObyI6IjU4In1dfQ",
"listing_count": 597
}
]
},
"listing_type": "sale"
},
"meta": {
"billable": true,
"endpoint_family": "autocomplete"
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
HTTP 404
The property or agent does not exist or is no longer online. This response is not billable.
HTTP 422
A parameter is missing or invalid, or the page reaches past the first 10000 results. This response is not billable.
HTTP 503
Centaline is temporarily unavailable, or its answer did not match the request. 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.