Search Listings

get

https://api.getbuildify.com/{apiVersion}/{apiProvince}/search_listings

🔎 Search for the most up-to-date listings information.

Path Params

apiVersion

string

enum

required

Allowed:

apiProvince

string

enum

required

Query Params

string

The given search string is searched from listing's name, summary, amenities, cityOrDistrict, streetName, country, neighbourhood. See more info.

page

string

Fetch the given page of the results, starts from 0. See more info.

perPage

string

Number of results to be fetched per page.

facets

string

Facets to fetch, possible values can be amenities, builders, marketers, etc. It should be comma separated. See more info.

filterQuery

string

Query to filter the listings. This parameter will work if the retrieveAttributes is also filled in. See more info.

retrieveAttributes

string

Attributes to retrieve. For example: name, summary, builders, etc. It should be comma separated. See more info.

highlightResults

boolean

Highlight the strings matching the search.

nearby

string

Fetch listings nearby to the given coordinates. See more info.

radius

int32

Listings under the given radius. See more info.

referrences

string

Fields to attach referrences. For example: builders, marketers, etc. It should be comma separated. See more info.

sortBy

string

Sort by either name, price or sellingStatusUpdateTimestamp

sortOrder

string

asc for ascending, dsc for descending

searchWithin

string

Comma separated list of values to be used for searching, by default all the values are used. Only acceptable values are from name, summary, amenities, cityOrDistrict, streetName, country, neighbourhood, fullAddress, listingId

Responses

Language

Credentials

Header

Response

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

application/json

200200

403403

404404