Score Export API

Authentication

Pass your key in the x-api-key header (or as a Bearer token). Keys look like hl_live_…. Keep them secret — they identify your account.

curl https://haushld.com/api/v1/properties/US27053XXXXXXXXXXXX \
  -H "x-api-key: hl_live_xxxxxxxxxxxxxxxxxxxx"

Get a property score

GET /api/v1/properties/{hlid} — returns the latest computed Structr Score™. Read-only; never consumes report credits.

{
  "hlid": "US27053XXXXXXXXXXXX",
  "address": { "line1": "…", "city": "Minneapolis", "state": "MN", "zip": "55401" },
  "structrScore": {
    "score": 82,
    "grade": "B",
    "modelVersion": "1.1",
    "subScores": { "flood": 95, "storm": 71, "permits": 88, "disputes": 100 },
    "summary": "Structr Score™ 82/100 (B) — …"
  },
  "computedAt": "2026-05-31T12:00:00.000Z",
  "badgeUrl": "/api/badge/US27053XXXXXXXXXXXX"
}

Returns 404 if no score has been generated for the property yet — run a report first. Returns 401 for a missing or revoked key.

Embed a verified badge

The badge endpoint is public (no key) and returns an SVG. Drop it into any listing page:

<a href="https://haushld.com/report/US27053XXXXXXXXXXXX">
  <img src="https://haushld.com/api/badge/US27053XXXXXXXXXXXX"
       alt="Haushld Structr Score" height="28" />
</a>

The badge color reflects the grade (A green → F red) and is cached for one hour.