Skip to content

FAST catalog Specification

Specification

Field Type Description Required
channel Channel[] Yes
metadata Metadata[] Yes

Channel type

Field Type Description Required
countries string[] List of countries where the FAST channel is available at. Yes
descriptions Description[] Localized descriptions of the channel.
genre string[] Channel genre list. Yes
id string Uniquely identifies the channel. Immutable value. Yes
images ChannelImage[]
monetization_type enum It is always ads. Yes
order number Channel order on the lineup. Yes
titles Title[] For channels, we only include the US version of the title. Yes
url string Public page URL that forwards to channel playback. Yes

ChannelImage type

Field Type Description Required
height number Height in pixels
language string Image language in ISO 639-1 format. Can be undefined if the language is neutral.
type enum Can either be clearLogo or art (horizontal) Yes
url string URL to the image resource Yes
width number Width in pixels

Metadata type

Field Type Description Required
availabilities Availability[] Airings information for this metadata. Includes airings across several channels. Yes
credits Credit[] Cast and crew.
descriptions Description[] Localized summaries of the content.
external_ids ExternalID[] External IDs that the partner may choose to be shared with to better match content.
genre string[] Genre list.
id string Uniquely identifies the content. Immutable value. Yes
images Image[]
ratings Rating[] List of ratings by rating systems.
release_date string Date in ISO 8601 format (only date segment) Yes
runtime number Duration of the content, in minutes.
series_info SeriesInfo This field is populated when the metadata belongs to a season or episode.
titles Title[] Localized titles of the content. Yes
type enum Type of the metadata object. Can either be movie, show, season or episode. Yes

Availability type

Field Type Description Required
available_ending string Date in ISO 8601 format (including time). Yes
available_starting string Date in ISO 8601 format (including time). Yes
channel_id string ID of the channel this airing belongs to. Yes
delivery_method enum Always live for FAST catalogs. Yes
monetization_type enum It is always ads. Yes

Credit type

Field Type Description Required
person_image string URL to the person's image
person_name string Yes
role string Role that the person performs in the title.
type enum Can either be actor or director. Yes

Description type

Field Type Description Required
country string Country of the description, in ISO 3166-1 alpha-2 code. Yes
description string Description of the content in the language specified in language field. Yes
language string Description language in ISO 639-1 format. This can be undefined. Yes

ExternalID type

Field Type Description Required
id string Identifier of the content according to the source specified in type. Yes
type string Source of the identifier. Can either be gracenote, imdb or tmdb. Yes

Image type

Field Type Description Required
height number Height in pixels
language string Image language in ISO 639-1 format. Can be undefined if the language is neutral.
type enum Can either be coverPoster (vertical) or coverArt (horizontal) Yes
url string URL to the image resource Yes
width number Width in pixels

Rating type

Field Type Description Required
country string Country of the rating, in ISO 3166-1 alpha-2 code. Yes
rating string Rating value. Yes
rating_body string Code of the rating system. For instance, for US this value is MPAA. Yes

SeriesInfo type

Field Type Description Required
episode_number number Episode order. This field is only defined on a season.
number_of_episodes number Number of episodes in a season. This field is only defined on a season and episode.
season_id string ID of the season an episode belongs to.
season_number number Season order. This field is only defined on a season.
show_id string ID of the show an episode or season belongs to. Yes for season and episode

Title type

Field Type Description Required
country string Country of the title, in ISO 3166-1 alpha-2 code. Yes
language string Title language in ISO 639-1 format. This can be undefined.
title string Title of the content in the language specified in language field. Yes

Examples

Channel example

{
  "countries": [
    "GB" //(1)!
  ],
  "descriptions": [
    {
      "description": "My Binge Channel, satisfy your TV craving!",
      "language": "en"
    }
  ],
  "genres": [
    "Action"
  ],
  "id": "6196c76e1d310bf925e02614",
  "images": [
    {
      "type": "clearLogo",
      "url": "https://provider-static.plex.tv/epg/cms/production/1642abf1-1056-4a27-a7be-3e2d9fe3697e/MyBingeChannel_logo_LIGHTRDX.png",
      "height": 1000,
      "width": 1500
    },
    {
      "type": "art",
      "url": "https://provider-static.plex.tv/epg/cms/production/252ee8d6-d281-406b-8d36-5eaa1698828b/MyBingeChannel_artwork_HOR_RDX_FINAL.jpg",
      "height": 1080,
      "width": 1920
    }
  ],
  "monetization_type": "ads",
  "order": 895,
  "titles": [
    {
      "country": "US",
      "title": "My Binge Channel"
    }
  ],
  //(2)!
  "url": "https://watch.plex.tv/live-tv/channel/my-binge-channel?autoplay=1&utm_content=6196c76e1d310bf925e02614&utm_medium=deeplink&utm_source=plex-v2-linear-catalog"
},
  1. The channel only works in Great Britain.
  2. This URL takes directly to the playback page.

Metadata example

{
  "availabilities": [
    //(1)!
    {
      "available_ending": "2024-03-03T08:47:07.000Z",
      "available_starting": "2024-03-03T07:01:28.000Z",
      "channel_id": "61a94815f6575693e6392561",
      "delivery_method": "live",
      "monetization_type": "ads"
    },
    {
      "available_ending": "2024-03-07T11:17:07.000Z",
      "available_starting": "2024-03-07T10:31:28.000Z",
      "channel_id": "65ce8c17d0a4e397276614cd",
      "delivery_method": "live",
      "monetization_type": "ads"
    }
  ],
  "credits": [
    {
      "person_image": "https://metadata-static.plex.tv/d/people/d14adc31bed31e2b370a6e459575849e.jpg",
      "person_name": "Joanna Kerns",
      "role": "Kathy Plunk",
      "type": "actor"
    },
    {
      "person_image": "https://metadata-static.plex.tv/people/5d7768322e80df001ebdde60.jpg",
      "person_name": "Barry Bostwick",
      "role": "Paul Plunk",
      "type": "actor"
    },
    {
      "person_image": "https://metadata-static.plex.tv/5/people/5f79c0b97d988f8a012cd91f2f3efcfe.jpg",
      "person_name": "Chad Lowe",
      "role": "Jeff Frost",
      "type": "actor"
    },
    {
      "person_image": "https://metadata-static.plex.tv/7/people/78b724ac7f9c9fae0f51e9dd957b0231.jpg",
      "person_name": "John Stamos",
      "role": "Robert Knotts",
      "type": "actor"
    },
    {
      "person_image": "https://metadata-static.plex.tv/2/people/2c1e7949b707655947097e84d1ae4a46.jpg",
      "person_name": "Don S. Davis",
      "role": "Deputy Mack",
      "type": "actor"
    },
    {
      "person_image": "https://metadata-static.plex.tv/people/5d7768258718ba001e3118f9.jpg",
      "person_name": "Patricia Charbonneau",
      "role": "Karen",
      "type": "actor"
    },
    {
      "person_name": "Ted Stidder",
      "role": "Rudy Bruger",
      "type": "actor"
    },
    {
      "person_name": "Florence Paterson",
      "role": "Hilda Bruger",
      "type": "actor"
    },
    {
      "person_image": "https://metadata-static.plex.tv/4/people/4483900e670e98aa018f5bf49b656e1c.jpg",
      "person_name": "Timothy Webber",
      "role": "Harry Jordon",
      "type": "actor"
    },
    {
      "person_name": "Michael Tuchner",
      "role": "director",
      "type": "director"
    }
  ],
  "descriptions": [
    {
      "description": "In order to escape hectic city life, a young couple moves to Oregon where they buy and operate a small hotel. Their world is shattered when two criminals kidnap and terrorize them. Based on a true story.",
      "language": "en"
    }
  ],
  "genres": [],
  "id": "5d776bb69ab544002150ea38",
  "images": [
    {
      "language": "en",
      "type": "coverPoster",
      "url": "https://metadata-static.plex.tv/3/gracenote/3ffd008114a3a72cb70b72529500cd49.jpg"
    }
  ],
  "ratings": [
    {
      "country": "US",
      "rating": "TV-14",
      "rating_body": "USA Parental Rating"
    }
  ],
  "release_date": "1991-10-13",
  "runtime": 105,
  "titles": [
    {
      "country": "US",
      "title": "Captive"
    }
  ],
  "type": "movie"
}
  1. Airings can come from multiple channels for this specific movie, as we can see in this example.