Developer Hub

Build with Homedata APIs

Everything you need to integrate UK property data into your applications. RESTful APIs, comprehensive documentation, and code examples.

Quickstart Guide API Reference

Quickstart

Get your first API call working in 5 minutes

API Reference

Complete endpoint documentation

Authentication

API keys and security best practices

Changelog

API updates and version history

Quickstart Guide

Get up and running with the Homedata API in just a few minutes. Follow these steps to make your first API call.

1

Get your API key

Sign up for a free account to get your API key. You'll find it in your dashboard under Settings → API Keys.

2

Set up authentication

Include your API key in the Authorization header of every request using Bearer token authentication.

3

Make your first request

Use the code example to fetch property data. Replace the UPRN with any valid UK property reference number.

Terminal
# Make your first API request
curl -X GET \
"https://api.homedata.co.uk/v1/property/100023336956" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
# Response
{
"uprn": "100023336956",
"address": {
"line1": "10 Downing Street",
"city": "London",
"postcode": "SW1A 2AA"
},
"estimated_value": 4250000,
"property_type": "Terraced",
"bedrooms": 4,
"epc_rating": "D"
}

Authentication

All API requests require authentication using Bearer token authentication. Include your API key in the Authorization header.

Request Header Format

Authorization: Bearer YOUR_API_KEY

Keep your API key secure

Never expose your API key in client-side code or public repositories. Use environment variables to store sensitive credentials.

Regenerate compromised keys

If you believe your API key has been compromised, regenerate it immediately from your dashboard. Old keys are invalidated instantly.

Use separate keys for environments

We recommend using different API keys for development, staging, and production environments to isolate usage and improve security.

API Reference

Complete documentation for all available endpoints. Base URL: https://api.homedata.co.uk/v1

Property Intelligence API

Retrieve comprehensive property data by UPRN or address

Available
GET /property/{uprn}

Get property details by UPRN (Unique Property Reference Number)

Parameters: uprn (required) - The property's unique reference number
GET /property/search

Search for properties by address or postcode

Parameters: q (required) - Search query (address or postcode)
GET /property/{uprn}/history

Get transaction history for a property

Parameters: uprn (required), limit (optional, default 10)

Market Insights API

Access market trends, price indices, and area statistics

Available
GET /market/area/{postcode}

Get market statistics for a postcode area

Parameters: postcode (required) - Full or partial postcode
GET /market/trends

Get price trends and forecasts for an area

Parameters: postcode (required), period (optional: 1y, 5y, 10y)
GET /market/comparables/{uprn}

Find comparable properties for valuation

Parameters: uprn (required), radius (optional, default 0.5km), limit (optional)

Valuation Engine API

Automated valuations with confidence scores

Professional+
GET /valuation/{uprn}

Get automated valuation for a property

Returns: estimated_value, confidence_score, valuation_range, methodology
POST /valuation/batch

Request valuations for multiple properties

Body: uprns[] - Array of UPRNs (max 100 per request)

Rate Limits

API rate limits are determined by your subscription tier. Rate limit headers are included in every response.

Rate Limit Headers

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
X-RateLimit-Reset: 1699999999
Plan Requests/Minute Monthly Quota
Free 10 500
Starter 60 10,000
Professional 300 100,000
Enterprise Custom Unlimited

Changelog

Recent updates and changes to the Homedata API.

v1.2.0 November 2024

Market Insights API Launch

  • • Added /market/area endpoint for area statistics
  • • Added /market/trends endpoint for price forecasts
  • • Added /market/comparables endpoint for valuation support
v1.1.0 October 2024

Valuation Engine Beta

  • • Introduced automated valuation endpoints
  • • Added confidence scoring to all valuations
  • • Batch valuation support (up to 100 properties)
v1.0.0 September 2024

Initial Release

  • • Property Intelligence API with full UK coverage
  • • Search by UPRN, address, or postcode
  • • Transaction history endpoints
  • • EPC and council tax data

Ready to start building?

Get your free API key and start integrating UK property data into your application today.

Get Your Free API Key Contact Support