Search listings
search_listingsUse this when the user is looking for a property to buy or rent — a home, apartment, plot or commercial space — or asks what is on offer in a place, in a price range or of a given size. Searches real-estate listings published on new.estate in many countries and returns matching listings with price, area, location and the URL of each listing page. The accepted property type and country values are listed by get_catalog. The listing URL is the page to cite for each result. Do not use for publishing a listing; get_publishing_info covers that.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Result order; default is the portal's own order. Sorting by price puts listings that do not disclose a price last. | default |
| limit | No | ||
| rooms | No | Room counts to include; 6 means six or more. | |
| shelf | No | Limit to standard or to premium (prestige) listings. | |
| cursor | No | nextCursor of the previous page. | |
| locale | No | Language of names, titles, descriptions and listing URLs, e.g. en-US, pl-PL, de-DE. | en-US |
| country | No | ISO 3166-1 alpha-2 country code, upper case, e.g. PL, ES. | |
| maxArea | No | ||
| minArea | No | ||
| areaUnit | No | Unit of minArea/maxArea: square metres (m) or square feet (ft). | m |
| currency | No | ISO 4217 code of minPrice/maxPrice. Required with a price bound; listings in other currencies are compared after conversion. Listings that do not disclose a price (auction or tender) are left out of any search with a price bound. | |
| features | No | Only listings that have every feature given. | |
| latitude | No | ||
| location | No | Free-text place: city, district or street. Matched against the listing address, ignoring case and diacritics. | |
| maxPrice | No | ||
| minPrice | No | ||
| radiusKm | No | Search radius in kilometres around latitude/longitude. All three must be given together. | |
| longitude | No | ||
| propertyTypes | No | Property type values from the catalog (e.g. APARTMENT, HOUSE, PLOT). A base type also matches its variants. | |
| transactionType | No | Sale or rent. | |
| publishedWithinDays | No | Only listings first published in the last 7 or 30 days. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| source | Yes | ||
| listings | Yes | ||
| nextCursor | Yes | ||
| totalCount | Yes | Number of matching listings; given on the first page only. |