PRODUCTION

This service will return the list of properties for the customer

Resource information
AuthenticationRequired
HTTP MethodGET
ResponseJSON
Version1

Resource URL

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

Sample code

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

Parameters

KeyTypeRequiredDescription
termstringnoA term that will try to match at least 3 characters in the zone, address or title of the property. Full text search capabilities.
countryint/stringyesthe country from which the query is made Check available countries here
typeintyesA type of property. Constants
operationintyesAn operation of the property. Constants
fromintyesThe start record number.
sizeintyesThe amount of records to bring in each query. Default Max is 20 - Limited
bedroomsintnoThe amount of bedrooms of the property
ambiencesintnoExact number of rooms
ambiencesFromintnoSearch from a number upwards
ambiencesTointnoSearch up to the assigned number
bathroomsintnoThe amount of bathrooms of the property
countryIdintnoThe countryID of the property
stateIdintnoThe state ID of the property
countyIdintnoThe county ID of the property
cityIdintnoThe city ID of the property
buildingStatusintnoThe physical condition of the building. Constants
tempOccupancyintnoThe number of people who can live in a property
dateFromstringnoThe date you want to arrive (format is "dd-MM-yyyy")
dateTostringnoThe date you want to leave (format is "dd-MM-yyyy")
priceFromintnoThe minimum starting price to establish a search
priceTointnothe maximum price to establish a search
currencystringnothe currency of the property price. Max 3 chars, Min 2 Chars
brokerIdintnoThe broker ID of the properties

Response

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

ObjectFieldTypeRequiredDescription
ResponsetookintyesHow long the search took in milliseconds
totalintyesHow many total records are in the context of this search. You can paginate thru them
FiltersArray of filtersyesThe list of filters in url
brokerIdfilter intThe broker ID filter response
propertiesArray of PropertyyesThe list of Property objects
PropertypropertyHashstringyesA unique ID for the property
custIdintyesThe customer ID
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.
typestringyesThe translated description of the property type.  GET /api/action/portal-v2/settings/types/{country}
operationstringyesThe translated description of the property operation. GET /api/action/portal-v2/settings/operations/{country}
propertyTypestringyesThe id of the property type. GET /api/action/portal-v2/settings/types/{country}
propertyOperationintyesThe id of the property operation. GET /api/action/portal-v2/settings/operations/{country}
statusstringyesThe translated description of the property status of the building. 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 property location
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
LabelslabelsArray of labelsnoThe labels / amenities of properties - Constants
ObjectFieldTypeRequiredDescription
FiltersbedroomsintnoThe number of bedrooms in the property
sizeintyesThe size of property response
fromintyesproperty query start
tempOccupancyintnoTemporary occupancy status of the property.
dateTodatenoThe end date for a specific period of availability.
dateFromdatenoThe start date for a specific period of availability.
buildingStatusintnoThe status of the building (for example, like new, under construction, finished).
cityzone0IdintnoThe ID of the country
zone3IdintnoThe ID of the zone3
zone1IdintnoThe ID of the zone1
zone2IdintnoThe ID of the zone2
descriptionstringnoThe description of the zone3
countyzone0IdintnoThe ID of the country
zone1IdintnoThe ID of the zone1
zone2IdintnoThe ID of the zone2
descriptionstringnoThe description of the zone2
statezone0IdintnoThe ID of the country
zone1IdintnoThe ID of the zone1
descriptionstringnoThe description of the zone1
countryzone0IdintnoThe ID of the country
descriptionstringnoThe description of the zone0
typeidintyesThe ID of the property type.
namestringyesThe name of the property type (e.g., house)
operationidintyesThe ID of the property operation
namestringyesThe name of the property operation (e.g., sale, rent).
searchInfosearchInfoJSONyescurrent search information
removedremovedListnolist of removed filters
searchTypesearchTypeStringyesthe current search type
commentcommentStringnocomment clarification on search results

Sample response

{
  "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
                }
            ],
    }
  ]
}