PRODUCTION

This service will return the list of properties for the customer

Resource URL

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

Sample code

GET /api/action/express-v1/properties?operation=1&buildingStatus=5&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

Pagination

This endpoint uses offset-based pagination via the from and size query parameters.

The response always includes a total field with the total number of records matching your filters (not just the ones returned in the current page). Use it to know when to stop paginating.

How to paginate

To retrieve page N (1-indexed) with a fixed page size:

from = (N - 1) * size

Keep requesting the next page while from + size < total.

Example: paginate through 45 results, 20 per page

Assume a search returns "total": 45. To get every result you need 3 requests:

Page 1 — records 1 to 20:

GET /api/action/express-v1/properties?operation=1&from=0&size=20

Response: { "took": 12, "total": 45, "properties": [ ...20 items... ] }

Page 2 — records 21 to 40:

GET /api/action/express-v1/properties?operation=1&from=20&size=20

Response: { "took": 9, "total": 45, "properties": [ ...20 items... ] }

Page 3 — records 41 to 45:

GET /api/action/express-v1/properties?operation=1&from=40&size=20

Response: { "took": 7, "total": 45, "properties": [ ...5 items... ] }

At this point from + size = 60 >= total = 45, so there are no more pages.

Notes

• Keep filters consistent across pages. Changing any filter between requests (e.g. operation, priceFrom, stateId) resets the result set and your offset will point to a different collection.
• size cannot exceed 20. Requesting size=21 or more returns a validation error: "You cannot retrieve more than 20 properties at a time". To retrieve large result sets you must paginate.
• from is an offset, not a page number. from=2 returns records starting at position 3, not "page 2".
• The took field is the time in milliseconds the search took on the server side for that page only.

Response

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

Sample response

{
    "took": 111,
    "total": 13,
    "properties": [
        {
            "country": "Argentina",
            "county": "Caballito",
            "type": 20,
            "zone": "Caballito, Capital Federal, Argentina",
            "price": 54554,
            "state": "Capital Federal",
            "branchId": 773,
            "images": [],
            "suspended": false,
            "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"
            ],
            "propertyOperation": "Alquiler Temporario",
            "reserved": false,
            "lastUpdate": "2019-10-29T14:13:54.000-03:00",
            "customerCountryDesc": "Argentina",
            "code": "1-6454656",
            "description": "gran casa en haedo capital de ahora morona",
            "alternativePrices": [],
            "title": "gran casa en haedo capital de ahora morona",
            "customerCountry": 1,
            "countryId": 1,
            "seoUrl": "alquiler-temporario-de-loft-en-caballito-capital-federal-1-147874",
            "rented": false,
            "countyId": 18,
            "propertyType": "Loft",
            "ambiences": 2,
            "hightlight": {},
            "currency": "USD",
            "timestamp": "2019-10-29T00:00:00.000-03:00",
            "sold": false,
            "address": "paysandu 984",
            "stateId": 1,
            "propertyHash": "e86a6a15b7f93ae633b0b009c5c51120",
            "mainImage": "https://s3.amazonaws.com/mapaprop-dev/photos/noimage.gif",
            "location": {
                "lon": "-58.45284939999999",
                "lat": "-34.6125374"
            },
            "operation": 3
        },
        {
            "country": "Argentina",
            "county": "Saavedra",
            "cityId": 1774,
            "type": 17,
            "zone": "Arroyo Corto, Saavedra, Buenos Aires, Argentina",
            "price": 1,
            "state": "Buenos Aires",
            "branchId": 773,
            "images": [
                {
                    "image": "https://s3.amazonaws.com/mapaprop-dev/photos/1/145148/1342116.jpg",
                    "thumbnail": "https://s3.amazonaws.com/mapaprop-dev/photos/1/145148/1342116t.jpg",
                    "orientation": 2,
                    "imageId": 1342116,
                    "main": true,
                    "type": 2,
                    "contentType": "image/jpeg",
                    "order": 0,
                    "timestamp": "2017-12-20T16:27:58Z"
                }
            ],
            "suspended": false,
            "labels": [],
            "propertyOperation": "Alquiler Temporario",
            "reserved": false,
            "lastUpdate": "2018-01-16T15:36:31.000-03:00",
            "paymentPeriod": "Por día",
            "customerCountryDesc": "Argentina",
            "code": "1-ABC635265",
            "city": "Arroyo Corto",
            "description": "una descripcion larga es mucho mejor que nada.",
            "alternativePrices": [],
            "title": "Una gran casa requiere una casita",
            "customerCountry": 1,
            "countryId": 1,
            "seoUrl": "alquiler-temporario-de-complejo-turistico-en-arroyo-corto-saavedra-buenos-aires-1-145148",
            "rented": false,
            "countyId": 300,
            "propertyType": "Complejo Turístico",
            "hightlight": {},
            "currency": "ARS",
            "timestamp": "2018-01-16T00:00:00.000-03:00",
            "sold": false,
            "address": "Maipu 191",
            "stateId": 2,
            "propertyHash": "c6ed3571d0215b75c19de96d40783a1b",
            "mainImage": "https://s3.amazonaws.com/mapaprop-dev/photos/1/145148/1342116t.jpg",
            "location": {
                "lon": "-62.40793050000002",
                "lat": "-37.5996419"
            },
            "operation": 19
        },
        {
            "country": "Argentina",
            "occupancy": 2,
            "county": "Balvanera",
            "type": 1,
            "zone": "Balvanera, Capital Federal, Argentina",
            "price": 90000,
            "state": "Capital Federal",
            "branchId": 773,
            "images": [
                {
                    "image": "https://s3.amazonaws.com/mapaprop-dev/photos/1/139555/1335004.jpg",
                    "thumbnail": "https://s3.amazonaws.com/mapaprop-dev/photos/1/139555/1335004t.jpg",
                    "orientation": 2,
                    "imageId": 1335004,
                    "main": false,
                    "type": 1,
                    "contentType": "image/png",
                    "timestamp": "2017-12-09T16:27:54Z"
                },
            ],
            "suspended": false,
            "labels": [],
            "propertyOperation": "Alquiler Temporario",
            "reserved": false,
            "lastUpdate": "2017-11-28T21:16:48.000-03:00",
            "paymentPeriod": "Por día",
            "customerCountryDesc": "Argentina",
            "code": "1-389398",
            "expensesCurrency": "ARS",
            "description": "Buena prop a estrenar",
            "alternativePrices": [
                {
                    "price": 50000.0,
                    "description": "Casa",
                    "currency": "ARS",
                    "id": "1863"
                },
                {
                    "price": 6500.0,
                    "description": "Por dia",
                    "currency": "ARS",
                    "id": "12216"
                }
            ],
            "title": "Nueva propeidad here",
            "customerCountry": 1,
            "countryId": 1,
            "seoUrl": "alquiler-temporario-de-departamento-en-balvanera-capital-federal-1-139555",
            "rented": false,
            "expensesPrice": 2323,
            "countyId": 91,
            "propertyType": "Departamento",
            "hightlight": {},
            "currency": "ARS",
            "timestamp": "2017-09-29T00:00:00.000-03:00",
            "sold": false,
            "address": "Balvanera 3993",
            "zipCode": "1661",
            "stateId": 1,
            "propertyHash": "74f6dd0e4809f9ba1b044f3704cfef62",
            "mainImage": "https://s3.amazonaws.com/mapaprop-dev/photos/1/139555/1272968t.jpg",
            "taxCurrency": "ARS",
            "taxPrice": 2000,
            "location": {
                "lon": "-58.392606099999966",
                "lat": "-34.6098208"
            },
"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": 19,
"status": "En Construcción"
        },
    ]
}