API Explorer

• Online Video Methods

  • List Methods
  • Expand Methods

  • GET Single Episode Information v2/episodes/:id.xml
    Obtain single episode information (for example, tmsId=EP000002040014)

    Parameter	Value	Type	Description
    :id		string	rootId or tmsId of episode

  • GET Multiple Episode Information v2/episodes.xml
    Obtain multiple episode information (for example, EP005000800081,EP005000800083)

    Parameter	Value	Type	Description
    episode_id		string	The episode IDs (rootId or tmsId) separated by commas

  • GET Series v2/series/:seriesId.xml
    Obtain series information (for example, seriesId=185554)

    Parameter	Value	Type	Description
    :seriesId		string	The rootId or tmsId of TV series

  • GET Movies v2/movies/:id.xml
    Obtain movie information (for example, rootId=17420)

    Parameter	Value	Type	Description
    :id		string	rootId or tmsId of movie

• Online Social Methods

  • List Methods
  • Expand Methods

  • GET Movie/Series Information social/:id.xml
    Obtain links for a single movie or TV series. Note that this method uses rootIds or seriesIds only (for example, movie rootId=9287010).

    Parameter	Value	Type	Description
    :id		string	rootId of movie, or seriesId of TV show

• Public Plan Methods

  • List Methods
  • Expand Methods

  • GET Movies Playing in Local Theatres v1/movies/showings
    Returns a list of all movies currently playing in local theatres, with showtimes.

    Parameter	Value	Type	Description
    startDate		date	Start date (yyyy-mm-dd). Schedules available starting with current day.
    numDays		string	Number of schedule days. Defaults to 1.
    zip		string	US zip code or Canadian postal code. Must supply either zip or coordinates.
    lat		string	Latitude coordinate. Valid values are between -90 and 90. Must supply either zip or coordinates.
    lng		string	Longitude coordinate. Valid values are between -180 and 180. Must supply either zip or coordinates.
    radius		string	Range to search from initial location. Defaults to 5 miles. Maximum 100 mi (160 km).
    units	mi km	string	Unit of measurement for the radius parameter as well as the distance value in response. Defaults to miles.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)

  • GET New Shows Airing on TV v1/programs/newShowAirings
    Return all shows and episodes and associated metadata airing new (or live) on a lineup for a given time period up to 24 hours in length and up to 14 days in advance.

    Parameter	Value	Type	Description
    lineupId		string	Lineup ID
    startDateTime		datetime	Date/Time to start from (ISO 8601).
    endDateTime		datetime	Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours.
    includeAdult	true false	boolean	Boolean indicating whether to include adult TV shows in response. Defaults to false.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)
    imageAspectTV	2x3 3x4 4x3	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.

  • GET Airings of Sports Events v1/sports/sportsId/events/airings
    Returns live sports events and associated metadata for a list of sports that are airing on a lineup for a given time period up to 24 hours in length and up to 14 days in advance.

    Parameter	Value	Type	Description
    sportsId		string	A comma-separated list of sports genre ids (e.g., 58 for baseball, 59 for basketball) or 'all' to return airings for all sports.
    lineupId		string	Lineup ID
    startDateTime		datetime	Date/Time to start from (ISO 8601).
    endDateTime		datetime	Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours.
    liveOnly	true false	boolean	Boolean indicating whether to only include live events. Defaults to false.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)
    imageAspectTV	2x3 3x4 4x3	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.

  • GET Movies Airing on TV v1/movies/airings
    Return movies and associated metadata that are airing on a lineup for a given time period up to 24 hours in length and up to 14 days in advance.

    Parameter	Value	Type	Description
    lineupId		string	Lineup ID
    startDateTime		datetime	Date/Time to start from (ISO 8601).
    endDateTime		datetime	Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours.
    includeAdult	true false	boolean	Boolean indicating whether to include adult TV shows in response. Defaults to false.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)

• Lineups

  • List Methods
  • Expand Methods

  • GET Find Lineups v1/lineups
    Returns a list of lineups for a given Zip/Postal code.

    Parameter	Value	Type	Description
    postalCode		string	Postal Code
    country	USA CAN	string	Country: USA or CAN. Defaults to USA.

  • GET Lineup Details v1/lineups/lineupId
    Returns details for a given lineup. *Available with R&D/Commercial plans only.

    Parameter	Value	Type	Description
    lineupId		string	Lineup ID

  • GET Lineup Channel List v1/lineups/lineupId/channels
    Returns a list of stations and channel positions associated with the lineup provided.

    Parameter	Value	Type	Description
    lineupId		string	Lineup ID
    imageSize	Sm Md Lg Ms	enumerated	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)

  • GET Lineup Airings (TV Grid) v1/lineups/lineupId/grid
    Returns schedule airing and associated program metadata for a lineup to be contained within a TV grid. Allows for up to 6 hours of schedule metadata for a given date up to 14 days in advance.

    Parameter	Value	Type	Description
    lineupId		string	Lineup ID
    stationId		string	Station ID. Multiple stations accepted, comma-separated.
    startDateTime		datetime	Date/Time to start from (ISO 8601)
    endDateTime		datetime	Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours.
    size	Basic Detailed	enumerated	Amount of program metadata to be returned in TV grid. The default value is Detailed. For smaller response size, use Basic.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)
    imageAspectTV	2x3 3x4 4x3	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.

• Stations

  • List Methods
  • Expand Methods

  • GET Station Details v1/stations/stationId
    Returns details for a single station. *Available with R&D/Commercial plans only.

    Parameter	Value	Type	Description
    stationId		string	Station ID
    lineupId		string	Lineup ID. If not provided, channel numbers will not be included in the response.

  • GET Station Airings v1/stations/stationId/airings
    Returns airings schedule and associated program metadata for a single station for a given time period over the next 14 days.

    Parameter	Value	Type	Description
    stationId		string	Station ID
    lineupId		string	Lineup ID. If not provided, channel numbers will not be included in the response.
    startDateTime		datetime	Date/Time to start from (ISO 8601).
    endDateTime		datetime	Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)
    imageAspectTV	2x3 3x4 4x3	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.

• Programs

  • List Methods
  • Expand Methods

  • GET Program Search v1/programs/search
    Returns basic program metatdata based on free-form search criteria.

    Parameter	Value	Type	Description
    q		string	Query string. Wildcards and boolean operators allowed.
    queryFields		string	Comma-separated list of fields in which the search string is queried against. Valid fields are title, description, cast, genres, directors and keywords. Do not include spaces in list.
    entityType		string	Comma-separated list of program types to search. Valid values are movie, series, episode, sports, show. Do not include spaces in list.
    genres		string	Filter results by the specified comma-separated list of genres. See Program Genres method for available genres.
    includeAdult	true false	boolean	Boolean indicating whether to include programs with 'Adults Only' genre in response. Defaults to false.
    titleLang	en es en-GB pt-BR	string	Filter results based on the specified title language (e.g., en=English, es=Spanish, en-GB=British English, pt-BR=Brazilian Portugese)
    descriptionLang	en es en-GB pt-BR	string	Filter results based on the specified description language (e.g., en=English, es=Spanish, en-GB=British English, pt-BR=Brazilian Portugese)
    limit		string	The maximum number of results to be returned from the query. Valid values are between 1 and 50. Default is 10.
    offset		string	Zero-based offset index on the result set. Used in conjunction with limit to page through results. For example, offset=10 will set response data to begin with 11th hit.
    lineupId		string	Lineup ID. If specified, response will include only programs found in the schedule and list their airings under each program summary. If not specified, all programs matching the query will be returned, and no airings will be listed.
    startDateTime		string	Date/Time to start from (ISO 8601). Defaults to start of current hour. Only used when lineupId is specified. Example: 2013-03-05T22:00Z
    endDateTime		string	Date/Time to end on (ISO 8601). If not specified, airings will be shown chronologically from the startDateTime, up to the maximum of 50 per program. Only used when lineupId is specified.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)
    imageAspectTV	2x3 3x4 4x3	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.

  • GET Program Details v1/programs/tmsId
    Returns detailed metadata for any TMS program ID (Movie, Show, Episode, or Sports).

    Parameter	Value	Type	Description
    tmsId		string	TMS ID
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)
    imageAspectTV	2x3 3x4 4x3	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.

  • GET Program Airings v1/programs/tmsId/airings
    Returns all airings of a specific program for a given lineup and time period up to 14 days in advance.

    Parameter	Value	Type	Description
    tmsId		string	TMS ID
    lineupId		string	Lineup ID
    startDateTime		datetime	Date/Time to start from (ISO 8601).
    endDateTime		datetime	Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours.
    includeDetail	true false	boolean	Boolean indicating whether to include detailed program metadata with each airing. Defaults to false.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)
    imageAspectTV	2x3 3x4 4x3	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.

  • GET New Shows Airing on TV v1/programs/newShowAirings
    Returns all shows and episodes and associated metadata airing new (or live) on a lineup for a given time period up to 24 hours in length and up to 14 days in advance.

    Parameter	Value	Type	Description
    lineupId		string	Lineup ID
    startDateTime		datetime	Date/Time to start from (ISO 8601).
    endDateTime		datetime	Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours.
    includeAdult	true false	boolean	Boolean indicating whether to include adult TV shows in response. Defaults to false.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)
    imageAspectTV	2x3 3x4 4x3	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.

  • GET New Shows that Aired in Last Week v1/programs/newShowsLastWeek
    Returns all shows and episodes and associated metadata that aired new (or live) for given past dates up to 7 days. *Available with R&D/Commercial plans only.

    Parameter	Value	Type	Description
    startDate		date	Date to start (yyyy-mm-dd).
    endDate		date	Date to end (yyyy-mm-dd). Defaults to startDate.
    includeAdult	true false	boolean	Boolean indicating whether to include adult TV shows in response. Defaults to false.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)
    imageAspectTV	2x3 3x4 4x3	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.

  • GET Advance Planner v1/programs/advancePlanner
    Returns a list of notable TV programming and associated metadata due to air at future date. *Available with R&D/Commercial plans only.

    Parameter	Value	Type	Description
    startDate		date	Date to start (yyyy-mm-dd).
    endDate		date	Date to end (yyyy-mm-dd). Defaults to 31 days after startDate.
    eventCode	1- Holiday Special 2- Network Premiere of Movie on TV 3- Notable Episode 4- Returning with New Episodes 5- Season Premiere 6- Season Finale 7- Series Premiere 8- Series Finale 9- Special 10-Sporting Event 11-TV Movie Premiere	string	Comma-separated list corresponding to selected event type codes. Default will return all types.
    imageSize	Sm Md Lg Ms	string	Size of the images to be returned. If not specified, images in all available sizes will be returned.
    imageAspectTV	2x3 3x4 4x3	string	Aspect ratio of the images to be returned. Only applies to TV content. If not specified, images in all available aspect ratios will be returned.

  • GET All Program Images v1/programs/resourceId/images
    Returns all available images associated with a program. *Available with R&D/Commercial plans only.

    Parameter	Value	Type	Description
    resourceId		string	tmsId or rootId for program
    imageSize	Sm Md Lg Ms	string	If specified, only images in selected size will be included. Default will return all available image sizes.
    imageAspectTV	2x3 3x4 4x3	string	If specified, only images in selected aspect ratio will be included. Only applies to TV content. Default will return images in all available aspect ratios.

  • GET Program Genres v1/programs/genres
    Returns a list of program genres, to be used in conjunction with Program Search.

• Series

  • List Methods
  • Expand Methods

  • GET Series Details v1/series/seriesId
    Returns detailed metadata for a given series.

    Parameter	Value	Type	Description
    seriesId		string	Series ID
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)
    imageAspectTV	2x3 3x4 4x3	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.

  • GET Series Airings v1/series/seriesId/airings
    Returns all airings of a series for a given lineup and time period up to 14 days in advance.

    Parameter	Value	Type	Description
    seriesId		string	Series ID
    lineupId		string	Lineup ID
    startDateTime		datetime	Date/Time to start from (ISO 8601).
    endDateTime		datetime	Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours.
    includeDetail	true false	boolean	Boolean indicating whether to include detailed program metadata with each airing. Defaults to false.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)
    imageAspectTV	2x3 3x4 4x3	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.

  • GET Series Episodes v1/series/seriesId/episodes
    Returns all episodes of a series, sorted by season and episode numbers.

    Parameter	Value	Type	Description
    seriesId		string	Series ID
    season		string	Season number. If not specified, will return episodes from all seasons.
    size	Basic Detailed	enumerated	Amount of program metadata to be returned for episodes. The default value is Detailed. For smaller response size, use Basic.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)
    imageAspectTV	2x3 3x4 4x3	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.

• Movies on TV

  • List Methods
  • Expand Methods

  • GET Movie Versions v1/movies/rootId/versions
    Returns all versions of a given movie. *Available with R&D/Commercial plans only.

    Parameter	Value	Type	Description
    rootId		string	Movie Root ID
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)

  • GET Movie Airings v1/movies/rootId/airings
    Returns all airings of a movie for a given lineup and time period up to 14 days in advance.

    Parameter	Value	Type	Description
    rootId		string	Movie Root ID
    lineupId		string	Lineup ID
    startDateTime		datetime	Date/Time to start from (ISO 8601).
    endDateTime		datetime	Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours.
    includeDetail	true false	boolean	Boolean indicating whether to include detailed movie metadata with each airing. Defaults to false.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)

  • GET All Movies Airing on TV v1/movies/airings
    Returns movies and associated metadata that are airing on a lineup for a given time period up to 24 hours in length and up to 14 days in advance.

    Parameter	Value	Type	Description
    lineupId		string	Lineup ID
    startDateTime		datetime	Date/Time to start from (ISO 8601).
    endDateTime		datetime	Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours.
    includeAdult	true false	boolean	Boolean indicating whether to include adult TV shows in response. Defaults to false.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)

• Movies in Theatres

  • List Methods
  • Expand Methods

  • GET Find Theatres v1/theatres
    Returns a list of theatres for a given zip/postal code or coordinates.

    Parameter	Value	Type	Description
    zip		string	US zip code or Canadian postal code. Must supply either zip or coordinates.
    lat		string	Latitude coordinate. Valid values are between -90 and 90. Must supply either zip or coordinates.
    lng		string	Longitude coordinate. Valid values are between -180 and 180. Must supply either zip or coordinates.
    radius		string	Range to search from initial location. Defaults to 5 miles. Maximum 100 mi (160 km).
    units	mi km	string	Unit of measurement for the radius parameter as well as the distance value in response. Defaults to miles.
    numTheatres		string	Maximum number of theatres to return. If not specified, response will include all theatres within specified radius.

  • GET Theatre Details v1/theatres/theatreId
    Returns details for a specified theatre. *Available with R&D/Commercial plans only.

    Parameter	Value	Type	Description
    theatreId		string	Theatre ID.

  • GET Theatre Showtimes v1/theatres/theatreId/showings
    Returns a list of all movies and showtimes at a theatre for a given day(s).

    Parameter	Value	Type	Description
    theatreId		date	Theatre ID.
    startDate		date	Start date (yyyy-mm-dd). Schedules available starting with current day.
    numDays		string	Number of schedule days. Defaults to 1.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)

  • GET Movie Showtimes (single movie) v1/movies/movieId/showings
    Returns movie metadata and theatre/showtimes information for a specified movie.

    Parameter	Value	Type	Description
    movieId		date	tmsId or rootId.
    startDate		date	Start date (yyyy-mm-dd). Schedules available starting with current day.
    numDays		string	Number of schedule days. Defaults to 1.
    zip		string	US zip code or Canadian postal code. Must supply either zip or coordinates.
    lat		string	Latitude coordinate. Valid values are between -90 and 90. Must supply either zip or coordinates.
    lng		string	Longitude coordinate. Valid values are between -180 and 180. Must supply either zip or coordinates.
    radius		string	Range to search from initial location. Defaults to 5 miles. Maximum 100 mi (160 km).
    units	mi km	string	Unit of measurement for the radius parameter as well as the distance value in response. Defaults to miles.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)

  • GET Movies Playing in Local Theatres v1/movies/showings
    Returns a list of all movies currently playing in local theatres, with showtimes.

    Parameter	Value	Type	Description
    startDate		date	Start date (yyyy-mm-dd). Schedules available starting with current day.
    numDays		string	Number of schedule days. Defaults to 1.
    zip		string	US zip code or Canadian postal code. Must supply either zip or coordinates.
    lat		string	Latitude coordinate. Valid values are between -90 and 90. Must supply either zip or coordinates.
    lng		string	Longitude coordinate. Valid values are between -180 and 180. Must supply either zip or coordinates.
    radius		string	Range to search from initial location. Defaults to 5 miles. Maximum 100 mi (160 km).
    units	mi km	string	Unit of measurement for the radius parameter as well as the distance value in response. Defaults to miles.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)

  • GET Future Releases v1/movies/futureReleases
    Returns a list of movies and associated metadata being released on a given date provided and up to 6 months into the future. *Available with R&D/Commercial plans only.

    Parameter	Value	Type	Description
    releaseDate		date	Start date (yyyy-mm-dd). Can be up to 7 days prior to current date.
    numDays		string	Number of days to search. Defaults to 60. Maximum 180.
    country		string	Returns releases for specified country (USA or CAN). Defaults to USA.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)

  • GET ScreenPlay Trailers v1/screenplayTrailers
    Returns movie trailer metadata for one or more assets, with option for embeddable player links. A ScreenPlay customer agreement is required for production use.

    Parameter	Value	Type	Description
    rootids		date	Comma-separated list of movie rootIds.
    bitrateids	10 - 300k Windows Media Stream (320 x 240) 214 - 700k Windows Media Stream (480 x 360) 267 - JPEG Thumbnail Image (250 x 200) 268 - JPEG Thumbnail Image (150 x 120) 269 - JPEG Thumbnail Image (112 x 90) 270 - JPEG Thumbnail Image (75 x 60) 308 - 300k Flash V8 Progressive Download (320 x 240) 310 - 700k Flash V8 Progressive Download (480 x 360) 312 - 300k Flash V8 Progressive Download (320 x 180) 314 - 700k Flash V8 Progressive Download (480 x 270) 382 - JPEG Thumbnail Image (480 x 360) 449 - h.264 2.3Mbps mp4 HD Widescreen (1280 x 720) 452 - h.264 300k mp4 Fullscreen (320 x 240) 455 - h.264 700k mp4 Fullscreen (480 x 360) 456 - h.264 112k 3gp Fullscreen (176 x 132) 457 - h.264 300k mp4 Widescreen (320 x 180) 460 - h.264 112k 3gp Widescreen (176 x100) 461 - h.264 700k mp4 Widescreen (480 x 270) 471 - h.264 1mbps mp4 Fullscreen (640 x 480) 472 - h.264 1mbps mp4 Widescreen (640 x 360)	string	Comma-separated list of one or more encode bitrates. If omitted, all encode bitrates available per customer agreement will be returned.
    trailersonly	0 1	string	Filter by video asset type. 0 (default) returns trailers and extras. 1 returns trailers only.
    languageid		string	Return trailers in specified language only. Defaults to English. See documentation for Screenplay language codes.
    player_url	0 1	string	0 (default) returns bounce links, which require developer to supply appropriate player for format. 1 returns embeddable player links.
    best_eclip	0 1	string	0 (default) returns all video assets for each rootId. 1 returns most recent trailer asset.

• Sports

  • List Methods
  • Expand Methods

  • GET Sports with Optional Organizations v1/sports/sportsId
    Returns all (or specified) sports with associated organizations.

    Parameter	Value	Type	Description
    sportsId		string	A comma-separated list of sports genre ids (e.g., "59" for Basketball) or 'all' for all sports.
    includeOrg	true false	boolean	Boolean indicating whether to include organization metadata. Defaults to false.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)

  • GET Airings of Sports Events v1/sports/sportsId/events/airings
    Returns live sports events and associated metadata for a list of sports that are airing on a lineup for a given time period up to 24 hours in length and up to 14 days in advance.

    Parameter	Value	Type	Description
    sportsId		string	A comma-separated list of sports genre ids (e.g., 58 for baseball, 59 for basketball) or 'all' to return airings for all sports.
    lineupId		string	Lineup ID
    startDateTime		datetime	Date/Time to start from (ISO 8601).
    endDateTime		datetime	Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours.
    liveOnly	true false	boolean	Boolean indicating whether to only include live events. Defaults to false.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)
    imageAspectTV	2x3 3x4 4x3	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.

  • GET Airings of Sports Non-Events v1/sports/sportsId/non-events/airings
    Returns sports non-events (talk shows) and taped events (classic games, early morning replays, etc.) for a list of sports that are airing on a lineup for a given time period up to 24 hours in length and up to 14 days in advance.

    Parameter	Value	Type	Description
    sportsId		string	A comma-separated list of sports genre ids (e.g., 58 for baseball, 59 for basketball) or 'all' to return airings for all sports.
    lineupId		string	Lineup ID
    startDateTime		datetime	Date/Time to start from (ISO 8601).
    endDateTime		datetime	Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)
    imageAspectTV	2x3 3x4 4x3	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.

  • GET All Universities v1/sports/universities
    Returns a list of all universities.

    Parameter	Value	Type	Description
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)

  • GET Teams in an Organization v1/sports/organizations/organizationId
    Returns a list of all teams associated with specified organizations. *Available with R&D/Commercial plans only.

    Parameter	Value	Type	Description
    organizationId		string	A comma-separated list of organization IDs (e.g., 17 for MLB, 19 for NBA)
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)

  • GET Teams at a University v1/sports/universities/universityId
    Returns a list of all teams associated with specified universities. *Available with R&D/Commercial plans only.

    Parameter	Value	Type	Description
    universityId		string	A comma-separated list of university IDs, or 'all' for entire list of universities and teams.
    includeTeam	true false	boolean	Boolean indicating whether to include organization metadata. Defaults to false.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)

  • GET Team Details v1/sports/teams/teamBrandId
    Returns details for a specified team. *Available with R&D/Commercial plans only.

    Parameter	Value	Type	Description
    teamBrandId		string	A comma-separated list of team IDs.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)

  • GET Team Airings v1/sports/teams/teamBrandId/airings
    Returns airings for specified teams. *Available with R&D/Commercial plans only.

    Parameter	Value	Type	Description
    teamBrandId		string	A comma-separated list of teamBrandIds to return airings.
    lineupId		string	Lineup ID
    startDateTime		datetime	Date/Time to start from (ISO 8601).
    endDateTime		datetime	Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours.
    includeDetail	true false	boolean	Boolean indicating whether to include detailed program metadata with each airing. Defaults to false.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)
    imageAspectTV	2x3 3x4 4x3	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.

  • GET Organization Airings v1/sports/organizations/organizationId/airings
    Returns airings for specified organizations (e.g., MLB, NBA, NFL).

    Parameter	Value	Type	Description
    organizationId		string	A comma-separated list of organizationIds to return airings (e.g., 17 for MLB, 19 for NBA)
    lineupId		string	Lineup ID
    startDateTime		datetime	Date/Time to start from (ISO 8601).
    endDateTime		datetime	Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours.
    includeDetail	true false	boolean	Boolean indicating whether to include detailed program metadata with each airing. Defaults to false.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)
    imageAspectTV	2x3 3x4 4x3	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.

• Celebrities

  • List Methods
  • Expand Methods

  • GET Celebrity Details v1/celebs/personId
    Returns details for a given celebrity.

    Parameter	Value	Type	Description
    personId		string	Person ID
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)

  • GET Airings of Celebrities v1/celebs/personId/airings
    Returns all airings of a given celebrity and given time period over the next 14 days.

    Parameter	Value	Type	Description
    personId		string	Person ID
    lineupId		string	Lineup ID
    startDateTime		datetime	Date/Time to start from (ISO 8601).
    endDateTime		datetime	Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)
    imageAspectTV	2x3 3x4 4x3	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.

  • GET Celebrities Appearing on Talk Shows by Day v1/celebs/talkShowAirings
    Returns a list of celebrities and associated metadata that are appearing on a talk show on a lineup for a given time period up to 24 hours in length and up to 14 days in advance. *Available with R&D/Commercial plans only.

    Parameter	Value	Type	Description
    lineupId		string	Lineup ID
    startDateTime		datetime	Date/Time to start from (ISO 8601).
    endDateTime		datetime	Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)
    imageAspectTV	2x3 3x4 4x3	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.

  • GET All Celebrity Images v1/celebs/personId/images
    Returns all available images associated with a celebrity. *Available with R&D/Commercial plans only.

    Parameter	Value	Type	Description
    personId		string	Person ID
    imageSize	Sm Md Lg Ms	string	If specified, only images in selected size will be included. Default will return all available image sizes.
    imageAspectTV	2x3 3x4 4x3	string	If specified, only images in selected aspect ratio will be included. Only applies to TV content. Default will return images in all available aspect ratios.