Vepler logo
v2.140.0 Breaking change

Prosperity Index moves to its own endpoint, keyed by small-area code

New endpoint returns the Vepler Prosperity Index by small-area code, with deciles, dimensions and per-indicator sources. The embedded prosperity object is removed from property responses.

Added

  • New endpoint GET /v1/prosperity/{geographicCodes} returns the Vepler Prosperity Index for one or more small-area codes (LSOA in England and Wales, Data Zone in Scotland, SOA in Northern Ireland). Pass a single code or a comma-separated list of up to 100.
  • Each result is a composite 0-100 score with national decile (1-10) and percentile, a four-way dimensions breakdown (income, housing, employment, livingStandards), the underlying indicators with per-indicator source attribution, and an OAC geodemographic classification (null for Scotland and Northern Ireland).
  • Each item carries its own geographicCode, so multi-code lookups can be mapped back by the caller. Responses use the standard versioned list envelope; valid codes with no persisted score are omitted rather than returning a 404. Requesting more than 100 codes returns 400.

Removed