Add property intelligence to your CRM.

curl "https://api.homedata.co.uk/address/find/?q=14+Chapel+Lane+Bristol" \
  -H "Authorization: Api-Key YOUR_API_KEY"
  # address/find: 2 tokens
  # returns suggestions[] with uprn, address, postcode
  # e.g. uprn: 100023336956, address: "14 Chapel Lane, Bristol, BS8 4JX"

# Step 2: retrieve the full property record
curl "https://api.homedata.co.uk/property/100023336956/address/" \
  -H "Authorization: Api-Key YOUR_API_KEY"
  # address/retrieve: 5 tokens
  # returns 60+ fields: bedrooms, property_type, floor_area_sqm,
  #   epc_rating, tenure, council_tax_band, last_sold_price, sold_date ...

import requests

API_KEY = "YOUR_API_KEY"
BASE    = "https://api.homedata.co.uk"
HEADERS = {"Authorization": f"Api-Key {API_KEY}"}

# Step 1: typeahead: called on each keystroke (2 tokens)
def address_find(query: str) -> list:
    r = requests.get(f"{BASE}/address/find/", params={"q": query}, headers=HEADERS)
    return r.json()["suggestions"]  # [{uprn, address, postcode}, ...]

# Step 2: user selects a suggestion; retrieve full record (5 tokens)
def address_retrieve(uprn: str) -> dict:
    r = requests.get(f"{BASE}/property/{uprn}/address/", headers=HEADERS)
    return r.json()

# --- CRM form auto-population ---
suggestions = address_find("14 Chapel Lane Bristol")
# suggestions[0] => uprn: "100023336956", address: "14 Chapel Lane, Bristol, BS8 4JX"

property_data = address_retrieve(suggestions[0]["uprn"])

# Map API fields to CRM fields
crm_record = {
    "address":        property_data["address"],
    "postcode":       property_data["postcode"],
    "bedrooms":       property_data["bedrooms"],
    "property_type":  property_data["property_type"],
    "floor_area_sqm": property_data["floor_area_sqm"],
    "epc_rating":     property_data["epc_rating"],
    "tenure":         property_data["tenure"],
    "council_tax":    property_data["council_tax_band"],
    "last_sold":      property_data["last_sold_price"],
}
print(crm_record)

const API_KEY = 'YOUR_API_KEY';
const BASE    = 'https://api.homedata.co.uk';
const headers = { 'Authorization': `Api-Key ${API_KEY}` };

// Step 1: typeahead suggestions (2 tokens)
async function addressFind(query) {
  const res  = await fetch(`${BASE}/address/find/?q=${encodeURIComponent(query)}`, { headers });
  const data = await res.json();
  return data.suggestions; // [{uprn, address, postcode}, ...]
}

// Step 2: retrieve full property record on selection (5 tokens)
async function addressRetrieve(uprn) {
  const res = await fetch(`${BASE}/property/${uprn}/address/`, { headers });
  return res.json();
}

// --- Wire up a CRM address field ---
async function onAddressSelected(uprn) {
  const property = await addressRetrieve(uprn);

  // Auto-populate form fields: no manual data entry
  document.getElementById('field-bedrooms').value       = property.bedrooms;
  document.getElementById('field-type').value           = property.property_type;
  document.getElementById('field-floor-area').value     = property.floor_area_sqm;
  document.getElementById('field-epc').value            = property.epc_rating;
  document.getElementById('field-tenure').value         = property.tenure;
  document.getElementById('field-council-tax').value    = property.council_tax_band;
  document.getElementById('field-last-sold').value      = property.last_sold_price;
}

// Example: user types "14 Chapel Lane Bristol"
addressFind('14 Chapel Lane Bristol').then(suggestions => {
  // uprn: "100023336956": "14 Chapel Lane, Bristol, BS8 4JX"
  onAddressSelected(suggestions[0].uprn);
});