House price index series
market_index_seriesThe published house-price INDEX for one postcode district or local
authority: the level per month (base period = 100), the forecast tail
flagged, and provenance saying how the index was built.
Use this for "how has W14 moved since 2015", "what is the trend in
Camden", or to carry a known price to today:
price(t2) = price(t1) x value(t2) / value(t1). It is the same series that
shapes valuation_full's back-series (`provenance.series_basis` matches
its `series_basis`). For PRICES by cohort use market_facts; for sale
COUNTS use market_volume_series. `value` is an index level, never a price.
`area_code` is a postcode district ("W14"; a full postcode is truncated)
with area_type="district", or a local authority NAME ("Camden",
"Manchester" — not a GSS code) with area_type="lad". An unknown area is an
error naming the nearest matches; read them back to the user.
`start` / `end` are periods: "2015", "2015-06" or "2015-Q2"; `end` is
inclusive. `limit` keeps the most recent N periods inside the bounds (the
default returns the whole monthly series, 1995 to present).
READ `provenance` BEFORE QUOTING A MOVE. `index_method` is
repeat_sales_area where the area carries its own repeat-sales index, and
repeat_sales_national where the area was too thin and the pipeline
published the NATIONAL index against it — the turns are then national,
not local, and you must say so. `last_settled_period` is the last month
the registry has filled; points after it carry is_forecast=true with
lo/hi bands. `tx_n` per point is the cube's UPRN-matched sample, not the
registry's count.
The index is published monthly. frequency="quarterly" returns an empty
series with a note wherever no quarterly rows exist. UK only. Free.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | ||
| limit | No | ||
| start | No | ||
| area_code | Yes | ||
| area_type | No | district | |
| frequency | No | monthly | |
| include_forecast | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||