GET /api/action/portal-v2/properties/{propertyHash}

PROD

Este serviço retorna os detalhes de um imóvel.

Informações do recurso
Autenticação	Required
Scope	`internal-portal`
Método HTTP	GET
Resposta	JSON
Versão	2

Escopo de rede

Se seu cliente possui o scope network-suscription, o imóvel deve pertencer a um cliente da sua rede. Imóveis fora da sua rede retornam um erro de não encontrado, mesmo que o hash seja válido.

URL do recurso

https://mapaprop.app/api/action/portal-v2/properties/{propertyHash}

Exemplo de chamada

GET /api/action/portal-v2/properties/YoJEWd1x4qvlpGw 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
propertyHash	string	yes	O Hash ID do imóvel

Resposta

Um documento JSON com os detalhes do imóvel.

Objeto	Campo	Tipo	Obrigatório	Descrição
Response	property	Property object	yes	O objeto imóvel
Property	propertyHash	string	yes	ID único do imóvel
	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 ao imóvel. GET /api/action/express-v1/branches.
	type	int	yes	Tipo do imóvel. GET /api/action/portal-v2/settings/types/{country}
	propertyType	string	yes	Descrição traduzida do tipo de imóvel. GET /api/action/portal-v2/settings/types/{country}
	operation	int	yes	Operação do imóvel. GET /api/action/portal-v2/settings/operations/{country}
	propertyOperation	string	yes	Descrição traduzida da operação. GET /api/action/portal-v2/settings/operations/{country}
	status	int	yes	ID 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
branch	Branch Data	Array of info	yes	Lista de dados da filial do corretor
	zip	string	yes
	zone0Description	string	yes
	zone1Description	string	yes
	zone2Description	string	yes
	zone3Description	string	no
	zone0	int	yes
	zone1	int	yes
	zone2	int	yes
	zone3	int	no
	address	string	yes
	phone1	string	yes
	phone2	string	no
	phone3	string	no
	mobile	string	no
	main	boolean	yes
	name	string	yes
	email	string	yes
	customer	string	yes
Labels	labels	Array of labels	no	Etiquetas / comodidades do imóvel - Constantes
customer	customerAddress	string	yes
	customerCountry	int	yes
	customerEmail	string	yes
	customerId	int	yes
	customerlogo	string	yes
	customerName	string	yes
	customerPhone	string	yes
attributes	attributes	Array of json attributes	no	Todos os atributos do imóvel
descriptionFormatted	description	string	no	Descrição com nova formatação que aceita quebras de linha
videos	videos	Array of json	no	Vídeos do imóvel (URL ou embed)

Exemplo de resposta

{
  "property": {
      "country": "Argentina",
      "heatingType": "Estufas",
      "occupancy": 2,
      "waterHeaterType": "Termotanque",
      "landArea": 200,
      "county": "Chilecito",
      "buildingArea": 120,
      "ubication": "Lateral",
      "cityId": 4011,
      "type": "1",
      "propertyType": "Departamento",
      "apartmentsPerFloor": 3,
      "zone": "Colonia Malligasta, Chilecito, La Rioja, Argentina",
      "price": 2500,
      "airConditionerType": "Split/Ventana",
      "state": "La Rioja",
      "branchId": 23443,
       "videos": [
        {
            "custId": 1,
            "description": "asdasdsadadasd",
            "videoId": 7252,
            "source": "https://www.youtube.com/shorts/DV5mG3XGPZU",
            "propertyId": 256854
        },
        {
            "custId": 1,
            "description": "asdasdsadadasd",
            "videoId": 7253,
            "source": "https://www.youtube.com/watch?v=gLcP6qqulhA&ab_channel=NovalProperties",
            "propertyId": 256854
        },
        {
            "custId": 1,
            "description": "asdasdsadadasd",
            "videoId": 7254,
            "source": "<iframe width=\"560\" height=\"315\" src=\"https://www.youtube.com/embed/gLcP6qqulhA?si=CpKaYWLYZXXh4zyP\" title=\"YouTube video player\" frameborder=\"0\" allow=\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share\" referrerpolicy=\"strict-origin-when-cross-origin\" allowfullscreen></iframe>",
            "propertyId": 256854
        },
        {
            "custId": 1,
            "description": "dasdsadsss",
            "videoId": 7258,
            "source": "https://my.matterport.com/show?play=1&lang=en-US&m=CmhKN1eSdqR",
            "propertyId": 256854
        }
    ],
      "branch": {
        "zip": "1878",
        "zone2Description": "Quilmes",
        "branchId": 7914,
        "address": "Lavalle 654 ",
        "phone2": "11-0000-0000",
        "main": true,
        "zone0Description": "Argentina",
        "zone3": 1098,
        "zone2": 237,
        "zone1": 2,
        "zone0": 1,
        "phone1": "7078-0000",
                "mobile": "541144440000"
        "zone1Description": "Buenos Aires",
        "custId": 7466,
        "name": "Gabriel Bagnato Bienes Ra?ces",
        "zone3Description": "Quilmes",
        "email": "xxxxx@gmail.com",
        "customer": "Ruben Inmobiliaria"
    },
      "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": "3",
      "propertyOperation": "Alquiler Temporario",
      "customerLogo": "https://s3.amazonaws.com/mapaprop-dev/photos/32443/2434/755270t.jpg",
      "customerAddress": "Malabia 3526",
      "customerCountry": 1,
      "customerEmail": "email@dominio.com",
      "customerId": 0000,
      "customerName": "Inmobiliaria X",
      "customerPhone": "111-111",
            "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
                }
          ],
        "descriptionFormatted": "Test Images, Propiedad TestTest Images, \n\nPropiedad Test",
    }
}