PROD

Este serviço retorna a lista de imóveis do cliente.

Informações do recurso
AutenticaçãoRequired
Método HTTPGET
RespostaJSON
Versão1

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

ChaveTipoObrigatórioDescrição
termstringnoTermo que tenta corresponder a pelo menos 3 caracteres na zona, endereço ou título do imóvel. Busca de texto completo.
countryint/stringyesO país a partir do qual a consulta é feita. Constantes
typeintyesTipo de imóvel. Constantes
operationintyesOperação do imóvel. Constantes
fromintyesNúmero do registro inicial
sizeintyesQuantidade de registros por consulta. Máximo padrão: 20 - Limitado
bedroomsintnoQuantidade de quartos
ambiencesintnoNúmero exato de ambientes
ambiencesFromintnoBuscar a partir de um número
ambiencesTointnoBuscar até o número atribuído
bathroomsintnoQuantidade de banheiros
countryIdintnoID do país do imóvel
stateIdintnoID do estado
countyIdintnoID do município
cityIdintnoID da cidade
buildingStatusintnoEstado físico do edifício. Constantes
tempOccupancyintnoQuantidade de pessoas que podem viver no imóvel
dateFromstringnoData de chegada (formato "dd-MM-yyyy")
dateTostringnoData de saída (formato "dd-MM-yyyy")
priceFromintnoPreço mínimo de busca
priceTointnoPreço máximo de busca
currencystringnoMoeda do preço do imóvel. Máx 3 chars, Mín 2 chars
brokerIdintnoID do corretor dos imóveis

Resposta

Um documento JSON com a lista de imóveis que correspondem aos filtros.

ObjetoCampoTipoObrigatórioDescrição
ResponsetookintyesTempo que a busca levou em milissegundos
totalintyesTotal de registros disponíveis. Você pode paginar por eles
FiltersArray of filtersyesLista de filtros aplicados na URL
brokerIdfilter intFiltro de ID de corretor na resposta
propertiesArray of PropertyyesLista de objetos Property
PropertypropertyHashstringyesID único do imóvel
custIdintyesID do cliente
timestampstringyesTimestamp ISO8601 de quando o imóvel foi criado
lastUpdatestringyesTimestamp ISO8601 da última atualização
codestringyesCódigo único do imóvel inserido pelo cliente
branchIdintyesID da filial associada. GET /api/action/express-v1/branches.
typestringyesDescrição traduzida do tipo de imóvel. GET /api/action/portal-v2/settings/types/{country}
operationstringyesDescrição traduzida da operação. GET /api/action/portal-v2/settings/operations/{country}
propertyTypestringyesID do tipo de imóvel. GET /api/action/portal-v2/settings/types/{country}
propertyOperationintyesID da operação. GET /api/action/portal-v2/settings/operations/{country}
statusstringyesDescrição traduzida do status construtivo. Constantes
mainImagestringnoURL da thumbnail principal do imóvel
currencystringyesSímbolo da moeda do preço. Constantes
priceintyesPreço do imóvel
expensesCurrenciesstringnoSímbolo da moeda do condomínio. Constantes
expensesPriceintnoValor do condomínio mensal / anual
taxCurrencystringnoSímbolo da moeda dos impostos. Constantes
taxPriceintnoValor dos impostos mensais / anuais
titlestringyesTítulo inserido pelo cliente
addressstringyesRua e número do imóvel
zipCodestringyesCEP da localização
zonestringyesDescrição amigável combinando cidade (se disponível) e estado
countryIdintyesID do país do imóvel
stateIdintyesID do estado. GET /api/action/express-v1/zones
countyIdintyesID do município. GET /api/action/express-v1/zones
cityIdintnoID da cidade. GET /api/action/express-v1/zones
countryIdintyesID do país. GET /api/action/express-v1/zones
countrystringyesNome do país
statestringyesNome do estado
countystringyesNome do município ou segunda divisão
citystringnoNome da cidade / bairro ou terceira divisão
suspendedbooleanyesA publicação foi suspensa
reservedbooleanyesO imóvel foi reservado
rentedbooleanyesO imóvel foi alugado
soldbooleanyesO imóvel foi vendido
descriptionstringyesDescrição longa do imóvel
conditionsstringnoCondições do imóvel. Geralmente relacionadas ao pagamento
bedroomsintnoQuantidade de quartos
ambiencesintnoQuantidade de ambientes
bathroomsintnoQuantidade de banheiros
dependenciesintnoQuantidade de dependências (quartos extras)
occupancyintnoQuantidade de ocupantes (geralmente para aluguel temporário)
toilettesintnoQuantidade de lavabos
buildingAreaintnoMetros quadrados de área construída
landAreaintnoMetros quadrados de terreno
yearsOldintnoAntiguidade do imóvel
ubicationstringnoOrientação cardinal do imóvel no edifício
totalFloorsintnoTotal de andares do edifício
apartmentsPerFloorintnoQuantidade de apartamentos por andar
airConditionerTypestringnoTipo de ar-condicionado
waterHeaterTypestringnoTipo de aquecedor de água
heatingTypestringnoTipo de aquecimento
balconyTypestringnoTipo de varanda
garageintnoQuantidade de vagas de garagem
garageTypestringnoTipo de garagem
imagesArray of ImagenoArray de objetos Image
locationLocationyesObjeto de localização geográfica
LocationlonstringyesLongitude do imóvel
latstringyesLatitude do imóvel
ImageimagestringyesURL da imagem
thumbnailstringyesURL da thumbnail
orientationintyesOrientação da imagem. 1 = PORTRAIT, 2 = LANDSCAPE
typeintyesTipo de imagem. 1 = PHOTO, 2 = BLUEPRINT
contentTypestringyesTipo de conteúdo da imagem
timestampstringyesTimestamp ISO8601 de quando a imagem foi enviada
LabelslabelsArray of labelsnoEtiquetas / comodidades do imóvel - Constantes
ObjectFieldTypeRequiredDescription
FiltersbedroomsintnoQuantidade de quartos no imóvel
sizeintyesTamanho da resposta de imóveis
fromintyesInício da consulta
tempOccupancyintnoStatus de ocupação temporária
dateTodatenoData de fim do período de disponibilidade
dateFromdatenoData de início do período de disponibilidade
buildingStatusintnoStatus do edifício (por ex.: como novo, em construção, concluído)
cityzone0IdintnoID do país
zone3IdintnoID da zone3
zone1IdintnoID da zone1
zone2IdintnoID da zone2
descriptionstringnoDescrição da zone3
countyzone0IdintnoID do país
zone1IdintnoID da zone1
zone2IdintnoID da zone2
descriptionstringnoDescrição da zone2
statezone0IdintnoID do país
zone1IdintnoID da zone1
descriptionstringnoDescrição da zone1
countryzone0IdintnoID do país
descriptionstringnoDescrição da zone0
typeidintyesID do tipo de imóvel
namestringyesNome do tipo de imóvel (ex.: casa)
operationidintyesID da operação
namestringyesNome da operação (ex.: venda, aluguel)
searchInfosearchInfoJSONyesInformações sobre a busca atual
removedremovedListnoLista de filtros removidos
searchTypesearchTypeStringyesTipo de busca atual
commentcommentStringnoEsclarecimento 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".

CampoTipoEm um empreendimentoEm uma unidadeEm um imóvel comum
developmentbooleantruefalsefalse
developmentIdint0 (não tem pai)o propertyId do empreendimento0
developmentPropertiesArrayos propertyId das suas unidades[][]
developmentStatsObjectos números derivados — veja abaixoausenteausente

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.

CampoTipoDescrição
commercialTaglinestringO slogan comercial do projeto
deliveryDatestringData de entrega, em formato ISO com fuso horário
logoUrlstringO logotipo do projeto — diferente do logotipo da imobiliária
totalApartmentsintApartamentos
totalHousesintCasas
totalLotsintLotes
totalTowersintTorres
totalElevatorsintElevadores
totalOfficesintEscritórios
totalCommercialUnitsintLojas 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.

BlocoCampos
unitstotal · available · sold · rented · reserved · suspended · withOperation · availabilityRate
buildingAreatotal · available · sold · rented · reserved · unavailable · unit
pricesbyCurrency (por moeda: units · from · to · average · total) · mixedCurrencies
sale · rent · otherOperationunits · commercialized · rate
typologybyAmbiences · 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
                }
            ],
    }
  ]
}