Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.homelogs.io/llms.txt

Use this file to discover all available pages before exploring further.

HomeLogs authenticates business endpoints with: 
X-API-Key: <your_api_key>

​
Required endpoints

X-API-Key is required for:
  • GET /v1/locations/resolve
  • GET /v1/locations/{geo_id}
  • GET /v1/signals/geo/location/{geo_id}
  • GET /v1/permits/search
  • GET /v1/signals/geo/search
  • GET /v1/signals/catalog
GET /v1/health/live does not require an API key.

​
Production key handling checklist

  • keep keys server-side only
  • use environment variables or a secrets manager
  • do not commit keys to source control
  • rotate keys on schedule and on suspected leakage
  • issue separate keys per environment/service when possible

​
Auth responses

  • 403 missing/invalid key
  • 429 throttled/quota exceeded