Skip to content
Scrappa Get API key
Centaline Property API 1 credit/request

Centaline Agents API

GET https://scrappa.co/api/centaline/agents

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.

Centaline Agents API 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/centaline/agents
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "data": {
        "page": 1,
        "size": 20,
        "agents": [
            {
                "name": "Cyrus Chan",
                "star": 5,
                "awards": [
                    {
                        "name": "Most Transaction Award",
                        "years": "2025"
                    }
                ],
...

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.

3 optional filters available.

keyword string Optional

Part of an agent name in English or Chinese. Leave out for the default list.

Example value running shoes
page integer Optional

Page 1 to 3, 20 agents per page.

Example value 1
lang string Optional

en (default) for English names, hk for Traditional Chinese.

Example value example

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "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

Handle these documented responses before retrying or showing customer-facing failures.

404

HTTP 404

The property or agent does not exist or is no longer online. This response is not billable.

422

HTTP 422

A parameter is missing or invalid, or the page reaches past the first 10000 results. This response is not billable.

503

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.