# QuintoAndar Similar Listings API Documentation

Scrappa's `GET /api/quintoandar/similar` returns listings similar to one listing.

## What you get

`type` picks the pool: `neighbourhood` (default), `nearby` or `condominium`. Listings have the same shape as search results. `condominium` is empty for listings that are not in a condominium. `business` must match the listing, RENT or SALE. An unknown id returns a non-billable `404`.

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

## 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 |
| --- | --- | --- | --- |
| `id` | string | Yes | Numeric listing id from search. |
| `business` | string | Yes | RENT or SALE. |
| `type` | string | No | neighbourhood (default), nearby or condominium. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/quintoandar/similar?id=893892728&business=RENT&type=neighbourhood"
```

## Example response

```json
{
    "success": true,
    "id": 893892728,
    "type": "neighbourhood",
    "business": "RENT",
    "returned": 1,
    "listings": [
        {
            "id": 893892728,
            "origin": "TRANSACTIONAL",
            "url": "https://www.quintoandar.com.br/imovel/893892728/alugar",
            "for_rent": true,
            "for_sale": false,
            "type": "Apartamento",
            "price": 1318,
            "rent_price": 1318,
            "sale_price": null,
            "total_cost": 1913,
            "condominium_fee": 500,
            "iptu": 42,
            "iptu_plus_condominium": 542,
            "area": 53,
            "bedrooms": 2,
            "bathrooms": 1,
            "suites": 0,
            "parking_spaces": 1,
            "is_furnished": false,
            "has_elevator": false,
            "address": "Rua Rosam\u00e9lia de Oliveira",
            "neighbourhood": "Campo Comprido",
            "region": "Campo Comprido",
            "city": "Curitiba",
            "latitude": -25.4582091,
            "longitude": -49.3285549,
            "cover_image": "https://www.quintoandar.com.br/img/893892728-393.9820271578673IMG9002.jpg",
            "images": [
                "https://www.quintoandar.com.br/img/893892728-44.647550986580576IMG1315.jpg"
            ],
            "image_captions": [
                "Quarto 2"
            ],
            "amenities": [
                "CHURRASQUEIRA",
                "AREA_DE_SERVICO"
            ],
            "installations": [
                "PLAYGROUND",
                "SALAO_DE_FESTAS"
            ],
            "condominium": {
                "id": 344059,
                "name": null
            },
            "visit_status": "ACCEPT_NEW",
            "special_conditions": [
                "Exclusivity"
            ],
            "tags": [
                "RENT_ON_TERMINATION"
            ]
        }
    ],
    "meta": {
        "billable": true,
        "attempts": 1,
        "last_status": 200,
        "endpoint_family": "similar"
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 404 | Not Found | Nothing exists with that id or hash (`not_found`). Non-billable. |
| 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)