Search Listings

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

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

Path Params

apiVersion

string

required

apiProvince

string

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

Response body

object

results

array of objects

results

object

estimatedCompletionYear

integer

Defaults to 0

firstOccupancyDateTBD

boolean

Defaults to true

country

string

numberOfUnits

string

constructionStartedTBD

boolean

Defaults to true

state

string

isFeatured

boolean

Defaults to true

logo

object

maxBaths

integer

Defaults to 0

_geoloc

object

minBaths

integer

Defaults to 0

assignmentFee

string

developmentLevies

string

ccOrMaintFeeIncluded

boolean

Defaults to true

brokerages

array

brokerages

endPricePerSqFeet

integer

Defaults to 0

developmentLeviesIncluded

boolean

Defaults to true

long

string

lockerMaintainance

integer

Defaults to 0

sellingStatus

string

floorPlans

array of objects

floorPlans

object

contactForPricing

boolean

Defaults to true

exposure

array

exposure

floorPlanType

array of strings

floorPlanType

image

object

name

string

numberOfBathrooms

integer

Defaults to 0

numberOfBedrooms

integer

Defaults to 0

planCategory

string

squareFeet

string

startPrice

string

status

string

constructionStatus

string

lockerMaintainanceIncluded

boolean

Defaults to true

streetName

string

completionDate

string

virtualShowing

string

builders

array of strings

builders

moveInReady

string

listingId

string

architects

array of strings

architects

parkingCostIncluded

boolean

Defaults to true

meteringIncluded

boolean

Defaults to true

maxSize

integer

Defaults to 0

numberOfFloorPlans

integer

Defaults to 0

salesCompanies

array of strings

salesCompanies

hasParking

boolean

Defaults to true

estimatedCompletionDate

string

photos

array of objects

photos

object

createdAt

string

name

string

tags

type

string

url

string

storageCostIncluded

boolean

Defaults to true

maxBeds

integer

Defaults to 0

estimatedCompletionDateTBD

boolean

Defaults to true

averagePricePerSqFeet

integer

Defaults to 0

startPrice

string

parkingCost

integer

Defaults to 0

minBeds

integer

Defaults to 0

marketingCompanies

array of strings

marketingCompanies

storageCost

integer

Defaults to 0

endPrice

string

contactForPricing

boolean

Defaults to true

region

string

assignmentFeeFree

boolean

Defaults to true

interiorDesigners

array of strings

interiorDesigners

firstOccupancyDate

string

owners

array

owners

hasLocker

boolean

Defaults to true

startPricePerSqFeet

integer

Defaults to 0

numberOfIncentives

integer

Defaults to 0

summary

string

ccOrMaintFee

number

Defaults to 0

geographicAddress

string

fullAddress

string

name

string

streetNumber

integer

Defaults to 0

minSize

integer

Defaults to 0

exposures

array

exposures

coverPhoto

object

salesStarted

string

parkingMaintainance

integer

Defaults to 0

type

array of strings

type

paymentStructures

array of objects

paymentStructures

object

milestones

array of objects

milestones

object

amount

integer

Defaults to 0

prefix

string

suffix

string

text

string

type

string

totalDeposit

integer

Defaults to 0

type

string

neighbourhood

array of strings

neighbourhood

completionDateTBD

boolean

Defaults to true

ceilingHeights

string

postalCode

string

amenities

array of strings

amenities

cityOrDistrict

string

parkingRestriction

string

finishes

string

municipalities

array of strings

municipalities

incentives

array

incentives

metering

string

storageRestriction

string

parkingMaintainanceIncluded

boolean

Defaults to true

lat

string

videos

array

videos

path

string

isPreLaunch

boolean

Defaults to true

objectID

string

total

integer

Defaults to 0

page

integer

Defaults to 0

pages

integer

Defaults to 0

perPage

integer

Defaults to 0

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.getbuildify.com/v1-sandbox/on/search_listings \
3
     --header 'accept: application/json'

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

application/json

200200

403403

404404