Find estates by name, in English or Chinese, and get the estate id and district. Use the id as `estate_id` in the search. A keyword without a match returns an empty list. The keyword needs at least 2 characters.
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.
1 optional filter available.
string
Required
Estate or location name, at least 2 characters, e.g. Taikoo.
running shoes
string
Optional
buy (default) or rent.
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": {
"mode": "buy",
"keyword": "Taikoo",
"results": [
{
"id": "1140",
"name": "TaiKoo Shing",
"text": "TaiKoo Shing (Taikoo Shing)",
"district": "Taikoo Shing"
},
{
"id": "1141",
"name": "Splendid Place",
"text": "Splendid Place (Quarry Bay)",
"district": "Quarry Bay"
}
]
},
"meta": {
"billable": true,
"endpoint_family": "autocomplete"
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
HTTP 404
The listing 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
28Hse 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.