API Reference

Create a saved search

post
https://api.repliers.io/searches

Use this endpoint to create a saved search for a client.Important - When a saved search is updated the filters must be specific enough so that the initial matches do not exceed 100 listings otherwise a 406 (not accepted) response will be received.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32
required

The clientId of the client that the search is for. This client will receive notifications from the agent that's assigned to them when listings that match the saved search criteria are listed.

string

You can specify a name for the saved search. This is useful in cases where users have multiple saved searches, to help them distinguish between saved searches.

amenities
array of strings
amenities
areas
array of strings

An array of areas to be used as a filter for this search. Required if a value for map is not provided.

areas
basement
array of strings

If specified, matches only listings whose basement description match all of the supplied values. For a list of supported values, make a GET /listings?listings=false&aggregates=details.basement1,details.basement2 request.

basement
cities
array of strings

An array of cities to be used as a filter for this search. Required if a value for map is not provided.

cities
class
array of strings
required

Indicates what class of property to search for.

Allowed values:

residential,condo,commercial

class*
heating
array of strings

An array of heating values to be used as a filter for this search.

heating
keywords
array of strings
keywords
neighborhoods
array of strings

An array of neighborhoods to be used as a filter for this search. Required if a value for map is not provided.

neighborhoods
string
Defaults to instant

Sets the frequency that clients will be notified of listings that match their search criteria.

Allowed values:

instant, daily, weekly, monthly

json

An array of polygons arrays with arrays of longitude/latitude shapes to be used as a filter for this search. If used, only listings that area geographically located within these shapes will be matched. Required if values for areas, cities and neighborhoods are not provided.

int32

The maximum amount of bathrooms to be used as a filter for this search.

int32

The maximum amount of half bathrooms to be used as a filter for this search.

int32

The maximum amount of bedrooms to be used as a filter for this search.

int32

The maximum amount of covered spaces to be used as a filter for this search.

int32

If specified, matches only listings whose parking space count is >= the supplied value.

int32
required

The maximum list price to be used as a filter for this search.

int32
int32
int32
int32

The minimum amount of bathrooms to be used as a filter for this search.

int32

The minimum amount of half bathrooms to be used as a filter for this search.

int32

The minimum amount of bedrooms to be used as a filter for this search.

int32

The minimum amount of covered spaces to be used as a filter for this search.

int32

If specified, matches only listings whose garage space count is >= the supplied value.

int32

If specified, matches only listings whose kitchen count is >= the supplied value.

int32

If supplied limits matches to listings where the maintenance fee is <= the supplied value.

int32
required

The minimum list price to be used as a filter for this search.

int32
int32
int32
string
boolean
Defaults to false

If set to true, clients will receive price change notifications for listings that have been matched for them.

propertyTypes
array of strings

An array of property types to be used as a filter for this search.

propertyTypes
sewer
array of strings

An array of sewer values to be used as a filter for this search.

sewer
boolean
Defaults to true

If set to false, disables this search.

boolean
Defaults to false

If set to true, clients will receive sold notifications for listings that have been matched for them.

streetNames
array of strings

An array of street names to be used as a filter for this search.

streetNames
streetNumbers
array of strings

An array of street numbers to be used as a filter for this search.

streetNumbers
styles
array of strings

An array of property styles to be used as a filter for this search.

styles
swimmingPool
array of strings

An array of swimming pool values to be used as a filter for this search.

swimmingPool
string
required

Indicates whether the search is for a property that's for sale or for lease.

Allowed values:

sale,lease

waterSource
array of strings

An array of water source values to be used as a filter for this search.

waterSource
int32

The minimum lot size in square feet to be used as a filter for this search.

int32

The maximum lot size in square feet to be used as a filter for this search.

date

Indicates whether the search is for properties that have an Open House on or after the supplied date. Date format: YYYY-MM-DD

date

Indicates whether the search is for properties that have an Open House on or before the supplied date. Date format: YYYY-MM-DD. It's not recommended to use it unless you have a very good reason to set it.

standardStatus
array of strings
enum

Indicates what Standard Status of property to search for.

Allowed values:

Active, Active Under Contract, Closed, Expired, Pending, Canceled, Incomplete

standardStatus
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 10 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated 10 months ago