Statistics Finland Metadata API

openapi: 3.2.0
info:
  title: Stat Fi Metadata API
  version: v1
  contact:
    name: Statistics Finland
    url: https://stat.fi
    email: tietokannat@stat.fi
  license:
    name: CC BY 4.0
    url: https://creativecommons.org/licenses/by/4.0/deed
  description: 'Operations tagged Metadata across 2 of this provider''s published API definitions: stat-fi-pxapi-beta-openapi.json, stat-fi-pxapi-beta-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.stat.fi/px/beta
  description: Primary API server
tags:
- name: Metadata
paths:
  /meta/databases/{database}/tables/{table}:
    get:
      tags:
      - Metadata
      summary: Gets metadata for a single table in JSON-stat 2.0 format (no data values…
      operationId: getTableMeta
      parameters:
      - name: database
        in: path
        description: Identifier of the database containing the table.
        required: true
        schema:
          type: string
      - name: table
        in: path
        description: Identifier of the table.
        required: true
        schema:
          type: string
      - name: lang
        in: query
        description: Optional language code; if omitted the table's default language is used.
        schema:
          type: string
      responses:
        '200':
          description: Metadata returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonStat2'
        '400':
          description: Requested language not available.
          content:
            application/json:
              schema:
                type: string
        '404':
          description: Database or table not found.
          content:
            application/json:
              schema:
                type: string
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                type: string
        '499':
          description: Client closed the request before the server could respond.
    head:
      tags:
      - Metadata
      summary: HEAD endpoint returning only headers for the metadata resource
      operationId: headTableMeta
      parameters:
      - name: database
        in: path
        description: Identifier of the database containing the table.
        required: true
        schema:
          type: string
      - name: table
        in: path
        description: Identifier of the table.
        required: true
        schema:
          type: string
      - name: lang
        in: query
        description: Optional language code.
        schema:
          type: string
      responses:
        '200':
          description: Resource exists.
        '400':
          description: Requested language not available.
        '404':
          description: Database or table not found.
        '500':
          description: Unexpected server error.
        '499':
          description: Client closed the request before the server could respond.
    options:
      tags:
      - Metadata
      summary: Returns allowed HTTP methods for the metadata resource
      operationId: optionsTableMeta
      parameters:
      - name: database
        in: path
        description: Identifier of the database containing the table.
        required: true
        schema:
          type: string
      - name: table
        in: path
        description: Identifier of the table.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns allowed methods in the Allow header.
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                type: string
    servers:
    - url: https://api.stat.fi/px/beta
      description: Primary API server
components:
  schemas:
    Dimension:
      required:
      - category
      - label
      type: object
      properties:
        label:
          minLength: 1
          type: string
          description: The label of the dimension.
        note:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Annotations about the dimension. Language-dependent.
        category:
          $ref: '#/components/schemas/Category'
      additionalProperties: false
      description: Represents a dimension in the JSON-stat format.
    Unit:
      required:
      - decimals
      - label
      type: object
      properties:
        label:
          minLength: 1
          type: string
          description: Localized label of the unit (e.g., Persons).
        symbol:
          type:
          - string
          - 'null'
          description: Optional symbol for the unit (e.g., %, �).
        position:
          type:
          - string
          - 'null'
          description: 'Optional symbol position relative to value. Allowed values: start, end.'
        decimals:
          type: integer
          description: Number of decimals to display for this unit (>= 0).
          format: int32
      additionalProperties: false
      description: Represents a unit of measurement in the JSON-stat format.
    Category:
      required:
      - index
      - label
      type: object
      properties:
        index:
          type: array
          items:
            type: string
          description: The index array of the category.
        label:
          type: object
          additionalProperties:
            type: string
          description: The labels for each category value.
        note:
          type:
          - object
          - 'null'
          additionalProperties:
            type: array
            items:
              type: string
          description: Possible annotations related to some category values.
        unit:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/Unit'
          description: The unit of measurement for each category.
      additionalProperties: false
      description: Represents a category in a dimension.
    JsonStat2:
      required:
      - class
      - dimension
      - id
      - label
      - size
      - source
      - updated
      - value
      - version
      type: object
      properties:
        version:
          minLength: 1
          type: string
          description: The JSON-stat version string.
        class:
          minLength: 1
          type: string
          description: The object class of the JSON-stat response. For data queries this is always 'dataset'.
          readOnly: true
        id:
          type: array
          items:
            type: string
          description: Ordered list of dimension identifiers. The order defines the major-to-minor traversal used to produce the PxApi.Models.JsonStat.JsonStat2.Value array.
        label:
          minLength: 1
          type: string
          description: Short, language-dependent dataset label.
        note:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Optional annotations about the dataset (language dependent).
        source:
          type:
          - string
          - 'null'
          description: The source of the dataset. Language-dependent.
        updated:
          type:
          - string
          - 'null'
          description: Timestamp indicating when the dataset was last updated (ISO 8601, UTC recommended).
        dimension:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Dimension'
          description: Map from dimension identifier to its metadata (categories, labels, units, etc.).
        value:
          type: array
          items:
            type:
            - number
            - 'null'
            format: double
          description: Flattened array of data values following the Cartesian product of dimensions in the order given by PxApi.Models.JsonStat.JsonStat2.Id. Missing values are encoded as null.
        status:
          type:
          - object
          - 'null'
          additionalProperties:
            type: string
          description: Optional status information for data values. Keys are zero-based indexes into PxApi.Models.JsonStat.JsonStat2.Value; values are arbitrary status codes.
        extension:
          type:
          - object
          - 'null'
          additionalProperties: {}
          description: Optional extension object for additional, non-standard metadata. Keys and value types are unrestricted.
        size:
          type: array
          items:
            type: integer
            format: int32
          description: Size of each dimension in the same order as PxApi.Models.JsonStat.JsonStat2.Id. Product of all elements equals PxApi.Models.JsonStat.JsonStat2.Value length.
        role:
          type:
          - object
          - 'null'
          additionalProperties:
            type: array
            items:
              type: string
          description: Optional mapping declaring special roles for certain dimensions (e.g. time, metric). Each role maps to a list of dimension identifiers.
      additionalProperties: false
      description: Represents a JSON-stat 2.0 dataset response. See https://json-stat.org/ for full specification details.
x-refined-from:
- stat-fi-pxapi-beta-openapi.json
- stat-fi-pxapi-beta-openapi.yml