المطوّرون / API

أضِف القيمة العادلة والثقة ونطاق السعر إلى أي منتج باستدعاء واحد للـ API.

المصادقة

تتطلّب خدمة التقييم مفتاح API يُرسَل في ترويسة X-API-Key (أو كـ Authorization: Bearer <key>).

X-API-Key: hri_your_key_here

أنشئ حساباً مجانياً أعلاه وتحقّق من بريدك لإصدار المفاتيح فوراً. يمكن إبطال المفاتيح في أي وقت.

نقاط النهاية

POST/api/v1/valuationمفتاح APIتقييم باستدعاء واحد (قيمة عادلة، نطاق، ثقة) — يتطلّب مفتاح API
POST/api/v1/score/simpleتقييم فوري + قيمة عادلة (دون حفظ)
POST/api/v1/reportsإنشاء تقرير دائم قابل للاستشهاد
GET/api/v1/reports/{reference}جلب / التحقق من تقرير
GET/api/v1/reports/accuracyإحصاءات الدقة المنشورة
GET/api/v1/widget.svg?neighborhood_id=&asking=&size=أداة المطلوب مقابل العادل القابلة للتضمين (SVG)
GET/api/v1/badge/{property_id}.svgشارة درجة الواقعية القابلة للتضمين (SVG)

مثال

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}'

يُعيد القيمة العادلة، ونطاق السعر، والقيمة الأرجح، والثقة، ودرجة الواقعية، و(اختيارياً) رقماً مرجعياً لتقرير قابل للاستشهاد.

{
  "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"
}

المرجع التفاعلي الكامل للـ API (OpenAPI / Swagger):

فتح وثائق API