Get similar listings

get

https://api.repliers.io/listings/{mlsNumber}/similar

Provide this endpoint with an mls number and it'll retrieve similar properties that are also for sale.

This is really useful if you'd like to show your users other properties they may be interested in.

By default this endpoint will retrieve similar properties in the same neighborhood, however you can override this by using a radius parameter.

Path Params

mlsNumber

string

required

The MLS number of the listing you wish to retrieve similar listings for.

Query Params

boardId

array of int32s

Filter by boardId. This is only required if your account has access to more than one MLS. You may specify one or more board IDs to filter by, if not specified, returns all boards that that account has access to be default.

boardId

fields

string

Use if you want to limit the response to containing certain fields only. For example: fields=listPrice,soldPrice would limit the response to contain listPrice and soldPrice only. You can also specify the amount of images to return, for example if a listing has 40 images total and you specify fields=images[5] it will only return the first 5 images.

listPriceRange

int32

If specified, returns similar listings whose listPrice are +/- the supplied value, for a given listing. For example, if the given listing is 1M and listPriceRange is 250k, similar listings between 750k and 1.25M will be returned.

radius

int32

If specified, will show similar listings within the specified radius (km). If not specified, defaults to showing listings in the same neighborhood.

sortBy

string

Defaults to updatedOnDesc

Allowed values:

updatedOnDesc,updatedOnAsc,createdOnAsc,createdOnDesc

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400Bad Request