Properties
Search properties
Search properties using flat filters or a nested AND/OR criteria tree, with page-based or cursor-based pagination — all selected via the request body.
Authorization
apiKey X-API-KEY<token>
Value for the X-API-KEY header parameter.
In: header
Request Body
application/json
Property search request. The criteria field is a recursive tree — see the examples below, from a flat filter bag to a composed tree.
Response Body
curl -X POST "https://example.com/properties" \ -H "Content-Type: application/json" \ -d '{ "paginationType": "PAGE", "page": 1, "size": 20, "criteria": { "property": { "type": { "in": [ "FLAT", "HOUSE" ] }, "transaction": { "type": "SELL" }, "pricing": { "displayed": { "gte": 350000, "lte": 750000 }, "pricePerArea": { "gte": 8000, "lte": 14000 }, "sale": { "netPrice": { "gte": 300000, "orMissing": true }, "fees": { "agency": { "paidBy": "SELLER", "includedInPrice": true } } } }, "areas": { "displayed": { "gte": 45 } }, "locations": { "countryCode": "FR", "in": { "uniqueCodes": [ "75056" ] }, "nin": { "uniqueCodes": [ "75118" ] }, "accuracy": [ "PRECISE", "STREET" ] }, "unit": { "features": { "in": [ "BALCONY" ], "nin": [ "GROUND_FLOOR" ], "inOrMissing": [ "FURNISHED" ] }, "rooms": { "gte": 2, "lte": 5, "orMissing": false }, "bedrooms": { "gte": 1, "orMissing": true }, "orientation": { "inOrMissing": [ "SOUTH", "SOUTH_WEST" ] }, "condition": { "nin": [ "TO_RENOVATE" ] }, "energy": { "heating": { "energyCarrier": { "nin": [ "OIL" ] }, "collective": false } } }, "building": { "constructionYear": { "gte": 1900, "lte": 2024, "orMissing": true }, "constructionType": { "in": [ "HAUSSMANNIAN", "STONE" ] }, "condition": { "inOrMissing": [ "GOOD", "NEW" ] } }, "body": { "title": { "in": [ "lumineux balcon" ] } } }, "publisher": { "type": { "in": [ "PROFESSIONAL" ] }, "mandate": { "in": [ "EXCLUSIVE", "SEMI_EXCLUSIVE" ] }, "hasEmail": true, "hasPhone": true }, "listings": { "marketing": { "urgent": true } }, "dates": { "updatedAt": { "from": "2026-01-01T00:00:00Z" } } } }'[ { "id": "019dedb1-fdf4-714c-8392-5b9cfd63cde3", "property": { "createdAt": "2025-01-15T10:30:00+00:00", "updatedAt": "2025-06-15T12:00:00+00:00", "expired": false, "propertyType": "FLAT", "constructionStatus": "OLD", "transaction": { "type": "SELL", "status": "AVAILABLE", "saleType": "STANDARD", "availableAt": "2026-06-01" }, "area": { "displayed": 56, "unit": "SQM", "indoor": { "unit": "SQM", "legal": { "value": 35, "law": "CARREZ" }, "living": 56, "total": 72 }, "outdoor": { "unit": "SQM", "terrace": 12, "balcony": 4.5, "garden": 80 }, "annexes": { "unit": "SQM", "basement": 10, "parking": 12 }, "land": { "unit": "HECTARE", "value": 320 } }, "unit": { "rooms": 3, "bedrooms": 2, "bathrooms": 1, "showerRooms": 1, "wc": 1, "livingRooms": 1, "kitchens": 1, "floor": 2, "lastFloor": false, "groundFloor": false, "gardenFloor": false, "orientation": [ "SOUTH" ], "condition": "GOOD", "furnished": false, "disabledAccess": false, "equippedKitchen": true, "fireplace": true, "airConditioning": false, "doubleGlazing": true, "parquet": true, "balcony": true, "terrace": false, "garden": false, "dressing": true, "crossing": true, "quiet": true, "cellar": true, "basement": true, "storage": true, "parking": { "total": 2, "spots": [ { "type": "GARAGE", "box": false } ] }, "diagnostic": { "type": "DPE", "date": "2024-06-15", "standard": "FR_DPE_2021", "methodVersion": "2.4", "reference": "2421E1234567X", "scores": { "ENERGY_CONSUMPTION": { "rating": "D", "value": 245, "unit": "KWH_EP_PER_SQM_YEAR" }, "CARBON_EMISSIONS": { "rating": "D", "value": 35, "unit": "KG_CO2E_PER_SQM_YEAR" } } }, "energy": { "heating": [ { "system": "BOILER", "energyCarrier": "GAS", "collective": true } ] } }, "building": { "constructionYear": 1980, "renovationYear": 2020, "constructionType": "HAUSSMANNIAN", "condition": "GOOD", "floors": 6, "numberOfLots": 45, "legalStatus": { "underLegalProceedings": false }, "energy": { "heating": [ { "system": "BOILER", "energyCarrier": "GAS", "collective": true } ] } }, "amenities": { "parking": { "type": "COVERED", "spaces": 25 }, "elevator": true, "intercom": true, "digicode": true, "caretaker": true, "bikeRoom": true, "disabledAccess": false, "gym": false, "playground": false, "partyHall": false, "sportCourt": false, "adultGameRoom": false, "gatedCommunity": false, "barbecueGrill": false, "swimmingPool": false, "connectivity": [ "FIBER" ] }, "body": { "title": "Beautiful flat in Paris", "description": "Renovated flat on a quiet street, close to transit and shops." }, "pricing": { "displayed": 400000, "currency": "EUR", "sale": { "netPrice": 320000, "fees": { "agency": { "amount": 24000, "percentage": 7.5, "currency": "EUR", "paidBy": "SELLER", "includedInPrice": true }, "legal": { "type": "NOTARY", "currency": "EUR", "amount": 7500, "percentage": 2.5, "paidBy": "BUYER" }, "condominium": { "total": 1020, "currency": "EUR", "frequency": "MONTHLY", "breakdown": [ { "type": "MAINTENANCE", "amount": 85, "currency": "EUR", "frequency": "MONTHLY" } ] }, "taxes": { "propertyTax": { "amount": 1200, "currency": "EUR", "frequency": "YEARLY", "paidBy": "OWNER" } } } }, "rental": { "rent": { "amount": 1450, "currency": "EUR", "frequency": "MONTHLY", "includesCharges": true }, "fees": { "charges": { "amount": 120, "currency": "EUR", "frequency": "MONTHLY", "details": [ { "type": "HEATING", "amount": 35, "currency": "EUR" } ] }, "deposit": { "amount": 1450, "currency": "EUR", "months": 1, "paidBy": "TENANT" }, "taxes": { "housingTax": { "amount": 800, "currency": "EUR", "frequency": "YEARLY", "paidBy": "TENANT", "includedInCharges": false } }, "inventory": { "amount": 150, "percentage": 5, "currency": "EUR", "paidBy": "TENANT" }, "agency": { "amount": 150, "percentage": 5, "currency": "EUR", "paidBy": "TENANT" } } } }, "location": { "geometry": { "type": "Point", "coordinates": [ 2.3522, 48.8566 ] }, "accuracy": "NEIGHBORHOOD", "address": "10 rue Eugène Sue", "countryCode": "FR", "city": { "iri": "/geo/administrative-divisions/019dedb1-fdf4-714c-8392-5b9cfd63cde3", "id": "019dedb1-fdf4-714c-8392-5b9cfd63cde3", "name": "Paris", "type": "MUNICIPALITY", "uniqueCode": "75056", "postalCodes": [ "75018" ] }, "neighborhood": { "iri": "/geo/administrative-divisions/019dedb1-fdf4-714c-8392-5b9cfd63cde3", "id": "019dedb1-fdf4-714c-8392-5b9cfd63cde3", "name": "Paris", "type": "MUNICIPALITY", "uniqueCode": "75056", "postalCodes": [ "75018" ] }, "subNeighborhood": { "iri": "/geo/administrative-divisions/019dedb1-fdf4-714c-8392-5b9cfd63cde3", "id": "019dedb1-fdf4-714c-8392-5b9cfd63cde3", "name": "Paris", "type": "MUNICIPALITY", "uniqueCode": "75056", "postalCodes": [ "75018" ] } }, "pictures": [ { "url": "https://pictures.stream.estate/123.png" } ], "changes": [ { "attribute": "DISPLAYED_PRICE", "occurredAt": "2026-07-20T09:30:00+00:00", "listingId": "019dedb1-fdf4-714c-8392-5b9cfd63cde3", "revisionId": "019dedb1-fe02-72a1-9d70-4a1b2c3d4e5f", "variationPercent": -5.2, "numericOld": 100000, "numericNew": 90000 } ] }, "publishers": [ { "id": "019d0000-0000-7000-8000-000000000001", "publisherType": "REAL_ESTATE_AGENCY", "agencyName": "Foncia Paris 18", "professionalCardNumber": "12345", "website": "https://www.foncia-paris18.example.com", "mandate": "EXCLUSIVE", "reference": "REF-AB42", "contact": { "email": "contact@foncia-paris18.example.com", "phone": "+33123456789", "profileUrl": "https://www.example-realestate.com/agencies/foncia-paris18" } } ], "listings": [ { "id": "019dedb1-ff41-7e5a-bd16-6900cbd8c004", "url": "https://www.example-realestate.com/listings/019dedb1", "source": { "iri": "/sources/019d0000-0000-7000-8000-000000000001", "uuid": "019d0000-0000-7000-8000-000000000001", "slug": "leboncoin" }, "publishedAt": "2026-04-15T09:00:00+00:00", "expiredAt": "2026-07-15T09:00:00+00:00", "lastSeenAt": "2026-05-12T08:30:00+00:00", "title": "Bright 3-room apartment with balcony", "description": "Renovated flat on a quiet street, close to transit and shops.", "createdAt": "2026-04-15T09:05:00+00:00", "updatedAt": "2026-05-12T08:30:00+00:00", "area": 54, "rooms": 3, "bedrooms": 2, "bathrooms": 1, "showerRooms": 1, "wc": 1, "livingRooms": 1, "kitchens": 1, "floor": 2, "lastFloor": false, "groundFloor": false, "gardenFloor": false, "condition": "TO_RENOVATE", "furnished": false, "disabledAccess": false, "equippedKitchen": true, "fireplace": true, "airConditioning": false, "doubleGlazing": true, "parquet": true, "balcony": true, "terrace": false, "garden": false, "dressing": true, "crossing": true, "quiet": true, "cellar": true, "basement": true, "storage": true, "transactionStatus": "SOLD", "displayedPrice": 420000, "propertyType": "FLAT", "transactionType": "SELL", "marketing": { "favorites": 12, "urgent": false, "boosted": true, "highlighted": true } } ] }]Resolve the address of a propertyBeta POST
Finds the exact postal address of a property from the data its listings carry: the energy certificate registry first, then the national address base around a precise location. Beta: the matching is being tuned and the confidence bands may move. A result is returned whatever the outcome; read the confidence before showing the address. EXACT and HIGH can be shown as the address, MEDIUM and LOW as a probable address, NONE means nothing was found. Covers properties located in France; other countries are refused.
Get transaction GET
Retrieve a single transaction by its id.