Comps API v3.2.0 - Developer Documentation

Interactive API Explorer

Swagger UI - Test endpoints directly

OpenAPI Spec

Download complete API specification

Try the Tool

Web-based comps search interface

Support

Get help and contact information

POST /comps/search

Search for comparable properties. Returns ranked list of similar sales with optional PDF, audio, and share links.

Minimal Request

{
  "address": "412 West H St, Ontario, CA 91762"
}

Full Request

{
  "address": "412 West H St, Ontario, CA 91762",
  "gla_sqft": 1439,
  "beds": 3,
  "baths": 3.0,
  "year_built": 1925,
  "max_distance_miles": 5.0,
  "months_back": 6,
  "max_results": 10,
  "generate_share_link": true,
  "generate_pdf": true,
  "generate_audio": true,
  "include_images": true
}

Try It — cURL Example

curl -X POST "https://comps-api.scheduleappraisal.com/comps/search" \\
  -H "Content-Type: application/json" \\
  -d '{
    "address": "412 West H St, Ontario, CA 91762",
    "email_results": true,
    "email_to": "your@email.com",
    "generate_share_link": true
  }'

Paste this in your terminal or click to copy. Replace the email with your own.

Rate Limits

Plan	Requests / Minute	Requests / Day
Founding Member (Free)	10	100
Professional	60	1,000
Enterprise	300	10,000

Rate limit headers are included in all responses: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

Response Schema

Field	Type	Description
status	string	"OK", "FALLBACK_USED", or "INSUFFICIENT_MARKET_DATA"
success	boolean	Whether the search completed successfully
count	integer	Number of comparable properties returned (0-20)
message	string\|null	Human-readable status message
results	array[CompResult]	List of ranked comparable properties
metadata	object	Report metadata including share_url, market_context
search_trace	object	Audit trail for compliance and debugging

Error Codes

Code	HTTP	Description
COMP_SEARCH_001	400	Missing required field: address or property_id
COMP_SEARCH_002	400	Invalid address format
COMP_SEARCH_003	404	Subject property not found in MLS
COMP_SEARCH_004	422	Address is outside coverage area
COMP_SEARCH_005	429	Rate limit exceeded
COMP_SEARCH_006	404	No comparable sales found
COMP_SEARCH_007	500	Internal search error

Response Fields

Field	Type	Description
success	boolean	Whether search succeeded
count	int	Number of comps returned
results	array	List of comparable properties
metadata.report_short_url	string	Shareable report link
status	string	OK, FALLBACK_USED, INSUFFICIENT_MARKET_DATA
search_trace	object	Audit trail for compliance

GET /api/report/{short_code} NEW v3.2.0

Get report data as JSON for visualization clients (Location Map).

Example

curl "https://comps-api.scheduleappraisal.com/api/report/Hrfyz15x"

Response

{
  "short_code": "Hrfyz15x",
  "subject": {
    "latitude": 34.004645,
    "longitude": -117.716731,
    "address": "4033 Jose St, Chino CA 91710"
  },
  "comps": [
    {
      "property_id": "375216421",
      "latitude": 34.073627,
      "longitude": -117.676596,
      "address": "1352 W Granada, Ontario, CA, 91762",
      "price": {"close_price": 710000},
      "distance_miles": 5.29,
      "status": "S",
      "year_built": 1973,
      "photo_url": "https://media.crmls.org/..."
    }
  ],
  "count": 10
}

GET /r/{short_code}

View the full HTML report with Location Map.

Reports expire after 30 days. Returns 404 if expired or not found.

POST /comps/collateral-risk-check

Pre-underwriting risk assessment for lenders.

Returns LTV scenarios, market support score, and risk indicators.

POST /comps/nl-query

Natural language search using DeepSeek AI.

{
  "query": "Find 3 bedroom condos sold in the last 6 months within 2 miles"
}

GET /health

Service health check with GPU status.

{
  "status": "healthy",
  "version": "v3.2.0",
  "gpu": {"available": true, "backend": "cuvs_cagra"}
}

Location Map Status Icons

🏠 Closed SaleCompleted transaction

🔥 Active ListingCurrently for sale (33% larger icon)

⏳ Pending SaleUnder contract, not yet closed

🔒 Under ContractPending sale status

🏗️ New ConstructionBuilt 2023 or later

⚡ Quick SaleSold in 7 days or less

🏦 Bank OwnedREO/Foreclosure sale

🔴 Subject PropertyProperty being valued

Price Comparison Border Colors

GreenSold above subject estimate

RedSold below subject estimate

GrayWithin +/-2% of estimate

SMS Text-to-Report

Send any address to (909) 566-2866 to receive a comps report link.

API Base URLs

Environment	URL
Production	`https://comps-api.scheduleappraisal.com`
Local	`http://localhost:18002`