Skip to main content

PropertyBatchRequest

Async batch valuation request for residential properties. Used by: POST /v1/avm/batch/property

notify_urlNotify Url (string)nullable

Optional webhook URL. When the job completes the server will POST the full results payload to this URL. Must be publicly reachable. If delivery fails it is retried up to 3 times with exponential backoff.

properties object[]required

List of properties to value (max 500 per job)

Possible values: >= 1, <= 500

  • Array [
  • property_idProperty Id (string)nullable

    Client-provided reference ID — echoed back in results for correlation

    location objectrequired

    Location input for AVM requests. Provide either address OR latitude + longitude.

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

    addressAddress (string)nullable

    Full street address

    latitudeLatitude (number)nullable

    Latitude

    Possible values: >= -90 and <= 90

    longitudeLongitude (number)nullable

    Longitude

    Possible values: >= -180 and <= 180

    maps_api_response objectnullable

    Pre-fetched Maps API response

    property name*anynullable

    Pre-fetched Maps API response

    search_params object

    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
    property_fields objectrequired
    bedroomsBedrooms (integer)required

    Number of bedrooms

    Possible values: >= 0 and <= 50

    bathroomsBathrooms (number)required

    Number of bathrooms

    Possible values: >= 0 and <= 50

    living_areaLiving Area (integer)nullable

    Living area in sqft

    Possible values: >= 0

    lot_sizeLot Size (integer)nullable

    Lot size in sqft

    Possible values: >= 0

    year_builtYear Built (integer)nullable

    Year built

    Possible values: >= 1800 and <= 2030

    property_typeProperty Type (string)nullable

    Property type classification. Valid values: houses, townhomes, condos, small_multifamily (2-4 units), multifamily (5+ units), mobile

    Possible values: [houses, townhomes, condos, small_multifamily, multifamily, mobile]

    total_unitsTotal Units (integer)nullable

    Total units (1–4). Defaults to 2 for small_multifamily, 1 otherwise.

    Possible values: >= 1 and <= 4

    has_poolHas Pool (boolean)nullable

    Has pool. If omitted, estimated from nearby comparables.

    has_basementHas Basement (boolean)nullable

    Has basement. If omitted, estimated from nearby comparables.

    has_central_airHas Central Air (boolean)nullable

    Has central air. If omitted, estimated from nearby comparables.

    has_porchHas Porch (boolean)nullable

    Has patio/porch. If omitted, estimated from nearby comparables.

    has_deckHas Deck (boolean)nullable

    Has deck/balcony. If omitted, estimated from nearby comparables.

    has_laundryHas Laundry (boolean)nullable

    Has in-unit laundry. If omitted, estimated from nearby comparables.

    has_aduHas ADU (boolean)nullable

    Has accessory dwelling unit. Defaults to false if omitted.

    fireplace_countFireplace Count (integer)nullable

    Number of fireplaces. Defaults to 0 if omitted.

    Possible values: >= 0 and <= 10

    garage_spacesGarage Spaces (integer)nullable

    Number of garage spaces. If omitted, estimated from nearby comparables.

    Possible values: >= 0

    other_spacesOther Spaces (integer)nullable

    Other parking spaces. If omitted, estimated from nearby comparables.

    Possible values: >= 0

    num_storiesNum Stories (integer)nullable

    Number of stories (1–5; cap at 5 for high-rise). If omitted, estimated from nearby comparables.

    Possible values: >= 1 and <= 5

    conditionCondition (number)nullable

    Property condition (0-5). 1=poor, 2=fair, 3=average, 4=good, 5=excellent. If omitted, estimated from nearby comparables.

    Possible values: >= 0 and <= 5

  • ]
  • PropertyBatchRequest
    {
    "notify_url": "string",
    "properties": [
    {
    "property_id": "string",
    "location": {
    "address": "123 Main St, Austin, TX 78701"
    },
    "search_params": {
    "radius_mi": 5,
    "lookback_months": 12,
    "num_comps": 5
    },
    "property_fields": {
    "bedrooms": 3,
    "bathrooms": 2,
    "living_area": 1800,
    "lot_size": 7500,
    "year_built": 1998,
    "property_type": "houses",
    "condition": 3.5
    }
    }
    ]
    }