ComprehensiveRequest

Request model for POST /v1/comprehensive

Allows requesting multiple data types in a single API call. Fields are validated based on which services are requested.

requestsstring[]required

Which services to call (e.g., ['property-avm', 'flood-zone'])

Possible values: [property-avm, rental-avm, multifamily-avm, socioeconomic, natural-hazards, flood-zone, storm-surge, fire-risk, crime-data, census-data], >= 1

addressAddress (string)nullable

Full street address

latitudeLatitude (number)nullable

Latitude

Possible values: >= -90 and <= 90

longitudeLongitude (number)nullable

Longitude

Possible values: >= -180 and <= 180

bedsBeds (integer)nullable

Total bedrooms

Possible values: >= 0 and <= 50

bathsBaths (number)nullable

Total bathrooms

Possible values: >= 0 and <= 50

living_areaLiving Area (integer)nullable

Living area sqft

Possible values: >= 0

lot_sizeLot Size (integer)nullable

Lot size sqft

Possible values: >= 0

year_builtYear Built (integer)nullable

Year built

Possible values: >= 1750 and <= 2026

property_typeProperty Type (string)nullable

Property type

total_unitsTotal Units (integer)nullable

Total units

Possible values: >= 1 and <= 2000

condition objectnullable

Condition (1-5 or C1-C5)

anyOf

• number
• string

number

porchPorch (boolean)nullable

Has patio/porch

deckDeck (boolean)nullable

Has deck/balcony

poolPool (boolean)nullable

Has private pool

basementBasement (boolean)nullable

Has basement

aduAdu (boolean)nullable

Has accessory dwelling unit

patioPatio (boolean)nullable

Has patio

balconyBalcony (boolean)nullable

Has balcony

central_airCentral Air (boolean)nullable

Has central air

in_unit_laundryIn Unit Laundry (boolean)nullable

Has in-unit laundry

fireplace_countFireplace Count (integer)nullable

Number of fireplaces

Possible values: >= 0 and <= 10

garage_spacesGarage Spaces (integer)nullable

Garage spaces

Possible values: >= 0 and <= 10

other_spacesOther Spaces (integer)nullable

Other parking spaces

Possible values: >= 0 and <= 10

num_storiesNum Stories (integer)nullable

Number of stories

Possible values: >= 1

walk_scoreWalk Score (integer)nullable

Walk score

Possible values: >= 0 and <= 100

month_soldMonth Sold (integer)nullable

Month sold

Possible values: >= 1 and <= 12

year_soldYear Sold (integer)nullable

Year sold

Possible values: >= 1900 and <= 2027

units object[]nullable

Rental units array

Array [

bedsBeds (integer)required

Bedrooms in unit

Possible values: >= 0 and <= 10

bathsBaths (number)required

Bathrooms in unit

Possible values: >= 0 and <= 10

living_areaLiving Area (integer)nullable

Unit size sqft

Possible values: >= 0

furnishedFurnished (boolean)

Is fully furnished

Default value: false

]

furnishedFurnished (boolean)nullable

Is furnished

laundryLaundry (boolean)nullable

Has laundry

parkingParking (boolean)nullable

Has parking

mixed_useMixed Use (boolean)nullable

Is mixed use

dateDate (string)nullable

As-of date (YYYY-MM-DD)

lookback_monthsLookback Months (integer)nullable

Months to look back

Possible values: >= 1 and <= 36

radius_miRadius Mi (number)nullable

Search radius in miles

Possible values: >= 0.1 and <= 20

num_comparablesNum Comparables (integer)nullable

Number of comparables

Possible values: >= 0 and <= 50

include_gradesInclude Grades (boolean)nullable

Include letter grades

yearYear (integer)nullable

Data year

Possible values: >= 2019 and <= 2023

geographiesstring[]nullable

Geography levels

census_keysstring[]nullable

Census variables to fetch

yearsinteger[]nullable

Multiple years for census data

start_dateStart Date (string)nullable

Crime data start date

end_dateEnd Date (string)nullable

Crime data end date

include_crime_summaryInclude Crime Summary (boolean)nullable

Include crime summary

include_crime_detailsInclude Crime Details (boolean)nullable

Include crime details

offense_categoriesstring[]nullable

Filter by offense categories

limitLimit (integer)nullable

Limit for crime records

Possible values: >= 1 and <= 500

ComprehensiveRequest

{
  "requests": [
    "property-avm"
  ],
  "address": "string",
  "latitude": 0,
  "longitude": 0,
  "beds": 0,
  "baths": 0,
  "living_area": 0,
  "lot_size": 0,
  "year_built": 0,
  "property_type": "string",
  "total_units": 0,
  "condition": 0,
  "porch": true,
  "deck": true,
  "pool": true,
  "basement": true,
  "adu": true,
  "patio": true,
  "balcony": true,
  "central_air": true,
  "in_unit_laundry": true,
  "fireplace_count": 0,
  "garage_spaces": 0,
  "other_spaces": 0,
  "num_stories": 0,
  "walk_score": 0,
  "month_sold": 0,
  "year_sold": 0,
  "units": [
    {
      "beds": 0,
      "baths": 0,
      "living_area": 0,
      "furnished": false
    }
  ],
  "furnished": true,
  "laundry": true,
  "parking": true,
  "mixed_use": true,
  "date": "string",
  "lookback_months": 0,
  "radius_mi": 0,
  "num_comparables": 0,
  "include_grades": true,
  "year": 0,
  "geographies": [
    "string"
  ],
  "census_keys": [
    "string"
  ],
  "years": [
    0
  ],
  "start_date": "string",
  "end_date": "string",
  "include_crime_summary": true,
  "include_crime_details": true,
  "offense_categories": [
    "string"
  ],
  "limit": 0
}