Returns teletext page data in JSON or XML format. E.g. /v1/teletext/pages/100.json

Parameters

Teletext page structure

The xml file contains the node “teletext” which contains the node “page” Within the node “page” there will be one node “subpage” for every subpage of the exported teletext page.

The node “teletext” contains the following attributes:

• network contains the name of the network as defined in FAB Network Controller
• xml:space=“preserve” is required because teletext is using spaces for text positioning

The node “page” contains the following attributes:

• number contains the teletext page number
• name contains the page name as defined in the TOP Structure
• time contains the timestamp of the last modification of the teletext page
• subpagecount contains the number of subpages
• prevpg contains the previous existing teletext page number
• nextpg contains the next existing page number
• toptype this is always “Block”

The node “subpage” contains the following attributes:

• number is the subpage number of the content within this xml node
• time is the duration of the display of the content within this xml node in seconds

The node “subpage” contains several nodes “content” with the same content in different representations which are defined by the value of the attribute “type”. Every teletext line is exported in a separate node “line” and the attribute “number” defined the teletext line number.

The content type “text” contains only text. All teletext control characters are replaced by spaces.

The content type “all” contains text and all teletext control characters. Teletext control characters with codes from 0 to 31 are replaced by keywords within {}.

The content type “structured” contains text and all necessary information regarding the representation of the text for every character. Every “line” node contains one or more “run” nodes. Every “run” node shall be displayed using the same foreground and background color. The following attributes are used in “run” nodes:

• bg contains the name of the background color
• fg contains the name of the foreground color
• length contains the number of characters that shall be displayed for this run
• charcode contains the hex number of the teletext character code used in the text of this run. This attribute is only present for characters with a graphic color (colors starting with g). Please check the teletext specification for a table of graphic characters.

The text within the “run” node is the text that shall be displayed using the specified background and foreground color.

The colors starting with the character g are teletext graphic colors. Special teletext symbols are defined for display in the teletext specification.

Response

200 OK on success

Response contains a JSON or XML document with the teletext page data.

Example files:

• 100.json
• 100.xml

404 Not Found if page does not match a teletext page, if there was an error reading the page or if page or format is invalid

cURL example

Parts of the response examples are removed (“…”) for brevity. See example files above for full responses.

XML

curl -XGET "https://external.api.yle.fi/v1/teletext/pages/100.xml?app_id=YOUR_APP_ID&app_key=YOUR_APP_KEY"

<teletext network="YLE" xml:space="preserve">
  <page number="100" name="Uutiset" time="2020-05-05T10:43:26" subpagecount="4" nextpg="101" toptype="Block" animated="yes">
    <subpage number="1" time="8">.../subpage>
    <subpage number="2" time="8">...</subpage>
    <subpage number="3" time="8">...</subpage>
    <subpage number="4" time="8">...</subpage>
  </page>
</teletext>

JSON

curl -XGET "https://external.api.yle.fi/v1/teletext/pages/100.json?app_id=YOUR_APP_ID&app_key=YOUR_APP_KEY"

{
  "teletext": {
    "network": "YLE",
    "xml": "preserve",
    "page": {
      "number": "100",
      "name": "Uutiset",
      "time": "2020-05-05T10:43:26",
      "subpagecount": "4",
      "nextpg": "101",
      "toptype": "Block",
      "animated": "yes",
      "subpage": [
        {
        "number": "1",
        "time": "8",
        "content": [...]
        },{
        "number": "2",
        "time": "8",
        "content": [...]
        },{
        "number": "3",
        "time": "8",
        "content": [...]
        },{
        "number": "4",
        "time": "8",
        "content": [...]
        }
      ]
    }
  }
}

Returns teletext page as a PNG image. E.g. /v1/teletext/images/100/1.png

Parameters

Response

200 OK on success

Response contains a PNG image of the requested teletext page.

PNG image data, 720 x 456, 8-bit colormap, non-interlaced

404 Not Found if page or subpage does not match a teletext page, if there was an error reading the page, or if page or subpage is invalid

cURL example

curl -XGET \
"https://external.api.yle.fi/v1/teletext/images/100/1.png?app_id=YOUR_APP_ID&app_key=YOUR_APP_KEY" \
-o 100-1.png