Property search
Combine location, price, rooms and energy rating in one AND/OR criteria tree.
- Nested AND and OR groups, with no depth limit.
- Page-based or cursor-based pagination.
- Count the results without reading them, with size set to 0.
- The same criteria create an alert.
POST /properties
{ "criteria": { "and": [
{ "property": {
"type": { "in": ["FLAT"] },
"areas": { "displayed": { "gte": 25 } },
"pricing": { "displayed": { "gte": 300000, "lte": 350000 } },
"locations": { "countryCode": "FR",
"in": { "postalCodes": ["75018"] } } } },
{ "or": [
{ "property": { "unit": { "floor": { "gte": 1, "lte": 2 } } } },
{ "property": {
"unit": { "floor": { "gte": 3 } },
"amenities": { "features": { "in": ["ELEVATOR"] } } } }
] }
] } }Response
{
"data": [ /* properties: type, id, attributes, relationships */ ],
"meta": { "totalItems": 41, "hasNextPage": true },
"included": [ /* their listings and publishers */ ]
}