filterQuery
String, Optional To do filtering, you must have the following parameters in the query:filterQuery
filterQuery
is used to apply filters or conditions to a dataset or query results, allowing users to retrieve specific information based on their desired criteria.
This parameter accepts a query syntax, which works as shown below.
Syntax
retrieveAttributes
retrieveAttributes
enables users to retrieve specific property attributes or details, such as selling status, type, and owners, for a particular listing or set of listings.
You must input the attribute that you input in the filterQuery
, for example:
Syntax
Info See this page for more info about Retrievable Attributes.
Usage Examples
Please refer to the usage examples of thefilterQuery
below to gain a deeper understanding:
Filter By String
Filter by numeric value
Filter by boolean
Filter an array
An array filter returns true if any array elements match the given filtered value.Using Boolean Operators
Buildify supports the following boolean operations on filters.- OR: must match any combined conditions (disjunction).
- AND: must match all combined conditions (conjunction).
- NOT: negates a filter
Filterable attributes
Filterable attributes refer to the characteristics or properties of a dataset that can be used as criteria to filter or narrow down the results of a search or query. Take a look at the attributes offered by Buildify in the following list:For Listings
agents | architects | amenities |
---|---|---|
brokerages | builders | cityOrDistrict |
communities | completionDateTBD | constructionStartedTBD |
constructionStatus | country | estimatedCompletionDateTBD |
firstOccupancyDateTBD | floorPlans.exposure | floorPlans.floorPlanType |
floorPlans.numberOfBathrooms | floorPlans.numberOfBedrooms | floorPlans.squareFeet |
floorPlans.startPrice | interiorDesigners | marketingCompanies |
municipalities | name | neighbourhood |
numberOfFloorPlans | numberOfFloors | numberOfIncentives |
numberOfPayments | numberOfRealtorPayouts | numberOfUnits |
owners | realtorCommission | realtorCommissionByContact |
salesCentres | salesCompanies | salesStartedTBD |
sellingStatus | state | streetName |
type | startPrice | endPrice |
contactForPricing |
For profiles
name | contact | |
---|---|---|
website | address | listings |