Digitraffic (Fintraffic) Variable Sign V1 API

openapi: 3.2.0
info:
  title: Digitraffic Road Variable Sign V1 API
  version: 'Branch: master, tag: 2026.11.2-1 #ae693ff @ 2026-11-03T08:05:21+0000'
  description: 'OpenAPI document


    Digitraffic is a service operated by Fintraffic, offering real time traffic information. Currently the service covers *road, marine and rail* traffic. More information can be found at the Digitraffic website


    The service has a public Google-group road.digitraffic.fi for communication between developers, service administrators and Fintraffic. The discussion in the forum is mostly in Finnish, but you''re welcome to communicate in English too.


    ### General notes of the API

    * Many Digitraffic APIs use the GeoJSON format. The definition of GeoJSON can be found at https://tools.ietf.org/html/rfc7946.

    * For dates and times, the ISO 8601 format is used with "Zulu" zero offset from UTC unless otherwise specified (i.e., "yyyy-mm-ddThh:mm:ss[.mmm]Z"). E.g. 2019-11-01T06:30:00Z.'
  termsOfService: https://www.digitraffic.fi/en/terms-of-service/
  contact:
    name: Digitraffic / Fintraffic
    url: https://www.digitraffic.fi/
  license:
    name: Creative Commons 4.0 BY
    url: https://creativecommons.org/licenses/by/4.0/
servers:
- url: https://tie.digitraffic.fi
tags:
- name: Variable Sign V1
  description: Variable signs
  externalDocs:
    description: Documentation
    url: https://www.digitraffic.fi/en/road-traffic/#variable-signs
paths:
  /api/variable-sign/v1/images/{text}:
    get:
      tags:
      - Variable Sign V1
      summary: Generate svg-image from given text
      parameters:
      - name: text
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: 200 response
          headers:
            Access-Control-Allow-Origin:
              schema:
                type: string
          content:
            image/svg+xml:
              schema:
                $ref: '#/components/schemas/SvgModel'
        '400':
          description: 400 response
          headers:
            Access-Control-Allow-Origin:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Empty'
        '500':
          description: 500 response
          headers:
            Access-Control-Allow-Origin:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Empty'
      operationId: getApiVariableSignV1ImagesByText
      x-operation-id-source: derived
  /api/variable-sign/v1/signs.datex2:
    get:
      tags:
      - Variable Sign V1
      summary: Return all variables signs as DatexII 2.3.3
      responses:
        '200':
          description: 200 response
          headers:
            Access-Control-Allow-Origin:
              schema:
                type: string
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/XmlModel'
      operationId: getApiVariableSignV1SignsDatex2
      x-operation-id-source: derived
  /api/variable-sign/v1/signs:
    get:
      tags:
      - Variable Sign V1
      summary: Return the latest data of variable signs.
      operationId: variableSigns
      parameters:
      - name: deviceId
        in: query
        description: If parameter is given list only latest value of given sign
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful retrieval of variable sign data
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/VariableSignFeatureCollectionV1'
  /api/variable-sign/v1/signs/{deviceId}:
    get:
      tags:
      - Variable Sign V1
      summary: Return the latest value of a variable sign
      operationId: variableSignByPath
      parameters:
      - name: deviceId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful retrieval of variable sign data
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/VariableSignFeatureCollectionV1'
  /api/variable-sign/v1/signs/history:
    get:
      tags:
      - Variable Sign V1
      summary: Return the history of variable sign data. Only returns history from last 7 days.
      operationId: variableSignHistory
      parameters:
      - name: deviceId
        in: query
        description: Id of sign.
        required: true
        schema:
          type: string
      - name: effectiveDate
        in: query
        description: When a date is given, return only history for that day.  This is date of UTC-0 time.
        required: false
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Successful retrieval of variable sign history
          content:
            application/json;charset=UTF-8:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TrafficSignHistoryV1'
  /api/variable-sign/v1/signs/code-descriptions:
    get:
      tags:
      - Variable Sign V1
      summary: Return all code descriptions
      operationId: getCodeDescriptions
      responses:
        '200':
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/VariableSignDescriptions'
components:
  schemas:
    HistoryTextRowV1:
      type: object
      properties:
        text:
          type: string
        rowNumber:
          type: integer
          format: int32
        screen:
          type: integer
          format: int32
    XmlModel:
      type: object
    GeometryObject:
      required:
      - coordinates
      - type
      type: object
      properties:
        type:
          type: string
          description: GeoJson Geometry Object type
          enum:
          - Point
          - LineString
          - Polygon
          - MultiPoint
          - MultiLineString
          - MultiPolygon
        coordinates:
          type: array
          description: GeoJson Geometry Object coordinates
          items:
            type: object
            description: GeoJson Geometry Object coordinates
      description: GeoJson Geometry Object
      discriminator:
        propertyName: type
    VariableSignDescriptions:
      required:
      - dataUpdatedTime
      type: object
      properties:
        signTypes:
          type: array
          items:
            $ref: '#/components/schemas/CodeDescription'
        dataUpdatedTime:
          type: string
          description: Data last updated time
          format: date-time
    VariableSignFeatureV1:
      required:
      - geometry
      - properties
      - type
      type: object
      properties:
        type:
          type: string
          description: GeoJSON Object Type
        geometry:
          $ref: '#/components/schemas/Point'
        properties:
          $ref: '#/components/schemas/VariableSignPropertiesV1'
      description: GeoJSON Feature Object of variable sign
    SvgModel:
      type: object
    CodeDescription:
      required:
      - code
      - description
      - descriptionEn
      type: object
      properties:
        description:
          type: string
          description: Description of the code (Finnish)
        descriptionEn:
          type: string
          description: Description of the code(English
        code:
          type: string
          description: Code
      description: Description of code
    SignTextRowV1:
      type: object
      properties:
        screen:
          type: integer
          description: Screen number
          format: int32
        rowNumber:
          type: integer
          description: Row number
          format: int32
        text:
          type: string
          description: Text on a row
      description: Variable Sign text row
    Empty:
      title: Empty Schema
      type: object
    VariableSignPropertiesV1:
      type: object
      properties:
        id:
          type: string
          description: Id
        type:
          type: string
          description: Type
          enum:
          - SPEEDLIMIT
          - WARNING
          - INFORMATION
        roadAddress:
          type: string
          description: Sign location as road address
        direction:
          type:
          - string
          - 'null'
          description: Direction of variable sign, increasing or decreasing road address
          enum:
          - INCREASING
          - DECREASING
          - null
        carriageway:
          type: string
          description: 'Variable sign placement:

            SINGLE = Single carriageway rod

            RIGHT = First carriageway on the right in the direction of the road number

            LEFT = Second carriageway on the left in the direction of the road number

            BETWEEN = Between the carriageways'
          enum:
          - SINGLE
          - RIGHT
          - LEFT
          - BETWEEN
          - END_OF_ROAD
          - ALONG
          - ACROSS
        displayValue:
          type: string
          description: Value that is displayed on the device
        additionalInformation:
          type:
          - string
          - 'null'
          description: Additional information displayed on the device
        effectDate:
          type: string
          description: Information is effect after this date
          format: date-time
        cause:
          type:
          - string
          - 'null'
          description: 'Cause for changing the sign:

            Automaatti = Automatic

            Käsiohjaus = By hand'
        reliability:
          type: string
          description: Variable sign reliability
          enum:
          - NORMAL
          - DISCONNECTED
          - MALFUNCTION
        textRows:
          type: array
          description: Text rows if sign contains a screen
          items:
            $ref: '#/components/schemas/SignTextRowV1'
      description: Variable Sign properties
    VariableSignFeatureCollectionV1:
      required:
      - dataUpdatedTime
      - features
      - type
      type: object
      properties:
        type:
          type: string
          description: GeoJSON Object Type
        dataUpdatedTime:
          type: string
          description: Date time of the most recent metadata update
          format: date-time
        features:
          type: array
          description: GeoJSON Feature Objects
          items:
            $ref: '#/components/schemas/VariableSignFeatureV1'
      description: GeoJSON Feature Collection of variable signs
    Point:
      required:
      - coordinates
      - type
      type: object
      description: GeoJson Point Geometry Object
      allOf:
      - $ref: '#/components/schemas/GeometryObject'
      - type: object
        properties:
          type:
            type: string
            example: Point
            enum:
            - Point
          coordinates:
            type: array
            description: 'An array of coordinates. Coordinates are in WGS84 format in decimal degrees: [LONGITUDE, LATITUDE, {ALTITUDE}]. Altitude is optional and measured in meters.'
            example:
            - 26.97677492
            - 65.3467385
            items:
              type: number
              description: 'An array of coordinates. Coordinates are in WGS84 format in decimal degrees: [LONGITUDE, LATITUDE, {ALTITUDE}]. Altitude is optional and measured in meters.'
              format: double
    TrafficSignHistoryV1:
      type: object
      properties:
        cause:
          type: string
        displayValue:
          type: string
        additionalInformation:
          type: string
        effectDate:
          type: string
          format: date-time
        rows:
          type: array
          items:
            $ref: '#/components/schemas/HistoryTextRowV1'