Skip to main content

SearchParams

Common search parameters for AVM requests. All fields are optional with sensible defaults.

Used by all AVM endpoints (property, rental, multifamily) in both single and batch modes.

radius_miRadius Mi (number)

Search radius in miles

Possible values: >= 0.1 and <= 10

Default value: 5
lookback_monthsLookback Months (integer)nullable

Months to look back

Possible values: >= 1 and <= 36

dateDate (string)nullable

As-of date (YYYY-MM-DD)

num_compsNum Comps (integer)

Number of comparables to return (0 = subject-only, skips DB query)

Possible values: >= 0 and <= 20

Default value: 0
SearchParams
{
"radius_mi": 5,
"lookback_months": 12,
"num_comps": 5
}