Location intelligence

Deprivation API

Retrieve English Indices of Deprivation scores, ranks, deciles, domain breakdowns, and local authority context for a full postcode.

Endpoint

GET/api/v1/area/deprivation

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	Yes	string	Full English postcode.

Source and coverage

Source: English Indices of Deprivation 2025
Coverage: England, at LSOA 2021 level

Example request

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

Example response

{
  "success": true,
  "data": {
    "postcode": "S11 8YL",
    "lsoa": {
      "code": "E01008049",
      "name": "Sheffield 050D"
    },
    "overall": {
      "score": 12.4,
      "rank": 26750,
      "decile": 8
    },
    "domains": {
      "income": {
        "score": 0.08,
        "rank": 27110,
        "decile": 9
      }
    }
  }
}

OpenAPI specification

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