# Centaline Filter Options API

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

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

## 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 |
| --- | --- | --- | --- |
| `listing_type` | string | No | `sale` (default) or `rent`. |
| `lang` | string | No | `en` (default) for English names, `hk` for Traditional Chinese. |

## Example response

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

| 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)