Este serviço retorna a lista de imóveis do cliente.
| Informações do recurso | |
|---|---|
| Autenticação | Required |
| Método HTTP | GET |
| Resposta | JSON |
| Versão | 1 |
URL do recurso
https://mapaprop.app/api/action/portal-v2/properties/{country}/
Exemplo de chamada
GET /api/action/portal-v2/properties/{country}/?operation=1&buildingStatus=5?currency=USD?tempOccupancy=2&dateFrom=20-02-2019&dateTo=28-02-2019 HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer {access_token}
Parâmetros
| Chave | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| term | string | no | Termo que tenta corresponder a pelo menos 3 caracteres na zona, endereço ou título do imóvel. Busca de texto completo. |
| country | int/string | yes | O país a partir do qual a consulta é feita. Constantes |
| type | int | yes | Tipo de imóvel. Constantes |
| operation | int | yes | Operação do imóvel. Constantes |
| from | int | yes | Número do registro inicial |
| size | int | yes | Quantidade de registros por consulta. Máximo padrão: 20 - Limitado |
| bedrooms | int | no | Quantidade de quartos |
| ambiences | int | no | Número exato de ambientes |
| ambiencesFrom | int | no | Buscar a partir de um número |
| ambiencesTo | int | no | Buscar até o número atribuído |
| bathrooms | int | no | Quantidade de banheiros |
| countryId | int | no | ID do país do imóvel |
| stateId | int | no | ID do estado |
| countyId | int | no | ID do município |
| cityId | int | no | ID da cidade |
| buildingStatus | int | no | Estado físico do edifício. Constantes |
| tempOccupancy | int | no | Quantidade de pessoas que podem viver no imóvel |
| dateFrom | string | no | Data de chegada (formato "dd-MM-yyyy") |
| dateTo | string | no | Data de saída (formato "dd-MM-yyyy") |
| priceFrom | int | no | Preço mínimo de busca |
| priceTo | int | no | Preço máximo de busca |
| currency | string | no | Moeda do preço do imóvel. Máx 3 chars, Mín 2 chars |
| brokerId | int | no | ID do corretor dos imóveis |
Resposta
Um documento JSON com a lista de imóveis que correspondem aos filtros.
| Objeto | Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| Response | took | int | yes | Tempo que a busca levou em milissegundos |
| total | int | yes | Total de registros disponíveis. Você pode paginar por eles | |
| Filters | Array of filters | yes | Lista de filtros aplicados na URL | |
| brokerId | filter int | Filtro de ID de corretor na resposta | ||
| properties | Array of Property | yes | Lista de objetos Property | |
| Property | propertyHash | string | yes | ID único do imóvel |
| custId | int | yes | ID do cliente | |
| timestamp | string | yes | Timestamp ISO8601 de quando o imóvel foi criado | |
| lastUpdate | string | yes | Timestamp ISO8601 da última atualização | |
| code | string | yes | Código único do imóvel inserido pelo cliente | |
| branchId | int | yes | ID da filial associada. GET /api/action/express-v1/branches. | |
| type | string | yes | Descrição traduzida do tipo de imóvel. GET /api/action/portal-v2/settings/types/{country} | |
| operation | string | yes | Descrição traduzida da operação. GET /api/action/portal-v2/settings/operations/{country} | |
| propertyType | string | yes | ID do tipo de imóvel. GET /api/action/portal-v2/settings/types/{country} | |
| propertyOperation | int | yes | ID da operação. GET /api/action/portal-v2/settings/operations/{country} | |
| status | string | yes | Descrição traduzida do status construtivo. Constantes | |
| mainImage | string | no | URL da thumbnail principal do imóvel | |
| currency | string | yes | Símbolo da moeda do preço. Constantes | |
| price | int | yes | Preço do imóvel | |
| expensesCurrencies | string | no | Símbolo da moeda do condomínio. Constantes | |
| expensesPrice | int | no | Valor do condomínio mensal / anual | |
| taxCurrency | string | no | Símbolo da moeda dos impostos. Constantes | |
| taxPrice | int | no | Valor dos impostos mensais / anuais | |
| title | string | yes | Título inserido pelo cliente | |
| address | string | yes | Rua e número do imóvel | |
| zipCode | string | yes | CEP da localização | |
| zone | string | yes | Descrição amigável combinando cidade (se disponível) e estado | |
| countryId | int | yes | ID do país do imóvel | |
| stateId | int | yes | ID do estado. GET /api/action/express-v1/zones | |
| countyId | int | yes | ID do município. GET /api/action/express-v1/zones | |
| cityId | int | no | ID da cidade. GET /api/action/express-v1/zones | |
| countryId | int | yes | ID do país. GET /api/action/express-v1/zones | |
| country | string | yes | Nome do país | |
| state | string | yes | Nome do estado | |
| county | string | yes | Nome do município ou segunda divisão | |
| city | string | no | Nome da cidade / bairro ou terceira divisão | |
| suspended | boolean | yes | A publicação foi suspensa | |
| reserved | boolean | yes | O imóvel foi reservado | |
| rented | boolean | yes | O imóvel foi alugado | |
| sold | boolean | yes | O imóvel foi vendido | |
| description | string | yes | Descrição longa do imóvel | |
| conditions | string | no | Condições do imóvel. Geralmente relacionadas ao pagamento | |
| bedrooms | int | no | Quantidade de quartos | |
| ambiences | int | no | Quantidade de ambientes | |
| bathrooms | int | no | Quantidade de banheiros | |
| dependencies | int | no | Quantidade de dependências (quartos extras) | |
| occupancy | int | no | Quantidade de ocupantes (geralmente para aluguel temporário) | |
| toilettes | int | no | Quantidade de lavabos | |
| buildingArea | int | no | Metros quadrados de área construída | |
| landArea | int | no | Metros quadrados de terreno | |
| yearsOld | int | no | Antiguidade do imóvel | |
| ubication | string | no | Orientação cardinal do imóvel no edifício | |
| totalFloors | int | no | Total de andares do edifício | |
| apartmentsPerFloor | int | no | Quantidade de apartamentos por andar | |
| airConditionerType | string | no | Tipo de ar-condicionado | |
| waterHeaterType | string | no | Tipo de aquecedor de água | |
| heatingType | string | no | Tipo de aquecimento | |
| balconyType | string | no | Tipo de varanda | |
| garage | int | no | Quantidade de vagas de garagem | |
| garageType | string | no | Tipo de garagem | |
| images | Array of Image | no | Array de objetos Image | |
| location | Location | yes | Objeto de localização geográfica | |
| Location | lon | string | yes | Longitude do imóvel |
| lat | string | yes | Latitude do imóvel | |
| Image | image | string | yes | URL da imagem |
| thumbnail | string | yes | URL da thumbnail | |
| orientation | int | yes | Orientação da imagem. 1 = PORTRAIT, 2 = LANDSCAPE | |
| type | int | yes | Tipo de imagem. 1 = PHOTO, 2 = BLUEPRINT | |
| contentType | string | yes | Tipo de conteúdo da imagem | |
| timestamp | string | yes | Timestamp ISO8601 de quando a imagem foi enviada | |
| Labels | labels | Array of labels | no | Etiquetas / comodidades do imóvel - Constantes |
| Object | Field | Type | Required | Description |
| Filters | bedrooms | int | no | Quantidade de quartos no imóvel |
| size | int | yes | Tamanho da resposta de imóveis | |
| from | int | yes | Início da consulta | |
| tempOccupancy | int | no | Status de ocupação temporária | |
| dateTo | date | no | Data de fim do período de disponibilidade | |
| dateFrom | date | no | Data de início do período de disponibilidade | |
| buildingStatus | int | no | Status do edifício (por ex.: como novo, em construção, concluído) | |
| city | zone0Id | int | no | ID do país |
| zone3Id | int | no | ID da zone3 | |
| zone1Id | int | no | ID da zone1 | |
| zone2Id | int | no | ID da zone2 | |
| description | string | no | Descrição da zone3 | |
| county | zone0Id | int | no | ID do país |
| zone1Id | int | no | ID da zone1 | |
| zone2Id | int | no | ID da zone2 | |
| description | string | no | Descrição da zone2 | |
| state | zone0Id | int | no | ID do país |
| zone1Id | int | no | ID da zone1 | |
| description | string | no | Descrição da zone1 | |
| country | zone0Id | int | no | ID do país |
| description | string | no | Descrição da zone0 | |
| type | id | int | yes | ID do tipo de imóvel |
| name | string | yes | Nome do tipo de imóvel (ex.: casa) | |
| operation | id | int | yes | ID da operação |
| name | string | yes | Nome da operação (ex.: venda, aluguel) | |
| searchInfo | searchInfo | JSON | yes | Informações sobre a busca atual |
| removed | removed | List | no | Lista de filtros removidos |
| searchType | searchType | String | yes | Tipo de busca atual |
| comment | comment | String | no | Esclarecimento sobre os resultados de busca |
O grupo de desenvolvimento
Todo imóvel traz estes quatro campos, seja ou não um empreendimento. Vêm sempre: um valor em 0,
em false ou em [] significa "não se aplica", não "falta o dado".
| Campo | Tipo | Em um empreendimento | Em uma unidade | Em um imóvel comum |
|---|---|---|---|---|
development | boolean | true | false | false |
developmentId | int | 0 (não tem pai) | o propertyId do empreendimento | 0 |
developmentProperties | Array | os propertyId das suas unidades | [] | [] |
developmentStats | Object | os números derivados — veja abaixo | ausente | ausente |
developmentStats é o único que nem sempre está presente: é escrito apenas em um
empreendimento que tenha unidades vinculadas. Um projeto sem unidades carregadas não o traz, e isso
está correto — não há nada a partir do que derivá-lo.
Os 10 campos declarados do projeto
A imobiliária os declara e só fazem sentido em um empreendimento. Um contador em 0 significa que
não foi declarado, não que o seu valor seja zero.
| Campo | Tipo | Descrição |
|---|---|---|
commercialTagline | string | O slogan comercial do projeto |
deliveryDate | string | Data de entrega, em formato ISO com fuso horário |
logoUrl | string | O logotipo do projeto — diferente do logotipo da imobiliária |
totalApartments | int | Apartamentos |
totalHouses | int | Casas |
totalLots | int | Lotes |
totalTowers | int | Torres |
totalElevators | int | Elevadores |
totalOffices | int | Escritórios |
totalCommercialUnits | int | Lojas comerciais |
developmentStats — os números derivados das unidades
São calculados no backend a partir das unidades vinculadas, uma única vez e para todas as superfícies. Não são derivados dos 10 campos acima: aqueles são o que o projeto anuncia, estes são o que as suas unidades carregadas dizem.
| Bloco | Campos |
|---|---|
units | total · available · sold · rented · reserved · suspended · withOperation · availabilityRate |
buildingArea | total · available · sold · rented · reserved · unavailable · unit |
prices | byCurrency (por moeda: units · from · to · average · total) · mixedCurrencies |
sale · rent · otherOperation | units · commercialized · rate |
typology | byAmbiences · byRooms · byBuildingArea · byLandArea — contagem de unidades por valor |
Se mixedCurrencies for true, o empreendimento tem unidades em mais de uma moeda e não existe
uma faixa única: é preciso ler byCurrency moeda por moeda. Exibir uma única faixa misturando
moedas produz um número que não significa nada.
Exemplo do grupo
{
"development": true,
"developmentId": 0,
"developmentProperties": [257092, 257093, 257094, 257095],
"commercialTagline": "Torres del Parque, el emprendimiento que cambia el barrio",
"deliveryDate": "2028-03-15T00:00:00.000-03:00",
"totalApartments": 120,
"totalTowers": 3,
"developmentStats": {
"units": { "total": 4, "available": 4, "sold": 0, "availabilityRate": 100 },
"buildingArea": { "total": 936, "available": 936, "unit": "m2" },
"prices": {
"byCurrency": { "ARS": { "units": 4, "from": 2333333, "to": 2333333, "average": 2333333 } },
"mixedCurrencies": false
}
}
}
Exemplo de resposta
{
"took": 11,
"total": 197,
"searchInfo": {
"removed": [
"zone3"
],
"searchType": "alternativeSearch",
"comment": "No se encontraron resultados para la búsqueda con el filtro 'zone3'. Mostrando resultados con los filtros alternativos."
},
"filters": {
"bedrooms": "1",
"size": "20",
"tempOccupancy": "2",
"dateTo": "28-02-2019",
"from": "1",
"state": {
"zone0Id": 1,
"description": "Buenos Aires",
"zone1Id": 2
},
"country": {
"zone0Id": 1,
"description": "Argentina",
},
"dateFrom": "20-02-2019",
"type": {
"name": "Departamento",
"id": "1"
},
"operation": {
"name": "Alquiler Temporario",
"id": "3"
},
"buildingStatus": "6"
},
"properties": [
{
"country": "Argentina",
"custId": 123,
"heatingType": "Estufas",
"occupancy": 2,
"waterHeaterType": "Termotanque",
"landArea": 200,
"county": "Chilecito",
"buildingArea": 120,
"ubication": "Lateral",
"cityId": 4011,
"type": "Departamento",
"propertyType": "Departamento",
"apartmentsPerFloor": 3,
"zone": "Colonia Malligasta, Chilecito, La Rioja, Argentina",
"price": 2500,
"airConditionerType": "Split/Ventana",
"state": "La Rioja",
"branchId": 23443,
"images": [
{
"image": "https://s3.amazonaws.com/mapaprop-dev/photos/2342/92478/755270.jpg",
"thumbnail": "https://s3.amazonaws.com/mapaprop-dev/photos/234/92478/755270t.jpg",
"orientation": 1,
"imageId": 234432,
"main": true,
"type": 1,
"contentType": "image/jpeg",
"timestamp": "2015-11-18T22:47:53Z"
},
{
"image": "https://s3.amazonaws.com/mapaprop-dev/photos/234/9242348/755271.jpg",
"thumbnail": "https://s3.amazonaws.com/mapaprop-dev/photos/1687/2/34755271t.jpg",
"orientation": 2,
"imageId": 234,
"main": false,
"type": 1,
"contentType": "image/jpeg",
"timestamp": "2015-11-18T22:48:23Z"
}
],
"bathrooms": 1,
"suspended": false,
"dependencies": 3,
"labels": [
"mortgageReady",
"professionalAvailable",
"furnished",
"janitor",
"grill",
"security",
"securityBox",
"swimmingPool",
"partySaloon",
"cableIncluded",
"heating",
"airConditioning",
"telephoneLine",
"dialyDinning",
"alarm",
"frontGarden",
"garage",
"laundry",
"patio",
"playroom",
"privateElevator",
"suite"
],
"bedrooms": 2,
"ambiences": 2,
"balconyType": "Terraza",
"yearsOld": 2,
"reserved": false,
"lastUpdate": "2017-11-01T06:40:40.000-04:00",
"paymentPeriod": "Por mes",
"conditions": "•\tAlquiler pago mes a mes. •\tDepósito de 1 mes de alquiler. •\tComisión inmobiliaria. ",
"status": "A Refaccionar",
"code": "1687-paunero.lasheras-102apt",
"expensesCurrency": "USD",
"city": "Colonia Malligasta",
"description": "Muy luminoso departamento muy bien ubicado en Palermo - Gran balcón - Totalmente amoblado - Gran Sofa - Cocina completamente equipada - Cama grande - baño completo - Tv con Cable - Wifi - Todo INCLUIDO",
"alternativePrices": [],
"title": "Hermoso y muy Luminoso depto ubicado en Palermo",
"totalFloors": 2,
"countryId": 1,
"toilettes": 2,
"seoUrl": "alquiler-temporario-de-departamento-en-colonia-malligasta234-la-rioja-16e87-344",
"rented": false,
"expensesPrice": 322,
"countyId": 561,
"hightlight": {},
"currency": "ARS",
"timestamp": "2015-11-18T00:00:00.000-05:00",
"sold": true,
"orientation": "NORTE",
"address": "Paunero ",
"zipCode": "1661",
"stateId": 12,
"propertyHash": "9cd969ac3a4623sdffd2cfeea1abab7",
"mainImage": "https://s3.amazonaws.com/mapaprop-dev/photos/32443/2434/755270t.jpg",
"taxCurrency": "USD",
"garage": 2,
"garageType": "Garage Cubierto",
"taxPrice": 329032,
"location": {
"lon": "-58.409215670639014",
"lat": "-34.58256378363613"
},
"operation": "Alquiler Temporario",
"propertyOperation": "Alquiler Temporario",
"attributes": [
{
"group_sub": "label",
"country": "ar",
"key_legacy": "electricity",
"group_subtype": "services",
"id": "electricity",
"label": "Electricidad",
"locale": "es_AR",
"type": "bool",
"group": "propertyAttribute",
"status": true
},
{
"group_sub": "label",
"country": "ar",
"key_legacy": "grill",
"group_subtype": "ammenities",
"id": "grill",
"label": "Parrilla",
"locale": "es_AR",
"type": "bool",
"group": "propertyAttribute",
"status": true
},
{
"group_sub": "label",
"country": "ar",
"key_legacy": "laundryMachine",
"group_subtype": "ammenities",
"id": "laundry-machine",
"label": "Lavarropas",
"locale": "es_AR",
"type": "bool",
"group": "propertyAttribute",
"status": true
},
{
"group_sub": "label",
"country": "ar",
"key_legacy": "professionalAvailable",
"group_subtype": "extras",
"id": "professional-available",
"label": "Apto profesional",
"locale": "es_AR",
"type": "bool",
"group": "propertyAttribute",
"status": true
},
{
"group_sub": "label",
"country": "ar",
"key_legacy": "hasSecurity",
"group_subtype": "services",
"id": "security",
"label": "Seguridad",
"locale": "es_AR",
"type": "bool",
"group": "propertyAttribute",
"status": true
},
{
"group_sub": "label",
"country": "ar",
"key_legacy": "sewers",
"group_subtype": "services",
"id": "sewers",
"label": "Cloacas",
"locale": "es_AR",
"type": "bool",
"group": "propertyAttribute",
"status": true
}
],
}
]
}