PROD

Este serviço retorna os detalhes de um imóvel da sua conta (a imobiliária dona do token). O escopo vem do access token, não é enviado como parâmetro.

Informações do recurso
AutenticaçãoObrigatória (Token de API, Bearer)
Scopeexpress-base
HTTP MethodGET
ResponseJSON
Version1

URL do recurso

https://mapaprop.app/api/action/express-v1/properties/{propertyHash}

Código de exemplo

GET /api/action/express-v1/properties/YoJEWd1x4qvlpGw HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer {access_token}

Parâmetros

KeyTypeRequiredDescrição
propertyHashstringyesO Hash ID do imóvel

Resposta

Um documento JSON com o detalhe do imóvel.

ObjetoCampoTipoObrigatórioDescrição
ResponsepropertyProperty objectyesO objeto imóvel
PropertypropertyHashstringyesO ID único do imóvel
timestampstringyesTimestamp ISO8601 de quando o imóvel foi criado
lastUpdatestringyesTimestamp ISO8601 da última atualização do imóvel
codestringyesCódigo único do imóvel inserido pelo cliente
branchIdintyesO ID da filial à qual o imóvel pertence. GET /api/action/express-v1/branches.
typeintyesO tipo de imóvel. GET /api/action/express-v1/types
propertyTypestringyesA descrição traduzida do tipo de imóvel. GET /api/action/express-v1/types
operationintyesO Id da operação do imóvel. Constantes
propertyOperationstringyesA descrição traduzida da operação do imóvel. Constantes
statusidyesO Id do estado de construção do imóvel. Constantes
mainImagestringnoA URL da imagem principal (thumbnail) do imóvel
currencystringyesO símbolo de moeda do preço do imóvel. Constantes
priceintyesO preço do imóvel
expensesCurrenciesstringnoO símbolo de moeda das despesas mensais/anuais do imóvel. Constantes
expensesPriceintnoO valor das despesas mensais/anuais do imóvel
taxCurrencystringnoO símbolo de moeda dos impostos mensais/anuais do imóvel. Constantes
taxPriceintnoO valor dos impostos mensais/anuais do imóvel
titlestringyesTítulo inserido pelo cliente
addressstringyesO endereço e número do imóvel
zipCodestringyesO CEP da localização do imóvel
zonestringyesDescrição amigável combinando cidade (se disponível) e estado
countryIdintyesO ID do país onde o imóvel está localizado
stateIdintyesO ID do estado onde o imóvel está localizado. GET /api/action/express-v1/zones
countyIdintyesO ID do município onde o imóvel está localizado. GET /api/action/express-v1/zones
cityIdintnoO ID da cidade onde o imóvel está localizado. GET /api/action/express-v1/zones
countryIdintyesO ID do país onde o imóvel está localizado. GET /api/action/express-v1/zones
countrystringyesO nome do país
statestringyesO nome do estado
countystringyesO nome do município ou segunda divisão geográfica
citystringnoO nome 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
descriptionstringyesA descrição longa do imóvel
conditionsstringnoAs condições detalhadas do imóvel. Geralmente relacionadas a pagamentos
bedroomsintnoNúmero de quartos no imóvel
ambiencesintnoQuantidade de ambientes do imóvel
bathroomsintnoNúmero de banheiros no imóvel
dependenciesintnoNúmero de quartos de dependência (quartos extras)
occupancyintnoQuantidade de ocupantes (geralmente para aluguel temporário)
toilettesintnoNúmero de lavabos (banheiros incompletos) no imóvel
buildingAreaintnoMetros quadrados da área construída
landAreaintnoMetros quadrados do terreno do imóvel
yearsOldintnoIdade do imóvel
ubicationstringnoPosiçã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.
garageintnoTotal de vagas de garagem do imóvel
garageTypestringnoTipo de garagem.
imagesArray of ImagenoArray de objetos Image
locationLocationyesObjeto Location
LocationlonstringyesLongitude geográfica do imóvel
latstringyesLatitude geográfica do imóvel
ImageimagestringyesURL da imagem
thumbnailstringyesURL do thumbnail
orientationintyesOrientação da imagem. 1 = PORTRAIT, 2 = LANDSCAPE
typeintyesTipo de imagem. 1 = PHOTO, 2 = BLUEPRINT
contentTypestringyesO content type da imagem
timestampstringyesTimestamp ISO8601 de quando a imagem foi enviada
LabelslabelsArray of labelsnoLabels do imóvel - Constantes
attributesattributesArray of json attributesnoTodos os atributos do imóvel
descriptionFormatteddescriptionstringnoDescrição com novo formato que aceita quebras de linha
videosvideosArray of jsonnoVídeos do imóvel (URL ou opção embed)

Exemplo de resposta

{
    "code": "1-6454656",
    "codeSearch": "1-6454656",
    "description": "gran casa en haedo capital de ahora morona",
    "alternativePrices": [],
    "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
        }
    ],
    "type": 20.0,
    "title": "gran casa en haedo capital de ahora morona",
    "branch": {
        "zip": "1416",
        "zone2Description": "Cañuelas",
        "branchId": 773,
        "address": "Camarones 2755",
        "main": true,
        "zone0Description": "Argentina",
        "zone3": 1074,
        "zone2": 155,
        "zone1": 2,
        "zone0": 1,
        "phone1": "4581-8985",
        "zone1Description": "Buenos Aires",
        "custId": 1,
        "name": "Sucursal Haedo",
        "zone3Description": "Máximo Paz",
        "email": "info@mapaprop.com",
        "customer": "Mapaprop Demo INC"
    },
    "customerCountry": 1.0,
    "zone2Desc": "Caballito",
    "customerPhone": "4581-8985",
    "seoUrl": "alquiler-temporario-de-loft-en-caballito-capital-federal-1-147874",
    "rented": false,
    "zone": "Caballito, Capital Federal, Argentina",
    "price": 54554.0,
    "customerEmail": "info@mapaprop.com",
    "propertyType": "Loft",
    "customerId": 1.0,
    "codeRaw": "6454656",
    "currency": "USD",
    "propertyId": 147874.0,
    "timestamp": "2019-10-29T00:00:00.000-03:00",
    "customerAddress": "Camarones 2755",
    "branchId": 773.0,
    "sold": false,
    "ambiences": 5,
    "images": [],
    "address": "paysandu 984",
    "published": true,
    "zone2": 18.0,
    "customerName": "Mapaprop Demo INC",
    "suspended": false,
    "zone1": 1.0,
            "labels": [
                "mortgage-ready",
                "professional-available",
                "furnished",
                "janitor",
                "grill",
                "storage",
                "security",
                "security-box",
                "swimming-pool",
                "party-saloon",
                "cable-included",
                "telephone-line",
                "daily-dinning",
                "alarm",
                "front-garden",
                "laundry",
                "patio",
                "playroom",
                "private-elevator",
                "suite"
            ],
    "zone0": 1.0,
    "zone1Desc": "Capital Federal",
    "propertyOperation": "Alquiler Temporario",
    "propertyHash": "e86a6a15b7f93ae633b0b009c5c51120",
    "mainImage": "noimage.gif",
    "lastUpdateFormated": "29-10-2019",
    "reserved": false,
    "lastUpdate": "2019-10-29T14:13:54.000-03:00",
    "onlyWebsite": true,
    "location": {
        "lon": "-58.45284939999999",
        "lat": "-34.6125374"
    },
        "attributes": [
        {
            "group_sub": "label",
            "country": "ar",
            "key_legacy": "accessible",
            "group_subtype": "ammenities",
            "id": "accessible",
            "label": "Accesible",
            "locale": "es_AR",
            "type": "bool",
            "group": "propertyAttribute",
            "status": true
        },
         ],
        "descriptionFormatted": "Test Images, Propiedad TestTest Images, \n\nPropiedad Test",
    "operation": 3.0,
    "status": 6.0,
    "zone0Desc": "Argentina",
    "zipCode": "1661"
}