Areas

Multi-year series for one postal code area

Time series for every metric of one area. years is the shared x-axis and every series is index-aligned to it, with nulls where a figure is missing.

Two independent free-tier limits apply here; whatever they withhold is named in locked, and a response without locked withheld nothing.

  1. Without Pro, years is cut to the latest 3 years and every series shortens with it; locked carries years (requires: pro) with the withheld span in its reason. A 3-year window is not a trend — do not describe it as one. Pro returns the full record from 2010.
  2. Without Pro or an Area Pass covering this exact area, every dwelling-price metric (housing_price_m2_*, housing_txn_count_*) has both its values and its nationalMedians replaced by nulls, for all years. The keys stay present; only the locked entry series.housing_* (requires: area-pass) tells this apart from an area with no sales, and it is emitted only when there were sales to withhold. The same callers also get derivedHistory in locked: /derived-history would answer them 402, so do not probe it. Note the asymmetry — the year window needs Pro, while the dwelling-price series and derived history also accept an Area Pass for this area. Pro or the matching Area Pass returns the full series from 2009.

Note the asymmetry: the year window needs Pro, while the dwelling-price series also accepts an Area Pass for this one area.

Example request: https://suomiatlas.com/api/v1/postal-codes/00120/history

get/api/v1/postal-codes/{postalCode}/history

Request

  • Base URL: https://suomiatlas.com
  • URL: https://suomiatlas.com/api/v1/postal-codes/{postalCode}/history
  • Auth: one of:
    • none
    • HTTP bearer

Path parameters

postalCodestring required

A 5-digit Finnish postal code. Not format-checked on this operation: an invalid code produces a 404 rather than a 400.

Response

Series, subject to the two limits above.

postalCodestring required
yearsinteger[] required

The shared x-axis, ascending. Only the latest 3 entries without Pro; when the window was cut, locked names years and its reason gives the withheld span.

seriesobject required
variableNamesStringMap required

Example response

{
  "locked": [
    {
      "upgrade": "https://suomiatlas.com/hinnat"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.