Skip to navigation
CLOUD PLAYOUT APISchedule and EPG

Get a channel's program guide

This endpoint returns a Cloud Playout channel’s program guide as XMLTV, the format television guides and players expect, so you can publish what is on to viewers.

How it works

  1. Make a GET request to this endpoint with the channelId and the channel’s type.

  2. The response is an XML document describing the channel and the programs in the window, with each program carrying its start and stop times.

  3. Set the window with startTime and endTime. Leave them out and FastPix picks a window around the present moment, inside the channel’s own start and end times.

When you send both startTime and endTime, the window cannot be longer than 14 days. The guide is returned in full, without pagination, and the number of programs in it is also returned in the X-Total-Count header.

Example

A broadcaster publishes tomorrow’s guide to its smart TV app by fetching the XMLTV document for that day.

Authentication

AuthorizationBasic

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request.

  • Username: Access Token ID
  • Password: Secret Key

Activate your FastPix account to generate your API credentials. See the guide here

Path parameters

channelIdstringRequiredformat: "uuid"
The unique identifier of the channel whose program guide is retrieved.

Query parameters

typeenumRequired
The type of the channel. It must match the channel's own type.
Allowed values:
startTimestringOptional

The start of the guide window, in yyyy-MM-dd'T'HH:mm:ss format and interpreted as UTC.

endTimestringOptional

The end of the guide window, in yyyy-MM-dd'T'HH:mm:ss format and interpreted as UTC. When both times are given, the window cannot be longer than 14 days.

Response

Programme guide retrieved successfully