Question 1

Searching, Filtering, and Pagination Guide

Accepted Answer

Our real estate APIs provide powerful and flexible search capabilities, allowing you to find the perfect listings using a variety of query string parameters. In this article, we'll guide you through the process of searching, filtering, and paginating listings using our API.

Getting Started

To search for real estate listings, you will make a GET request to our listings endpoint. By appending query string parameters to the URL, you can filter the listings to match your specific criteria.

Example Search Request

Let's say you want to find homes in New York that have three bedrooms and are priced under one million dollars. You would make a request like this:

GET https://api.repliers.io/listings?maxPrice=1000000&city=New York&minBeds=3

This request will return an array of listings that match the search criteria you specified.

Supported Filters

Our API supports a wide range of filters to help you narrow down your search. Here are some of the most commonly used filters:

maxPrice: The maximum price of the listings.
minPrice: The minimum price of the listings.
city: The city where the listings are located.
minBeds: The minimum number of bedrooms.
maxBeds: The maximum number of bedrooms.
minBaths: The minimum number of bathrooms.
maxBaths: The maximum number of bathrooms.
propertyType: The type of property (e.g., house, condo, townhouse).
status: The status of the listing (e.g., active, pending, sold).
minSqft: The minimum square footage of th

Question 2

Listing Images Implementation Guide

Accepted Answer

Repliers offers a robust Listing Images Content Delivery Network (CDN) that allows developers to embed and dynamically resize/format property photos seamlessly. This feature brings significant cost and time savings, enhances performance through shared caching, and mitigates the need for manual image monitoring.

CDN URL Structure

For listings with available images, an "images" array will be present. Here's an example listings array:

"images": [
                "area/IMG-N8418368_1.jpg",
                "area/IMG-N8418368_2.jpg",
                "area/IMG-N8418368_3.jpg",
                "area/IMG-N8418368_4.jpg",
                "area/IMG-N8418368_5.jpg",
                "area/IMG-N8418368_6.jpg",
                "area/IMG-N8418368_7.jpg",
                "area/IMG-N8418368_8.jpg",
                "area/IMG-N8418368_9.jpg",
                "area/IMG-N8418368_10.jpg",
                "area/IMG-N8418368_11.jpg",
                "area/IMG-N8418368_12.jpg",
                "area/IMG-N8418368_13.jpg",
                "area/IMG-N8418368_14.jpg",
                "area/IMG-N8418368_15.jpg"
          ],

The image URLs should be prefixed with https://cdn.repliers.io/. For example:

https://cdn.repliers.io/area/IMG-N8418368_15.jpg

Authorization

To embed images at scale, your website's URL must be whitelisted. For app developers, a custom user-agent can be created for authorization purposes.

Default Image Sizes

Mobile Devices: Image width def

Question 3

AI Image Search Implementation Guide

Accepted Answer

Our real estate APIs enable advanced image search capabilities using AI to enhance the search experience. When searching images, the results are not limited by the search criteria but are sorted by relevance, ensuring the most relevant listings appear first. Each listing is assigned a relevance score, indicating how closely it matches the image inputs.

Important Note

When using image search, the results are not restricted by the image search criteria. For instance, if you search through 500 listings, you will still receive all 500 listings in the response. The key benefit is that these listings will be sorted by relevance, with the most relevant listing appearing first. Each listing will have a score indicating its relevance to the image inputs, helping you quickly identify the best matches. By not limiting the results based on image inputs, we ensure that no potential listings are hidden from the buyer, saving them time and providing the most relevant options without excluding any inventory.

Using the API

To perform an image search, you will need to make a POST request to https://api.repliers.io/listings instead of a GET request. This is because the image inputs are provided in the body of the request in JSON format.

Request Structure

Text-based Image Search

{
    "imageSearchItems": [
        {
            "type": "text",
            "value": "wine cellar",
            "boost": 1
        }
    ]
}

_Example: Searching for listings with a wi

Question 4

lastStatus Definitions

Accepted Answer

Bellow is as list of lastStatus abbreviations as well as their full description.

Note, that some real estate boards support more values than others. For example, "Deal Fell Through" is used in the Toronto Real Estate Board but not others.

To get a list of all supported lastStatus values for your real estate board you can use the following requests:

GET /listings?aggregates=lastStatus&status=U&listings=false to get all possible values for Unavailable (U) listings.
GET /listings?aggregates=lastStatus&status=A&listings=false to get all possible values for Active (A) listings.

Sus = Suspended Exp = Expired Sld = Sold Ter = Terminated Dft = Deal Fell Through Lsd = Leased Sc = Sold Conditionally Sce = Sold Conditionally with Escape Clause (rare) Lc = Leased Conditionally Pc = Price Change Ext = Extension New = New Cs = Coming Soon

Question 5

Using Aggregates To Determine Acceptable Values For Filters

Accepted Answer

The Repliers real estate APIs include a powerful feature called "aggregates," which allows users to determine acceptable values for certain parameters and filters. This guide will explain how to use this feature effectively.

Determining Acceptable Values

To find out what values you can use for a specific parameter like propertyType, you can make a request to the Repliers API with the aggregates query parameter. For example:

https://api.repliers.io/listings?aggregates=details.propertyType

In the response, you will receive an aggregates object containing the possible values and their respective counts. Here is an example of what the response might look like:

```json { "aggregates": { "details": { "propertyType": { "Apartment/Condo": 8844, "House/Single Family": 8661, "Townhouse": 3114, "Vacant Land": 1021, "Business": 1001, "House With Acreage": 865, "Industrial": 804, "Office": 738, "Retail": 680, "1/2 Duplex": 594, "Land Commercial": 328, "Multi-Family Commercial": 136, "Manufactured": 134, "Business With Property": 83, "Other": 83, "Agri-Business": 70, "Duplex": 60, "Manufactured With Land": 41, "Row House (Non-Strata)": 38,

Question 6

The Permissions Object

Accepted Answer

Each listing has a permissions object that looks like this:

permissions: { displayAddressOnInternet: 'Y', displayPublic: 'Y', displayInternetEntireListing: 'Y' }

Here's an explanation of what the keys and values mean:

Y = Yes N = No

displayAddressOnInternet

This indicates whether or not the listing's address can be displayed on internet portals.

displayPublic

This indicates whether or not the listing should require sign in. Typically all unavailable listings require sign in, however there are some MLSes that require sign in for some active listings as well.

displayInternetEntireListing

This indicates whether or not the listing can be displayed on customer-facing applications. Even if the customer is signed in they should not be able to view a listing if this value is 'N'. For back-office applications that only agents have access to, this key has no relevance.

Frequently Read Articles

Browse All Categories

No categories configured.