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

# Resolve Location

> Resolves text input to ranked location candidates across supported geo scopes.

Use this endpoint to turn user-entered text into candidate `geo_id` values.

Typical input is a partial location string such as city, ZIP, county, or jurisdiction name.\
Use the returned `geo_id` in downstream permit and signal endpoints.


## OpenAPI

````yaml GET /v1/locations/resolve
openapi: 3.1.0
info:
  title: HomeLogs Geo + Permit Intelligence API
  version: 1.0.0
  description: >-
    Geo-first API for location resolution, permit retrieval, and active geo
    signal access.
servers:
  - url: https://api.homelogs.io
    description: Production API
security:
  - ApiKeyAuth: []
tags:
  - name: locations
    description: Location resolution and anchor detail endpoints.
  - name: permits
    description: Raw permit retrieval by geo scope.
  - name: signals
    description: Signal catalog and signal reads.
  - name: permit-signals
    description: Permit-scoped signal leads and aggregates.
  - name: health
    description: Service liveness endpoint.
paths:
  /v1/locations/resolve:
    get:
      tags:
        - locations
      summary: Resolve user input to ranked geo candidates
      description: >-
        Resolves text input to ranked location candidates across supported geo
        scopes.
      operationId: resolveLocations
      parameters:
        - name: query
          in: query
          required: true
          description: 'Free-form text input (aliases: q, address, text).'
          schema:
            type: string
            minLength: 1
            maxLength: 200
        - name: state
          in: query
          required: false
          description: Optional two-letter state filter.
          schema:
            type: string
            pattern: ^[A-Za-z]{2}$
            example: WA
        - name: geo_type
          in: query
          required: false
          description: Optional scope filter.
          schema:
            type: string
            enum:
              - property
              - jurisdiction
              - city
              - zip
              - county
              - state
        - name: limit
          in: query
          required: false
          description: Maximum candidates to return.
          schema:
            type: integer
            minimum: 1
            maximum: 20
            default: 5
      responses:
        '200':
          description: Candidates found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationResolveResponse'
        '403':
          $ref: '#/components/responses/GatewayAuth403'
        '404':
          $ref: '#/components/responses/LocationNotFound404'
        '422':
          $ref: '#/components/responses/ValidationError422'
        '429':
          $ref: '#/components/responses/GatewayThrottle429'
        '500':
          $ref: '#/components/responses/InternalError500'
components:
  schemas:
    LocationResolveResponse:
      type: object
      required:
        - query
        - count
        - candidates
      properties:
        query:
          type: string
        count:
          type: integer
          minimum: 0
        candidates:
          type: array
          items:
            $ref: '#/components/schemas/LocationResolveCandidate'
    LocationResolveCandidate:
      type: object
      required:
        - geo_id
        - geo_type
        - display_name
        - score
        - confidence
        - match_method
        - decision
        - reasons
      properties:
        geo_id:
          type: string
        geo_type:
          type: string
          enum:
            - property
            - jurisdiction
            - city
            - zip
            - county
            - state
        display_name:
          type: string
        score:
          type:
            - number
            - 'null'
        confidence:
          type:
            - number
            - 'null'
        match_method:
          type:
            - string
            - 'null'
        decision:
          type:
            - string
            - 'null'
        reasons:
          type: array
          items:
            type: string
        state:
          type: string
        county:
          type: string
        city:
          type: string
        zipcode:
          type: string
        jurisdiction:
          type: string
      additionalProperties: false
    GatewayErrorResponse:
      type: object
      properties:
        message:
          type: string
      additionalProperties: true
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              example: VALIDATION_ERROR
            message:
              type: string
              example: state must be a 2-letter code
            request_id:
              type:
                - string
                - 'null'
              example: req-123
  responses:
    GatewayAuth403:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GatewayErrorResponse'
    LocationNotFound404:
      description: No matching location/resource found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ValidationError422:
      description: Validation failure.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    GatewayThrottle429:
      description: Rate limit or quota exceeded.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GatewayErrorResponse'
    InternalError500:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````