Comps API Documentation

Value Cluster Map

Value Clusters

Town East North
Military Heights
Creek Crossing
Leaflet © OpenStreetMap contributors
Click anywhere on the map to get coordinates and generate an API URL.

Try it out

Endpoint

GET /access/comps

Endpoint

GET /access/comps

Description

Returns comparable properties for a given location based on property type and number of bedrooms. Properties are sourced from predefined value clusters based on geographical boundaries.

Parameters

ParameterTypeRequiredDescription
latfloatYesLatitude of the target property
lngfloatYesLongitude of the target property
propertyTypestringYesType of property ('single_family', 'condo', 'multi_family', 'townhouse')
bedroomsintegerNoNumber of bedrooms

Example Requests

/access/comps?lat=32.8165&lng=-96.6245&propertyType=single_family&bedrooms=4

/access/comps?lat=32.8115&lng=-96.6238&propertyType=single_family&bedrooms=3

/access/comps?lat=32.8065&lng=-96.6230&propertyType=single_family&bedrooms=3

Responses

Success Response (200)

{
    "status": "success",
    "property": {
        "latitude": 32.8165,
        "longitude": -96.6245,
        "type": "single_family",
        "bedrooms": "4"
    },
    "analysis": {
        "totalComparables": 8,
        "medianPrice": "$325,000",
        "averagePrice": "$328,750",
        "lastUpdated": "January 14, 2025"
    },
    "comparables": [
        {
            "address": "3737 Town East Blvd",
            "basicInfo": {
                "bedrooms": 4,
                "bathrooms": 2,
                "squareFeet": 1856,
                "yearBuilt": 1985,
                "lotSize": "0.25 acres"
            },
            "lastSale": {
                "price": "$325,000",
                "date": "January 5, 2024"
            },
            "location": {
                "latitude": 32.8165,
                "longitude": -96.6245
            },
            "viewOnZillow": "https://www.zillow.com/homes/..."
        }
    ]
}

Error Responses

Property Not Found (404)

{
    "status": "error",
    "message": "Location not in any known value cluster",
    "property": {
        "latitude": 32.8165,
        "longitude": -96.6245,
        "type": "single_family",
        "bedrooms": "4"
    }
}

No Comparables Found (404)

{
    "status": "error",
    "message": "No comparable properties found in this cluster",
    "property": {
        "latitude": 32.8165,
        "longitude": -96.6245,
        "type": "single_family",
        "bedrooms": "4"
    }
}

Server Error (500)

{
    "status": "error",
    "message": "Internal server error message",
    "property": {
        "latitude": 32.8165,
        "longitude": -96.6245,
        "type": "single_family",
        "bedrooms": "4"
    }
}

Notes

  • The API uses predefined value clusters to group properties in similar geographical areas
  • Each comparable includes a link to view the property on Zillow
  • All prices are formatted in USD with no decimal places
  • Dates are formatted in "Month Day, Year" format
  • Up to 5 most recent comparable sales are returned
  • Property coordinates matching uses a small tolerance (0.0001 degrees)