Location intelligence

Liveability API

Resolve a postcode or coordinate to the nearest scored H3 neighbourhood, including the overall score, component scores, tags, and supporting local summaries.

Endpoint

GET/api/v1/area/liveability

Provide postcode, or both latitude and longitude.

Billing details in the response

Successful chargeable JSON responses include a top-level billing object. The endpoint examples on this page focus on the endpoint-specific data, so this repeated block may not be shown in every example.

"billing": {
  "mode": "prepaid",
  "creditsCharged": 1,
  "creditsRemaining": 1999,
  "creditsRefreshAt": "2026-08-14T09:30:00.000Z"
}

Field or header	Meaning
billing.creditsCharged X-Credits-Charged	Credits charged by this call. Failed and non-chargeable calls return `0` in the header.
billing.creditsRemaining X-Credits-Remaining	The credit balance after the call.
billing.creditsRefreshAt X-Credits-Refresh-At	The next monthly credit refresh as an ISO 8601 timestamp. Trial and non-renewing balances return `null` and omit the header.

All authenticated API-key calls expose the billing headers, including validation errors and zero-credit status or management requests. Only successful chargeable JSON responses add the billing object to the response body.

Parameters

Name	Required	Type	Description
postcode	No	string	Full English postcode. Alternatively provide coordinates.
latitude	No	number	Latitude when postcode is omitted.
longitude	No	number	Longitude when postcode is omitted.

Source and coverage

Source: Property Insights liveability model using Census, deprivation, amenities, crime, and school data
Coverage: England, using H3 resolution 9

Example request

curl "https://propertyinsights.co.uk/api/v1/area/liveability?postcode=S11%208YL" \
  -H "x-api-key: YOUR_API_KEY"

Example response

{
  "success": true,
  "data": {
    "postcode": "S11 8YL",
    "hexId": "8919423964fffff",
    "score": 94,
    "components": {
      "safety": 91,
      "social": 88,
      "amenities": 97,
      "schools": 93
    },
    "tags": [
      {
        "id": "commuter",
        "label": "Commuter"
      }
    ]
  }
}

OpenAPI specification

Authentication, parameters, billing headers and response schemas are also published in the machine-readable OpenAPI document.