Real Estate API

Property Comparables Analysis

POST /v3/PropertyComps
Api key

Find comparable properties for valuation and analysis purposes. Includes advanced filtering and market analysis features.

Headers

  • x-api-key string Required

    API key for authentication

  • x-user-id string

    Optional user identifier for tracking and analytics

application/json

Body Required

Property comparables request

  • id string | integer

    Unique property identifier to find comps for

    One of:
    string-1 string integer-2 integer
  • address string

    Full property address

  • apn string

    Assessor's Parcel Number

  • lat number

    Property latitude

    Minimum value is -90, maximum value is 90.

  • lon number

    Property longitude

    Minimum value is -180, maximum value is 180.

  • radius number

    Search radius in miles for finding comps

    Minimum value is 0.1, maximum value is 25. Default value is 1.

  • comp_count integer

    Number of comparable properties to return

    Minimum value is 1, maximum value is 50. Default value is 10.

  • bedrooms integer

    Number of bedrooms for filtering

    Minimum value is 0, maximum value is 20.

  • bathrooms number

    Number of bathrooms for filtering

    Minimum value is 0, maximum value is 20.

  • sqft_min integer

    Minimum square footage for comps

    Minimum value is 0.

  • sqft_max integer

    Maximum square footage for comps

    Minimum value is 0.

  • property_type array[string]

    Property types to include in comps

    Values are SFR, MFR, CON, TH, MOB, APT, COM, IND, or VAC.

  • sale_date_min string(date)

    Minimum sale date for comparable properties

  • sale_date_max string(date)

    Maximum sale date for comparable properties

Responses

  • 200 application/json

    Successful response with comparable properties

    Hide response attributes Show response attributes object
    • input object

      Echo of the input parameters

    • subject_property object

      Details of the subject property

    • data array[object]

      Array of comparable properties

      Hide data attributes Show data attributes object
      • id string

        Comparable property identifier

      • address object

        Comparable property address

      • distance number

        Distance from subject property in miles

      • similarity_score number

        Similarity score compared to subject property

        Minimum value is 0, maximum value is 1.

    • analysis object

      Comparative market analysis

      Hide analysis attributes Show analysis attributes object
      • estimated_value number

        Estimated value based on comps

      • value_range object
        Hide value_range attributes Show value_range attributes object
        • low number
        • high number
    • totalResults integer

      Total comparable properties found

    • returnedResults integer

      Number of comps returned

    • statusCode integer

      HTTP status code

    • live boolean

      Indicates if data is live
  • 400 application/json

    Bad Request - Invalid input parameters

    Hide response attributes Show response attributes object
    • error string
    • message string
    • statusCode integer
    • details object

      Additional error details
  • 401 application/json

    Unauthorized - Invalid or missing API key

    Hide response attributes Show response attributes object
    • error string
    • message string
    • statusCode integer
  • 404 application/json

    Not Found - Resource not found

    Hide response attributes Show response attributes object
    • error string
    • message string
    • statusCode integer
  • 500 application/json

    Internal Server Error

    Hide response attributes Show response attributes object
    • error string
    • message string
    • statusCode integer
POST /v3/PropertyComps 
curl \
 --request POST 'https://api.realestateapi.com/v3/PropertyComps' \
 --header "Content-Type: application/json" \
 --header "x-api-key: string" \
 --header "x-user-id: string" \
 --data '{"id":"148046016","radius":1.5,"comp_count":10}'
Request examples 
{
  "id": "148046016",
  "radius": 1.5,
  "comp_count": 10
}
{
  "radius": 2,
  "address": "2025 Peachtree Rd NE, Atlanta GA 30309",
  "comp_count": 15
}
{
  "id": "148046016",
  "radius": 3,
  "bedrooms": 3,
  "bathrooms": 2,
  "comp_count": 20,
  "property_type": [
    "SFR"
  ],
  "sale_date_min": "2022-01-01"
}
Response examples (200) 
{
  "input": {},
  "subject_property": {},
  "data": [
    {
      "id": "string",
      "address": {},
      "distance": 42.0,
      "similarity_score": 42.0
    }
  ],
  "analysis": {
    "estimated_value": 42.0,
    "value_range": {
      "low": 42.0,
      "high": 42.0
    }
  },
  "totalResults": 42,
  "returnedResults": 42,
  "statusCode": 42,
  "live": true
}
Response examples (400) 
{
  "error": "Bad Request",
  "message": "Invalid input parameters",
  "statusCode": 400,
  "details": {}
}
Response examples (401) 
{
  "error": "Unauthorized",
  "message": "Invalid or missing API key",
  "statusCode": 401
}
Response examples (404) 
{
  "error": "Not Found",
  "message": "Property not found",
  "statusCode": 404
}
Response examples (500) 
{
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "statusCode": 500
}