Search Centaline branches by part of the name or address. Each branch has the branch code, name, district, address, position, image, page URL, manager name, number of agents, listing counts for sale and rent and the area. Branch phone and fax numbers are not returned. `total` is the number of matching branches.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
This endpoint has no required query parameters.
4 optional filters available.
string
Optional
Part of a branch name or address. Leave out for all branches.
running shoes
integer
Optional
Page number, 1-based.
1
integer
Optional
Branches per page, 1 to 50. Default 10.
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": {
"page": 1,
"size": 10,
"total": 10,
"keyword": "taikoo",
"branches": [
{
"name": "Tai Koo Shing Tung Shan Mansion Branch",
"address": "Shop G1, G/F., Tung Shan Mansion, No. 11 Tai Koo Shing Road, Quarry Bay, Hong Kong",
"manager": {
"name": "KENNETH CHIU",
"name_zh": "\u8d99\u9d3b\u904b",
"agent_no": "06832"
},
"district": "Eastern District",
"location": {
"lat": 22.285901,
"lng": 114.220437
},
"agent_count": 10,
"branch_code": "TKS",
"rent_listing_count": 129,
"sale_listing_count": 786
}
],
"has_more": false
},
"meta": {
"billable": true,
"endpoint_family": "branches"
},
"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.