Piloterr

ImoveisWeb Property

GET
/v2/imoveisweb/property

Read one Imobiliária Aquários listing from its imoveisweb.com.br URL. price_display is rebuilt from the asking amount.

Credit cost: 1 credit per call

Authorization

ApiKeyAuth
headerx-api-key<token>

Your API key. Include it in the x-api-key header for every request.

Query Parameters

query*string

Listing URL from search.

Example:

https://www.imoveisweb.com.br/imoveis/casas/3151/

JSON: one flat object. id is the listing code. A catalog URL such as casas.htm returns 400.

return_page_source?boolean

Optional. Default false.

false returns the parsed JSON described below. true returns {"result": ""} and omits results, pagination, and listing fields.

Defaultfalse
fields?string

Comma-separated list of response fields to return, with dot notation for nested fields (e.g. name,location.city).

is_async?boolean

Run the request as a background job: the API answers 202 with a job_id to poll on GET /v1/jobs/{id}.

Defaultfalse
soft_fail?boolean

Return HTTP 200 even when the request fails; the error is in the error field of the body.

Defaultfalse

Response Body

Successful response

application/json
  1. response
id?string
url?string
area?integer
city?string
image?string
price?integer
state?string
title?string
images?array<string>
currency?string
locality?string
operation?string
description?string
area_display?string
price_display?string
property_type?string
Example Request
curl -X GET 'https://api.piloterr.com/v2/imoveisweb/property?query=string'
Example Response
{  "id": "766",  "url": "https://www.imoveisweb.com.br/imoveis/chacaras/766/",  "area": 4000,  "city": "Extrema",  "image": "https://www.imoveisweb.com.br/imoveis/chacaras/766/01.jpg",  "price": 2100000,  "state": "MG",  "title": "Grande oportunidade! 4.000,00 m² em perímetro urbano, excelente para investidor construir condomínio vertical ou horizontal (casas ou apartamentos), galpão ou...",  "images": [    "https://www.imoveisweb.com.br/imoveis/chacaras/766/01.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/02.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/03.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/04.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/05.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/06.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/07.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/08.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/09.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/10.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/11.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/12.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/13.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/14.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/15.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/16.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/17.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/18.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/19.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/20.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/21.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/22.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/23.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/24.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/25.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/26.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/27.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/28.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/29.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/30.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/31.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/32.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/33.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/34.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/35.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/36.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/37.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/38.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/39.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/40.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/41.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/42.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/43.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/44.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/45.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/46.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/47.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/48.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/49.jpg",    "https://www.imoveisweb.com.br/imoveis/chacaras/766/50.jpg"  ],  "currency": "BRL",  "locality": "Extrema - MG",  "operation": "venda",  "description": "Grande oportunidade! 4.000,00 m² em perímetro urbano, excelente para investidor construir condomínio vertical ou horizontal (casas ou apartamentos), galpão ou uma bela chácara para morar, próximo ao centro, prefeitura, bairro em crescimento, imóvel todo murado, com casa sede ampla, contendo 2 dormitórios, 1 suíte, sala de jantar, sala visita, cozinha, área gourmet com churrasqueira e cozinha, piscina, churrasqueira, casa de empregado, pomar, toda gramada.",  "area_display": "4.000 m²",  "price_display": "R$ 2.100.000",  "property_type": "chacaras"}