Piloterr

ImoveisWeb Search

GET
/v2/imoveisweb/search

Search the Imobiliária Aquários catalog on imoveisweb.com.br. Pass a catalog name such as casas. price_display is rebuilt from the asking amount.

Credit cost: 1 credit per call

Autorización

ApiKeyAuth
headerx-api-key<token>

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

Parámetros de consulta

query*string

Catalog name or an ImoveisWeb results URL. This is Imobiliária Aquários, not ZonaProp.

Example:

casas

Allowed: apartamentos, casas, lotes, chacaras, sitios, fazendas, terrenos, locacao. Accents are optional. rent and aluguel mean locacao.

JSON: casas sets property_type to casas and operation to venda. locacao sets operation to locacao. A property URL returns 400. A bare place name such as extrema returns 400.

property_type?string

Optional catalog when query is not already a catalog name.

Allowed: the same names as query.

JSON: sets results[].property_type. operation is locacao only for the rental catalog, otherwise venda. If both query and property_type name a catalog and they differ, the call returns 400.

page?number

Page from 1.

Default: 1, which requests casas.htm and sets pagination.page to 1.

JSON: page 2 requests casas_02.htm. pagination.next is the next catalog URL, or null. On a paged catalog with an ellipsis, total_results and total_pages are null. per_page is the card count on that page.

Default"1"
return_page_source?boolean

Optional. Default false.

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

Default"false"

Cuerpo de la respuesta

Successful response

application/json
  1. response
results?array<>
pagination?
Example Request
curl -X GET 'https://api.piloterr.com/v2/imoveisweb/search?query=string'
Example Response
{  "results": [    {      "id": "3151",      "url": "https://www.imoveisweb.com.br/imoveis/casas/3151/",      "area": 534,      "city": "Extrema",      "image": "https://www.imoveisweb.com.br/imoveis/casas/3151/destaque.jpg",      "price": 450000,      "state": "MG",      "title": "Casa próximo aos Bombeiros, contendo ponto comercial com 2 portas de aço e banheiro, 2 dormitórios, sala, cozinha, banheiro, lavanderia e quintal.",      "currency": "BRL",      "locality": "Extrema - MG",      "operation": "venda",      "description": "Casa próximo aos Bombeiros, contendo ponto comercial com 2 portas de aço e banheiro, 2 dormitórios, sala, cozinha, banheiro, lavanderia e quintal.",      "area_display": "534 m²",      "price_display": "R$ 450.000",      "property_type": "casas"    }  ],  "pagination": {    "next": "https://www.imoveisweb.com.br/casas_02.htm",    "page": 1,    "per_page": 79,    "total_pages": null,    "total_results": null  }}