Search buildings

post

https://api.repliers.io/buildings

Search buildings based on the provided filter criteria.

Query Params

area

array of strings

Filter buildings by the geographical area (also referred to as region or county).

area

buildingName

array of strings

Filter buildings by their name. Availability of building names may vary by MLS and is not guaranteed for all buildings.

buildingName

city

array of strings

Filters buildings by city names. Returns buildings within the specified city.

city

class

array of strings

Filter by property class.

class

displayPublic

string

enum

Filter by display public status

Allowed:

lat

float

-90 to 90

Accepts a value for latitude. Must be used with radius parameter to return buildings within a certain radius of a given latitude and longitude.

long

float

-180 to 180

Accepts a value for longitude. Must be used with radius parameter to return buildings within a certain radius of a given latitude and longitude.

map

json

GeoJSON polygon or multi-polygon boundary for geographical filtering. Limits results to buildings within the specified boundaries. For complex polygons or multipolygons that exceed query parameter size limits, use the POST method and include the map data in the request body.

Format: Array of coordinate arrays, where each coordinate is [longitude, latitude] in WGS 84 format. The polygon must be closed (first and last points must be identical).

For more information refer to the implementation guide Filtering Listings Geo-Spatially Using the "map" Parameter

maxPrice

integer

≥ 0

Maximum price filter

maxStories

integer

≥ 1

Maximum number of stories/floors in the building

minBathrooms

integer

≥ 0

Minimum number of bathrooms

minBedrooms

integer

≥ 0

Minimum number of bedrooms

minPrice

integer

≥ 0

Minimum price filter

minStories

integer

≥ 1

Minimum number of stories/floors in the building

neighborhood

array of strings

Filter results by neighborhood names. Returns specified neighborhoods. Neighborhoods represent the smallest geographical division in the hierarchy.

neighborhood

pageNum

integer

≥ 1

Defaults to 1

If specified indexes a specific page in the results set. For example, if there are 1000 buildings and 100 buildings per page, if you'd like to view buildings 101-200 you'd specify pageNum=2

propertyType

array of strings

Filter by property type(s). Returns buildings matching the specified property types.

propertyType

radius

float

≥ 1

Accepts a value for radius in KM. Must be used with lat and long parameters to return buildings within the specified radius of a given latitude and longitude.

resultsPerPage

integer

1 to 300

Defaults to 100

The amount of buildings to return in each page of the results set.

sortBy

string

enum

Sort results by specified field

Allowed:

streetName

array of strings

Filter by street name(s). Returns buildings located on the specified streets.

streetName

streetNumber

array of strings

Filter by street number(s). Returns buildings with the specified street numbers.

streetNumber

type

string

enum

Used to filter properties that are for sale or for lease.

Allowed:

Body Params

Optional request body for complex geographical filtering using GeoJSON polygons. Use this for large polygon data that exceeds query parameter size limits.

map

object

GeoJSON polygon for geographical filtering. Limits results to buildings within the specified boundaries. Format: Array of coordinate arrays, where each coordinate is [longitude, latitude] in WGS 84 format. The polygon must be closed (first and last points must be identical).

Responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

200Successful response containing list of buildings

400Bad Request