PRODUCCION

This service will return the details of one property

Resource information
AuthenticationRequired
HTTP MethodGET
ResponseJSON
Version1

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

KeyTypeRequiredDescription
propertyHashstringyesThe Hash ID of the property

Response

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

ObjectFieldTypeRequiredDescription
ResponsepropertyProperty objectyesThe property object
PropertypropertyHashstringyesA unique ID for the property
timestampstringyesISO8601 timestamp of when the property was created
lastUpdatestringyesISO8601 timestamp of when the property was last updated
codestringyesA unique code of the property entered by the customer
branchIdintyesThe ID of the branch that this property is related to. GET /api/action/express-v1/branches.
typeintyesThe type of property. GET /api/action/portal-v2/settings/types/{country}
propertyTypestringyesThe translated description of the property type. GET /api/action/portal-v2/settings/types/{country}
operationintyesThe operation of the property. GET /api/action/portal-v2/settings/operations/{country}
propertyOperationstringyesThe translated description of the property operation. GET /api/action/portal-v2/settings/operations/{country}
statusintyesThe Id of the building status. Constants
mainImagestringnoThe url of the main thumbnail related to the property
currencystringyesThe currency symbol of the price of the property. Constants
priceintyesThe price of the property
expensesCurrenciesstringnoThe currency symbol of the monthly / yearly expenses of the property. Constants
expensesPriceintnoThe price of the monthly / yearly expenses of the property
taxCurrencystringnoThe currency symbol of the monthly / yearly taxes of the property. Constants
taxPriceintnoThe price of the monthly / yearly taxes of the property
titlestringyesA title entered by the customer
addressstringyesThe street address and number of the property
zipCodestringyesThe postal code of the location property
zonestringyesA friendly description combining from city (if available) to state
countryIdintyesThe ID of the property country location
stateIdintyesThe ID of the property state location. GET /api/action/express-v1/zones
countyIdintyesThe ID of the property county location. GET /api/action/express-v1/zones
cityIdintnoThe ID of the property city location. GET /api/action/express-v1/zones
countryIdintyesThe ID of the property country location. GET /api/action/express-v1/zones
countrystringyesThe name of the country
statestringyesThe name of the state
countystringyesThe name of the county or 2nd division location
citystringnoThe name of the city / neighborhood or 3rd division
suspendedbooleanyesThe publication has been suspended
reservedbooleanyesThe property has been reserved
rentedbooleanyesThe property has been rented
soldbooleanyesThe property has been sold
descriptionstringyesThe long description of the property
conditionsstringnoThe long conditions statement of the property. Usually related to payments
bedroomsintnoNumber of bedrooms of the property
ambiencesintnoNumber of ambiences / spaces of the property
bathroomsintnoNumber of bathrooms of the property
dependenciesintnoNumber of dependency rooms (extra rooms)
occupancyintnoNumber of occupants (generally if this is a temp rental)
toilettesintnoNumber of toilettes (half bathrooms) in the property
buildingAreaintnoSquare meters of the built area
landAreaintnoSquare meters of the land of the property
yearsOldintnoHow old the property is
ubicationstringnoThe property cardinal ubication in the building
totalFloorsintnoThe total floors in the building
apartmentsPerFloorintnoThe amount of apartments per floor
airConditionerTypestringnoType of air conditioner.
waterHeaterTypestringnoType of water heater.
heatingTypestringnoType of heating appliances.
balconyTypestringnoType of balcony.
garageintnoThe total garages of the property
garageTypestringnoType of garage.
imagesArray of ImagenoArray of Image object
locationLocationyesLocation object
LocationlonstringyesLongitude location of the property
latstringyesLatitude location of the property
ImageimagestringyesURL for image
thumbnailstringyesURL for the thumbail
orientationintyesOrientation of the image. 1 = PORTRAIT, 2 = LANDSCAPE
typeintyesType of image.
1 = PHOTO,
2 = BLUEPRINT
contentTypestringyesThe image content type
timestampstringyesThe ISO8601 timestamp of when the image was uploaded
branchBranch DataArray of infoyesThe listo of data Branch Realtor
zipstringyes
zone0Descriptionstringyes
zone1Descriptionstringyes
zone2Descriptionstringyes
zone3Descriptionstringno
zone0intyes
zone1intyes
zone2intyes
zone3intno
addressstringyes
phone1stringyes
phone2stringno
phone3stringno
mobilestringno
mainbooleanyes
namestringyes
emailstringyes
customerstringyes
LabelslabelsArray of labelsnoThe labels / amenities of properties - Constants
customercustomerAddressstringyes
customerCountryintyes
customerEmailstringyes
customerIdintyes
customerlogostringyes
customerNamestringyes
customerPhonestringyes
attributesattributesArray of json attributesnoAll property attributes
descriptionFormatteddescriptionstringnoDescription with new formatting that accepts line breaks
videosvideosArray of jsonnoVideos 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": "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",
    }
} "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
        }
    ],