Areas

Compare several postal code areas side by side

One column per area, grouped by metric group, with national benchmarks shared across the columns.

Free-tier limit: a free caller's list is truncated to the first 2 areas. Passing 5 codes returns 200 with 2 columns and a locked entry for areas (requires: pro) whose reason names the 3 dropped codes. Pro allows 12.

Asking for more than 12 is a 400 for everyone. Duplicates are removed, caller order preserved. asOf appears for metrics whose latest published year lags the year you asked for, so a single response can mix vintages — label them.

Example request: https://suomiatlas.com/api/v1/stats?postalCodes=00120,00180

get/api/v1/stats

Request

  • Base URL: https://suomiatlas.com
  • URL: https://suomiatlas.com/api/v1/stats
  • Auth: one of:
    • none
    • HTTP bearer

Query parameters

postalCodesstring required

Comma-separated postal codes. Required; more than 12 unique codes is a 400.

yearinteger

Defaults to the latest year. A non-numeric value is a 404.

Response

The comparison, possibly truncated to 2 columns.

yearinteger required
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.

asOfobject required

Present only for metrics whose latest published year lags the requested one — so a single response can mix vintages. Label those rows rather than presenting one year.

Example response

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

Changes

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