Skip to main content

​
Authentication

Business endpoints require API key auth:

​
Endpoint map

  • GET /v1/locations/resolve
  • GET /v1/locations/{geo_id}
  • GET /v1/permits/search
  • GET /v1/signals/catalog
  • GET /v1/signals/geo/location/{geo_id}
  • GET /v1/signals/geo/search
  • GET /v1/signals/permit/leads
  • GET /v1/signals/permit/stats
  • GET /v1/health/live (no API key)
Permit-scoped signal reads use geo_id anchors and reject property geo_id values. For signal meanings and timing guidance, see Signals Catalog.

​
Which endpoint should I call?

  1. user text input -> /v1/locations/resolve
  2. raw permits for one geo -> /v1/permits/search
  3. active geo-scoped signals for one geo -> /v1/signals/geo/location/{geo_id}
  4. geo-scoped leaderboard/feed by signal -> /v1/signals/geo/search
  5. permit-scoped leads for one geo -> /v1/signals/permit/leads
  6. permit-scoped stats for one geo -> /v1/signals/permit/stats

​
Practical call order

Most integrations follow this order:
  1. Resolve user input to a stable ID with /v1/locations/resolve.
  2. Read permits with /v1/permits/search and/or permit leads with /v1/signals/permit/leads.
  3. Add geo trend context with /v1/signals/geo/location/{geo_id} or /v1/signals/geo/search.