> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ihuus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Privacy Index Score

> <Badge color="blue" icon="sparkles" size="lg" shape="pill">Pro AI</Badge>

Evaluates how secluded and private a neighborhood feels based on
housing density, lot sizes, tree cover, and street-level visibility.
Scores range from 1 (High Density) to 255 (Estate Sprawl).



## OpenAPI

````yaml /openapi.json get /vibe/privacy
openapi: 3.1.0
info:
  title: Neighborhood Intelligence API
  description: >-
    High-performance geospatial API for neighborhood-level intelligence. Covers
    K-12 school search and four scored dimension groups: Vibe (privacy,
    walkability, visual appeal, dog friendliness, urban-rural character,
    liveliness), Environment (acoustic comfort, air quality, industrial
    proximity), Demographics (health insurance coverage, ideological lean,
    population age profile), and Risk (flood and fire hazard).
  contact:
    name: iHuus, Inc.
    url: https://ihuus.com/
  version: 0.1.0
servers:
  - url: https://api.ihuus.com/v1
    description: iHuus API v1
security:
  - BearerAuth: []
tags:
  - name: Schools & Ratings
    description: >-
      Search for K-12 schools by geographic coordinates. Results include
      distance, school level, district information, demographics, and
      performance metrics where available.
  - name: Vibe
    description: >-
      Neighborhood vibe dimension scores. Each endpoint returns a 0-255 score
      for a single dimension (privacy, walkability, visual appeal, dog
      friendliness, urban-rural character) along with a semantic description.
  - name: Environment
    description: >-
      Environment dimension scores (0-255). Includes composite noise levels, air
      quality, and other environmental factors accompanied by detailed source
      breakdowns.
  - name: Demographics
    description: >-
      Demographic dimension scores (0-255) derived from US Census Bureau data.
      Includes health insurance coverage and other population-level indicators.
  - name: Risk
    description: >-
      Risk dimension scores (0-255). Covers natural hazard exposure including
      flood and fire risk, derived from FEMA and other authoritative hazard
      datasets. Lower scores indicate higher risk.
  - name: Tools
    description: >-
      Auxiliary tools for processing data and agent assistance, such as
      geocoding addresses into geospatial coordinates.
paths:
  /vibe/privacy:
    get:
      tags:
        - Vibe
      summary: Privacy Index Score
      description: >-
        <Badge color="blue" icon="sparkles" size="lg" shape="pill">Pro
        AI</Badge>


        Evaluates how secluded and private a neighborhood feels based on

        housing density, lot sizes, tree cover, and street-level visibility.

        Scores range from 1 (High Density) to 255 (Estate Sprawl).
      operationId: ihuus_vibe_privacy
      parameters:
        - name: lat
          in: query
          required: true
          schema:
            type: number
            maximum: 90
            minimum: -90
            title: Lat
            description: >-
              The latitude of the location in decimal degrees (WGS 84). Must be
              between -90 and 90.
          description: >-
            The latitude of the location in decimal degrees (WGS 84). Must be
            between -90 and 90.
        - name: lon
          in: query
          required: true
          schema:
            type: number
            maximum: 180
            minimum: -180
            title: Lon
            description: >-
              The longitude of the location in decimal degrees (WGS 84). Must be
              between -180 and 180.
          description: >-
            The longitude of the location in decimal degrees (WGS 84). Must be
            between -180 and 180.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivacyResponse'
        '401':
          description: Unauthorized — API key is missing, invalid, or expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Too Many Requests — rate limit or monthly quota exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    PrivacyResponse:
      properties:
        result:
          $ref: '#/components/schemas/PrivacyResult'
          description: The Privacy Index result. A score of 0 means no data is available.
      type: object
      required:
        - result
      title: PrivacyResponse
      description: API response for a Privacy Index lookup.
      examples:
        - result:
            description: >-
              High privacy: large lot sizes, mature tree canopy, and generous
              street setbacks limit visibility from passing traffic.
            score: 210
    ErrorResponse:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message.
      required:
        - detail
      title: ErrorResponse
      description: >-
        Standard error response returned on authentication failure and
        rate-limit violations.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PrivacyResult:
      properties:
        score:
          type: integer
          title: Score
          description: >-
            Privacy Index score (0-255). Measures how secluded and private a
            neighborhood feels based on housing density, lot sizes, tree cover,
            and street-level visibility. Higher is more private.
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: >-
            A short human-readable narrative explaining the score and the key
            factors that influenced it at this location.
      type: object
      required:
        - score
      title: PrivacyResult
      description: Privacy Index score for a location.
      examples:
        - description: >-
            High privacy: large lot sizes, mature tree canopy, and generous
            street setbacks limit visibility from passing traffic.
          score: 210
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'Your access token or API key. Pass as ``Authorization: Bearer <token>``.'

````