Areas

All statistics for one postal code area

The main area endpoint: every published metric for one area, with national, municipal and regional percentiles, plus an embedded crime block. Entirely free — including the latest dwelling sale prices and crime figures. History is what costs money, not the current picture.

Two things to read carefully. A null inside variables means Statistics Finland suppressed that figure for this area, usually because too few people or dwellings lie behind it — nothing is withheld here for payment. And nationalMedians is a median only for some metrics: check nationalBenchmarkBasis for the same key before describing any of these numbers, because for average-type metrics (mean incomes, dwelling prices) the value is a weighted mean.

Housing metrics carry their own, usually newer, vintage — see housingPricesYear.

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

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

Request

  • Base URL: https://suomiatlas.com
  • URL: https://suomiatlas.com/api/v1/postal-codes/{postalCode}/stats
  • 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.

Query parameters

yearinteger

Defaults to the area's latest vintage. If the requested year holds no data, the response silently falls back to the latest year — so compare year in the response against what you asked for. A non-numeric value is a 404, not a 400.

Response

Statistics for the resolved year.

postalCodestring required
yearinteger required

The year actually served, which may differ from the one requested.

variablesNullableNumberMap required

Metric code to value. A key may be present with a null value — Statistics Finland suppresses figures resting on too few people or dwellings.

variableNamesStringMap required
variableGroupsobject required

Group name to the metrics in that group, for laying out a panel.

nationalMediansNullableNumberMap required

Metric code to value. A key may be present with a null value — Statistics Finland suppresses figures resting on too few people or dwellings.

nationalBenchmarkBasisStringMap required
nationalBenchmarkCoverageNullableNumberMap required

Metric code to value. A key may be present with a null value — Statistics Finland suppresses figures resting on too few people or dwellings.

ratioBenchmarksobject required

National benchmarks for numerator/denominator pairs, keyed "numeratorCode:denominatorCode".

percentilesNullableNumberMap required

Metric code to value. A key may be present with a null value — Statistics Finland suppresses figures resting on too few people or dwellings.

kuntaPercentilesNullableNumberMap required

Metric code to value. A key may be present with a null value — Statistics Finland suppresses figures resting on too few people or dwellings.

maakuntaPercentilesNullableNumberMap required

Metric code to value. A key may be present with a null value — Statistics Finland suppresses figures resting on too few people or dwellings.

maakuntaNamestring nullable required
housingPricesYearinteger nullable required

Dwelling-price metrics carry their own, usually newer, vintage than year.

groupYearsobject required

Data group → the year its values are from, for every group not at year: dwelling prices and each capital-region (HRI) group. A group absent here is at year.

benchmarkScopeobject required

Variables that exist only for part of the country: pks (Helsinki, Espoo, Vantaa, Kauniainen) or hr14 (the 14-municipality Helsinki region). Their benchmark and percentile are within that region, never national. Outside its region such a variable is absent from variableGroups.

variableUnitsobject required

Variable → unit token (k-m² floor area, €/m², %, …) for the variables in this response that have one. Most Paavo counts have none.

Example response

{
  "crime": {
    "metrics": [
      {
        "unit": "per 1,000 inhab."
      }
    ]
  }
}

Changes

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