Skip to main content

RentalAVMRequest

Rental AVM request model. Used by: POST /v1/avm/rental

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
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

    is_furnishedIs Furnished (boolean)nullable

    Is furnished. Defaults to false if omitted.

  • ]
    • 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

    conditionCondition (number)nullable

    Condition (0-5). 1=poor, 2=fair, 3=average, 4=good, 5=excellent.

    Possible values: >= 0 and <= 5

    has_central_airHas Central Air (boolean)nullable

    Has central air

    has_laundryHas Laundry (boolean)nullable

    Has in-unit laundry

    has_parkingHas Parking (boolean)nullable

    Has off-street parking

    RentalAVMRequest
    {
      "location": {
        "address": "456 Oak Ave, Tampa, FL 33602"
      },
      "property_fields": {
        "units": [
          {
            "bedrooms": 2,
            "bathrooms": 1
          }
        ],
        "property_type": "houses"
      },
      "search_params": {
        "radius_mi": 5,
        "num_comps": 5
      }
    }