# Imovelweb Similar Listings API Documentation

<p><strong>Imovelweb Similar Listings API</strong> returns the listings Imovelweb recommends next to one listing, with price, fees, address, coordinates, headline numbers and the publisher. A listing without recommendations returns an empty list, which is a valid, billed answer. An unknown id returns 404 and is not billed.</p>

- **Documentation:** [https://scrappa.co/docs/imovelweb-api/imovelweb_similar](https://scrappa.co/docs/imovelweb-api/imovelweb_similar)
- **API group:** Imovelweb API
- **Endpoint:** `GET https://scrappa.co/api/imovelweb/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 | Listing id from search. Example: 3004987121. |

## Example response

```json
{
    "data": {
        "items": [
            {
                "id": "3038485650",
                "geo": {
                    "latitude": -23.6215592,
                    "longitude": -46.6370048
                },
                "url": "https://www.imovelweb.com.br/propriedades/apartamento-para-venda-em-saude-com-3-quartos-sendo-1-3038485650.html",
                "fees": {
                    "iptu": null,
                    "text": "Condom\u00ednio R$ 980",
                    "condominium": 980
                },
                "price": {
                    "amount": 850000,
                    "formatted": "R$ 850.000"
                },
                "title": "Venta \u00b7 Apartamento",
                "address": {
                    "area": "Sa\u00fade, S\u00e3o Paulo, S\u00e3o Paulo",
                    "street": "Rua Biobedas, 103"
                },
                "picture": "https://imgbr.imovelwebcdn.com/avisos/2/30/38/48/56/50/720x532/6860257979.jpg",
                "features": {
                    "suites": null,
                    "garages": 1,
                    "bedrooms": 3,
                    "age_years": null,
                    "bathrooms": 3,
                    "total_area": {
                        "text": "75 m\u00b2 totais",
                        "unit": "m2",
                        "value": 75
                    },
                    "covered_area": null
                },
                "publisher": {
                    "id": "30015375",
                    "name": "Flow Im\u00f3veis",
                    "is_owner": false,
                    "is_premier": true
                },
                "posting_type": "property"
            },
            {
                "id": "3026981856",
                "geo": {
                    "latitude": -23.6215729,
                    "longitude": -46.6277143
                },
                "url": "https://www.imovelweb.com.br/propriedades/apartamento-a-venda-em-vila-santo-estefano-com-71-m-3026981856.html",
                "fees": {
                    "iptu": null,
                    "text": "Condom\u00ednio R$ 1.082",
                    "condominium": 1082
                },
                "price": {
                    "amount": 460000,
                    "formatted": "R$ 460.000"
                },
                "title": "Venta \u00b7 Apartamento",
                "address": {
                    "area": "S\u00e3o Paulo, S\u00e3o Paulo",
                    "street": "Rua das Mangueiras, 0"
                },
                "picture": "https://imgbr.imovelwebcdn.com/avisos/2/30/26/98/18/56/720x532/6211841898.jpg",
                "features": {
                    "suites": null,
                    "garages": 1,
                    "bedrooms": 3,
                    "age_years": null,
                    "bathrooms": 2,
                    "total_area": {
                        "text": "71 m\u00b2 totais",
                        "unit": "m2",
                        "value": 71
                    },
                    "covered_area": null
                },
                "publisher": {
                    "id": "47775469",
                    "name": "Sucursal 8",
                    "is_owner": false,
                    "is_premier": false
                },
                "posting_type": "property"
            }
        ],
        "listing_id": "3004987121"
    },
    "meta": {
        "billable": true,
        "endpoint_family": "similar"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A parameter is missing or outside its allowed values. This response is not billable. |
| 404 | Not Found | The listing does not exist or was removed. This response is not billable. |
| 503 | Upstream Unavailable | Imovelweb could not be reached, or returned data that does not match the expected shape. Retry shortly. 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)