Many PropertyRadar endpoints accept a "Criteria object" to define the search criteria for an operation. For instance, a Criteria object could specify single-family properties in certain zip codes, with pools, and whose owners have at least $100,000 in equity in the home:
ℹ️ TIP - You can use the Try It console to compose your Criteria object and it will automatically check your syntax.
[
{
"name": "ZipFive",
"value": [97202, 97212]
},
{
"name": "Pool",
"value": [1]
},
{
"name": "AvailableEquity",
"value": [[100000, null]]
},
{
"name": "PropertyType",
"value": [
{
"name": "PType",
"value": ["SFR"]
}
]
}
]Multiple Value criteria accept one or more values, which are OR'd together. For instance, in the ZipFive example above, the criteria object will find properties in either 97202 OR 97212.
Similar to Multiple Value, except an exact match is not required; properties will be found if they merely begin with the given value. For instance, the following criteria will find the property with exactly the APN "910-021-669-000", as well as all properties APN's that start with "123".
{"name":"APN", "value":["123","910-021-669-000"]}Boolean criteria accept either integer 1 or 0. In the Pool example above, [1] means the property must have a pool. [0] would mean the property must not have a pool.
Multiple Range criteria accept a series of arrays with min and max values. For instance, in the AvailableEquity example [[100000, null]] will return properties having Equity from $100,000 to infinity. Other Multiple Range examples:
[[100000, 100000]]Only properties with exactly $100,000 in equity.[[null, 100000]]Only properties with up to $100,000 in equity.[[null, 100000],[200000, 300000]]Properties with less than $100,000 or between $200,000 and $300,000.
Accepts the same syntax as Multiple Range, but when null is used as the left (minimum) end of the range, unknown values are included in the results. For example, the following criteria will include properties with square footage less than 1000, as well as properties for which we don't know the square footage.
{"name":"SqFt", "value":[[null, 1000]]}Relative Date criteria accept over 20 preset date strings, such as "Next Quarter" or "Last 30 Days" as well specific dates and date ranges using a from: to: syntax. For example, the following would find properties sold at foreclosure auction in the last 7 days, as well as throughout first month of 2023 as well ones scheduled to sell on the first day of 2048 and finally any auctioned prior to 1/1/1999.
{"name":"ForeclosureSaleDate", "value":["Last 7 Days", "from: 1/1/2023 to: 1/31/2023", "1/1/2028", "from: to: 1/1/1999"]}ℹ️ TIP - You can view the preset date strings for any criteria by clicking Click for enumerated values in any of the Relative Date fields in the Criteria Reference.
Accepts the same values as Relative Date but when the from: section is left empty, includes properties for which we don't know the value for that field.
Like Multiple Value but accepts only one value.
A special format combining both our list of simple property types known as PType along with our AdvancedPropertyTypes. See PropertyType in the Criteria Reference for more infomation.