# QuintoAndar Condominium API Documentation

Scrappa's `GET /api/quintoandar/condominium` returns the public record of one building.

## What you get

Name, address, region and city (with slugs for search), doorman type, installations, images and the ids of similar condominiums. Take `hash_id` from `condominium.hash_id` in the property endpoint.

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

## 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 |
| --- | --- | --- | --- |
| `hash_id` | string | Yes | Condominium hash id from the listing detail. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/quintoandar/condominium?hash_id=pm8sqex37k"
```

## Example response

```json
{
    "success": true,
    "condominium": {
        "hash_id": "1d47s7e58d",
        "name": "Conjunto Resid\u00eancial Cotolengo",
        "slug": "conjunto-residencial-cotolengo-campo-comprido-curitiba",
        "address": "Rua Rosam\u00e9lia de Oliveira",
        "number": "780",
        "neighborhood": "Campo Comprido",
        "region": {
            "id": 1937,
            "hash_id": "vk8qtmvrkq",
            "name": "Campo Comprido",
            "slug": "campo-comprido-curitiba-pr-brasil",
            "latitude": -25.466876,
            "longitude": -49.327463
        },
        "city": {
            "id": 1918,
            "hash_id": "6knguqmzp2",
            "name": "Curitiba",
            "slug": "curitiba-pr-brasil",
            "latitude": -25.480876,
            "longitude": -49.304425
        },
        "doorman_type": "DayShiftOnly",
        "installations": [
            {
                "key": "PLAYGROUND",
                "label": "Playground"
            }
        ],
        "images": [
            {
                "url": "https://www.quintoandar.com.br/img/892892581-420.8976082927696IMG5499.jpg",
                "caption": "Quadra"
            }
        ],
        "featured_image": {
            "url": "https://www.quintoandar.com.br/img/892892581-381.99702460009775IMG5506.jpg",
            "caption": "Fachada"
        },
        "similar_condominium_ids": [
            344059,
            78158
        ]
    },
    "meta": {
        "billable": true,
        "attempts": 1,
        "last_status": 200,
        "endpoint_family": "condominium"
    }
}
```

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