Areas

Download a PDF report for one area

A rendered PDF summary of one area, returned as an attachment.

Paid outright: 402 without Pro or an Area Pass for this exact area. Unlike /derived-history, validation runs first here — a malformed code is a 400 and an unknown one a 404 for everybody, so a 402 does imply the area exists.

Rate-limited far more tightly than the rest of the API: 6 requests per minute, burst 3. Rendering is synchronous, so expect seconds, not milliseconds, and a 503 if the renderer is unavailable.

Example request: https://suomiatlas.com/api/v1/postal-codes/00120/report.pdf?lang=en

get/api/v1/postal-codes/{postalCode}/report.pdf

Request

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

Path parameters

postalCodestring required

A 5-digit Finnish postal code. This is the one path parameter that is format-checked: anything else is a 400.

Query parameters

yearinteger

Defaults to the latest year.

lang'fi' | 'sv' | 'en'

Report language. An unsupported value is silently ignored rather than rejected.

Response

The PDF, as an attachment.

Changes

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