I/O Docs: Interactive API Documentation

Test our API services using I/O Docs. You can also view our written documentation. In order for I/O Docs to work properly, you'll need to be logged into your developer account. You can sign in by clicking the link on the top right of this page.

OAuth 2.0 Flow:

Existing Client Credentials:

API Key:

Shared Secret:

App/Key: Manually provide key information

Client ID:

Client Secret:

Client ID:

Client Secret:

Username:

Password:

Client ID:

Client Secret:

Authorization Code:

Access Token:

Username:

Password:

Search

List Methods

Expand Methods

GET Search search/v2.1/:endpoint/search

Searches titles or names in Rovi Cloud Services and returns results in order of popularity and similarity to the search query. Fields in bold are required.

Parameter	Type	Description
:endpoint	string	Database to search.
entitytype	string	Type of content to search for.
query	string	The search string.
clu	string	For an endpoint of video, the service ID of a television service that has upcoming movies or TV series you want to match against. For example 360861. You can get service IDs from the TV Listings API with a Services request.
start	string	If you specify the clu parameter, start specifies the start of the broadcast time window. For example 20120315140000Z.
end	string	If you specify the clu parameter, end specifies the end of the broadcast time window. For example 20120315140000Z.
rep	integer	If you specify the clu parameter, rep specifies the maximum number of broadcasts to be reported in the availabilities object. For example rep=5 returns up to 5 broadcasts.
facet	string	Count of items available to be returned.
filter	string	Returns only results with fields that meet your criteria. For a list of possible filters and values, see the Search documentation.
include	string	Data from other requests to include in each result returned. For multiple include values, separate the values with commas like this: include=movie:moods,crew.
size	integer	The number of items you want to be returned.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and size parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Single-Stage Search search/v2.1/:endpoint/singlestagesearch

Returns search results for titles or names as a user is typing, sorted in order of popularity and the priorities specified in the request filters. Fields in bold are required.

Parameter	Type	Description
:endpoint	string	Database to search.
entitytype	string	Type of content to search for.
query	string	The search string.
clu	string	For an endpoint of video, the service ID of a television service that has upcoming movies or TV series you want to match against. For example 360861. You can get service IDs from the TV Listings API with a Services request.
start	string	If you specify the clu parameter, start specifies the start of the broadcast time window. For example 20120315140000Z.
end	string	If you specify the clu parameter, end specifies the end of the broadcast time window. For example 20120315140000Z.
rep	integer	If you specify the clu parameter, rep specifies the maximum number of broadcasts to be reported in the availabilities object. For example rep=5 returns up to 5 broadcasts.
facet	string	Count of items available to be returned.
filter	string	Returns only results with fields that meet your criteria. For a list of possible filters and values, see the documentation of Single-Stage Search.
include	string	Data from other requests to include in each result returned. For multiple include values, separate the values with commas like this: include=movie:moods,crew.
size	integer	The number of items you want to be returned.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and size parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Autocomplete search/v2.1/:endpoint/autocomplete

Predicts search words or phrases for select areas of Rovi Cloud Services and returns results in order of popularity. Fields in bold are required.

Parameter	Type	Description
:endpoint	string	Database to search.
entitytype	string	Type of content to search for.
query	string	The search characters.
clu	string	For an endpoint of video, the service ID of a television service that has upcoming movies or TV series you want to match against. For example 360861. You can get service IDs from the TV Listings API with a Services request.
filter	string	If you specify the clu parameter, this parameter filters out content that is not found on the television service channel lineup. Specified with a value of availability, like this: filter=availability.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
size	integer	The number of items you want to be returned.
format	string	Format of the returned data.

GET FilterBrowse search/v2.1/:endpoint/filterbrowse

Locates content in Rovi Cloud Services based on field-level criteria and returns results listed in order of relevance. Fields in bold are required.

Parameter	Type	Description
:endpoint	string	Database to search.
entitytype	string	Type of content to search for.
facet	string	Count of items available to be returned.
filter	string	Returns only results with fields that meet your criteria. For a list of possible filters and values, see the documentation of FilterBrowse.
clu	string	For an endpoint of video, the service ID of a television service that has upcoming movies or TV series you want to match against. For example 360861. You can get service IDs from the TV Listings API with a Services request.
start	string	If you specify the clu parameter, start specifies the start of the broadcast time window. For example 20120315140000Z.
end	string	If you specify the clu parameter, end specifies the end of the broadcast time window. For example 20120315140000Z.
rep	integer	If you specify the clu parameter, rep specifies the maximum number of broadcasts to be reported in the availabilities object. For example rep=5 returns up to 5 broadcasts.
include	string	Data from other requests to include in each result returned. For multiple include values, separate the values with commas like this: include=movie:moods,crew.
size	integer	The number of items you want to be returned.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and size parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

Recommendations

List Methods

Expand Methods

GET Similar recs/v2.1/:endpoint/similar

Returns similar items in order of similarity and popularity. Please specify a value for albumid, trackid, amgvideoid, cosmoprogramid, or nameid. Fields in bold are required.

Parameter	Type	Description
:endpoint	string	Database to search.
entitytype	string	Type of content to search for.
albumid	string	Rovi Music ID for an album, consisting of the prefix MW followed by a ten-digit number. For a request with an album ID, specify an endpoint of music and an entitytype of album.
trackid	string	Rovi Music ID for a song, consisting of the prefix MT followed by a ten-digit number (like MT0009472348). For a request with a track ID, specify an endpoint of music and an entitytype of song.
amgvideoid	string	AMG database ID for a movie or TV series, consisting of a ten-character string that starts with V and is followed by 9 digits with leading spaces. For a request with an amgvideo ID, specify an endpoint of amgvideo and an entitytype of movie or tvseries.
cosmoprogramid	string	Cosmo database ID for a movie or television series. For a request with a Cosmo ID, specify an endpoint of video and an entitytype of movie or tvseries.
nameid	string	Rovi Music ID for a person or group, consisting of the prefix MN followed by a ten-digit number. For a request with a name ID, specify an endpoint of music and an entitytype of artist.
filter	string	Returns only results with fields that meet your criteria. For a list of possible filters and values, see the documentation of Recommendations Similar.
clu	string	For an endpoint of video, the service ID of a television service that has upcoming movies or TV series you want to match against. For example 360861. You can get service IDs from the TV Listings API with a Services request.
start	string	If you specify the clu parameter, start specifies the start of the broadcast time window. For example 20120315140000Z.
end	string	If you specify the clu parameter, end specifies the end of the broadcast time window. For example 20120315140000Z.
rep	integer	If you specify the clu parameter, rep specifies the maximum number of broadcasts to be reported in the availabilities object. For example rep=5 returns up to 5 broadcasts.
size	integer	The number of items you want to be returned.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Playlist recs/v2.1/music/playlist

Returns a playlist of songs based on a single seed item, which can be a song, album, artist, or any of hundreds of music attributes. Parameters in the request let you space out the songs from a single artist or album, and restrict the number of them. Please set a value for nameid, albumid, trackid, or attributeid. Fields in bold are required.

Parameter	Type	Description
entitytype	string	Type of content to look for. This request recognizes only song.
albumid	string	Rovi Music ID for an album, consisting of the prefix MW followed by a ten-digit number. For example, MW0000056882.
attributeid	string	Rovi ID for a music mood, style, theme, genre, or subgenre, consisting of the prefix MA or XA followed by a ten-digit number. For example, MA0000002504 or XA0000001029.
nameid	string	Rovi Name ID for a person or group, consisting of the prefix MN followed by a ten-digit number. For example, MN0000994823.
trackid	string	Rovi Music ID for a song, consisting of the prefix MT followed by a ten-digit number. For example, MT0009995109.
include	string	Additional Rovi Music Song data to include in each result returned. For multiple includes, separate the values with commas like this: review,appearances.
playlist-quota-album	integer	Maximum number of songs to select from the same album.
playlist-quota-artist	integer	Maximum number of songs to select from the same artist.
playlist-separation-album	integer	Minimum number of songs to place between songs from the same album.
playlist-separation-artist	integer	Minimum number of songs to place between songs from the same artist.
playlist-strict	boolean	Whether the quota and separation parameters should be followed when results are fewer than the number of results requested by the size parameter.
size	integer	The number of items you want to be returned.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

Video

List Methods

Expand Methods

GET Info data/v1.1/video/info

Returns information about a movie, TV series, or TV program. Please set a value for video, cosmoid, or iguideid. Fields in bold are required.

Parameter	Type	Description
video	string	Title of a movie, television program, or television series, or keywords from the title.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
iguideid	string	An ID for a television program used by the i-Guide™ interactive digital cable TV program guide.
serviceid	string	Database ID of a television service for an area. Returns the request for a schedule of upcoming broadcasts of the program and, if you specify include=all or include=schedule, also returns the schedule. You can get service IDs from the TV Listings API with a Services request.
inprogress	boolean	If you specify serviceid for a schedule of upcoming broadcasts of the program, inprogress determines whether shows that are in progress at starttime are included in the schedule.
sourceid	string	If you specify serviceid for a schedule of broadcasts of the episode, sourceid determines which channels will appear on the schedule. For further detail, see the documentation of Video/Info.
sourceexclude	string	If you specify sourceid to select the television sources to be returned, sourceexclude specifies attributes of the channels in the source ID list that you want to eliminate from the channels returned.
sourceinclude	string	If you specify sourceid to select the television sources to be returned, sourceinclude specifies an attribute of the channels in the source ID list that you want to include in the list of channels returned.
starttime	string	If you specify serviceid for a schedule of broadcasts of the program, starttime determines the starting time of the schedule. The time must be specified as a DateTime value within two weeks before or after the time of the request. The default is the time of the request. For further detail, see the documentation of Video/Info.
duration	integer	If you specify serviceid for a schedule of upcoming broadcasts of the program, duration determines the number of minutes the schedule will cover.
titletype	integer	If you specify serviceid for a schedule of upcoming broadcasts of the program, titletype determines the type of program title to return as described in the TitleType table. For details, see the documentation of Video/Info
include	string	Other Video Service requests to include in the request. For multiple includes, separate the values with commas like this: cast,crew.
formatid	string	If you specify All or Images in the include parameter, formatid specifies the size and file format of returned images. Select the format IDs you want from the Format IDs table. For details, see the documentation of Video/Info.
imagesize	string	If you specify All or Images in the include parameter, imagesize specifies the image sizes to be returned. Images are not dynamically resized to fit, so only available sizes are returned. For details, see the documentation of Video/Info
imagesort	string	If you specify All or Images in the include parameter, imagesort specifies the sort order of returned images. For details, see the documentation of Video/Info
imagecount	integer	If you specify All or Images in the include parameter, imagecount specifies the number of images to be returned. If fewer images are available, the available images are returned without error. The default is 25.
imageoffset	integer	If you specify All or Images in the include parameter, imageoffset specifies the number of images at the start of the response to skip. The default is zero.
country	string	Country for the language that is specified as the language parameter, stated as a two-character ISO 3166 country code.
language	string	Language of program titles, keywords, and descriptions, stated as a two-character ISO 639 language code.
format	string	Format of the returned data.

GET Episode Info data/v1.1/video/season/:season/episode/:episode/info

Returns information about an episode in a television series. Please set a value for video, cosmoid, or iguideid. Fields in bold are required.

Parameter	Type	Description
:season	integer	Season number of the television series.
:episode	integer	Episode number of the season.
video	string	Title of the television series or keywords from the title.
cosmoid	integer	Cosmo database ID for the television series. Cosmo is a database of television information.
iguideid	string	An ID for a television program used by the i-Guide™ interactive digital cable TV program guide.
serviceid	string	Database ID of a television service for an area. Returns the request for a schedule of upcoming broadcasts of the program and, if you specify include=all or include=schedule, also returns the schedule. You can get service IDs from the TV Listings API with a Services request.
inprogress	boolean	If you specify serviceid for a schedule of upcoming broadcasts of the program, inprogress determines whether shows that are in progress at starttime are included in the schedule.
sourceid	string	If you specify serviceid for a schedule of broadcasts of the episode, sourceid determines which channels will appear on the schedule.
sourceexclude	string	If you specify sourceid to select the television sources to be returned, sourceexclude specifies attributes of the channels in the source ID list that you want to eliminate from the channels returned.
sourceinclude	string	If you specify sourceid to select the television sources to be returned, sourceinclude specifies an attribute of the channels in the source ID list that you want to include in the list of channels returned.
starttime	string	If you specify serviceid for a schedule of broadcasts of the program, starttime determines the starting time of the schedule. The time must be specified as a DateTime value within two weeks before or after the time of the request. The default is the time of the request.
duration	integer	If you specify serviceid for a schedule of upcoming broadcasts of the program, duration determines the number of minutes the schedule will cover.
titletype	integer	If you specify serviceid for a schedule of upcoming broadcasts of the program, titletype determines the type of program title to return as described in the TitleType table.
include	string	Other Video Service requests to include in the request. For multiple includes, separate the values with commas like this: cast,crew.
formatid	string	If you specify All or Images in the include parameter, formatid specifies the size and file format of returned images. Select the format IDs you want from the Format IDs table.
imagesize	string	If you specify All or Images in the include parameter, imagesize specifies the image sizes to be returned. Images are not dynamically resized to fit, so only available sizes are returned.
imagesort	string	If you specify All or Images in the include parameter, imagesort specifies the sort order of returned images.
imagecount	integer	If you specify All or Images in the include parameter, imagecount specifies the number of images to be returned. If fewer images are available, the available images are returned without error. The default is 25.
imageoffset	integer	If you specify All or Images in the include parameter, imageoffset specifies the number of images at the start of the response to skip. The default is zero.
country	string	Country for the language that is specified as the language parameter, stated as a two-character ISO 3166 country code.
language	string	Language of program titles, keywords, and descriptions, stated as a two-character ISO 639 language code.
format	string	Format of the returned data.

GET Awards data/v1.1/video/awards

Returns awards a program has been nominated for or won. Please set a value for video, cosmoid, or iguideid. Fields in bold are required.

Parameter	Type	Description
video	string	Title of a movie, television program, or television series, or keywords from the title.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
iguideid	string	An ID for a television program used by the i-Guide™ interactive digital cable TV program guide.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country for the language that is specified as the language parameter, stated as a two-character ISO 3166 country code.
language	string	Language of program titles, keywords, and descriptions, stated as a two-character ISO 639 language code.
format	string	Format of the returned data.

GET Cast data/v1.1/video/cast

Returns information about cast members with links to images. Please set a value for video, cosmoid, or iguideid. Fields in bold are required.

Parameter	Type	Description
video	string	Title of a movie, television program, or television series, or keywords from the title.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
iguideid	string	An ID for a television program used by the i-Guide™ interactive digital cable TV program guide.
filteradultcontents	boolean	Whether to filter out cast members who are tagged as Adult.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API supports only US.
language	string	Language of the response data. This request supports only en (English).
format	string	Format of the returned data.

GET Clip data/v1.1/video/clip

Returns data you can use to construct links to trailers and video clips. Please set a value for video, cosmoid, or iguideid. Fields in bold are required.

Parameter	Type	Description
video	string	Title of a movie, television program, or television series, or keywords from the title.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
iguideid	string	An ID for a television program used by the i-Guide™ interactive digital cable TV program guide.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API supports only US.
language	string	Language of the response data. This request supports only en (English).
format	string	Format of the returned data.

GET Crew data/v1.1/video/crew

Returns information about crew members with links to images. Please set a value for video, cosmoid, or iguideid. Fields in bold are required.

Parameter	Type	Description
video	string	Title of a movie, television program, or television series, or keywords from the title.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
iguideid	string	An ID for a television program used by the i-Guide™ interactive digital cable TV program guide.
filteradultcontents	boolean	Whether to filter out cast members who are tagged as Adult.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API supports only US.
language	string	Language of the response data. This request supports only en (English).
format	string	Format of the returned data.

GET Event data/v1.1/video/event

Returns information about a televised sporting event. Please set a value for video, cosmoid, or iguideid. Fields in bold are required.

Parameter	Type	Description
video	string	Title of a movie, television program, or television series, or keywords from the title.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
iguideid	string	An ID for a television program used by the i-Guide™ interactive digital cable TV program guide.
country	string	Country of the language of the response. The current release of the API supports only US.
language	string	Language of the response data. This request supports only en (English).
format	string	Format of the returned data.

GET Images data/v1.1/video/images

Returns links to movie and television program images. Please set a value for video, cosmoid, or iguideid. Fields in bold are required.

Parameter	Type	Description
video	string	Title of a movie, television program, or television series, or keywords from the title.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
iguideid	string	An ID for a television program used by the i-Guide™ interactive digital cable TV program guide.
formatid	string	Size and file format of returned images. Select the format IDs you want from the Format IDs table.
imagesize	string	Image sizes to be returned. Images are not dynamically resized to fit, so only available sizes are returned.
imagesort	string	Sort order of returned images.
imagecount	integer	Number of images to be returned. If fewer images are available, the available images are returned without error. The default is 25.
imageoffset	integer	Number of images at the start of the response to skip. The default is zero. Use the imagecount and imageoffset parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API supports only US.
language	string	Language of the response data. This request supports only en (English).
format	string	Format of the returned data.

GET Keywords data/v1.1/video/keywords

Returns keywords and characteristics that apply to a movie, TV series, or TV program. Please set a value for video, cosmoid, or iguideid. Fields in bold are required.

Parameter	Type	Description
video	string	Title of a movie, television program, or television series, or keywords from the title.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
iguideid	string	An ID for a television program used by the i-Guide™ interactive digital cable TV program guide.
country	string	Country for the language that is specified as the language parameter, stated as a two-character ISO 3166 country code.
language	string	Language of program titles, keywords, and descriptions, stated as a two-character ISO 639 language code.
format	string	Format of the returned data.

GET Moods data/v1.1/video/moods

Returns terms that describe expressive characteristics of a movie or television program, along with weightings that reflect the relative strength of each term. Please set a value for video, cosmoid, or iguideid. Fields in bold are required.

Parameter	Type	Description
video	string	Title of a movie, television program, or television series, or keywords from the title.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
iguideid	string	An ID for a television program used by the i-Guide™ interactive digital cable TV program guide.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API supports only US.
language	string	Language of the response data. This request supports only en (English).
format	string	Format of the returned data.

GET ParentalRatings data/v1.1/video/parentalratings

Returns the parental ratings for a movie or television program. Please set a value for video, cosmoid, or iguideid. Fields in bold are required.

Parameter	Type	Description
video	string	Title of a movie, television program, or television series, or keywords from the title.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
iguideid	string	An ID for a television program used by the i-Guide™ interactive digital cable TV program guide.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API supports only US.
language	string	Language of the response data. This request supports only en (English).
format	string	Format of the returned data.

GET Related data/v1.1/video/related

Returns movies, series, seasons, and programs that have a relationship with a movie, series, season, or program specified in the request. Please set a value for video, cosmoid, or iguideid. Fields in bold are required.

Parameter	Type	Description
video	string	Title of a movie, television program, or television series, or keywords from the title.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
iguideid	string	An ID for a television program used by the i-Guide™ interactive digital cable TV program guide.
country	string	Country for the language that is specified as the language parameter, stated as a two-character ISO 3166 country code.
language	string	Language of program titles, keywords, and descriptions, stated as a two-character ISO 639 language code.
format	string	Format of the returned data.

GET Review data/v1.1/video/review

Returns a professional review of a movie or program. Please set a value for video, cosmoid, or iguideid. Fields in bold are required.

Parameter	Type	Description
video	string	Title of a movie, television program, or television series, or keywords from the title.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
iguideid	string	An ID for a television program used by the i-Guide™ interactive digital cable TV program guide.
country	string	Country of the language of the response. The current release of the API supports only US.
language	string	Language of the response data. This request supports only en (English).
format	string	Format of the returned data.

GET Schedule data/v1.1/video/schedule

Returns a list of recent and upcoming television broadcasts of a movie or program. Please set a value for video, cosmoid, or iguideid. Fields in bold are required.

Parameter	Type	Description
video	string	Title of a movie, television program, or television series, or keywords from the title.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
iguideid	string	An ID for a television program used by the i-Guide™ interactive digital cable TV program guide.
serviceid	string	Database ID of a television service for an area. You can get service IDs that apply to an area with a Services request in the TV Listings API.
inprogress	boolean	Whether shows that are in progress at starttime are included in the schedule.
sourceid	string	Determines which channels will appear on the schedule. The default is all.
sourceexclude	string	Specifies attributes of the channels in the source ID list that you want to eliminate from the channels returned.
sourceinclude	string	Specifies an attribute of the channels in the source ID list that you want to include in the list of channels returned.
starttime	string	Beginning of the time period covered by the schedule, specified as a DateTime value that is within two weeks before or after the time of the request. The default is the time of the request.
duration	integer	The number of minutes the schedule will cover, from 1 to 20160. Default is 20160 (14 days).
titletype	integer	Type of program title to return as described in the TitleType table.
copytexttype	string	Type of description you want returned for the program, movie, or TV series.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country for the language that is specified as the language parameter, stated as a two-character ISO 3166 country code.
language	string	Language of program titles, keywords, and descriptions, stated as a two-character ISO 639 language code.
format	string	Format of the returned data.

GET Season Info data/v1.1/video/season/:season/info

Returns information about a season of a TV series. Please set a value for video, cosmoid, or iguideid. Fields in bold are required.

Parameter	Type	Description
:season	integer	Season number of the television series.
video	string	Title of the television series or keywords from the title.
cosmoid	integer	Cosmo database ID for the television series. Cosmo is a database of television information.
iguideid	string	An ID for a television program used by the i-Guide™ interactive digital cable TV program guide.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
include	string	Specify include=all to include episode titles in the response.
country	string	Country of the language of the response. The current release of the API supports only US.
language	string	Language of the response data. This request supports only en (English).
format	string	Format of the returned data.

GET Season 0 Info data/v1.1/video/season/0/info

Returns information about unsequenced episodes in a TV series—-episodes that, for one reason or another, have not been assigned to a season. Please set a value for video, cosmoid, or iguideid. Fields in bold are required.

Parameter	Type	Description
video	string	Title of the television series or keywords from the title.
cosmoid	integer	Cosmo database ID for the television series. Cosmo is a database of television information.
iguideid	string	An ID for a television program used by the i-Guide™ interactive digital cable TV program guide.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
include	string	Specify include=all to include episode titles in the response.
country	string	Country of the language of the response. The current release of the API supports only US.
language	string	Language of the response data. This request supports only en (English).
format	string	Format of the returned data.

GET Season Episodes data/v1.1/video/season/:season/episodes

Links to every episode in a season of a television series. Please set a value for video, cosmoid, or iguideid. Fields in bold are required.

Parameter	Type	Description
:season	integer	Season number of the television series.
video	string	Title of the television series or keywords from the title.
cosmoid	integer	Cosmo database ID for the television series. Cosmo is a database of television information.
iguideid	string	An ID for a television program used by the i-Guide™ interactive digital cable TV program guide.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
include	string	Specify include=all to include episode titles in the response.
country	string	Country of the language of the response. The current release of the API supports only US.
language	string	Language of the response data. This request supports only en (English).
format	string	Format of the returned data.

GET Synopsis data/v1.1/video/synopsis

Returns the best available synopsis associated with a movie or program. Please set a value for video, cosmoid, or iguideid. Fields in bold are required.

Parameter	Type	Description
video	string	Title of a movie, television program, or television series, or keywords from the title.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
iguideid	string	An ID for a television program used by the i-Guide™ interactive digital cable TV program guide.
country	string	Country of the language of the response. The current release of the API supports only US.
language	string	Language of the response data. This request supports only en (English).
format	string	Format of the returned data.

GET Themes data/v1.1/video/themes

Returns a list of topics and circumstances that motivate or fit with a movie or program. Please set a value for video, cosmoid, or iguideid. Fields in bold are required.

Parameter	Type	Description
video	string	Title of a movie, television program, or television series, or keywords from the title.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
iguideid	string	An ID for a television program used by the i-Guide™ interactive digital cable TV program guide.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API supports only US.
language	string	Language of the response data. This request supports only en (English).
format	string	Format of the returned data.

GET Tones data/v1.1/video/tones

Returns feelings and attitudes that motivate or fit with a movie or program, along with weightings that reflect the relative strength of each term. Please set a value for video, cosmoid, or iguideid. Fields in bold are required.

Parameter	Type	Description
video	string	Title of a movie, television program, or television series, or keywords from the title.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
iguideid	string	An ID for a television program used by the i-Guide™ interactive digital cable TV program guide.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API supports only US.
language	string	Language of the response data. This request supports only en (English).
format	string	Format of the returned data.

Movie

List Methods

Expand Methods

GET Info data/v1.1/movie/info

Returns basic information about a movie or TV series. Please set a value for movie, or cosmoid, or movieid. Fields in bold are required.

Parameter	Type	Description
movie	string	Keywords from title of the movie or TV series.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
movieid	string	AMG ID of a movie or TV series, consisting of the letter V followed by 9 digits with leading spaces.
include	string	Other Movie Service requests to include in the request. For multiple includes, separate the values with commas like this: crew,images.
formatid	string	If you specify All or Images in the include parameter, formatid specifies the size and file format of returned images. Select the format IDs you want from the Format IDs table. For details, see the documentation of Movie/Info.
imagesize	string	If you specify All or Images in the include parameter, imagesize specifies the image sizes to be returned. Images are not dynamically resized to fit, so only available sizes are returned. For details, see the documentation of Movie/Info
imagesort	string	If you specify All or Images in the include parameter, imagesort specifies the sort order of returned images. For details, see the documentation of Movie/Info
imagecount	integer	If you specify All or Images in the include parameter, imagecount specifies the number of images to be returned. If fewer images are available, the available images are returned without error. The default is 25.
imageoffset	integer	If you specify All or Images in the include parameter, imageoffset specifies the number of images at the start of the response to skip. The default is zero. Use the imagecount and imageoffset parameters to page the available list of images.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Cast data/v1.1/movie/cast

Returns information about cast members with links to images. Please set a value for movie, or cosmoid, or movieid. Fields in bold are required.

Parameter	Type	Description
movie	string	Keywords from title of the movie or TV series.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
movieid	string	AMG ID of a movie or TV series, consisting of the letter V followed by 9 digits with leading spaces.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Crew data/v1.1/movie/crew

Returns information about crew members with links to images. Please set a value for movie, or cosmoid, or movieid. Fields in bold are required.

Parameter	Type	Description
movie	string	Keywords from title of the movie or TV series.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
movieid	string	AMG ID of a movie or TV series, consisting of the letter V followed by 9 digits with leading spaces.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Images data/v1.1/movie/images

Returns URLs to images of a movie along with associated image information. Note: Access to images is governed by your subscription level and geographical location. Please set a value for movie, or cosmoid, or movieid. Fields in bold are required.

Parameter	Type	Description
movie	string	Keywords from title of the movie or TV series.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
movieid	string	AMG ID of a movie or TV series, consisting of the letter V followed by 9 digits with leading spaces.
formatid	string	Size and file format of returned images. Select the format IDs you want from the Format IDs table. For details, see the documentation of Movie/Images.
imagesize	string	Image sizes to be returned. Images are not dynamically resized to fit, so only available sizes are returned. For details, see the documentation of Movie/Images.
imagesort	string	Sort order of returned images. For details, see the documentation of Movie/Images.
imagecount	integer	Number of images to be returned. If fewer images are available, the available images are returned without error. The default is 25.
imageoffset	integer	Number of images at the start of the response to skip. The default is zero. Use the imagecount and imageoffset parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Keywords data/v1.1/movie/keywords

Returns keywords that apply to a movie and weightings that reflect the relative importance of each keyword. Please set a value for movie, or cosmoid, or movieid. Fields in bold are required.

Parameter	Type	Description
movie	string	Keywords from title of the movie or TV series.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
movieid	string	AMG ID of a movie or TV series, consisting of the letter V followed by 9 digits with leading spaces.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Moods data/v1.1/movie/moods

Returns keywords that apply to a movie and weightings that reflect the relative importance of each keyword. Please set a value for movie, or cosmoid, or movieid. Fields in bold are required.

Parameter	Type	Description
movie	string	Keywords from title of the movie or TV series.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
movieid	string	AMG ID of a movie or TV series, consisting of the letter V followed by 9 digits with leading spaces.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Related data/v1.1/movie/related

Returns titles of movies that are related to a movie specified in the request. Please set a value for movie, or cosmoid, or movieid. Fields in bold are required.

Parameter	Type	Description
movie	string	Keywords from title of the movie or TV series.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
movieid	string	AMG ID of a movie or TV series, consisting of the letter V followed by 9 digits with leading spaces.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Releases data/v1.1/movie/releases

Returns information about DVDs, Blu-rays, and other movie releases. Please set a value for movie, or cosmoid, or movieid. Fields in bold are required.

Parameter	Type	Description
movie	string	Keywords from title of the movie or TV series.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
movieid	string	AMG ID of a movie or TV series, consisting of the letter V followed by 9 digits with leading spaces.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Review data/v1.1/movie/review

Returns a review of a movie. Please set a value for movie, or cosmoid, or movieid. Fields in bold are required.

Parameter	Type	Description
movie	string	Keywords from title of the movie or TV series.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
movieid	string	AMG ID of a movie or TV series, consisting of the letter V followed by 9 digits with leading spaces.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Synopsis data/v1.1/movie/synopsis

Returns a synopsis of the plot and the name of the author. Please set a value for movie, or cosmoid, or movieid. Fields in bold are required.

Parameter	Type	Description
movie	string	Keywords from title of the movie or TV series.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
movieid	string	AMG ID of a movie or TV series, consisting of the letter V followed by 9 digits with leading spaces.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Themes data/v1.1/movie/themes

Returns a list of topics and circumstances that motivate or fit with a movie, along with weightings that reflect the relative importance of each. Please set a value for movie, or cosmoid, or movieid. Fields in bold are required.

Parameter	Type	Description
movie	string	Keywords from title of the movie or TV series.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
movieid	string	AMG ID of a movie or TV series, consisting of the letter V followed by 9 digits with leading spaces.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Tones data/v1.1/movie/tones

Returns a list of feelings that motivate or fit with the movie or TV series, along with weightings that reflect the relative importance of each. Please set a value for movie, or cosmoid, or movieid. Fields in bold are required.

Parameter	Type	Description
movie	string	Keywords from title of the movie or TV series.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
movieid	string	AMG ID of a movie or TV series, consisting of the letter V followed by 9 digits with leading spaces.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Types data/v1.1/movie/types

Returns movie subgenres that apply to the movie, along with weightings that reflect the relative importance of each. Please set a value for movie, or cosmoid, or movieid. Fields in bold are required.

Parameter	Type	Description
movie	string	Keywords from title of the movie or TV series.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
movieid	string	AMG ID of a movie or TV series, consisting of the letter V followed by 9 digits with leading spaces.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Videos data/v1.1/movie/videos

Returns data for constructing links to movie trailers. Please set a value for movie, or cosmoid, or movieid. Fields in bold are required.

Parameter	Type	Description
movie	string	Keywords from title of the movie or TV series.
cosmoid	integer	Cosmo database ID for a movie or television series. Cosmo is a database of television information.
movieid	string	AMG ID of a movie or TV series, consisting of the letter V followed by 9 digits with leading spaces.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

Movie Release

List Methods

Expand Methods

GET Info data/v1.1/movierelease/info

Returns basic information about a movie release. Please set a value for upcid or moviereleaseid. Fields in bold are required.

Parameter	Type	Description
moviereleaseid	integer	ID of a movie release.
upcid	integer	Universal Product Code for an item.
include	string	Any other Movie Release requests to include in the request. For multiple includes, separate the values with commas like this: description,images.
formatid	string	If you specify All or Images in the include parameter, formatid specifies the size and file format of returned images. Select the format IDs you want from the Format IDs table. For details, see the documentation of MovieRelease/Info.
imagesize	string	If you specify All or Images in the include parameter, imagesize specifies the image sizes to be returned. Images are not dynamically resized to fit, so only available sizes are returned. For details, see the documentation of MovieRelease/Info
imagesort	string	If you specify All or Images in the include parameter, imagesort specifies the sort order of returned images. For details, see the documentation of MovieRelease/Info
imagecount	integer	If you specify All or Images in the include parameter, imagecount specifies the number of images to be returned. If fewer images are available, the available images are returned without error. The default is 25.
imageoffset	integer	If you specify All or Images in the include parameter, imageoffset specifies the number of images at the start of the response to skip. The default is zero. Use the imagecount and imageoffset parameters to page the available list of images.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Description data/v1.1/movierelease/description

Returns the description of a movie release. Please set a value for upcid or moviereleaseid. Fields in bold are required.

Parameter	Type	Description
moviereleaseid	integer	ID of a movie release.
upcid	integer	Universal Product Code for an item.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Features data/v1.1/movierelease/features

Returns the description of a movie release. Please set a value for upcid or moviereleaseid. Fields in bold are required. Fields in bold are required.

Parameter	Type	Description
moviereleaseid	integer	ID of a movie release.
upcid	integer	Universal Product Code for an item.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Images data/v1.1/movierelease/images

Returns URLs to images of a movie release along with associated image information. Note: Access to images is governed by your subscription level and geographical location. Please set a value for upcid or moviereleaseid. Fields in bold are required.

Parameter	Type	Description
moviereleaseid	integer	ID of a movie release.
upcid	integer	Universal Product Code for an item.
formatid	string	Size and file format of returned images. Select the format IDs you want from the Format IDs table. For details, see the documentation of MovieRelease/Images.
imagesize	string	Image sizes to be returned. Images are not dynamically resized to fit, so only available sizes are returned. For details, see the documentation of MovieRelease/Images.
imagesort	string	Sort order of returned images. For details, see the documentation of MovieRelease/Images.
imagecount	integer	Number of images to be returned. If fewer images are available, the available images are returned without error. The default is 25.
imageoffset	integer	Number of images at the start of the response to skip. The default is zero. Use the imagecount and imageoffset parameters to paginate the available images.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Videos data/v1.1/movierelease/videos

Returns data for constructing links to trailers of a movie release. Please set a value for upcid or moviereleaseid. Fields in bold are required.

Parameter	Type	Description
moviereleaseid	integer	ID of a movie release.
upcid	integer	Universal Product Code for an item.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

Music Album

List Methods

Expand Methods

GET Info data/v1.1/album/info

Returns basic information about an album. Please set a value for album, albumid, amgpopid, or amgclassicalid. Fields in bold are required.

Parameter	Type	Description
album	string	Keywords from the album title.
albumid	string	Rovi Music ID for an album, consisting of the prefix MW followed by a ten-digit number.
amgpopid	string	AMG ID for a popular music album, consisting of a ten-character string that starts with R and is followed by nine digits with leading spaces.
amgclassicalid	string	AMG ID for a classical music album, consisting of a ten-character string that starts with W and is followed by nine digits with leading spaces.
include	string	Other Album requests to include in the request. For multiple includes, separate the values with commas like this: include=images,tracks.
formatid	string	If you specify All or Images in the include parameter, formatid specifies the size and file format of returned images. Select the format IDs you want from the Format IDs table.
imagesize	string	If you specify All or Images in the include parameter, imagesize specifies the image sizes to be returned. Images are not dynamically resized to fit, so only available sizes are returned.
imagesort	string	If you specify All or Images in the include parameter, imagesort specifies the sort order of returned images.
imagecount	integer	If you specify All or Images in the include parameter, imagecount specifies the number of images to be returned. If fewer images are available, the available images are returned without error. The default is 25.
imageoffset	integer	If you specify All or Images in the include parameter, imageoffset specifies the number of images at the start of the response to skip. The default is zero. Use the imagecount and imageoffset parameters to paginate the available images.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Classical Review data/v1.1/album/classicalreview

Returns an editorial review of a classical music album. Please set a value for album, albumid, amgpopid, or amgclassicalid. Fields in bold are required.

Parameter	Type	Description
album	string	Keywords from the album title.
albumid	string	Rovi Music ID for an album, consisting of the prefix MW followed by a ten-digit number.
amgpopid	string	AMG ID for a popular music album, consisting of a ten-character string that starts with R and is followed by nine digits with leading spaces.
amgclassicalid	string	AMG ID for a classical music album, consisting of a ten-character string that starts with W and is followed by nine digits with leading spaces.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Credits data/v1.1/album/credits

Returns the production credits for an album, a list of the names and roles of the people and groups that produced the album. Please set a value for album, albumid, amgpopid, or amgclassicalid. Fields in bold are required.

Parameter	Type	Description
album	string	Keywords from the album title.
albumid	string	Rovi Music ID for an album, consisting of the prefix MW followed by a ten-digit number.
amgpopid	string	AMG ID for a popular music album, consisting of a ten-character string that starts with R and is followed by nine digits with leading spaces.
amgclassicalid	string	AMG ID for a classical music album, consisting of a ten-character string that starts with W and is followed by nine digits with leading spaces.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Images data/v1.1/album/images

Returns URLs to pictures of an album along with associated image information. Note: Access to images is governed by your subscription level and geographical location. Photography credits must be displayed with images. Please set a value for album, albumid, amgpopid, or amgclassicalid. Fields in bold are required.

Parameter	Type	Description
album	string	Keywords from the album title.
albumid	string	Rovi Music ID for an album, consisting of the prefix MW followed by a ten-digit number.
amgpopid	string	AMG ID for a popular music album, consisting of a ten-character string that starts with R and is followed by nine digits with leading spaces.
amgclassicalid	string	AMG ID for a classical music album, consisting of a ten-character string that starts with W and is followed by nine digits with leading spaces.
formatid	string	Size and file format of returned images. Select the format IDs you want from the Format IDs table.
imagesize	string	Image sizes to be returned. Images are not dynamically resized to fit, so only available sizes are returned.
imagesort	string	Sort order of returned images.
imagecount	integer	Number of images to be returned. If fewer images are available, the available images are returned without error. The default is 25.
imageoffset	integer	Number of images at the start of the response to skip. The default is zero. Use the imagecount and imageoffset parameters to paginate the available images.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Moods data/v1.1/album/moods

Returns a list of terms that describe expressive characteristics of the music, along with weightings that reflect the relative strength of each term. Please set a value for album, albumid, amgpopid, or amgclassicalid. Fields in bold are required. Fields in bold are required.

Parameter	Type	Description
album	string	Keywords from the album title.
albumid	string	Rovi Music ID for an album, consisting of the prefix MW followed by a ten-digit number.
amgpopid	string	AMG ID for a popular music album, consisting of a ten-character string that starts with R and is followed by nine digits with leading spaces.
amgclassicalid	string	AMG ID for a classical music album, consisting of a ten-character string that starts with W and is followed by nine digits with leading spaces.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Primary Review data/v1.1/album/primaryreview

Returns the most recent major review of an album. Please set a value for album, albumid, amgpopid, or amgclassicalid. Fields in bold are required.

Parameter	Type	Description
album	string	Keywords from the album title.
albumid	string	Rovi Music ID for an album, consisting of the prefix MW followed by a ten-digit number.
amgpopid	string	AMG ID for a popular music album, consisting of a ten-character string that starts with R and is followed by nine digits with leading spaces.
amgclassicalid	string	AMG ID for a classical music album, consisting of a ten-character string that starts with W and is followed by nine digits with leading spaces.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Releases data/v1.1/album/releases

Returns information about the releases of an album, including media type and whether it can be purchased. Please set a value for album, albumid, amgpopid, or amgclassicalid. Fields in bold are required.

Parameter	Type	Description
album	string	Keywords from the album title.
albumid	string	Rovi Music ID for an album, consisting of the prefix MW followed by a ten-digit number.
amgpopid	string	AMG ID for a popular music album, consisting of a ten-character string that starts with R and is followed by nine digits with leading spaces.
amgclassicalid	string	AMG ID for a classical music album, consisting of a ten-character string that starts with W and is followed by nine digits with leading spaces.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Styles data/v1.1/album/styles

Returns a list of musical styles that apply to the music on an album along with weightings that reflect the importance of each style in the music. Please set a value for album, albumid, amgpopid, or amgclassicalid. Fields in bold are required.

Parameter	Type	Description
album	string	Keywords from the album title.
albumid	string	Rovi Music ID for an album, consisting of the prefix MW followed by a ten-digit number.
amgpopid	string	AMG ID for a popular music album, consisting of a ten-character string that starts with R and is followed by nine digits with leading spaces.
amgclassicalid	string	AMG ID for a classical music album, consisting of a ten-character string that starts with W and is followed by nine digits with leading spaces.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Themes data/v1.1/album/themes

Returns a list of topics, feelings, and circumstances that motivate or fit with the music on an album. Please set a value for album, albumid, amgpopid, or amgclassicalid. Fields in bold are required.

Parameter	Type	Description
album	string	Keywords from the album title.
albumid	string	Rovi Music ID for an album, consisting of the prefix MW followed by a ten-digit number.
amgpopid	string	AMG ID for a popular music album, consisting of a ten-character string that starts with R and is followed by nine digits with leading spaces.
amgclassicalid	string	AMG ID for a classical music album, consisting of a ten-character string that starts with W and is followed by nine digits with leading spaces.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Tracks data/v1.1/album/tracks

Returns information about the songs on a popular music album and the performances on a classical music album. Popular music songs are identified by track IDs; classical music performances are identified by performance IDs. Please set a value for album, albumid, amgpopid, or amgclassicalid. Fields in bold are required.

Parameter	Type	Description
album	string	Keywords from the album title.
albumid	string	Rovi Music ID for an album, consisting of the prefix MW followed by a ten-digit number.
amgpopid	string	AMG ID for a popular music album, consisting of a ten-character string that starts with R and is followed by nine digits with leading spaces.
amgclassicalid	string	AMG ID for a classical music album, consisting of a ten-character string that starts with W and is followed by nine digits with leading spaces.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

Music Composition

List Methods

Expand Methods

GET Info data/v1.1/composition/info

Returns basic information about a classical music composition. Please set a value for compositionid or amgclassicalid. Fields in bold are required.

Parameter	Type	Description
compositionid	string	Rovi Music ID for a classical music composition, consisting of the prefix MC followed by a ten-digit number. For example: MC0002369165.
amgclassicalid	string	AMG ID for a classical music composition, consisting of a ten-character string that starts with C and is followed by nine digits with leading spaces. For example: C 43235.
include	string	Other requests to include in the request. For multiple includes, separate the values with commas like this: include=parts,description.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Description data/v1.1/composition/description

Returns a description of a classical music composition. Please set a value for compositionid or amgclassicalid. Fields in bold are required.

Parameter	Type	Description
compositionid	string	Rovi Music ID for a classical music composition, consisting of the prefix MC followed by a ten-digit number. For example: MC0002369165.
amgclassicalid	string	AMG ID for a classical music composition, consisting of a ten-character string that starts with C and is followed by nine digits with leading spaces. For example: C 43235.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Parts data/v1.1/composition/parts

Returns the names of the parts or movements of a classical music composition, each of which is recorded as a single track. Please set a value for compositionid or amgclassicalid. Fields in bold are required.

Parameter	Type	Description
compositionid	string	Rovi Music ID for a classical music composition, consisting of the prefix MC followed by a ten-digit number. For example: MC0002369165.
amgclassicalid	string	AMG ID for a classical music composition, consisting of a ten-character string that starts with C and is followed by nine digits with leading spaces. For example: C 43235.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Releases data/v1.1/composition/releases

Returns a list of album releases that feature a performance of a composition. Please set a value for compositionid or amgclassicalid. Fields in bold are required.

Parameter	Type	Description
compositionid	string	Rovi Music ID for a classical music composition, consisting of the prefix MC followed by a ten-digit number. For example: MC0002369165.
amgclassicalid	string	AMG ID for a classical music composition, consisting of a ten-character string that starts with C and is followed by nine digits with leading spaces. For example: C 43235.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

Music Performance

List Methods

Expand Methods

GET Info data/v1.1/performance/info

Returns basic information about a classical music performance. Please set a value for performanceid or amgclassicalid. Fields in bold are required.

Parameter	Type	Description
performanceid	string	Rovi Music ID for a classical music performance, consisting of the prefix MQ followed by a ten-digit number. For example, MQ0001169372.
amgclassicalid	string	AMG ID for a classical music composition, consisting of a ten-character string that starts with C and is followed by nine digits with leading spaces. For example: C 43235.
include	string	Other Performance requests to include in the request. For multiple includes, separate the values with commas like this: include=credits,release.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Composition data/v1.1/performance/composition

Returns information about a composition played in a classical music performance. Please set a value for performanceid or amgclassicalid. Fields in bold are required.

Parameter	Type	Description
performanceid	string	Rovi Music ID for a classical music performance, consisting of the prefix MQ followed by a ten-digit number. For example, MQ0001169372.
amgclassicalid	string	AMG ID for a classical music composition, consisting of a ten-character string that starts with C and is followed by nine digits with leading spaces. For example: C 43235.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Credits data/v1.1/performance/credits

Returns the names and roles of the people, groups, and organizations that contributed to a classical music performance and the album release. Please set a value for performanceid or amgclassicalid. Fields in bold are required.

Parameter	Type	Description
performanceid	string	Rovi Music ID for a classical music performance, consisting of the prefix MQ followed by a ten-digit number. For example, MQ0001169372.
amgclassicalid	string	AMG ID for a classical music composition, consisting of a ten-character string that starts with C and is followed by nine digits with leading spaces. For example: C 43235.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Images data/v1.1/performance/images

Returns URLs to images of an album that contains the recording a classical music performance, along with associated image information. Note: Access to images is governed by your subscription level and geographical location. Photography credits must be displayed with images. Please set a value for performanceid or amgclassicalid. Fields in bold are required.

Parameter	Type	Description
performanceid	string	Rovi Music ID for a classical music performance, consisting of the prefix MQ followed by a ten-digit number. For example, MQ0001169372.
amgclassicalid	string	AMG ID for a classical music composition, consisting of a ten-character string that starts with C and is followed by nine digits with leading spaces. For example: C 43235.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Release data/v1.1/performance/release

Returns information about an album release that contains the recording of a classical music performance. Please set a value for performanceid or amgclassicalid. Fields in bold are required.

Parameter	Type	Description
performanceid	string	Rovi Music ID for a classical music performance, consisting of the prefix MQ followed by a ten-digit number. For example, MQ0001169372.
amgclassicalid	string	AMG ID for a classical music composition, consisting of a ten-character string that starts with C and is followed by nine digits with leading spaces. For example: C 43235.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

Music Release

List Methods

Expand Methods

GET Info data/v1.1/release/info

Returns basic information about an LP, CD, DVD, cassette, download, or other release of an album. Please set a value for eanid, upcid, releaseid, amgpopid, or amgclassicalid. Fields in bold are required.

Parameter	Type	Description
eanid	string	EAN code of the release.
upcid	string	Universal Product Code for an item.
releaseid	string	Rovi Music ID for the release, consisting of the prefix MR followed by a ten-digit number.
amgpopid	string	AMG ID for a popular music album, consisting of a ten-character string that starts with R and is followed by nine digits with leading spaces. For example: R 1805889.
amgclassicalid	string	AMG ID for a classical music album, consisting of a ten-character string that starts with W and is followed by nine digits with leading spaces. For example: W 180317.
formatid	string	If you specify All or Images in the include parameter, formatid specifies the size and file format of returned images. Select the format IDs you want from the Format IDs table.
imagesize	string	If you specify All or Images in the include parameter, imagesize specifies the image sizes to be returned. Images are not dynamically resized to fit, so only available sizes are returned.
imagesort	string	If you specify All or Images in the include parameter, imagesort specifies the sort order of returned images.
imagecount	integer	If you specify All or Images in the include parameter, imagecount specifies the number of images to be returned. If fewer images are available, the available images are returned without error. The default is 25.
imageoffset	integer	If you specify All or Images in the include parameter, imageoffset specifies the number of images at the start of the response to skip. The default is zero. Use imagecount and imageoffset to paginate the list of available images.
include	string	Other Release requests to include in the request. For multiple includes, separate the values with commas like this: include=credits,tracks.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Classical Review data/v1.1/release/classicalreview

Returns an editorial review of a classical music album. Please set a value for eanid, upcid, releaseid, amgpopid, or amgclassicalid. Fields in bold are required.

Parameter	Type	Description
eanid	string	EAN code of the release.
upcid	string	Universal Product Code for an item.
releaseid	string	Rovi Music ID for the release, consisting of the prefix MR followed by a ten-digit number.
amgpopid	string	AMG ID for a popular music album, consisting of a ten-character string that starts with R and is followed by nine digits with leading spaces. For example: R 1805889.
amgclassicalid	string	AMG ID for a classical music album, consisting of a ten-character string that starts with W and is followed by nine digits with leading spaces. For example: W 180317.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Credits data/v1.1/release/credits

Returns the names and roles of the people, groups, and organizations that contributed to a release. Please set a value for eanid, upcid, releaseid, amgpopid, or amgclassicalid. Fields in bold are required.

Parameter	Type	Description
eanid	string	EAN code of the release.
upcid	string	Universal Product Code for an item.
releaseid	string	Rovi Music ID for the release, consisting of the prefix MR followed by a ten-digit number.
amgpopid	string	AMG ID for a popular music album, consisting of a ten-character string that starts with R and is followed by nine digits with leading spaces. For example: R 1805889.
amgclassicalid	string	AMG ID for a classical music album, consisting of a ten-character string that starts with W and is followed by nine digits with leading spaces. For example: W 180317.
count	integer	Number of items you want to be returned. The default is zero, which returns all items after the offset.
offset	integer	Number of items at the start of the response to skip. The default is zero. Use the offset and count parameters to paginate the available results.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Images data/v1.1/release/images

Returns URLs to pictures of the album release along with associated image information. Note: Access to images is governed by your subscription level and geographical location. Photography credits must be displayed with images. Please set a value for eanid, upcid, releaseid, amgpopid, or amgclassicalid. Fields in bold are required.

Parameter	Type	Description
eanid	string	EAN code of the release.
upcid	string	Universal Product Code for an item.
releaseid	string	Rovi Music ID for the release, consisting of the prefix MR followed by a ten-digit number.
amgpopid	string	AMG ID for a popular music album, consisting of a ten-character string that starts with R and is followed by nine digits with leading spaces. For example: R 1805889.
amgclassicalid	string	AMG ID for a classical music album, consisting of a ten-character string that starts with W and is followed by nine digits with leading spaces. For example: W 180317.
formatid	string	Size and file format of returned images. Select the format IDs you want from the Format IDs table.
imagesize	string	Image sizes to be returned. Images are not dynamically resized to fit, so only available sizes are returned.
imagesort	string	Sort order of returned images.
imagecount	integer	Number of images to be returned. If fewer images are available, the available images are returned without error. The default is 25.
imageoffset	integer	Number of images at the start of the response to skip. The default is zero. Use imagecount and imageoffset to paginate the list of available images.
country	string	Country of the language of the response. The current release of the API only supports US.
language	string	Language of the response data. This request only supports en (English).
format	string	Format of the returned data.

GET Moods data/v1.1/release/moods

Returns a list of terms that describe expressive characteristics of the music, along with weightings that reflect the relative strength of each term. Please set a value for eanid, upcid, releaseid, amgpopid, or amgclassicalid. Fields in bold are required.

Parameter	Type	Description
eanid	string	EAN code of the release.
upcid	string	Universal Product Code for an item.
releaseid	string	Rovi Music ID for the release, consisting of the prefix MR followed by a ten-digit number.
amgpopid

I/O Docs: Interactive API Documentation

Select an API Search and Recommendations APIs Metadata APIs REST TV Listings APIs

Search List Methods Expand Methods

Recommendations List Methods Expand Methods

Video List Methods Expand Methods

Movie List Methods Expand Methods

Movie Release List Methods Expand Methods

Music Album List Methods Expand Methods

Music Composition List Methods Expand Methods

Music Performance List Methods Expand Methods

Music Release List Methods Expand Methods

Search

List Methods

Expand Methods

Recommendations

List Methods

Expand Methods

Video

List Methods

Expand Methods

Movie

List Methods

Expand Methods

Movie Release

List Methods

Expand Methods

Music Album

List Methods

Expand Methods

Music Composition

List Methods

Expand Methods

Music Performance

List Methods

Expand Methods

Music Release

List Methods

Expand Methods