RentalAVMRequest

Rental AVM request model.

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

Rental-specific AVM fields.

units object[]required

List of rental units

Possible values: >= 1

Array [

bedroomsBedrooms (integer)required

Bedrooms in unit

Possible values: >= 0 and <= 10

bathroomsBathrooms (number)required

Bathrooms in unit

Possible values: >= 0 and <= 10

sizeSize (integer)nullable

Unit size in sqft

Possible values: >= 0

fully_furnishedFully Furnished (boolean)

Is fully furnished

Default value: false

]

property_typeProperty Type (string)nullable

Property type (houses, townhomes, condos, small_multifamily, multifamily)

total_unitsTotal Units (integer)nullable

Total units in the building (not units being valued). Defaults to 2 for small_multifamily, 1 for houses/condos/townhomes.

Possible values: >= 1

walk_scoreWalk Score (integer)nullable

Walk score

Possible values: >= 0 and <= 100

condition_scoreCondition Score (number)nullable

Condition score (1-5)

Possible values: >= 0 and <= 5

central_airCentral Air (boolean)nullable

Has central air

in_unit_laundryIn Unit Laundry (boolean)nullable

Has in-unit laundry

off_street_parkingOff Street Parking (boolean)nullable

Has off-street parking

RentalAVMRequest

{
  "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": {
    "units": [
      {
        "bedrooms": 0,
        "bathrooms": 0,
        "size": 0,
        "fully_furnished": false
      }
    ],
    "property_type": "string",
    "total_units": 0,
    "walk_score": 0,
    "condition_score": 0,
    "central_air": true,
    "in_unit_laundry": true,
    "off_street_parking": true
  }
}