Base URL
All API requests should be made to:Authentication
All requests require thex-api-key header. See the authentication guide for details.
| Header | Value | Required |
|---|---|---|
x-api-key | Your API key | Yes |
Content-Type | application/json | For POST requests |
Response Format
Success Response
Successful responses return a JSON object. The exact shape depends on the endpoint — refer to each endpoint’s documentation for details.Error Response
Pagination
List endpoints use offset-based pagination withlimit and offset parameters:
| Field | Description |
|---|---|
totalSize / total | Total number of matching records |
size / limit | Number of records returned in this page |
hasMore | Whether more records exist |
nextOffset / offset | Offset for the next page |
Status Codes
| Code | Description |
|---|---|
200 | Success |
400 | Bad Request — invalid parameters |
401 | Unauthorised — invalid or missing API key |
403 | Forbidden — insufficient permissions |
404 | Not Found — resource does not exist |
422 | Unprocessable Entity — validation failed |
429 | Too Many Requests — usage limit exceeded |
500 | Internal Server Error |
503 | Service Unavailable |
Versioning
The API uses URL versioning. The current version isv1. Breaking changes will result in a new version.
Available Endpoints
Property
30M+ UK properties
Planning
8M+ planning applications
Schools
32,000 UK schools
Safety
Crime and safety data
Listings
Property listings
EPC
Energy performance certificates
Address
Address resolution and postcodes
AVM
Automated valuations
Sites
Development sites
Companies
Company data
Areas
Area reference data
Search
Search suggestions
Interactive API Explorer
Explore and test the API interactively:API Reference (Scalar)
Interactive API explorer with try-it-out
OpenAPI Specification
Download OpenAPI 3.0 spec for Postman, Insomnia, etc.