# Centaline Branches API

<p>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.</p>

- **Documentation:** [https://scrappa.co/docs/centaline-api/centaline_branches](https://scrappa.co/docs/centaline-api/centaline_branches)
- **API group:** Centaline Property API
- **Endpoint:** `GET https://scrappa.co/api/centaline/branches`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `keyword` | string | No | Part of a branch name or address. Leave out for all branches. |
| `page` | integer | No | Page number, 1-based. |
| `size` | integer | No | Branches per page, 1 to 50. Default 10. |
| `lang` | string | No | `en` (default) for English names, `hk` for Traditional Chinese. |

## Example response

```json
{
    "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

| Status | Error | Description |
| --- | --- | --- |
|  | The property or agent does not exist or is no longer online. This response is not billable. |  |
|  | A parameter is missing or invalid, or the page reaches past the first 10000 results. This response is not billable. |  |
|  | Centaline is temporarily unavailable, or its answer did not match the request. Retry the request. This response is not billable. |  |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)