# Imovelweb Listing API Documentation

<p><strong>Imovelweb Listing API</strong> returns the full record of one listing: title, full description, price with Imovelweb's own price text, condominium and IPTU fees as text and as numbers, bedrooms, bathrooms, suites, parking, total and covered area, amenity groups, all photos, videos, address with coordinates, the publisher with rating, listing codes and view statistics. Fee numbers are parsed from the fee text and the text is kept next to them. An unknown id returns 404 and is not billed.</p>

- **Documentation:** [https://scrappa.co/docs/imovelweb-api/imovelweb_listing](https://scrappa.co/docs/imovelweb-api/imovelweb_listing)
- **API group:** Imovelweb API
- **Endpoint:** `GET https://scrappa.co/api/imovelweb/listing`

## 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 or similar. Example: 3004987121. |

## Example response

```json
{
    "data": {
        "id": "3004987121",
        "geo": {
            "latitude": -23.5480789,
            "longitude": -46.6871162
        },
        "url": "https://www.imovelweb.com.br/propriedades/apartamento-para-aluguel-vila-madalena-1-quarto-3004987121.html",
        "codes": {
            "license": "J24.344",
            "listing_code": "3004987121",
            "advertiser_code": "894728039"
        },
        "title": "Apartamento para Aluguel - Vila Madalena, 1 Quarto,  42 m2 - S\u00e3o Paulo",
        "prices": [
            {
                "fees": {
                    "iptu": 163,
                    "text": "Condom\u00ednio R$ 900 - IPTU R$ 163",
                    "condominium": 900
                },
                "amount": 3330,
                "formatted": "R$ 3.330",
                "operation": "rent"
            }
        ],
        "videos": [],
        "address": {
            "area": "Jardim das Bandeiras, S\u00e3o Paulo, S\u00e3o Paulo",
            "street": "Rua Professor Nicolau de Morais Barros",
            "visibility": "EXACT"
        },
        "currency": "BRL",
        "features": {
            "suites": 1,
            "garages": null,
            "bedrooms": 1,
            "age_years": null,
            "bathrooms": 1,
            "total_area": {
                "text": "42 m\u00b2 totais",
                "unit": "m2",
                "value": 42
            },
            "covered_area": {
                "text": "42 m\u00b2 \u00fatil",
                "unit": "m2",
                "value": 42
            }
        },
        "pictures": [
            "https://imgbr.imovelwebcdn.com/avisos/2/30/04/98/71/21/720x532/7412539401.jpg",
            "https://imgbr.imovelwebcdn.com/avisos/2/30/04/98/71/21/720x532/7412539508.jpg",
            "https://imgbr.imovelwebcdn.com/avisos/2/30/04/98/71/21/720x532/7412538695.jpg"
        ],
        "amenities": [
            {
                "items": [
                    "Ar condicionado",
                    "\u00c1rea de servi\u00e7o",
                    "Permite animais",
                    "Varanda"
                ],
                "category": "\u00c1reas privativas"
            },
            {
                "items": [
                    "Pr\u00f3ximo ao metro"
                ],
                "category": "\u00c1reas comuns"
            }
        ],
        "is_online": true,
        "publisher": {
            "id": "47514139",
            "logo": "https://imgbr.imovelwebcdn.com/empresas/2/00/47/51/41/39/130x70/logo_quintoandar-premier-locacao_1723736805814.jpg",
            "name": "QuintoAndar (Premier Loca\u00e7\u00e3o)",
            "rating": null,
            "is_owner": false,
            "is_premier": true
        },
        "statistics": {
            "text": "Publicado h\u00e1 9 dias | 14 visualiza\u00e7\u00f5es",
            "views": 14
        },
        "description": "Sobre o im\u00f3vel: \n\nValores:\n- Aluguel: R$ 3330\n- Condom\u00ednio: R$ 900\n- IPTU: R$ 163\n\n\n\nSeu im\u00f3vel sem burocracia\nO QuintoAndar revolucionou o jeito de alugar e comprar im\u00f3veis: r\u00e1pido, f\u00e1cil, online, se\u2026",
        "has_whatsapp": true,
        "listing_type": "rent",
        "property_type": "Apartamento"
    },
    "meta": {
        "billable": true,
        "endpoint_family": "listing"
    },
    "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)