> ## 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.

# Overview

> Detect property events from permit data with geo-first permits and signal APIs

HomeLogs provides geo-first APIs for permit retrieval, geo-scoped signal discovery, and permit-scoped lead analytics.
For a plain-language catalog of the current signal set, see [Signals Catalog](/signals).

## Time to first value

Most teams can get a first successful response in about 3 minutes:

1. Resolve input text into a stable `geo_id`
2. Pull permits for that `geo_id`
3. Pull geo-scoped or permit-scoped signals for that same `geo_id`

<CardGroup cols={3}>
  <Card title="Start Quickstart" icon="rocket" href="/quickstart">
    Fast copy/paste path to first 200 response.
  </Card>

  <Card title="API Reference" icon="book" href="/api-reference/introduction">
    Full endpoint contract and schemas.
  </Card>

  <Card title="Troubleshooting" icon="circle-alert" href="/troubleshooting">
    Fix 403/422/429 and empty-result scenarios quickly.
  </Card>
</CardGroup>

## Choose your integration path

| If you want to...                                            | Start with                   | Then call                                        |
| ------------------------------------------------------------ | ---------------------------- | ------------------------------------------------ |
| Search by place text (city/zip/jurisdiction)                 | `GET /v1/locations/resolve`  | `GET /v1/permits/search`                         |
| Display one location overview                                | `GET /v1/locations/{geo_id}` | optional `GET /v1/signals/geo/location/{geo_id}` |
| Build a geo-scoped hotspot feed across WA                    | `GET /v1/signals/geo/search` | optional `GET /v1/signals/catalog`               |
| Discover active signal keys and timing families              | `GET /v1/signals/catalog`    | `GET /v1/signals/geo/location/{geo_id}`          |
| Build permit-scoped leads for a non-property `geo_id`        | `GET /v1/locations/{geo_id}` | `GET /v1/signals/permit/leads`                   |
| Summarize permit-scoped activity for a non-property `geo_id` | `GET /v1/locations/{geo_id}` | `GET /v1/signals/permit/stats`                   |

## Base URL and auth

Base URL: `https://api.homelogs.io`

```http theme={null}
X-API-Key: <your_api_key>
```

## Next

* [Quickstart](/quickstart)
* [Signals Catalog](/signals)
* [Signals & Methodology](/signals-and-methodology)
* [Pagination](/pagination)
* [Errors](/errors)