Getting started

curl "https://api.homedata.co.uk/address/find?q=10%20Downing%20Street" \
  -H "Authorization: Api-Key YOUR_API_KEY"

import requests

API_KEY = "YOUR_API_KEY"
headers = {"Authorization": f"Api-Key {API_KEY}"}

response = requests.get(
    "https://api.homedata.co.uk/address/find",
    params={"q": "10 Downing Street"},
    headers=headers
)
data = response.json()
for addr in data["suggestions"]:
    print(f"{addr['address']}, {addr['postcode']} (UPRN: {addr['uprn']})")

const API_KEY = "YOUR_API_KEY";

const response = await fetch(
  "https://api.homedata.co.uk/address/find?q=10%20Downing%20Street",
  { headers: { "Authorization": `Api-Key ${API_KEY}` } }
);
const data = await response.json();
data.suggestions.forEach(a =>
  console.log(`${a.address}, ${a.postcode} (UPRN: ${a.uprn})`)
);

$apiKey = "YOUR_API_KEY";
$url = "https://api.homedata.co.uk/address/find?" . http_build_query(['q' => '10 Downing Street']);

$context = stream_context_create(['http' => [
    'header' => "Authorization: Api-Key $apiKey"
]]);
$response = file_get_contents($url, false, $context);
$data = json_decode($response, true);
foreach ($data['suggestions'] as $addr) {
    echo $addr['address'] . ", UPRN: " . $addr['uprn'] . "\n";
}

# Property record: 15 base fields; add more with ?with=
curl https://api.homedata.co.uk/properties/100023336956 \
  -H "Authorization: Api-Key YOUR_API_KEY"

# Nearby schools with Ofsted ratings
curl "https://api.homedata.co.uk/schools/nearby?postcode=SW1A+2AA&radius_km=1" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# Broadband speeds by postcode
curl "https://api.homedata.co.uk/broadband?postcode=SW1A2AA" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# Street-level crime nearby
curl "https://api.homedata.co.uk/crime/?postcode=SW1A+2AA" \
  -H "Authorization: Api-Key YOUR_API_KEY"

import requests

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

# Get full property data
prop = requests.get(f"{BASE}/properties/100023336956", headers=headers).json()
print(f"Type: {prop['property_type']}, EPC score: {prop['current_energy_efficiency']}")

# Nearby schools with Ofsted ratings
schools = requests.get(
    f"{BASE}/schools/nearby",
    params={"postcode": "SW1A 2AA", "radius_km": 1},
    headers=headers
).json()
for school in schools["schools"][:5]:
    print(f"{school['name']}: {school['ofsted']['rating']} ({school['distance_miles']}mi)")

# Broadband speeds by postcode
bb = requests.get(
    f"{BASE}/broadband",
    params={"postcode": "SW1A2AA"},
    headers=headers
).json()

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

// Get full property data
const prop = await fetch(`${BASE}/properties/100023336956`, { headers })
  .then(r => r.json());

// Nearby schools with Ofsted ratings
const schools = await fetch(
  `${BASE}/schools/nearby?postcode=SW1A+2AA&radius_km=1`, { headers }
).then(r => r.json());
schools.schools.slice(0, 5).forEach(s =>
  console.log(`${s.name}: ${s.ofsted.rating} (${s.distance_miles}mi)`)
);

// Broadband speeds by postcode
const bb = await fetch(
  `${BASE}/broadband?postcode=SW1A2AA`, { headers }
).then(r => r.json());