This service will return the list of properties for the customer
| Resource information | |
|---|---|
| Authentication | Required |
| HTTP Method | GET |
| Response | JSON |
| Version | 1 |
<https://mapaprop.app/api/action/express-v1/properties>
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
| Key | Type | Required | Description |
|---|---|---|---|
| term | string | no | A term that will try to match at least 3 characters in the zone, address, code, or title of the property. Full text search capabilities. |
| address | string | no | A term that will try to match at least 3 characters in address field. Full text search capabilities. |
| type | int | no | A type of property. Constants |
| operation | int | no | An operation of the property. Constants |
| from | int | no | The start record number. Default is 0. |
| size | int | no | The amount of records to bring in each query. Default is 10. Maximum is 20 (validation error: "You cannot retrieve more than 20 properties at a time"). |
| branchId | int | no | The ID of the branch where the properties are located. |
| buildingStatus | int | no | The physical condition of the building. Constants |
| bedrooms | int | no | The amount of bedrooms of the property |
| ambiences | int | no | Exact number of rooms |
| ambiencesFrom | int | no | Search from a number upwards |
| ambiencesTo | int | no | Search up to the assigned number |
| bathrooms | int | no | The amount of bathrooms of the property |
| priceFrom | int | no | Minimum price filter |
| priceTo | int | no | Maximum price filter |
| stateId | int | no | The state ID of the property |
| countyId | int | no | The county ID of the property |
| cityId | int | no | The city ID of the property |
| tempOccupancy | int | no | The number of people who can live in a property |
| dateFrom | string | no | The date you want to arrive (format is "dd-MM-yyyy") |
| dateTo | string | no | The date you want to leave (format is "dd-MM-yyyy") |
This endpoint uses offset-based pagination via the from and size query parameters.
| Parameter | Meaning | Default | Maximum |
|---|---|---|---|
from |
Zero-based offset of the first record to return | 0 |
— |
size |
Number of records returned per request | 10 |
20 |
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.
To retrieve page N (1-indexed) with a fixed page size:
from = (N - 1) * size
Keep requesting the next page while from + size < total.
Assume a search returns "total": 45. To get every result you need 3 requests:
Page 1 — records 1 to 20: