API Explorer

OAuth 2.0 Flow: Select OAuth 2.0 Flow

Existing Client Credentials: Manual Input

API Key:

App/Key: Select Application Key Manually provide key information

Shared Secret:

Client ID:

Client Secret: Authorize

Client ID: Get Access Token

Client ID:

Client Secret:

---

Username:

Password: Get Access Token

Client ID:

Client Secret: Get Access Token

Authorization Code: Get Access Token

Access Token:

Secure Hash:

Username:

Password:

Username:

Binary Security Token:

Username:

Password:

• Public Plan Methods

  • List Methods
  • Expand Methods

  • GET Movies Playing in Local Theatres v1.1/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)
    imageText	true false	boolean	Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text).
    market		string	Outputs source provided imagery that is specific to a certain country, if available.

  • GET New Shows Airing on TV v1.1/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 16x9	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.
    imageText	true false	boolean	Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text).
    market		string	Outputs source provided imagery that is specific to a certain country, if available.

  • GET Airings of Sports Events v1.1/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 16x9	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.1/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)
    imageText	true false	boolean	Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text).

• Lineups

  • List Methods
  • Expand Methods

  • GET Find Lineups v1.1/lineups

    Returns a list of lineups for a country and postal code.

    Parameter	Value	Type	Description
    country	--North America-- USA (United States) CAN (Canada) --Asia-Pacific-- AUS (Australia) --Europe-- AUT (Austria) BEL (Belgium) CHE (Switzerland) DEU (Germany) DNK (Denmark) ESP (Spain) FIN (Finland) FRA (France) GBR (United Kingdom) IRL (Ireland) ITA (Italy) NLD (Netherlands) NOR (Norway) POL (Poland) SWE (Sweden) --Latin America-- ARG (Argentina) BLZ (Belize) BRA (Brazil) CHL (Chile) COL (Colombia) CRI (Costa Rica) ECU (Ecuador) GTM (Guatemala) GUY (Guyana) HND (Honduras) MEX (Mexico) PAN (Panama) PER (Peru) URY (Uruguay) VEN (Venezuela) --Caribbean-- AIA (Anguilla) ATG (Antigua/Barbuda) ABW (Aruba) BHS (Bahamas) BRB (Barbados) BMU (Bermuda) BES (Bonaire, Saba, St. Eustatius) VGB (British Virgin Islands) CYM (Cayman Islands) CUW (Curacao) DMA (Dominica) DOM (Dominican Republic) GRD (Grenada) JAM (Jamaica) PRI (Puerto Rico) MAF (Saint Martin) VCT (Saint Vincent/Grenadines) KNA (St. Kitts and Nevis) LCA (St. Lucia) TTO (Trinidad and Tobago) TCA (Turks and Caicos)	string	Country code. See here for list of countries currently available. If not specified, defaults to USA.
    postalCode		string	Postal Code. See International Lineups for more information.

  • GET Lineup Details v1.1/lineups/lineupId

    Returns details for a given lineup.

    Parameter	Value	Type	Description
    lineupId		string	Lineup ID

  • GET Lineup Channel List v1.1/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)
    enhancedCallSign	true false	boolean	Boolean indicating whether or not to include display-friendly call signs in the results. Defaults to false.

  • GET Lineup Airings (TV Grid) v1.1/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 DetailedNoImage	enumerated	Amount of program metadata to be returned in TV grid. The default value is Detailed. For smaller response size, use Basic or DetailedNoImage.
    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 16x9	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.
    imageText	true false	boolean	Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text).
    market		string	Outputs source provided imagery that is specific to a certain country, if available.
    excludeChannels		string	Optional comma-delimited list of channel types to exclude from grid. Valid values are: nonhd, music, ppv, adult, premium.
    enhancedCallSign	true false	boolean	Boolean indicating whether or not to include display-friendly call signs in the results. Defaults to false.

• Stations

  • List Methods
  • Expand Methods

  • GET Station Search v1.1/stations/search

    Returns TV Station metadata with text matching the given name or call sign.

    Parameter	Value	Type	Description
    q		string	Query string.
    queryFields		string	Comma-separated list of station fields to search. Valid values are callsign and name. Do not include spaces in list.
    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.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)

  • GET Station Details v1.1/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.
    imageSize	Sm Md	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium). Only small and medium logos available for stations.

  • GET Station Airings v1.1/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 16x9	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.
    imageText	true false	boolean	Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text).
    market		string	Outputs source provided imagery that is specific to a certain country, if available.

• Programs

  • List Methods
  • Expand Methods

  • GET Program Search v1.1/programs/search

    Returns basic program metatdata based on free-form search criteria.

    Parameter	Value	Type	Description
    q		string	Query string.
    queryFields		string	Comma-separated list of fields in which the search string is queried against. Valid fields are title, cast, genres, and directors. Do not include spaces in list.
    entityType		string	Comma-separated list of program types to search. Valid values are movie, 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.
    subType		string	Filter results by the specified program subType.
    includeAdult	true false	boolean	Boolean indicating whether to include programs with 'Adults Only' genre in response. Defaults to false.
    titleLang	da de en en-GB en-AU es fi fr fr-CA it nl no pt pt-BR sv	string	Filter results based on the specified title language (e.g., en=English, es=Spanish, en-GB=British English, en-AU=Australian English pt-BR=Brazilian Portugese)
    descriptionLang	da de en en-GB en-AU es fi fr fr-CA it nl no pt pt-BR sv	string	Filter results based on the specified description language, using IETF language tags.
    limit		string	The maximum number of results to be returned from the query. Valid values are between 1 and 50. Default is 50.
    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 16x9	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.
    imageText	true false	boolean	Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text).
    market		string	Outputs source provided imagery that is specific to a certain country, if available.

  • GET Program Details v1.1/programs/tmsId

    Returns detailed metadata for any program (Movie, Show, Episode, or Sports) referred to by a given TMS ID or TMS root ID.

    Parameter	Value	Type	Description
    tmsId		string	TMS ID or TMS 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)
    imageAspectTV	2x3 3x4 4x3 16x9	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.
    imageText	true false	boolean	Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text).
    market		string	Outputs source provided imagery that is specific to a certain country, if available.

  • GET Program Airings v1.1/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 16x9	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.
    imageText	true false	boolean	Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text).
    market		string	Outputs source provided imagery that is specific to a certain country, if available.

  • GET New Shows Airing on TV v1.1/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 16x9	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.
    imageText	true false	boolean	Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text).
    market		string	Outputs source provided imagery that is specific to a certain country, if available.

  • GET New Shows that Aired in Last Week v1.1/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 16x9	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.
    imageText	true false	boolean	Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text).
    market		string	Outputs source provided imagery that is specific to a certain country, if available.

  • GET Advance Planner v1.1/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.
    titleLang	da de en en-GB en-AU es fi fr fr-CA it nl no pt pt-BR sv	string	Filter results based on the specified title language (e.g., en=English, es=Spanish, en-GB=British English, pt-BR=Brazilian Portugese)
    descriptionLang	da de en en-GB en-AU es fi fr fr-CA it nl no pt pt-BR sv	string	Preference for description language to be returned. If specified descriptionLang not found for series, reverts to primary TMS ID for series.
    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 16x9	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.
    imageText	true false	boolean	Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text).
    market		string	Outputs source provided imagery that is specific to a certain country, if available.

  • GET All Program Images v1.1/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 16x9	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.
    imageText	true false	boolean	Boolean indicating filter for image types with or without text. If not specified, will return all image types.
    market		string	Outputs source provided imagery that is specific to a certain country, if available.

  • GET Program Genres v1.1/programs/genres

    Returns a list of program genres, to be used in conjunction with Program Search. Note: language parameter deprecated in v1.1.

• Series

  • List Methods
  • Expand Methods

  • GET Series Details v1.1/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 16x9	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.
    imageText	true false	boolean	Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text).
    market		string	Outputs source provided imagery that is specific to a certain country, if available.
    titleLang	da de en en-GB en-AU es fi fr fr-CA it nl no pt pt-BR sv	string	Filter results based on the specified title language (e.g., en=English, es=Spanish, en-GB=British English, pt-BR=Brazilian Portugese)
    descriptionLang	da de en en-GB en-AU es fi fr fr-CA it nl no pt pt-BR sv	string	Preference for description language to be returned. If specified descriptionLang not found for series, reverts to primary TMS ID for series.

  • GET Series Airings v1.1/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 16x9	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.
    imageText	true false	boolean	Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text).
    market		string	Outputs source provided imagery that is specific to a certain country, if available.
    descriptionLang	da de en en-GB en-AU es fi fr fr-CA it nl no pt pt-BR sv	string	Optional filter based on specified description language. If not specified, all series airings returned.

  • GET Series Episodes v1.1/series/seriesId/episodes

    Returns episodes of a series, sorted by season and episode numbers. If limit/offset parameters not provided, will return up to maximum of 100 episodes. If limit/offset parameters provided, response will be wrapped in object with hitCount (total number of episodes) for paging.

    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.
    limit		string	The maximum number of results to be returned from the query. Default is 100.
    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.
    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 16x9	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.
    imageText	true false	boolean	Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text).
    market		string	Outputs source provided imagery that is specific to a certain country, if available.
    titleLang	da de en en-GB en-AU es fi fr fr-CA it nl no pt pt-BR sv	string	Filter results based on the specified title language (e.g., en=English, es=Spanish, en-GB=British English, pt-BR=Brazilian Portugese)
    descriptionLang	da de en en-GB en-AU es fi fr fr-CA it nl no pt pt-BR sv	string	Set preference for description language to be returned. If specified descriptionLang not found for episode, reverts to primary TMS ID for episode.

• Movies on TV

  • List Methods
  • Expand Methods

  • GET Movie Versions v1.1/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)
    imageText	true false	boolean	Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text).
    market		string	Outputs source provided imagery that is specific to a certain country, if available.
    descriptionLang	da de en en-GB en-AU es fi fr fr-CA it nl no pt pt-BR sv	string	Filter results based on the specified description language. When not specified, returns English versions, or if no English descriptions available, returns versions with descriptionLang of primary TMS ID.

  • GET Movie Airings v1.1/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)
    imageText	true false	boolean	Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text).
    market		string	Outputs source provided imagery that is specific to a certain country, if available.
    descriptionLang	da de en en-GB en-AU es fi fr fr-CA it nl no pt pt-BR sv	string	Optional filter based on specified description language. If not specified, all airings of movie returned.

  • GET All Movies Airing on TV v1.1/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)
    imageText	true false	boolean	Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text).
    market		string	Outputs source provided imagery that is specific to a certain country, if available.
    descriptionLang	da de en en-GB en-AU es fi fr fr-CA it nl no pt pt-BR sv	string	Optional filter based on specified description language. If not specified, all movies airings returned.

• Movies in Theatres

  • List Methods
  • Expand Methods

  • GET Find Theatres v1.1/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 max 100 theatres within specified radius.

  • GET Theatre Details v1.1/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.1/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)
    imageText	true false	boolean	Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text).
    market		string	Outputs source provided imagery that is specific to a certain country, if available.

  • GET Movie Showtimes (single movie) v1.1/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)
    imageText	true false	boolean	Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text).
    market		string	Outputs source provided imagery that is specific to a certain country, if available.

  • GET Movies Playing in Local Theatres v1.1/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)
    imageText	true false	boolean	Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text).

  • GET Future Releases v1.1/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	USA CAN	string	Returns releases for specified country (USA or CAN). Defaults to USA.
    titleLang		string	Filter results based on the specified title language (e.g., en=English). If not specified, defaults to en.
    descriptionLang		string	Filter results based on the specified description language (e.g., es=Spanish). If not specified, defaults to en.
    imageSize	Sm Md Lg Ms	string	Size of the image referenced by the preferred image URI returned. The default value is Md (medium)
    imageText	true false	boolean	Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text).
    market		string	Outputs source provided imagery that is specific to a certain country, if available.

• Sports

  • List Methods
  • Expand Methods

  • GET Sports with Optional Organizations v1.1/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.
    officialOrg	true false	boolean	If true, results are filtered to include only official organizations. 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.1/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 16x9	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.1/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 16x9	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.1/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.1/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.1/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.1/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.1/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 16x9	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.
    market		string	Outputs source provided imagery that is specific to a certain country, if available.

  • GET Organization Airings v1.1/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 16x9	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.
    market		string	Outputs source provided imagery that is specific to a certain country, if available.

• Celebrities

  • List Methods
  • Expand Methods

  • GET Celebrity Details v1.1/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.1/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 16x9	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.
    market		string	Outputs source provided imagery that is specific to a certain country, if available.

  • GET Celebrities Appearing on Talk Shows by Day v1.1/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 16x9	string	Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3.
    market		string	Outputs source provided imagery that is specific to a certain country, if available.

  • GET All Celebrity Images v1.1/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 16x9	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.

• Online Video Methods

  • List Methods
  • Expand Methods

  • GET Single Episode Information v2/episodes/rootId_tmsId

    Obtain single episode information (for example tmsId=EP006883590220)

    Parameter	Value	Type	Description
    rootId_tmsId		string	rootId or tmsId of TV episode.
    region	AU BR CA FR DE IT MX ES SE UK	string	While the API will try to automatically detect the host region based on the description language of the provided TMS ID there is also an option to add a region parameter to any OVD OnConnect query. Using this region parameter will ensure that an API request returns content matches for the desired region. To be used only with TMS ID (alphanumeric, beginning with 'SH', 'MV', 'EP'). If not specified defaults to US.

  • 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 (rootIds or tmsIds) separated by commas
    region	AU BR CA FR DE IT MX ES SE UK	string	While the API will try to automatically detect the host region based on the description language of the provided TMS ID there is also an option to add a region parameter to any OVD OnConnect query. Using this region parameter will ensure that an API request returns content matches for the desired region. To be used only with TMS ID (alphanumeric, beginning with 'SH', 'MV', 'EP'). If not specified defaults to US.

  • GET Series v2/series/seriesId

    Obtain series information (for example, seriesId=185554)

    Parameter	Value	Type	Description
    seriesId		string	seriesId of TV show
    region	AU BR CA FR DE IT MX ES SE UK	string	While the API will try to automatically detect the host region based on the description language of the provided TMS ID there is also an option to add a region parameter to any OVD OnConnect query. Using this region parameter will ensure that an API request returns content matches for the desired region. To be used only with TMS ID (alphanumeric, beginning with 'SH', 'MV', 'EP'). If not specified defaults to US.

  • GET Movies v2/movies/rootId_tmsId

    Obtain movie information (for example, rootId=17420)

    Parameter	Value	Type	Description
    rootId_tmsId		string	rootId or tmsId of movie
    region	AU BR CA FR DE IT MX ES SE UK	string	While the API will try to automatically detect the host region based on the description language of the provided TMS ID there is also an option to add a region parameter to any OVD OnConnect query. Using this region parameter will ensure that an API request returns content matches for the desired region. To be used only with TMS ID (alphanumeric, beginning with 'SH', 'MV', 'EP'). If not specified defaults to US.

  • GET Specials v2/specials/rootId_tmsId

    Obtain specials information

    Parameter	Value	Type	Description
    rootId_tmsId		string	rootId or tmsId of special
    region	AU BR CA FR DE IT MX ES SE UK	string	While the API will try to automatically detect the host region based on the description language of the provided TMS ID there is also an option to add a region parameter to any OVD OnConnect query. Using this region parameter will ensure that an API request returns content matches for the desired region. To be used only with TMS ID (alphanumeric, beginning with 'SH', 'MV', 'EP'). If not specified defaults to US.

• Online Social Methods

  • List Methods
  • Expand Methods

  • GET Movie/Series Information social/rootId_seriesId

    Obtain social links for a single movie or TV series. Note that this method uses the rootId of movie or seriesId from TV show.

    Parameter	Value	Type	Description
    rootId_seriesId		string	Movie rootId, or TV show seriesId