Developers / API

Add fair value, confidence and a price range to any product with a single API call.

Authentication

The valuation service requires an API key, sent in the X-API-Key header (or as Authorization: Bearer <key>).

X-API-Key: hri_your_key_here

Create a free account above and verify your email to issue keys instantly. Keys can be revoked anytime.

Endpoints

POST/api/v1/valuationAPI keyOne-call valuation (fair value, range, confidence) — API key
POST/api/v1/score/simpleInstant score + fair value (no persistence)
POST/api/v1/reportsCreate a permanent, citable report
GET/api/v1/reports/{reference}Fetch / verify a report
GET/api/v1/reports/accuracyPublished accuracy statistics
GET/api/v1/widget.svg?neighborhood_id=&asking=&size=Embeddable asking-vs-fair widget (SVG)
GET/api/v1/badge/{property_id}.svgEmbeddable Reality Score badge (SVG)

Example

curl -X POST https://backend-production-2caf.up.railway.app/api/v1/valuation \
  -H "Content-Type: application/json" \
  -H "X-API-Key: hri_your_key_here" \
  -d '{"neighborhood_id": 1, "asking_price": 60000, "size_sqm": 120, "create_report": true}'

Returns fair value, price range, most-likely value, confidence, Reality Score and (optionally) a citable report reference.

{
  "fair_value": 241000,
  "price_low": 212080,
  "price_high": 269920,
  "most_likely": 241000,
  "confidence": "medium",
  "confidence_pct": 80,
  "reality_score": 64,
  "band": "Above expected",
  "verdict": "above_fair_range_by_8pct",
  "currency": "USD",
  "methodology_version": "2.0",
  "neighborhood": "Al-Inshaat",
  "reference": "FA-2026-123456",
  "report_url": "https://fairaqar.help/r/FA-2026-123456"
}

Full interactive API reference (OpenAPI / Swagger):

Open API docs