PRODUCCION

This service will return the details of one property

Resource information
Authentication Required
HTTP Method GET
Response JSON
Version 1

Resource URL

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

Sample code

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 ya29.1.AADtN_UxybTdjLw9jX6lg_branSjjsldiwjtek4q2WvfETzSrz7Q6loEYoJEWd1x4qvlpGw

Parameters

Key Type Required Description
propertyHash string yes The Hash ID of the property

Response

A JSON document with the list of zones in a hierarchy where the customer has properties.

Object Field Type Required Description
Response property Property object yes The property object
Property propertyHash string yes A unique ID for the property
timestamp string yes ISO8601 timestamp of when the property was created
lastUpdate string yes ISO8601 timestamp of when the property was last updated
code string yes A unique code of the property entered by the customer
branchId int yes The ID of the branch that this property is related to. ‣.
type int yes The type of property. ‣
propertyType string yes The translated description of the property type. ‣
operation int yes The operation of the property. ‣
propertyOperation string yes The translated description of the property operation. ‣
status int yes The Id of the building status. ‣
mainImage string no The url of the main thumbnail related to the property
currency string yes The currency symbol of the price of the property. ‣
price int yes The price of the property
expensesCurrencies string no The currency symbol of the monthly / yearly expenses of the property. ‣
expensesPrice int no The price of the monthly / yearly expenses of the property
taxCurrency string no The currency symbol of the monthly / yearly taxes of the property. ‣
taxPrice int no The price of the monthly / yearly taxes of the property
title string yes A title entered by the customer
address string yes The street address and number of the property
zipCode string yes The postal code of the location property
zone string yes A friendly description combining from city (if available) to state
countryId int yes The ID of the property country location
stateId int yes The ID of the property state location. ‣
countyId int yes The ID of the property county location. ‣
cityId int no The ID of the property city location. ‣
countryId int yes The ID of the property country location. ‣
country string yes The name of the country
state string yes The name of the state
county string yes The name of the county or 2nd division location
city string no The name of the city / neighborhood or 3rd division
suspended boolean yes The publication has been suspended
reserved boolean yes The property has been reserved
rented boolean yes The property has been rented
sold boolean yes The property has been sold
description string yes The long description of the property
conditions string no The long conditions statement of the property. Usually related to payments
bedrooms int no Number of bedrooms of the property
ambiences int no Number of ambiences / spaces of the property
bathrooms int no Number of bathrooms of the property
dependencies int no Number of dependency rooms (extra rooms)
occupancy int no Number of occupants (generally if this is a temp rental)
toilettes int no Number of toilettes (half bathrooms) in the property
buildingArea int no Square meters of the built area
landArea int no Square meters of the land of the property
yearsOld int no How old the property is
ubication string no The property cardinal ubication in the building
totalFloors int no The total floors in the building
apartmentsPerFloor int no The amount of apartments per floor
airConditionerType string no Type of air conditioner.
waterHeaterType string no Type of water heater.
heatingType string no Type of heating appliances.
balconyType string no Type of balcony.
garage int no The total garages of the property
garageType string no Type of garage.
images Array of Image no Array of Image object
location Location yes Location object
Location lon string yes Longitude location of the property
lat string yes Latitude location of the property
Image image string yes URL for image
thumbnail string yes URL for the thumbail
orientation int yes Orientation of the image. 1 = PORTRAIT, 2 = LANDSCAPE
type int yes Type of image.
1 = PHOTO,
2 = BLUEPRINT
contentType string yes The image content type
timestamp string yes The ISO8601 timestamp of when the image was uploaded
branch Branch Data Array of info yes The listo of data Branch Realtor
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 The labels / amenities of properties - ‣
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 All property attributes
descriptionFormatted description string no Description with new formatting that accepts line breaks
videos videos Array of json no Videos of the property (URL or embed option)

Sample response

{
  "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": "[email protected]",
        "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 protected]",
      "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",            
    }
} "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
        }
    ],