PRODUCTION

This webservice is used to get properties from our database. You can retrieve up to 500 items per call. You should do this only until you retrieve the full list of items. Once that is completed you should use get-delta as your daily process.

Resource information
Authentication Required
HTTP Method GET
Response JSON
Version 1

Resource URL

<https://mapaprop.app/api/action/feed-v1/get-properties>

Parameters

Key Type Required Description
country string yes The ISO code for the country. ‣
types string yes Comma separated values of types. ‣
operations string yes Comma separated values of operations. ‣
from int yes The start record number.
to int yes The end record number. From/to difference cannot be more than 500.
locale string no The iso country code representing a locale to have texts translated to the particular country. Check available countries
skipNetwork boolean no Only if you have the scope network and you want all properties instead the network properties then this value should be true. Don't send any value if you want to get only network properties.

Sample code

GET /api/action/feed-v1/get-properties?country=AR&types=1,3,18&operations=sale,temp&from=1000&to=1500 HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer ya29.1.AADtN_UxybTdjLw9jX6lg_SXIgc3wTtek4q2WvfETzSrz7Q6loEYoJEWd1x4qvlpGw

Response

An array of properties with the following structure.

Object Field Type Required Description
Property id string yes The ID of the property generated by the system (hash)
propertyCode string yes An ID defined by the customer
type string yes The translated description of the property type. ‣.
typeCode int yes Type ID of the type. ‣.
propertyType string yes The translated description of the property type. ‣.
operation string yes The translated description of the property operation. ‣.
operationCode int yes The ID of the operation. ‣
propertyOperation string yes The translated description of the property operation. ‣.
url string yes The URL in memudoya.com or customer website.
title string yes Main title for the property. Usually entered by our customers.
description string yes Autogenerated description showing property features.
price int yes Price of the property
expenses int no Price of monthly expenses
currency string yes ISO description of the currency of the value of the property. ‣.
builtArea int no Total built area. Usually in square meters.
totalArea int no Total area of the lot. Usually in square meters.
occupancy int no The number of occupants allowed by the owner if this is a temporary lease or rental.
bedrooms int no The number of rooms of the property
ambiences int no The number of ambiences / spaces of the property
bathrooms int no The number of bathrooms of the property
yearsOld int no The age of the property in years
totalFloors int no The number of floors of the building
apartmentsPerFloor int no The number of apartments per floor of the property
floors int no The number of floors of the property
orientation String no The orientation of the property
ubication String no The ubication of property on the land
balconyType String no The type of Balcony of the apartment
lastUpdate String yes A ISO 8601 format date in UTC with the latest update of the property
paymentPeriod String no A description representing how is the payment period. This is for temp rentals and not required.
location Location yes Location information of the property
images Array of strings no An array of images of the property
videos Array of strings no An array of videos of the property
agency Agency yes The object representing the agency who publishes this property
amenities Array of strings yes An array representing labels of amenities of the property. See the example
Location latitude string yes Latitude of the property
longitude string yes Longitude of the property
country string yes The country where the property is located
state string yes The state where the property is located
city string yes The city where the property is located
address string yes The address where the property is located
zipCode string yes The postal code of the property location
Agency id string yes The ID of the agency
name string yes The name of the agency
address string yes The address of the agency
phone string yes The phone number of the agency
mobile string no The mobile number in universal format
email string yes The email of the agency (depending on your service)
logo string yes A URL with the logo of the agency
attributes attributes Array of json attributes no All property attributes
descriptionFormatted description string no Description with new formatting that accepts line breaks

Sample code

[
    {
        "id": "350ebf8f7d7be42bf18ad73b59005c54",
        "propertyCode": "2485-635896",
        "type": "Casa",
        "typeCode": 1,
        "propertyType": "Casa",
        "operation": "Venta",
        "operationCode": 1,
		"propertyOperation": "Venta",
        "url": "<http://gonzalezprops.com/propiedades/id=3223923>",
        "title": "Propiedad con vista al mar, excelente oportunidad!",
        "description": "CODIGO: 1520- MYR1504 ubicado en: a 0.2km de la ciudad - Campo en Venta en Lobos, Buenos Aires. Publicado a través de Mapaprop",
        "price": "180000",
        "expenses": "150",
        "lastUpdate": "2014-01-24T10:30:27Z",
        "paymentPeriod": "weekly",
        "currency": "USD",
        "builtArea": 180,
        "totalArea": 220,
        "occupancy": 5,
        "bedrooms": 4,
        "ambiences": 5,
        "bathrooms": 1,
        "yearsOld": 50,
        "totalFloors": 8,
        "apartmentsPerFloor": 5,
        "floors": 1,
        "orientation": "NORESTE",
        "ubication": "Frente",
        "balconyType": "Corrido",
        "location": {
            "latitude": "-33.23932932",
            "longitude": "-59.30203230",
            "country": "Argentina",
            "state": "Buenos Aires",
            "city": "Mar del Plata",
            "address": "De la Fuente 3993",
            "zipcode": "1661"
        },
        "images": [
            "<http://gestion.mapaprop.com/images/photos/1520/49998/343298.jpg>",
            "<http://gestion.mapaprop.com/images/photos/1520/49998/5155.jpg>",
            "<http://gestion.mapaprop.com/images/photos/1520/49998/23235.jpg>"
        ],
         "videos": [
            {
                "description": "Hermosa isla",
                "source": "<iframe width=\\"560\\" height=\\"315\\" src=\\"<https://www.youtube.com/embed/7nQ2oiVqKHw\\>" title=\\"YouTube video player\\" frameborder=\\"0\\" allow=\\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture\\" allowfullscreen></iframe>",
            },
        ],
        "agency": {
            "id": "8441239688441236",
            "name": "Gonzalez Propiedades",
            "address": "Gorostiaga 9393",
            "phone": "666 7114",
            "mobile": "541184485145",
            "email": "[email protected]",
            "logo": "<http://gonzalezprops.com/img/logo.png>"
        },
        "amenities": [
            "Patio",
            "Garage",
            "Aire acondicionado",
            "Linea telefonica",
            "Pileta",
            "Seguridad"
        ],
        "descriptionFormatted": "CODIGO: 2544-Chañ ubicado en: Av. Los Chañares -  Publicado por: FÉLIX RUIZ. Terreno en Venta en Oro Verde, Paraná, Entre Ríos. El precio es de USD 17000 null. La superficie total es de 300 metros cuadrados. Servicios en el Terreno: . El Terreno cuenta con: Cochera. . Comodidades: Electricidad | Parrilla | Lavarropas | Apto profesional | Seguridad | Cloacas |  Publicado a través de Mapaprop",
        "attributes": [
						  {
						    "group_sub": "propertyType",
						    "country": "ar",
						    "key_legacy": "1",
						    "id": "apartment",
						    "label": "Departamento",
						    "locale": "es_AR",
						    "type": "string",
						    "group": "type"
						  },        
						  {
						    "group_sub": "waterHeaterType",
						    "country": "ar",
						    "key_legacy": "1",
						    "id": "waterHeaterCalefon",
						    "label": "Agua caliente Calefón",
						    "locale": "es_AR",
						    "type": "list",
						    "value": "1",
						    "group": "propertyAttribute"
					  }, 
					  {
						    "group_sub": "heatingType",
						    "country": "ar",
						    "key_legacy": "1",
						    "id": "heatingCentral",
						    "label": "Calefacción Central",
						    "locale": "es_AR",
						    "type": "list",
						    "value": "1",
						    "group": "propertyAttribute"
					  },        
					  {
						    "group_sub": "airConditonerType",
						    "country": "ar",
						    "key_legacy": "1",
						    "id": "airConditonerTypeCentral",
						    "label": "Aire acondicionado Central",
						    "locale": "es_AR",
						    "type": "list",
						    "value": "1",
						    "group": "propertyAttribute"
					  },        
	          {
						    "group_sub": "garageType",
						    "country": "cl",
						    "number": 3,
						    "key_legacy": "2",
						    "id": "garageCovered",
						    "label": "Garaje cubierto",
						    "locale": "es_CL",
						    "type": "list",
						    "value": "2",
						    "group": "propertyAttribute"
					  },
            {
                "group_sub": "label",
                "country": "ar",
                "group_subtype": "services",
                "id": "electricity",
                "label": "Electricidad",
                "locale": "es_AR",
                "type": "bool",
                "group": "propertyAttribute",
                "status": true
            },
            {
                "group_sub": "label",
                "country": "ar",
                "group_subtype": "ammenities",
                "id": "grill",
                "label": "Parrilla",
                "locale": "es_AR",
                "type": "bool",
                "group": "propertyAttribute",
                "status": true
            },
            {
                "group_sub": "label",
                "country": "ar",
                "group_subtype": "ammenities",
                "id": "laundry-machine",
                "label": "Lavarropas",
                "locale": "es_AR",
                "type": "bool",
                "group": "propertyAttribute",
                "status": true
            },
            {
                "group_sub": "label",
                "country": "ar",
                "group_subtype": "extras",
                "id": "professional-available",
                "label": "Apto profesional",
                "locale": "es_AR",
                "type": "bool",
                "group": "propertyAttribute",
                "status": true
            },
            {
                "group_sub": "label",
                "country": "ar",
                "group_subtype": "services",
                "id": "security",
                "label": "Seguridad",
                "locale": "es_AR",
                "type": "bool",
                "group": "propertyAttribute",
                "status": true
            },
            {
                "group_sub": "label",
                "country": "ar",
                "group_subtype": "services",
                "id": "sewers",
                "label": "Cloacas",
                "locale": "es_AR",
                "type": "bool",
                "group": "propertyAttribute",
                "status": true
            }
        ]      
    }
]

Amenities Examples

The following list is an example of some amenities. Treat them as labels. This is not the full list of amenities in the system.

Original Value AR Spanish
heatingType Calefacción
airConditionerType Aire acondicionado
securityBox Caja de seguridad
alarm Alarma
janitor Encargado de edificio
telephoneLine Linea telefonica
cableIncluded Cable incluido
frontGarden Jardin al frente
hasSecurity Seguridad privada
terrace Terraza
suite Dormitorio en suite
grill Parrilla
hasStorage Baulera