MultifamilyBatchRequest

Async batch valuation request for multifamily properties.

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.

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.

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_comparablesNum Comparables (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.

total_bedroomsTotal Bedrooms (integer)required

Total bedrooms

Possible values: >= 0 and <= 50

total_bathroomsTotal Bathrooms (number)required

Total 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

total_unitsTotal Units (integer)required

Total units (must be 5+)

Possible values: >= 5

walk_scoreWalk Score (integer)nullable

Walk score

Possible values: >= 0 and <= 100

has_private_poolHas Private Pool (boolean)

Has private pool

Default value: false

has_basementHas Basement (boolean)

Has basement

Default value: false

central_airCentral Air (boolean)

Has central air

Default value: false

mixed_useMixed Use (boolean)

Is mixed use

Default value: false

garage_spacesGarage Spaces (integer)

Number of garage spaces

Possible values: >= 0

Default value: 0

other_spacesOther Spaces (integer)

Other parking spaces

Possible values: >= 0

Default value: 0

num_storiesNum Stories (integer)nullable

Number of stories

Possible values: >= 1

condition_scoreCondition Score (number)nullable

Condition score

Possible values: >= 0 and <= 5

]

MultifamilyBatchRequest

{
  "notify_url": "string",
  "properties": [
    {
      "property_id": "string",
      "location": {
        "address": "string",
        "latitude": 0,
        "longitude": 0,
        "maps_api_response": {}
      },
      "search_params": {
        "radius_mi": 5,
        "lookback_months": 0,
        "date": "string",
        "num_comparables": 0
      },
      "property_fields": {
        "total_bedrooms": 0,
        "total_bathrooms": 0,
        "living_area": 0,
        "lot_size": 0,
        "year_built": 0,
        "property_type": "string",
        "total_units": 0,
        "walk_score": 0,
        "has_private_pool": false,
        "has_basement": false,
        "central_air": false,
        "mixed_use": false,
        "garage_spaces": 0,
        "other_spaces": 0,
        "num_stories": 0,
        "condition_score": 0
      }
    }
  ]
}