BatchData Property Search API is an efficient way to search multiple properties by keywords. Passing a correct search query leads to desired results. Here are some configuration details to help you with search filters.
Setting Up Right Search Criteria
The Property Search API accepts two primary objects as input parameters, the searchCriteria and options.
The searchCriteria is used to narrow down the search and make the API highly performant by filtering un-necessary properties.
searchCriteria has multiple properties to define the filtering criteria, out of which query is the required property. This property expects a partial USPS address. Combined with all other optional properties, you can built a filter criteria which suits your usecase.
To help you understand it better, lets look at some of the examples -
Getting a list of the properties in Tampa Florida, can be done by setting just a query parameter as follows -
{ "searchCriteria": {
"query": "Tampa, FL"
}
}Searching for properties in Tampa Florida, whose last sale price was between the $50,000 and $100,000 range can be done by defining sale property as follows -
{
"searchCriteria": {
"query": "Tampa, FL",
"sale":{
"lastSalePrice":{
"min": 50000,
"max": 100000
}
}
}
}The above search can further be filtered to get a list of properties in Tampa Florida whose last sales prices fall within the $50,000 - $100,000 range and lot size range between 0.1- 0.5 acres as follows -
{
"searchCriteria": {
"query": "Dallas, TX",
"sale":{
"lastSalePrice":{
"min": 50000,
"max": 100000
},
"lot":{
"lotSizeAcres":{
"min": 0.1,
"max": 0.5
}
}
}
}
}
Structuring The Result
The options is a primary object that enables the customization of search results. It is optional and contains various secondary objects with useful customization functions.
Configuring this property correctly will help you get the structured result which is easier to understand and to integrate in your application. Some of the properties can also help improve API performance by retrieving a paginated result
To streamline the data points of each property item to just the desired attributes you can use customProjection property.
The following example will only retrieve the data points for the building attribute for each property in the search result, making a more streamlined dataset.
{
"searchCriteria": {
"query": "Phoenix, AZ",
"general":{
"vacant": true
}
},
"options": {
"projection": "custom",
"customProjection": [
"building"
]
}
}There are various ways to make this API more efficient and effective by using options property such as -
Setting up the webhook URL to save the response or errors occurred. This can be done by using
webhookUrlanderrorWebhookUrlproperty and is only applicable if you are usingProperty Search AsyncAPI.Setting up various flags to structure the response. Some of the examples are -
More information on all the available properties within
searchCriteriaandoptionscan be found here