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

Centaline Filter Options API

GET https://scrappa.co/api/centaline/filter-options

List the filter values of the search with the number of listings for each: property types, views, features, estate facilities, developers, bedroom counts, topics, floor bands, popular areas and branches, and the price, saleable area, price per square foot and building age ranges. The `value` of each entry is what you pass to the matching search parameter. `mtr_walk_minutes` lists the walking times for the `mtr_walk_minutes` filter. The counts are for the listing type you ask for. Lists such as developers, areas and branches show the most listed entries, not all of them.

Centaline Filter Options API 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/centaline/filter-options
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "data": {
        "options": {
            "views": [
                {
                    "label": "Garden",
                    "value": "Green",
                    "listing_count": 1923
                }
            ],
            "bedrooms": [
                {
                    "label": "Studio",
                    "value": 0,
...

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.

2 optional filters available.

listing_type string Optional

sale (default) or rent.

Example value example
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": {
        "options": {
            "views": [
                {
                    "label": "Garden",
                    "value": "Green",
                    "listing_count": 1923
                }
            ],
            "bedrooms": [
                {
                    "label": "Studio",
                    "value": 0,
                    "listing_count": 610
                },
                {
                    "label": "1 Room",
                    "value": 1,
                    "listing_count": 1647
                }
            ],
            "price_ranges": {
                "max": 800000,
                "min": 5000,
                "ranges": [
                    {
                        "to": 8000,
                        "from": 6000,
                        "listing_count": 16
                    }
                ]
            },
            "property_types": [
                {
                    "label": "Private residential",
                    "value": "private_residential"
                }
            ],
            "mtr_walk_minutes": [
                {
                    "label": "Within 10 minutes",
                    "value": 10,
                    "listing_count": 4783
                }
            ]
        },
        "listing_type": "rent"
    },
    "meta": {
        "billable": true,
        "endpoint_family": "filter_options"
    },
    "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.