# QuintoAndar Search Filters API Documentation

Scrappa's `GET /api/quintoandar/filters` returns the option lists the search understands.

## What you get

Per business (`rent`, `sale`): `options` with property types, amenities, installations, furnishings, appliances and availability, each as `value` and a Portuguese `label`, and `ranges` with the price and area bounds and steps. Use the `value` fields in the search filters.

- **Documentation:** [https://scrappa.co/docs/quintoandar-api/quintoandar_filters](https://scrappa.co/docs/quintoandar-api/quintoandar_filters)
- **API group:** QuintoAndar API
- **Endpoint:** `GET https://scrappa.co/api/quintoandar/filters`

## 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 |
| --- | --- | --- | --- |
| `business` | string | No | RENT or SALE. Both when omitted. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/quintoandar/filters?business=RENT"
```

## Example response

```json
{
    "success": true,
    "filters": {
        "rent": {
            "options": {
                "house_types": [
                    {
                        "value": "Apartamento",
                        "label": "Apartamento"
                    }
                ],
                "installations": [
                    {
                        "value": "ACADEMIA",
                        "label": "Academia"
                    }
                ]
            },
            "ranges": {
                "rent_price": {
                    "min": 500,
                    "max": 25000,
                    "step": 100
                },
                "area": {
                    "min": 20,
                    "max": 1000,
                    "step": 1
                }
            }
        }
    },
    "meta": {
        "billable": true,
        "endpoint_family": "filters",
        "cached": true
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A query parameter failed validation or is not supported. Unsupported parameters are rejected instead of ignored. Non-billable. |
| 503 | Upstream Unavailable | QuintoAndar could not be reached after a retry, or answered with a body this API cannot read (`upstream_unavailable`, `upstream_blocked`, `parser_drift`). Retryable and never billed. Clients are never rate limited. |

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