Returns basic information about a movie or TV series plus customized requests for all of the other content that is available through the Movie API. These customized requests are designed to make your programming easy and efficient: in a single step you both verify availability and capture the request. You just add your signature argument and execute the request.
The movie/info request also provides an optional argument to include responses from any or all of the other Movie requests. This may return a large amount of data. To speed data transmission, do the following:
movie/info? | movie=movie movieid=movieid cosmoid=cosmoid |
&apikey=apikey&sig=sig [&include=include] [&format=format] [&country=country] [&language=language] [&formatid=formatid] |
Click to re-sort
Parameter | Required | Description | ||||
---|---|---|---|---|---|---|
apikey | Yes | Access code that authorizes your request for data from Rovi. | ||||
sig | Yes | A calculated authorization code. To perform the calculation, execute the MD5 function on the concatenation of the following three strings:
Perform the calculation at the time of each request to be sure it's within a five-minute window of the server time. If you're testing the call in a browser, use our online signature generator to perform the calculation. | ||||
cosmoid | Conditional | Cosmo database ID for a movie or television series. Cosmo is a database of television information.
Condition: The request must contain just one of these parameters:
| ||||
movie | Conditional | Keywords from the title of the movie or TV series. This searches for the most popular title with that combination of words. Replace spaces with plus (+) or percent20 (%20) symbols.
Condition: The request must contain just one of these parameters:
| ||||
movieid | Conditional | AMG ID of a movie or TV series, consisting of the letter V followed by 9 digits with leading spaces. When using an AMG Video ID in a request, replace any spaces in the ID with plus (+) or percent20 (%20) symbols, like this: V+++295550. Your application can grab movie IDs from responses to the following requests:
Condition: The request must contain just one of these parameters:
| ||||
country | No | Country of the language of the response. The current release of the API supports only US. | ||||
format | No | Format of the returned data: json or xml. The default is JSON. | ||||
formatid | No | If you specify All or Images in the include parameter, formatid specifies the size and image format of returned images. The format IDs available are shown in the Format IDs table. To select multiple format IDs, specify the IDs as a comma-separated list like this formatid=36,44,51.
Note: Your access to images is governed by your subscription level. | ||||
include | No | Other Movie Service requests to include in the request. To include images, for example, add include=images. For multiple includes, separate the values with commas like this: include=crew,images. You can also include all Movie Service requests with include=all. The possible values are:
For information about a request, please see the documentation for the request. Notice: The value Similar is deprecated and will be removed from the API on a date to be announced. Reminder: These options may return a large amount of data. To speed data transmission, do the following:
| ||||
language | No | Language of the response data. This request supports only en (English). |
Response | Type | Description |
---|---|---|
build | String | The software release level of the API. |
code | Integer | HTTP status code. See the status field for the text part of the code. |
duration | Integer | Server processing time in milliseconds. The difference between startTime and endTime. |
endTime | String | When the server sent the response (UTC time). |
messages | Message [ ] | Elements of a multiple HTTP response status message. |
parameters | parameters | List of the parameters included in the request. |
serverName | String | Name of the server that processed the request. |
startTime | String | When the server received the request (UTC time). |
status | String | Text part of the HTTP status code that is shown in the code field. |
Response | Type | Description | ||||
---|---|---|---|---|---|---|
attributes | String [ ] | Attributes associated with the Movie:
| ||||
cast | People [ ] | Cast information and links to images, returned only if the request specified an include=cast argument. | ||||
castUri | String | The customized Movie/Cast request, returned only if cast data is available. | ||||
countries | String [ ] | List of countries the movie was released in. | ||||
crew | People [ ] | Crew names, roles, and images, returned only if the request specified an include=crew argument. | ||||
crewUri | String | The customized Movie/Crew request, returned only if crew information is available. | ||||
directors | Director [ ] | Directors of the movie or TV series, listed in order of AMG Movie ID. You can use the AMG Movie ID in a Name/Info request to return information about a director. | ||||
distributor | String [ ] | The company that distributed the movie. | ||||
duration | Integer | Run time in minutes. | ||||
flags | String [ ] | Additional features and characteristics that apply to the movie:
| ||||
genres | Genre [ ] | Genres that apply to the movie, along with a weighting that reflects the relative importance of each genre. | ||||
ids | ids | All of the IDs that are recognized by the API for a movie. The possible IDs are:
| ||||
images | Image [ ] | URLs to images of the movie, returned only if the request specified an include=images argument and your subscription level enables access to images. | ||||
imagesUri | String | The customized Movie/Images request, returned only if the data is available. | ||||
keywords | Keyword [ ] | Keywords for the plot structure of a movie or TV series, returned only if the request specified an include=keywords argument. | ||||
keywordsUri | String | The customized Movie/Keywords request, returned only if the data is available. | ||||
moods | MoviesMood [ ] | Terms that describe expressive characteristics of the movie, returned only if the request specified an include=moods argument. | ||||
moodsUri | String | The customized Movie/Moods request, returned only if the data is available. | ||||
mpaa | String | MPAA rating for the movie:
| ||||
producedBy | String [ ] | Companies that produced the movie. | ||||
rating | Integer | An editorially assigned rating of the movie from 0 to 10, where 0 is no rating and higher numbers indicate a higher rating. | ||||
related | related | Related movies, returned only if the request specified an include=related argument. | ||||
relatedUri | String | The customized Movie/Related request, returned only if the data is available. | ||||
releasedBy | String [ ] | The companies that released the movie. | ||||
releases | MovieRelease [ ] | DVD and other releases of the movie, returned only if the request specified an include=releases argument. | ||||
releasesUri | String | The customized Movie/Releases request, returned only if the data is available. | ||||
releaseYear | String | Year the movie was released. | ||||
review | review | A review of the movie, returned only if the request specified an include=review argument. | ||||
reviewUri | String | The customized Movie/Review request, returned only if the data is available. | ||||
similar | MovieSimilar [ ] | Similar movies to the movie named in the request, returned only if the request specified an include=similar argument. Notice: This property is deprecated and will be removed from the API on a date to be announced. | ||||
similarUri | String | The customized Movie/Similar request, returned only if the data is available. Notice: This property is deprecated and will be removed from the API on a date to be announced. | ||||
studio | String | The company that filmed the movie. | ||||
synopsis | synopsis | Synopsis of the plot, returned only if the request specified an include=synopsis argument. | ||||
synopsisUri | String | The customized Movie/Synopsis request, returned only if the data is available. | ||||
themes | MoviesTheme [ ] | Topics and circumstances that motivate or fit with the movie, returned only if the request specified an include=themes argument. | ||||
themesUri | String | The customized Movie/Themes request, returned only if the data is available. | ||||
title | String | Full title of the movie. | ||||
tones | MoviesTone [ ] | Feelings that motivate or fit with the movie, returned only if the request specified an include=tones argument. | ||||
tonesUri | String | The customized Movie/Tones request, returned only if the data is available. | ||||
types | MoviesType [ ] | Subgenres that apply to the movie, returned only if the request specified an include=types argument. | ||||
typesUri | String | The customized Movie/Types request, returned only if the data is available. | ||||
videos | Video [ ] | Data for constructing links to trailers for the movie, returned only if the request specified an include=videos argument. | ||||
videosUri | String | The customized Movie/Videos request, returned only if data is available. |