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&minBedrooms=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.
minBedrooms: The minimum number of bedrooms.
maxBedrooms: 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 f

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 defau

Question 3

Using Aggregates To Determine Distinct Values For Filters

Accepted Answer

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

Determining Distinct 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 4

Filtering Listings Geo-Spatially Using the "map" Parameter

Accepted Answer

Our real estate API allows users to filter listings geo-spatially by using the "map" parameter. Users can pass in single polygon or multipolygon shapes to isolate listings within specified map boundaries. This feature is commonly used to display listings within a map's boundaries or to allow users to draw shapes on a map to filter listings.

Single Polygon Request

To filter listings within a single polygon, use the following request format:

Request:

POST https://api.repliers.io/listings
{
  "map": [    [      [        -79.3928178512883,        43.65790500294517      ],
      [        -79.40145579410431,        43.651653527879944      ],
      [        -79.38874165704074,        43.64991005052994      ],
      [        -79.3928178512883,        43.65790500294517      ]
    ]
  ]
}

Multipolygon Request

To filter listings within multiple polygons, use the following request format:

Request:

```json POST https://api.repliers.io/listings { "map": [ [ [ -79.3928178512883, 43.65790500294517 ], [ -79.40145579410431, 43.651653527879944 ], [ -79.38874165704074, 43.64991005052994 ], [ -79.3928178512883, 43.65790500294517 ] ], [ [ -79.38538193864319, 43.65790207978401 ], [ -79.37818295748833, 43.656856957533705 ], [ -79.37794674628078, 43.663805792537715 ], [

Question 5

Real-Time Market Statistics Implementation Guide

Accepted Answer

Our Real Estate API offers a powerful feature that allows you to request real-time market statistics. This capability is invaluable for creating data visualizations, providing users with deep market insights to make more informed decisions. The feature offers a high level of granularity, enabling you to request specific scopes of market data just as you would when filtering listings.

How to Request Statistics

Step 1: Provide the Scope of Data

Begin by defining the scope of the data you wish to analyze using the GET /listings endpoint. This scope is defined in the same way you would filter for listings. For example, if you want statistics for 4-bedroom homes in New York City that have sold in the past 2 years, your request URL will look like this:

https://api.repliers.io/listings?city=New York&minBeds=4&maxBeds=4&status=U&lastStatus=Sld&minSoldDate=2022-07-01

Step 2: Specify the Statistics

To retrieve specific statistics, use the statistics parameter. For example, if you're interested in the average sold price, add &statistics=avg-soldPrice to your request. The full request URL would be:

https://api.repliers.io/listings?city=New York&minBeds=4&maxBeds=4&status=U&lastStatus=Sld&minSoldDate=2022-07-01&statistics=avg-soldPrice

This request will return all relevant listings along with a statistics object containing the average sold price:

{
  "statistics": {
    "soldPrice": {
      "avg": 823702
    }
  }
}

Requesting Only Statistics

If

Question 6

Map Clustering Implementation Guide

Accepted Answer

Our real estate APIs feature a map clustering capability that optimizes the display of listings on a map. This feature significantly improves performance by clustering listings server-side, thereby reducing the need to handle large datasets on the front-end.

Requesting Clusters

To request clusters of listings, set the cluster parameter to true in your API request:

GET https://api.repliers.io/listings?cluster=true

Example Response Containing Clusters

```json { "aggregates": { "map": { "clusters": [ { "count": 19585, "location": { "latitude": 43.70534443195513, "longitude": -79.36733720479269 }, "bounds": { "bottomright": { "latitude": 43.633363377302885, "longitude": -79.10189635120332 }, "topleft": { "latitude": 43.83431699126959, "longitude": -79.45311376824975 } }, "map": [ [ [ -79.45311376824975, 43.83431699126959 ], [ -79.45311376824975,

Frequently Read Articles

Browse All Categories