GET
/
{apiVersion}
/
{apiProvince}
/
featured_listings
curl --request GET \
  --url https://api.getbuildify.com/{apiVersion}/{apiProvince}/featured_listings \
  --header 'x-api-key: <api-key>'
"{}"

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
apiVersion
enum<string>
required
Available options:
v1-sandbox,
v1-lite,
v1
​
apiProvince
enum<string>
default:
on
required
Available options:
on,
bc,
ab,
mb,
nb,
nl,
ns,
pe,
qc,
sk

Query Parameters

​
search
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. 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
integer

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

Response

200
application/json
200

The response is of type object.

Move In Ready ListingsList subscriptions