Skip to main content
GET
/
v1
/
property
/
{property_id}
/
profile
Get derived property permit profile
curl --request GET \
  --url https://api.homelogs.io/v1/property/{property_id}/profile \
  --header 'X-API-Key: <api-key>'
{
  "property_id": "<string>",
  "total_permits": 1,
  "last_permit_date": "2023-12-25",
  "last_major_work_type": "roof",
  "major_work_flags": {
    "roof": true,
    "hvac": true,
    "electrical": true,
    "plumbing": true,
    "addition": true,
    "remodel": true
  },
  "permit_timeline": [
    {
      "year": 123,
      "count": 1
    }
  ],
  "risk_flags": {
    "open_permits": true,
    "stale_history": true
  },
  "confidence_score": 0.5
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
property_id
string
required
Pattern: ^prop_[0-9a-f]{32}$

Response

Property profile

​
property_id
string
required
Pattern: ^prop_[0-9a-f]{32}$
​
total_permits
integer
required
Required range: x >= 0
​
last_permit_date
string<date> | null
required
​
last_major_work_type
enum<string> | null
required
Available options:
roof,
hvac,
addition,
remodel,
electrical,
plumbing,
other,
null
​
major_work_flags
object
required
​
permit_timeline
object[]
required
​
risk_flags
object
required
​
confidence_score
number
required

Confidence in resolved property identity backing this profile.

Required range: 0 <= x <= 1