MultifamilyBatchRequest

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

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

Multifamily-specific AVM fields.

Multifamily-specific fields. Accepts properties with 2+ units. Used by: POST /v1/avm/multifamily, GET /v1/avm/multifamily, POST /v1/avm/batch/multifamily

bedroomsBedrooms (integer)required

Total bedrooms across all units

Possible values: >= 0 and <= 5000

bathroomsBathrooms (number)required

Total bathrooms across all units

Possible values: >= 0 and <= 5000

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

total_unitsTotal Units (integer)required

Total units (must be 2-1000)

Possible values: >= 2 and <= 1000

num_storiesNum Stories (number)nullable

Number of stories

Possible values: >= 1

condition_ratingCondition Rating (number)nullable

Property condition rating (also accepts condition or condition_score as aliases)

Possible values: >= 0 and <= 5

]

MultifamilyBatchRequest

{
  "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": 0,
        "bathrooms": 0,
        "living_area": 0,
        "lot_size": 0,
        "year_built": 0,
        "property_type": "string",
        "total_units": 0,
        "num_stories": 0,
        "condition_rating": 0
      }
    }
  ]
}