Statistics Finland Tables API

openapi: 3.2.0
info:
  title: Stat Fi Tables 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 Tables 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: Tables
paths:
  /meta/databases/{database}/tables:
    get:
      tags:
      - Tables
      summary: Returns a paged list of tables and their essential metadata for a database
      operationId: listTables
      parameters:
      - name: database
        in: path
        description: Unique identifier of the database.
        required: true
        schema:
          type: string
      - name: lang
        in: query
        description: Optional language used to get the metadata. If not provided, the default language is used.
        schema:
          type: string
      - name: page
        in: query
        description: Optional 1-based page number to retrieve, default value is 1.
        schema:
          maximum: 2147483647
          minimum: 1
          type: integer
          format: int32
          default: 1
      - name: pageSize
        in: query
        description: Optional number of items per page (1-100), default value is 50.
        schema:
          maximum: 100
          minimum: 1
          type: integer
          format: int32
          default: 50
      responses:
        '200':
          description: Returns the table listing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedTableList'
        '400':
          description: Invalid query parameter was provided (page < 1, pageSize outside 1-100 or unsupported language).
          content:
            application/json:
              schema:
                type: string
        '404':
          description: Database not found.
          content:
            application/json:
              schema:
                type: string
        '500':
          description: A table on the requested page contains broken metadata.
          content:
            application/json:
              schema:
                type: string
        '499':
          description: Client closed the request before the server could respond.
    head:
      tags:
      - Tables
      summary: HEAD endpoint to validate existence of database and optional page parameters…
      operationId: headTables
      parameters:
      - name: database
        in: path
        description: Unique identifier of the database.
        required: true
        schema:
          type: string
      - name: page
        in: query
        description: Optional page number.
        schema:
          type: integer
          format: int32
          default: 1
      - name: pageSize
        in: query
        description: Optional page size.
        schema:
          type: integer
          format: int32
          default: 50
      responses:
        '200':
          description: Resource exists.
        '400':
          description: Invalid paging parameters.
        '404':
          description: Database not found.
        '500':
          description: Unexpected server error.
    options:
      tags:
      - Tables
      summary: Returns allowed HTTP methods for the tables resource
      operationId: optionsTables
      parameters:
      - name: database
        in: path
        description: Unique identifier of the database.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns allowed methods in the Allow header.
        '404':
          description: Database not found.
          content:
            application/json:
              schema:
                type: string
        '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:
    TableSummary:
      required:
      - dimensions
      - lastUpdated
      - metrics
      - tableId
      - timeRange
      - title
      type: object
      properties:
        tableId:
          minLength: 1
          type: string
          description: Unique identifier for the table (e.g., TABLEID from PX metadata).
        title:
          minLength: 1
          type: string
          description: Localized display title of the table.
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/MetricInfo'
          description: Metric names and their units of measurement.
        timeRange:
          $ref: '#/components/schemas/TimeRange'
        dimensions:
          type: array
          items:
            $ref: '#/components/schemas/DimensionInfo'
          description: Names and sizes of all dimensions, excluding the metric and time dimensions.
        lastUpdated:
          type: string
          description: Last update timestamp (UTC) derived from the metric values.
          format: date-time
      additionalProperties: false
      description: 'Contains essential summary information about a statistical table, including

        its identification, metrics, time range, dimensions, and update timestamp.'
    TimeRange:
      required:
      - from
      - to
      type: object
      properties:
        from:
          minLength: 1
          type: string
          description: Name of the first time period value (e.g., "2000").
        to:
          minLength: 1
          type: string
          description: Name of the last time period value (e.g., "2024").
      additionalProperties: false
      description: Represents the time range of a table's time dimension.
    PagingInfo:
      required:
      - currentPage
      - pageSize
      - totalItems
      type: object
      properties:
        currentPage:
          maximum: 2147483647
          minimum: 1
          type: integer
          description: The current page number, starting from 1.
          format: int32
        pageSize:
          maximum: 100
          minimum: 1
          type: integer
          description: The number of items per page.
          format: int32
        totalItems:
          maximum: 2147483647
          minimum: 0
          type: integer
          description: The total number of items that can be paged through.
          format: int32
      additionalProperties: false
      description: Represents paging information for a list of items.
    DimensionInfo:
      required:
      - name
      - size
      type: object
      properties:
        name:
          minLength: 1
          type: string
          description: Localized display name of the dimension.
        size:
          type: integer
          description: Number of values in the dimension.
          format: int32
      additionalProperties: false
      description: 'Represents summary information about a dimension: its name and the number of values it contains.'
    TableListingItem:
      required:
      - links
      - table
      type: object
      properties:
        table:
          $ref: '#/components/schemas/TableSummary'
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
          description: HATEOAS links related to the table (e.g., self, metadata, data endpoints).
      additionalProperties: false
      description: Represents a table and its essential metadata used in listings.
    PagedTableList:
      required:
      - pagingInfo
      - tables
      type: object
      properties:
        tables:
          type: array
          items:
            $ref: '#/components/schemas/TableListingItem'
          description: List of tables and their essential metadata.
        pagingInfo:
          $ref: '#/components/schemas/PagingInfo'
      additionalProperties: false
      description: Represents a list of tables and their essential metadata with paging information.
    MetricInfo:
      required:
      - name
      - unit
      type: object
      properties:
        name:
          minLength: 1
          type: string
          description: Localized name of the metric (e.g., "Population", "GDP").
        unit:
          minLength: 1
          type: string
          description: Localized unit of measurement (e.g., "persons", "EUR").
      additionalProperties: false
      description: Represents a metric with its name and unit of measurement.
    Link:
      required:
      - href
      - method
      - rel
      type: object
      properties:
        href:
          minLength: 1
          type: string
          description: Absolute or relative URI of the target resource.
        rel:
          minLength: 1
          type: string
          description: Relation type describing how the target resource relates to the current resource (e.g., self, data, metadata).
        method:
          minLength: 1
          type: string
          description: HTTP method to use when following the link (e.g., GET, POST).
      additionalProperties: false
      description: Represents a link to a related resource (HATEOAS).
x-refined-from:
- stat-fi-pxapi-beta-openapi.json
- stat-fi-pxapi-beta-openapi.yml