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

# Premium Comparables Search

> Search for comparable properties based on location and optional property characteristics.



## OpenAPI

````yaml /api-reference/openapi.json get /public/premium/comparables/
openapi: 3.1.0
info:
  title: Property Data API
  description: API for looking up property details by address and unit number.
  version: 1.0.0
servers:
  - url: https://app.realie.ai/api
security: []
paths:
  /public/premium/comparables/:
    get:
      tags:
        - Premium
      summary: Premium Comparables Search
      description: >-
        Search for comparable properties based on location and optional property
        characteristics.
      operationId: comparableSearch
      parameters:
        - name: latitude
          in: query
          required: true
          schema:
            type: float
          description: The latitude coordinate of the target property.
        - name: longitude
          in: query
          required: true
          schema:
            type: float
          description: The longitude coordinate of the target property.
        - name: radius
          in: query
          required: false
          schema:
            type: float
            default: 1
          description: Search radius in miles. Defaults to 1 mile.
        - name: timeFrame
          in: query
          required: false
          schema:
            type: integer
            default: 18
          description: >-
            Number of months to look back for comparable sales. Defaults to 18
            months.
        - name: maxResults
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 50
            default: 25
          description: Maximum number of results to return. Defaults to 25, maximum is 50.
        - name: sqftMin
          in: query
          required: false
          schema:
            type: integer
          description: Minimum square footage.
        - name: sqftMax
          in: query
          required: false
          schema:
            type: integer
          description: Maximum square footage.
        - name: bedsMin
          in: query
          required: false
          schema:
            type: integer
          description: Minimum number of bedrooms.
        - name: bedsMax
          in: query
          required: false
          schema:
            type: integer
          description: Maximum number of bedrooms.
        - name: bathsMin
          in: query
          required: false
          schema:
            type: float
          description: Minimum number of bathrooms.
        - name: bathsMax
          in: query
          required: false
          schema:
            type: float
          description: Maximum number of bathrooms.
        - name: propertyType
          in: query
          required: false
          schema:
            enum:
              - any
              - condo
              - house
          description: Type of property to search for.
        - name: priceMin
          in: query
          required: false
          schema:
            type: integer
          description: Minimum price.
        - name: priceMax
          in: query
          required: false
          schema:
            type: integer
          description: Maximum price.
      responses:
        '200':
          description: Comparable properties found successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  comparables:
                    type: array
                    description: Array of comparable properties found.
                    items:
                      type: object
                  metadata:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Number of comparable properties found
                      searchParams:
                        type: object
                        description: Parameters used in the search
        '400':
          description: Bad Request - Missing or invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Description of the error that occurred.
                    example: >-
                      Bad Request: latitude and longitude are required
                      parameters
        '401':
          description: Unauthorized - Missing or invalid API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Description of the error that occurred.
                    example: 'Unauthorized: API key is missing'
        '403':
          description: Forbidden - Usage limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Description of the error that occurred.
                    example: 'Forbidden: Usage limit exceeded'
        '404':
          description: Not Found - No comparable properties found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Description of the error that occurred.
                    example: No comparable properties found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Description of the error that occurred.
                    example: Internal Server Error
      security:
        - apiKeyAuth: []
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      name: Authorization
      in: header
      description: Provide your API key directly in the header.

````