Skip to main content

​
Prerequisites

  • Base URL (for example https://api.homelogs.io)
  • API key

​
1. Search for a property

curl -sS --request GET \
  --url 'https://api.homelogs.io/v1/search/property?address=123%20Main%20St&city=Seattle&state=WA&zipcode=98101' \
  --header 'X-API-Key: YOUR_API_KEY'
Example response: 
{
  "property_id": "prop_0123456789abcdef0123456789abcdef",
  "canonical_address": "123 Main St, Seattle, WA 98101",
  "match_confidence": 0.99,
  "match_metadata": {
    "match_type": "exact",
    "input_address": "123 Main St",
    "normalized_input_address": "123 MAIN ST",
    "matched_fields": ["address", "city", "state", "zip"]
  },
  "lat": 47.61,
  "lon": -122.33,
  "state": "WA",
  "city": "Seattle",
  "parcel_id": null
}

​
2. Get permit history

curl -sS --request GET \
  --url 'https://api.homelogs.io/v1/property/prop_0123456789abcdef0123456789abcdef/permits?limit=25' \
  --header 'X-API-Key: YOUR_API_KEY'
Use next_cursor to request additional pages: 
curl -sS --request GET \
  --url 'https://api.homelogs.io/v1/property/prop_0123456789abcdef0123456789abcdef/permits?limit=25&cursor=CURSOR_TOKEN' \
  --header 'X-API-Key: YOUR_API_KEY'

​
3. Get profile summary

curl -sS --request GET \
  --url 'https://api.homelogs.io/v1/property/prop_0123456789abcdef0123456789abcdef/profile' \
  --header 'X-API-Key: YOUR_API_KEY'

​
Error and status semantics

  • Missing/invalid API key: 403 (gateway response)
  • Invalid property_id format: 400
  • Valid but unknown property_id: 404
  • Low-confidence fuzzy search result: 404