GET /api/v1/deal-score

Authorization: Bearer paid_your_key

curl "https://api.propaideals.co.uk/api/v1/deal-score?property_id=5fa1b2c3-d4e5-6f78-9012-3456789abcde" \
  -H "Authorization: Bearer paid_your_key"

import requests

res = requests.get(
    "https://api.propaideals.co.uk/api/v1/deal-score",
    params={"property_id": "5fa1b2c3-d4e5-6f78-9012-3456789abcde"},
    headers={"Authorization": "Bearer paid_your_key"},
)
score = res.json()["data"]

const params = new URLSearchParams({ property_id: "5fa1b2c3-d4e5-6f78-9012-3456789abcde" });
const res = await fetch(
  `https://api.propaideals.co.uk/api/v1/deal-score?${params}`,
  { headers: { Authorization: "Bearer paid_your_key" } },
);
const { data } = await res.json();

{
  "data": {
    "property_id": "5fa1b2c3-d4e5-6f78-9012-3456789abcde",
    "deal_score": 82,
    "is_hot_deal": true,
    "predicted_reduction_likelihood": 0.34,
    "factors": {
      "bmv_discount": { "weight": 0.35, "score": 88, "value": "12.4% below area average" },
      "gross_yield": { "weight": 0.25, "score": 79, "value": "6.8%" },
      "demand": { "weight": 0.20, "score": 71, "value": "high search interest" },
      "listing_freshness": { "weight": 0.10, "score": 64, "value": "listed 41 days" },
      "price_history": { "weight": 0.10, "score": 90, "value": "1 reduction (−5%)" }
    },
    "hidden_opportunities": {
      "epc_below_c": true,
      "lease_extension_candidate": false,
      "pd_conversion_potential": true
    }
  },
  "meta": {
    "usage": {
      "request_cost": 2,
      "monthly_used": 4823,
      "monthly_limit": 100000
    }
  }
}

res = requests.get(
    "https://api.propaideals.co.uk/api/v1/deal-score",
    params={"property_id": property_id},
    headers={"Authorization": "Bearer paid_your_key"},
).json()["data"]

if res["is_hot_deal"] and res["deal_score"] >= 80:
    print(f"Hot deal at {res['deal_score']}/100 — {res['predicted_reduction_likelihood']:.0%} reduction likelihood")