Property intelligence

Property Details API

Create a concise property profile with a canonical property identity, registered-title match, legal tenure, property facts, Council Tax and review enquiries. Use it as a property information API when you need one summary per address.

Property details API endpoint

POST/api/v1/property/profile

A completed request costs 100 credits and requires an API key. Use ?with= to request only the sections you need and pay less.

Choose sections with ?with=

Pass a comma-separated list, for example /api/v1/property/profile?with=epc,councilTax. Every request with with costs 20 credits for the address match, facts and enquiries, plus the sections you list. Leave it out to get every section except planningApplications for 100 credits.

SectionCreditsAdds
title25data.title, legal tenure, registered area and title enquiries.
building35data.building with OS building facts such as floors and age, footprint area, heights, roof shape, material and area by aspect, and an indicative solar rating.
epc5EPC property type, built form and measured floor area.
councilTax10Council Tax band.
planningConstraints5Planning constraint count and the constraint enquiry.
planningApplications5Beta, only when requested. Planning applications whose address matches the property by text and location, not UPRN, with council coverage. See the Planning Applications API for caveats.

An unknown section returns HTTP 400 with INVALID_WITH and no charge. Sections you leave out are not fetched and do not appear in data.unavailable.

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 headerMeaning
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.

When credits run out

If your balance is lower than the cost of a request, the API returns HTTP 402 and charges nothing. The error includes the credits needed, your balance and a link to change plan.

{
  "statusCode": 402,
  "statusMessage": "Payment Required",
  "data": {
    "success": false,
    "error": {
      "code": "INSUFFICIENT_CREDITS",
      "message": "This request costs 35 API credits. Upgrade your plan or wait for your monthly refresh: https://propertyinsights.co.uk/billing",
      "required": 35,
      "available": 12,
      "upgradeUrl": "https://propertyinsights.co.uk/billing"
    }
  }
}

JSON request body

FieldRequiredDescription
property.uprnConditionalPreferred property identifier. Provide this, or both address and postcode.
property.addressConditionalFull property address when a UPRN is not supplied.
property.postcodeConditionalFull Great Britain postcode when an address is supplied.

Geographic availability

Coverage by UK nation

Green: supported Amber: partial Red: not supported

The colour is a geographic coverage indicator, not a risk score. Always inspect source status and completeness in the API response.

England

Supported

HMLR title matching, OS, EPC, Council Tax and Planning Data context are configured.

Wales

Partial

HMLR title matching, OS, EPC and Council Tax context are supported. England-only Planning Data constraints are not returned.

Scotland

Partial

Land Register of Scotland title number from the ScotLIS search, Registers of Scotland INSPIRE parcel extent, OS, Scottish EPC, Council Tax and Scottish planning designations. Tenure is not returned and Sasine Register properties have no title match.

Northern Ireland

Not supported

Land Registry Northern Ireland title services are not integrated.

Example request

curl -X POST "https://propertyinsights.co.uk/api/v1/property/profile" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  --data '{
  "property": {
    "address": "14 Example Avenue, Exampleton",
    "postcode": "ZZ1 1ZZ"
  }
}'

Example response

{
  "success": true,
  "data": {
    "property": {
      "uprn": "100000000001",
      "address": "14 Example Avenue, Exampleton",
      "postcode": "ZZ1 1ZZ"
    },
    "complete": true,
    "title": {
      "status": "matched",
      "titleNumber": "GR514442",
      "tenure": "Freehold"
    },
    "facts": {
      "legalTenure": "Freehold",
      "tenureSource": "title",
      "propertyType": "House",
      "floorAreaSqM": 96,
      "councilTaxBand": "D",
      "planningConstraintCount": 0
    },
    "building": {
      "builtForm": "Semi-Detached",
      "constructionMaterial": "Brick Or Block Or Stone",
      "footprint": {
        "areaM2": 58.4,
        "buildingPartCount": 1
      },
      "height": {
        "relativeMaxM": 8.6,
        "relativeRoofBaseM": 5.4,
        "confidence": "Moderate"
      },
      "roof": {
        "shape": "Pitched",
        "material": "Tile Or Stone Or Slate",
        "solarPanels": "Not Present",
        "totalAreaM2": 68.2,
        "pitchedAreaM2": 68.2,
        "flatAreaM2": 0,
        "pitchedAreaByAspectM2": {
          "north": 34.1,
          "northEast": 0,
          "east": 0,
          "southEast": 0,
          "south": 34.1,
          "southWest": 0,
          "west": 0,
          "northWest": 0,
          "indeterminable": 0
        },
        "solarSuitability": {
          "rating": "good",
          "suitableAreaM2": 34.1,
          "southFacingPitchedAreaM2": 34.1,
          "flatAreaM2": 0,
          "indicative": true
        }
      }
    },
    "manualReviewRequired": false,
    "enquiries": [],
    "unavailable": []
  },
  "billing": {
    "mode": "prepaid",
    "creditsCharged": 100,
    "creditsRemaining": 900,
    "creditsRefreshAt": "2026-09-01T00:00:00.000Z"
  }
}

Important limits

  • The profile is property intelligence, not an official copy of the register or a legal opinion.
  • Title matching can return no match, multiple candidates or delayed when HM Land Registry queues the lookup. Delayed responses include reason and retryAfter.
  • data.complete is false when a source is unavailable. The affected sections are listed in data.unavailable.
  • EPC occupancy information is not used as evidence of legal tenure.
  • When the title lookup returns no tenure in England and Wales, facts.legalTenure uses the tenure on the address's most recent Land Registry sale. facts.tenureSource is then price_paid and facts.tenureAsOf is the sale date. A lease may have been extended, or the freehold bought, since that sale.
  • Floor area can be measured EPC evidence or an OS building estimate. Confirm it against plans or a measured survey before relying on it.
  • Roof, height and footprint figures come from OS NGD and describe the whole mapped building, which may contain more than one property. OS NGD does not publish a roof pitch angle.
  • roof.solarSuitability is indicative, not a survey. It adds south, south-east and south-west pitched roof area to flat roof area: 20 m2 or more is good, 10 m2 or more is moderate, anything less is limited. It does not account for shading, structure or planning rules.