Areas

Composite scores for one postal code area

Four composite indices, each 0–100 with a national rank: gentrification, family_prevalence, vitality and affluence.

Free-tier limit: the headline score, rank and total are free, but without Pro or an Area Pass for this exact area every components[].percentile is null while metric, name and weight remain, and locked names composites[].components[].percentile (requires: area-pass). So the factors behind a score are named but not quantified. A caller with access sees real percentiles there.

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

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

Request

  • Base URL: https://suomiatlas.com
  • URL: https://suomiatlas.com/api/v1/postal-codes/{postalCode}/composites
  • 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 latest year. A non-numeric value is a 404.

Response

Composite scores, components possibly redacted.

postalCodestring required
yearinteger required

Example response

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

Changes

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