Schedule EPG (Legacy)

Table of Contents

• Schedule EPG API V3 Overview
• API OAuth Authentication
• API Query Parameters
• XML Metadata Fields
• JSON Metadata Fields

Schedule EPG API V3 Overview

The schedule EPG API endpoint provides both schedule and program metadata in the same location. Schedule EPG supports both XML and JSON outputs. 

• OAuth Authentication:
  • To access the Schedule API, Partners must first authenticate into Wurl’s OAuth API to receive an access token which expires in 1 hour
• Output Formats:
  • Schedule EPG data can be formatted as .XML or .JSON. The EPG delivers standard metadata depending on the formatting option chosen, listed in detail below on this page .
• Time Zone Offsets:
  • Schedule EPG is provided in 0 UTC time zone and cannot be offset. If a Channel partner prefers their stream to be delivered in a different time zone from 0 UTC, the Streamer must offset the Schedule EPG’s time zone.
• Daily Update Time:
  • Schedule EPG is updated once daily at 00:00 UTC. 
• Days of Data:
  • The Schedule API endpoint provides 7 days of data forward from tomorrow by default. The API can also be queried by day, and by number of days up to 14 days.
• Backup Metadata: 
  • For certain program fields such as program thumbnails, the EPG sends backup metadata derived from the channel if a Content Company doesn’t provide metadata at the program level.

API OAuth Authentication

Each Wurl partner who ingests Schedule EPG is provided with a unique EPG App UID & Secret at the time of integration. These credentials are used to request the authentication tokens required to access individual channel schedule APIs.

Authentication Instructions

1. Using your EPG App's unique UID & Secret, request a token from the Wurl OAuth API

Request a token from the Wurl authentication provider: https://auth.wurl.com/oauth2/token

Your EPG APP UID and Secret should be added to the request Headers, as follows:

The OAuth API will return a Bearer Token that expires in 3600s (1 Hour). The response is formatted as follows:

2. Pass the token in the header of your request to the Schedule API

Pass this OAuth token in the header of your request to access the Schedule EPG API data for all channels. The same token may be used to access all channel-specific Schedule APIs that are requested before the token expires (1 hour).

A properly formatted request will return the channel's Schedule EPG data in the format requested.

API Query Parameters

API endpoint will provide the following parameters to allow support for format and dates. Below are the methods to which a Streamer can query the API:

Base URL 

• wurl_channel_slug (required)
  • Required - Unique identifier for the channel, provided by Wurl.
• format (required)
  • Required - Defines the EPG output format. Options are json (json) or tivo (xml)
• date (optional)
  • Can be added to grab data for a specific date. The input format is  <YYYY-MM-DD>.
  • If not included, the API will provide tomorrow + 7 days of EPG data.
• num_days (optional) 
  • Sets the numbers of days of schedule data to be returned by the API, from 1 to 14.
  • When combined with the date parameter, the API will return data for that date + the specified num_days.

Schedule XML Metadata Fields

Schedule JSON Metadata Fields