V1.Metadata.MovieService.Movie:Info

Jump to: navigation, search

Movie/Info

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:

  • Request only data that you need to immediately display.
  • Request a compressed response by including Accept-Encoding: gzip,deflate in the HTTP header.

Syntax

movie/info? movie=movie
movieid=movieid
cosmoid=cosmoid
&apikey=apikey&sig=sig [&include=include] [&format=format] [&country=country] [&language=language] [&formatid=formatid]

Request Example 1

Request basic information about the movie Being John Malkovich using the movie ID.

Request Example 2

Also request lists of keywords and releases.

Request Example 3

Request information using the title of the movie.

Request Example 4

Request basic information about the movie Being John Malkovich using the Cosmo ID.

Request Parameters

Sort none.gif  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:
  • Your API key.
  • The secret key you received with your API key.
  • The Unix time. Unix time is a timestamp supported in most development environments, and is generally defined as the number of seconds since January 1, 1970 00:00:00 GMT.

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
  • movieId
  • cosmoId
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:

  • movie
  • movieId
  • cosmoId
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:

  • movie
  • movieId
  • cosmoId
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:

  • Request only data that you need to immediately display.
  • Request a compressed response by including Accept-Encoding: gzip,deflate in the HTTP header.
language No Language of the response data. This request supports only en (English).

Response

Response Header

ResponseTypeDescription
buildStringThe software release level of the API.
codeIntegerHTTP status code. See the status field for the text part of the code.
durationIntegerServer processing time in milliseconds. The difference between startTime and endTime.
endTimeStringWhen the server sent the response (UTC time).
messagesMessage [ ]Elements of a multiple HTTP response status message.
parametersparametersList of the parameters included in the request.
serverNameStringName of the server that processed the request.
startTimeStringWhen the server received the request (UTC time).
statusStringText part of the HTTP status code that is shown in the code field.

Response for Movie/Info

ResponseTypeDescription
attributes String [ ] Attributes associated with the Movie:
  • Cult Film
  • High Artistic Quality
  • High Budget
  • High Historical Importance
  • High Production Values
  • Low Artistic Quality
  • Low Budget
  • Low Production Values
  • Sleeper
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:
  • Adult Humor
  • Adult Language
  • Adult Situations
  • Alcohol Consumption
  • Brief Nudity
  • Child Classic
  • Children in Peril
  • Drug Content
  • Excellent For Children
  • Gore
  • Graphic Violence
  • Mild Language
  • Mild Violence
  • Not For Children
  • Nudity
  • Profanity
  • Questionable for Children
  • Rape & Sexual Abuse
  • Scary Moments
  • Scatological Humor
  • Sci-Fi Violence
  • Sexual Situations
  • Slapstick Violence
  • Smoking
  • Strong Sexual Content
  • Substance Abuse
  • Suitable for Children
  • Suitable for Teens
  • Torture
  • Violence
  • War Violence
  • Watch With Your Kids
  • Watch With Your Teen
  • Western Violence
  • Youth Substance Use
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:
  • cosmoId
  • movieId
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:
  • G
  • PG  
  • PG-13  
  • R
  • NC-17  
  • NR
  • Not rated
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.

JSON Response Example

Here's the response to Request Example 3. It is formatted with extra spaces and carriage returns to make it easy to read.
{
  "status":"ok",
  "code":200,
  "messages":null,
  "build":"1.5.1.9",
  "parameters":{
    "apiKey":"apikey",
    "id":"being john malkovich"
  },
  "serverName":"tul1cssw1",
  "startTime":"2011-04-26T22:50:19.5983246Z",
  "endTime":"2011-04-26T22:50:20.1139529Z",
  "duration":515,
  "movie":{
    "ids":{
      "cosmoId":"2512627",
      "movieId":"V  180993"
    },
    "title":"Being John Malkovich",
    "releaseYear":"1999",
    "rating":9,
    "duration":112,
    "directors":[
      {
        "id":"P263616",
        "name":"Spike Jonze"
      }
    ],
    "countries":[
      "UK",
      "USA"
    ],
    "mpaa":"R",
    "flags":[
      "Not For Children",
      "Adult Humor",
      "Profanity",
      "Sexual Situations"
    ],
    "genres":[
      {
        "id":"D  648",
        "name":"Comedy",
        "weight":8
      }
    ],
    "attributes":[
      "High Artistic Quality"
    ],
    "cast":null,
    "castUri":"http:\/\/api.rovicorp.com\/v1\/movie\/cast?format=json&apikey=apikey&movieid=V+++180993",
    "crew":null,
    "crewUri":"http:\/\/api.rovicorp.com\/v1\/movie\/crew?format=json&apikey=apikey&movieid=V+++180993",
    "images":null,
    "imagesUri":"http:\/\/api.rovicorp.com\/v1\/movie\/images?format=json&apikey=apikey&movieid=V+++180993",
    "keywords":null,
    "keywordsUri":"http:\/\/api.rovicorp.com\/v1\/movie\/keywords?format=json&apikey=apikey&movieid=V+++180993",
    "moods":null,
    "moodsUri":"http:\/\/api.rovicorp.com\/v1\/movie\/moods?format=json&apikey=apikey&movieid=V+++180993",
    "related":null,
    "relatedUri":"http:\/\/api.rovicorp.com\/v1\/movie\/related?format=json&apikey=apikey&movieid=V+++180993",
    "releases":null,
    "releasesUri":"http:\/\/api.rovicorp.com\/v1\/movie\/releases?format=json&apikey=apikey&movieid=V+++180993",
    "review":null,
    "reviewUri":"http:\/\/api.rovicorp.com\/v1\/movie\/review?format=json&apikey=apikey&movieid=V+++180993",
    "similar":null,
    "similarUri":"http:\/\/api.rovicorp.com\/v1\/movie\/similar?format=json&apikey=apikey&movieid=V+++180993",
    "synopsis":null,
    "synopsisUri":"http:\/\/api.rovicorp.com\/v1\/movie\/synopsis?format=json&apikey=apikey&movieid=V+++180993",
    "themes":null,
    "themesUri":"http:\/\/api.rovicorp.com\/v1\/movie\/themes?format=json&apikey=apikey&movieid=V+++180993",
    "tones":null,
    "tonesUri":"http:\/\/api.rovicorp.com\/v1\/movie\/tones?format=json&apikey=apikey&movieid=V+++180993",
    "types":null,
    "typesUri":"http:\/\/api.rovicorp.com\/v1\/movie\/types?format=json&apikey=apikey&movieid=V+++180993",
    "videos":null,
    "videosUri":"http:\/\/api.rovicorp.com\/v1\/movie\/videos?format=json&apikey=apikey&movieid=V+++180993",
    "studio":"",
    "producedBy":[
      "Single Cell Pictures",
      "Gramercy Pictures",
      "Propaganda Films"
    ],
    "releasedBy":[
      "Universal",
      "USA Films"
    ],
    "distributor":[
      "USA Home Entertainment",
      "USA Home Entertianment"
    ]
  }
}

XML Response Example

Here's an XML response to Request Example 3.
<MovieDetail xmlns="com.rovicorp.metadataservice" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <status>ok</status>
  <code>200</code>
  <messages i:nil="true"/>
  <build>1.5.1.9</build>
  <parameters>
    <apiKey>apikey</apiKey>
    <id>being john malkovich</id>
    <format>xml</format>
  </parameters>
  <serverName>tul1cssw2</serverName>
  <startTime>2011-04-26T21:50:41.5964865Z</startTime>
  <endTime>2011-04-26T21:50:42.2371156Z</endTime>
  <duration>640</duration>
  <movie>
    <ids>
      <cosmoId>2512627</cosmoId>
      <movieId>V 180993</movieId>
    </ids>
    <title>Being John Malkovich</title>
    <releaseYear>1999</releaseYear>
    <rating>9</rating>
    <duration>112</duration>
    <directors>
      <Director>
        <id>P263616</id>
        <name>Spike Jonze</name>
      </Director>
    </directors>
    <countries xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <a:string>UK</a:string>
      <a:string>USA</a:string>
    </countries>
    <mpaa>R</mpaa>
    <flags xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <a:string>Not For Children</a:string>
      <a:string>Adult Humor</a:string>
      <a:string>Profanity</a:string>
      <a:string>Sexual Situations</a:string>
    </flags>
    <genres>
      <Genre>
        <id>D 648</id>
        <name>Comedy</name>
        <weight>8</weight>
      </Genre>
    </genres>
    <attributes xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <a:string>High Artistic Quality</a:string>
    </attributes>
    <cast i:nil="true"/>
    <castUri>http://api.rovicorp.com/v1/movie/cast?format=xml&amp;apikey=apikey&amp;movieid=V+++180993</castUri>
    <crew i:nil="true"/>
    <crewUri>http://api.rovicorp.com/v1/movie/crew?format=xml&amp;apikey=apikey&amp;movieid=V+++180993</crewUri>
    <images i:nil="true"/>
    <imagesUri>http://api.rovicorp.com/v1/movie/images?format=xml&amp;apikey=apikey&amp;movieid=V+++180993</imagesUri>
    <keywords i:nil="true"/>
    <keywordsUri>http://api.rovicorp.com/v1/movie/keywords?format=xml&amp;apikey=apikey&amp;movieid=V+++180993</keywordsUri>
    <moods i:nil="true"/>
    <moodsUri>http://api.rovicorp.com/v1/movie/moods?format=xml&amp;apikey=apikey&amp;movieid=V+++180993</moodsUri>
    <related i:nil="true"/>
    <relatedUri>http://api.rovicorp.com/v1/movie/related?format=xml&amp;apikey=apikey&amp;movieid=V+++180993</relatedUri>
    <releases i:nil="true"/>
    <releasesUri>http://api.rovicorp.com/v1/movie/releases?format=xml&amp;apikey=apikey&amp;movieid=V+++180993</releasesUri>
    <review i:nil="true"/>
    <reviewUri>http://api.rovicorp.com/v1/movie/review?format=xml&amp;apikey=apikey&amp;movieid=V+++180993</reviewUri>
    <similar i:nil="true"/>
    <similarUri>http://api.rovicorp.com/v1/movie/similar?format=xml&amp;apikey=apikey&amp;movieid=V+++180993</similarUri>
    <synopsis i:nil="true"/>
    <synopsisUri>http://api.rovicorp.com/v1/movie/synopsis?format=xml&amp;apikey=apikey&amp;movieid=V+++180993</synopsisUri>
    <themes i:nil="true"/>
    <themesUri>http://api.rovicorp.com/v1/movie/themes?format=xml&amp;apikey=apikey&amp;movieid=V+++180993</themesUri>
    <tones i:nil="true"/>
    <tonesUri>http://api.rovicorp.com/v1/movie/tones?format=xml&amp;apikey=apikey&amp;movieid=V+++180993</tonesUri>
    <types i:nil="true"/>
    <typesUri>http://api.rovicorp.com/v1/movie/types?format=xml&amp;apikey=apikey&amp;movieid=V+++180993</typesUri>
    <videos i:nil="true"/>
    <videosUri>http://api.rovicorp.com/v1/movie/videos?format=xml&amp;apikey=apikey&amp;movieid=V+++180993</videosUri>
    <studio/>
    <producedBy xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <a:string>Single Cell Pictures</a:string>
      <a:string>Gramercy Pictures</a:string>
      <a:string>Propaganda Films</a:string>
    </producedBy>
    <releasedBy xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <a:string>Universal</a:string>
      <a:string>USA Films</a:string>
    </releasedBy>
    <distributor xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <a:string>USA Home Entertainment</a:string>
      <a:string>USA Home Entertianment</a:string>
    </distributor>
  </movie>
</MovieDetail>


See Also

↑ Top

Personal tools