Integration

HouseCanary

Use approved HouseCanary property valuations and market analytics in calls.

Description

AIM AI can be configured to retrieve selected HouseCanary property and market data for a defined workflow. Products, locations, returned fields, permitted use, retention, and human review are confirmed before implementation.

Authentication

A HouseCanary API key and API secret are required.
Exact products, fields, and approved actions are confirmed during workflow scoping.

Supported Actions (68)

These are the operations this integration can perform after the required credentials and permissions are approved.

Property valuation and details
Property details (basic and advanced)
Value analysis and estimates
Historical values
Value by condition, adjustments, HPI, FSD threshold
Value by lat/long and within block
Block component batch requests
Block crime information
Block hazard data (earthquake, hail, hurricane, tornado, wind)
Block HCRI (Gross Rental Yield)
Block rental value distribution
Block superfund sites
Block value distribution
Block value time series (forecast and historical)
Block group component batch requests
Block group HCRI
Block group rental value distribution
Block group value distribution
Block group value time series (forecast and historical)
Metro division affordability time series (forecast and historical)
Metro division component batch requests
Metro division HPI time series (forecast and historical)
MSA affordability time series (forecast and historical)
MSA component batch requests
MSA details (returns and risk information)
MSA HCRI
MSA HPI time series (forecast and historical)
MSA RPI time series (forecast and historical)
State affordability time series (forecast and historical)
State component batch requests
State HCRI
State HPI time series (forecast and historical)
State RPI time series (forecast and historical)
Zip affordability time series (forecast and historical)
Zip component batch requests
Zip details (market details)
Zip HCRI
Zip HPI (forecast, historical, and time series)
Zip market grade
Zip RPI (forecast, historical, and time series)
Zip volatility
FEMA disaster area information
Flood risk information
Geo features
Geocoding
Rental value
Rental value forecast
Rental value by lat/long
Rental value within block
Mortgage lien (most recent and all)
LTV details and origination
Notice of Default (NOD)
Owner occupied status
Rental comparables
Sales comparables
Census information
Component batch requests
Land value
Sales history
School information
Tax history
HOA fees estimate
Property Explorer dynamic link
Property Explorer static link
Value by image job status
AEXP download
AEXP list
Test addresses

Examples

Use these representative payloads as a technical starting point, then replace the sample values with the approved workflow data.

HouseCanary - Property Valuation

Representative workflow configuration for HouseCanary - Property Valuation.

JSON

{
  "automationType": "housecanary",
  "nodeParams": {
    "action": "property_valuation",
    "params": {
      "apiKey": "YOUR_HOUSECANARY_API_KEY",
      "apiSecret": "YOUR_HOUSECANARY_API_SECRET",
      "address": "5500 Grand Lake Dr, San Antonio, TX, 78244"
    }
  }
}

HouseCanary - Value within Block

Representative workflow configuration for HouseCanary - Value within Block.

JSON

{
  "automationType": "housecanary",
  "nodeParams": {
    "action": "value_within_block",
    "params": {
      "apiKey": "YOUR_HOUSECANARY_API_KEY",
      "apiSecret": "YOUR_HOUSECANARY_API_SECRET",
      "address": "5500 Grand Lake Dr, San Antonio, TX, 78244",
      "city": "San Antonio",
      "state": "TX",
      "zipcode": "78244",
      "slug": "example_slug",
      "unit": "example_unit",
      "client_value": "example_client_value",
      "client_value_sqft": "example_client_value_sqft"
    }
  }
}

HouseCanary - Block Value Historical

Representative workflow configuration for HouseCanary - Block Value Historical.

JSON

{
  "automationType": "housecanary",
  "nodeParams": {
    "action": "block_value_ts_historical",
    "params": {
      "apiKey": "YOUR_HOUSECANARY_API_KEY",
      "apiSecret": "YOUR_HOUSECANARY_API_SECRET",
      "address": "5500 Grand Lake Dr, San Antonio, TX, 78244",
      "city": "San Antonio",
      "state": "TX",
      "zipcode": "78244",
      "slug": "example_slug",
      "unit": "example_unit",
      "end": "example_end",
      "limit": "example_limit",
      "order": "example_order",
      "property_type": "example_property_type",
      "start": "example_start"
    }
  }
}

HouseCanary - MSA Component Batch

Representative workflow configuration for HouseCanary - MSA Component Batch.

JSON

{
  "automationType": "housecanary",
  "nodeParams": {
    "action": "msa_component_mget",
    "params": {
      "apiKey": "YOUR_HOUSECANARY_API_KEY",
      "apiSecret": "YOUR_HOUSECANARY_API_SECRET",
      "address": "5500 Grand Lake Dr, San Antonio, TX, 78244",
      "city": "San Antonio",
      "state": "TX",
      "zipcode": "78244",
      "slug": "example_slug",
      "unit": "example_unit",
      "components": "example_components"
    }
  }
}

HouseCanary - Zip Affordability Forecast

Representative workflow configuration for HouseCanary - Zip Affordability Forecast.

JSON

{
  "automationType": "housecanary",
  "nodeParams": {
    "action": "zip_affordability_ts_forecast",
    "params": {
      "apiKey": "YOUR_HOUSECANARY_API_KEY",
      "apiSecret": "YOUR_HOUSECANARY_API_SECRET",
      "address": "5500 Grand Lake Dr, San Antonio, TX, 78244",
      "city": "San Antonio",
      "state": "TX",
      "zipcode": "78244",
      "slug": "example_slug",
      "unit": "example_unit",
      "end": "example_end",
      "limit": "example_limit",
      "order": "example_order",
      "start": "example_start"
    }
  }
}

HouseCanary - Zip Volatility

Representative workflow configuration for HouseCanary - Zip Volatility.

JSON

{
  "automationType": "housecanary",
  "nodeParams": {
    "action": "zip_volatility",
    "params": {
      "apiKey": "YOUR_HOUSECANARY_API_KEY",
      "apiSecret": "YOUR_HOUSECANARY_API_SECRET",
      "address": "5500 Grand Lake Dr, San Antonio, TX, 78244",
      "city": "San Antonio",
      "state": "TX",
      "zipcode": "78244",
      "slug": "example_slug",
      "unit": "example_unit"
    }
  }
}

HouseCanary - Owner Occupied

Representative workflow configuration for HouseCanary - Owner Occupied.

JSON

{
  "automationType": "housecanary",
  "nodeParams": {
    "action": "owner_occupied",
    "params": {
      "apiKey": "YOUR_HOUSECANARY_API_KEY",
      "apiSecret": "YOUR_HOUSECANARY_API_SECRET",
      "address": "5500 Grand Lake Dr, San Antonio, TX, 78244",
      "city": "San Antonio",
      "state": "TX",
      "zipcode": "78244",
      "slug": "example_slug",
      "unit": "example_unit"
    }
  }
}

HouseCanary - Test Addresses

Representative workflow configuration for HouseCanary - Test Addresses.

JSON

{
  "automationType": "housecanary",
  "nodeParams": {
    "action": "test_addresses",
    "params": {
      "apiKey": "YOUR_HOUSECANARY_API_KEY",
      "apiSecret": "YOUR_HOUSECANARY_API_SECRET"
    }
  }
}