Imovelweb Similar Listings API 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.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
1 required parameter needed before sending a request.
string
Required
Listing id from search. Example: 3004987121.
1234567890
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"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
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
A parameter is missing or outside its allowed values. This response is not billable.
{
"errors": {
"query": [
"The query field is required."
]
},
"message": "The request validation failed"
}Not Found
The listing does not exist or was removed. This response is not billable.
{
"meta": {
"billable": false,
"retryable": false,
"endpoint_family": "similar"
},
"error": {
"code": "NOT_FOUND",
"message": "The requested resource was not found."
},
"success": false
}Upstream Unavailable
Imovelweb could not be reached, or returned data that does not match the expected shape. Retry shortly. This response is not billable.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "similar"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "Imovelweb could not be reached. Please retry shortly."
},
"success": false
}Generate Code with AI
Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.
Try It Live
Test this endpoint in our interactive playground with real data.