# Centaline Agents API

<p>Search Centaline agents by part of their name in English or Chinese. Each agent has the agent number, names, licence, thumbnail, branch code, name and address, star rating, listing count, languages, years of experience and awards. Phone numbers, e-mail, WhatsApp and WeChat data are not returned. The site shows 20 agents per page and 60 agents per search, so `total_capped` is never above 60 and is not the true number of matching agents. Use a more specific keyword to reach other agents. Page 4 and above returns HTTP 422.</p>

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

## 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 an agent name in English or Chinese. Leave out for the default list. |
| `page` | integer | No | Page 1 to 3, 20 agents per page. |
| `lang` | string | No | `en` (default) for English names, `hk` for Traditional Chinese. |

## Example response

```json
{
    "data": {
        "page": 1,
        "size": 20,
        "agents": [
            {
                "name": "Cyrus Chan",
                "star": 5,
                "awards": [
                    {
                        "name": "Most Transaction Award",
                        "years": "2025"
                    }
                ],
                "license": "S-373904",
                "name_zh": "\u9673\u632f\u8070",
                "agent_no": "28042",
                "languages": [
                    "Cantonese",
                    "Putonghua",
                    "English"
                ],
                "experience": "11 - 15 Years seniority",
                "branch_code": "FM2",
                "branch_name": "West Kowloon Mei Foo Mount Sterling Branch No. 1 Team B",
                "listing_count": 594
            }
        ],
        "capped": true,
        "keyword": "Chan",
        "has_more": true,
        "total_capped": 60
    },
    "meta": {
        "billable": true,
        "endpoint_family": "agents"
    },
    "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)