v1

latestOpenAPI 3.1.02026-07-265018.6 KB
Premium

Premium Comparables Search

Search for comparable properties based on location and optional property characteristics.

get/public/premium/comparables/

Query parameters

{"stackTrail":"paths:/public/premium/comparables/:get:parameters:0:schema","oasType":"schema","type":"unknown"}

The latitude coordinate of the target property.

{"stackTrail":"paths:/public/premium/comparables/:get:parameters:1:schema","oasType":"schema","type":"unknown"}

The longitude coordinate of the target property.

{"stackTrail":"paths:/public/premium/comparables/:get:parameters:2:schema","oasType":"schema","type":"unknown"}

Search radius in miles. Defaults to 1 mile.

timeFrameinteger

Number of months to look back for comparable sales. Defaults to 18 months.

maxResultsinteger

Maximum number of results to return. Defaults to 25, maximum is 50.

sqftMininteger

Minimum square footage.

sqftMaxinteger

Maximum square footage.

bedsMininteger

Minimum number of bedrooms.

bedsMaxinteger

Maximum number of bedrooms.

{"stackTrail":"paths:/public/premium/comparables/:get:parameters:9:schema","oasType":"schema","type":"unknown"}

Minimum number of bathrooms.

{"stackTrail":"paths:/public/premium/comparables/:get:parameters:10:schema","oasType":"schema","type":"unknown"}

Maximum number of bathrooms.

propertyType'any' | 'condo' | 'house'

Type of property to search for.

priceMininteger

Minimum price.

priceMaxinteger

Maximum price.

Response

Comparable properties found successfully

comparablesobject[]

Array of comparable properties found.

All 5 operations