Documentation

Build with HomeAnalytics.

Guides, references, and copy-paste snippets for everything from your first API call to high-volume production deployments.

Quickstart

From signup to first /v1/property response in under five minutes.

  • Create an account
  • Generate an API key
  • Make your first call

SDKs

Typed clients for TypeScript, Python and Go — generated from our OpenAPI spec.

  • @homeanalytics/node
  • homeanalytics (PyPI)
  • github.com/ha/go

Widgets

Drop-in HTML components for property summary, valuation, comps map and trends.

  • Valuation card
  • Comparable sales map
  • Market trends panel

Webhooks

Async bulk jobs and CDC streams notify your endpoint when records change.

  • Job completion
  • Property updated
  • Signature verification

Quickstart

Three steps to your first reconciled property record.

1

Install the SDK

npm i @homeanalytics/node
2

Authenticate

import { HomeAnalytics } from "@homeanalytics/node";

const ha = new HomeAnalytics({
  apiKey: process.env.HA_KEY!,
});
3

Fetch a property

const p = await ha.property.get({
  address: "350 5th Ave, NY",
});

console.log(p.avm.value, p._meta.score);