Propera API & Webhooks

Authentication

Generate an API key in Propera under Account Settings → API Keys (Pro or Business plan). Send it on every request as an X-API-Key header. Authorization: Bearer YOUR_KEY also works.

X-API-Key: YOUR_PROPERA_API_KEY
Content-Type: application/json

Verify a key with a quick GET to the ping endpoint:

GET https://getpropera.com/api/v1/ping
X-API-Key: YOUR_PROPERA_API_KEY

200 OK
{ "ok": true, "email": "you@example.com", "plan_key": "pro", "api_enabled": true }

Run an analysis

POST a property to the ARV endpoint:

POST https://getpropera.com/api/v1/arv

Request body

Field	Value	Required
`address`	Full address (street, city, state, ZIP), or structured `street`/`city`/`state`/`zip`	Always
`property_type`	`sfh`, `condo`, `townhouse`, `manufactured`, or `land` (case-insensitive)	Always
`bedrooms`	Number of bedrooms	Residential
`bathrooms`	Number of bathrooms	Residential
`year_built`	Year the property was built	Residential
`sqft`	Living area for residential, or lot size for land	Always
`comp_radius`	Search radius in miles (residential up to 15, land up to 50)	Always
`lot_size_unit`	`sqft` or `acres`	Land only

curl -X POST https://getpropera.com/api/v1/arv \
  -H "X-API-Key: YOUR_PROPERA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "address": "123 Main St, Austin, TX 78704",
    "property_type": "sfh",
    "bedrooms": 4,
    "bathrooms": 2.5,
    "sqft": 2200,
    "year_built": 2005,
    "comp_radius": 5
  }'

Response

A successful run returns 200 with success: true:

{
  "success": true,
  "id": 1024,
  "run_url": "https://getpropera.com/comps_run?id=1024",
  "arv": 330000,
  "arv_confidence": "high",
  "comps_radius_miles": 5,
  "comp_count": 5,
  "price_per_sqft": 150.00,
  "summary_text": "ARV: $330,000 (high confidence) from 5 comparables within 5 mi.",
  "dom": { "quick_sale_days": 30, "market_days": 45, "top_dollar_days": 60 },
  "comps": [
    {
      "address": "456 Oak Ave, Austin, TX 78704",
      "price": 318000, "sqft": 2120, "beds": 4, "baths": 2.5,
      "price_per_sqft": 150.00, "distance_mi": 0.8,
      "zillow_url": "https://www.zillow.com/homes/..._rb/"
    }
  ],
  "generated_at": "2026-06-07T17:46:47Z"
}

A failure returns a 4xx with success: false and a reason:

{
  "success": false,
  "error": "No recent comparable sales were found within 5 mi of this address. Widen comp_radius and try again.",
  "error_code": "INSUFFICIENT_COMPS"
}

Branch your automation on success: on true, write arv and summary_text back to the lead; on false, write error to a notes field. Each successful run consumes one ARV credit on your plan.

Error codes

error_code	HTTP	Meaning & fix
`UNAUTHORIZED`	401	Missing/invalid key. Check the `X-API-Key` header.
`PLAN_NOT_ELIGIBLE`	403	Plan has no API access. Upgrade to Pro or Business.
`LIMIT_REACHED`	402	Monthly ARV limit hit. Resets next billing cycle.
`INSUFFICIENT_COMPS`	422	Not enough comps at that radius. Widen `comp_radius`.
`NO_USABLE_COMPS`	422	Comps found but none passed the filters. Widen `comp_radius`.
`ADDRESS_NOT_FOUND`	422	Address not matched. Include a street number.
`INVALID_COMP_RADIUS`	422	`comp_radius` is missing or out of range.
`INVALID_PROPERTY_DETAILS`	422	A required property field is missing or out of range.

Build it your way.

Generate an API key and start underwriting from any tool.

Get Started