Data/movie-api/v1.1/movie/releases

Jump to: navigation, search

Movie/Releases

Returns information about DVDs, Blu-rays, and other movie releases.

This request may return a large amount of data. To speed data transmission, do the following:

  • Request one page of data at a time, requesting only what you want to immediately display.
  • Request a compressed response by including Accept-Encoding: gzip,deflate in the HTTP header.

Syntax

movie/releases? movie=movie
movieid=movieid
cosmoid=cosmoid
&apikey=apikey&sig=sig [&format=format] [&offset=offset] [&count=count] [&country=country] [&language=language]

Request Example 1

Request the releases of Being John Malkovich using the movie ID.

Request Example 2

Request the releases in an XML response using the movie title.

Request Example 3

Request just the first release in the list.

Request Example 4

Request just the second release.

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, 32-hex-digit authorization code. To perform the calculation, execute the MD5 function on the concatenation of the following three ASCII 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.

Express the alpha hex digits as lower case.

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
count No Number of items to be returned. The default is zero, which returns all items after the offset.
country No Country the language parameter applies to. The current release of the API supports only US.
format No Format of the returned data: json or xml. The default is JSON.
language No Language of the response data. This request supports only en (English).
offset No Number of items at the start of the available data to skip. The default is zero.

Use count and offset to paginate the data that is available to be returned.

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.
parametersparametersThe parameters that were included in the request.
parentIdsparentIdsAll of the IDs for the requested object that are recognized by the API.
serverNamestringName of the server that processed the request.
startTimestringWhen the server received the request (UTC time).
statusstringText part of the HTTP status code, which is shown in the code field.
viewviewSummary of items returned in a list of items.

Response for Movie/Releases

ResponseTypeDescription
releases MovieRelease [ ] The DVDs, Blu-rays, and other releases of the movie specified in the request, sorted by year, rating, and title:
  • First sort order: value of the year element, earliest to latest.
  • Second sort order: value of the rating element, highest to lowest.
  • Third sort order: title in alphabetical order.

JSON Response Example

Here's the response to Request Example 1, which asks for releases of the movie Being John Malkovich using the movie ID. The response is formatted with extra spaces and carriage returns to make it easy to read.
Requested with http://api.rovicorp.com/data/v1.1/movie/releases?apikey=apikey&sig=sig&movieid=V+++180993.
{
   "status":"ok",
   "code":200,
   "messages":null,
   "build":"1.0",
   "parameters":{
      "apiKey":"4p1k3y",
      "id":"V 180993",
      "format":"json"
   },
   "view":{
      "total":8
   },
   "serverName":"tul1cssrcs",
   "startTime":"2012-03-22T21:16:10Z",
   "endTime":"2012-03-22T21:16:10Z",
   "duration":36,
   "parentIds":{
      "cosmoId":"2512627",
      "movieId":"V 180993"
   },
   "releases":[
      {
         "ids":{
            "movieReleaseId":null,
            "releaseId":"E277017",
            "upcId":"5050582844450"
         },
         "title":"Being John Malkovich [Blu-ray]",
         "studio":"Universal",
         "rating":9,
         "formats":[
            "Blu-ray"
         ],
         "year":"",
         "hasCommentary":true,
         "isPurchasable":false
      },
      {
         "ids":{
            "movieReleaseId":null,
            "releaseId":"E 7888",
            "upcId":"025192266522"
         },
         "title":"Being John Malkovich",
         "studio":"Polygram USA Video",
         "rating":9,
         "formats":[
            "DVD"
         ],
         "year":"2000 05 02",
         "hasCommentary":false,
         "isPurchasable":true
      },
      {
         "ids":{
            "movieReleaseId":null,
            "releaseId":"E105134",
            "upcId":"5035822007147"
         },
         "title":"Being John Malkovich",
         "studio":"Columbia Tristar",
         "rating":9,
         "formats":[
            "DVD"
         ],
         "year":"2000 09 18",
         "hasCommentary":false,
         "isPurchasable":false
      },
      {
         "ids":{
            "movieReleaseId":null,
            "releaseId":"E116967",
            "upcId":"5050582036930"
         },
         "title":"Being John Malkovich",
         "studio":"Universal",
         "rating":9,
         "formats":[
            "DVD"
         ],
         "year":"2003 08 11",
         "hasCommentary":false,
         "isPurchasable":false
      },
      {
         "ids":{
            "movieReleaseId":null,
            "releaseId":"E160870",
            "upcId":"025195010191"
         },
         "title":"Being John Malkovich [HD]",
         "studio":"Universal Studios",
         "rating":9,
         "formats":[
            "Hi Def"
         ],
         "year":"2007 06 26",
         "hasCommentary":true,
         "isPurchasable":true
      },
      {
         "ids":{
            "movieReleaseId":null,
            "releaseId":"E272590",
            "upcId":"5050582843699"
         },
         "title":"Being John Malkovich [Blu-ray]",
         "studio":"Ais",
         "rating":9,
         "formats":[
            "Blu-ray"
         ],
         "year":"2011 10 04",
         "hasCommentary":false,
         "isPurchasable":true
      },
      {
         "ids":{
            "movieReleaseId":null,
            "releaseId":"E280074",
            "upcId":"715515095419"
         },
         "title":"Being John Malkovich [Criterion Collection] [2 Discs]",
         "studio":"Criterion",
         "rating":9,
         "formats":[
            "DVD"
         ],
         "year":"2012 05 15",
         "hasCommentary":false,
         "isPurchasable":true
      },
      {
         "ids":{
            "movieReleaseId":null,
            "releaseId":"E280078",
            "upcId":"715515095310"
         },
         "title":"Being John Malkovich [Criterion Collection] [Blu-ray]",
         "studio":"Criterion",
         "rating":9,
         "formats":[
            "Blu-ray"
         ],
         "year":"2012 05 15",
         "hasCommentary":false,
         "isPurchasable":true
      }
   ]
}

XML Response Example

Here's the response to Request Example 2, which asks for an XML response with releases of Being John Malkovich, giving the movie title.
Requested with http://api.rovicorp.com/data/v1.1/movie/releases?apikey=apikey&sig=sig&
movie=Being+John+Malkovich&format=xml
.
<MovieReleases xmlns="com.rovicorp.metadataservice" xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <status>ok</status>
  <code>200</code>
  <messages i:nil="true"/>
  <build>1.0</build>
  <parameters>
    <apiKey>4p1k3y</apiKey>
    <id>Being John Malkovich</id>
    <format>xml</format>
  </parameters>
  <view>
    <total>8</total>
  </view>
  <serverName>tul1cssrcs</serverName>
  <startTime>2012-03-22T21:17:40Z</startTime>
  <endTime>2012-03-22T21:17:40Z</endTime>
  <duration>33</duration>
  <parentIds>
    <cosmoId>2512627</cosmoId>
    <movieId>V 180993</movieId>
  </parentIds>
  <releases>
    <MovieRelease>
      <ids>
        <movieReleaseId i:nil="true"/>
        <releaseId>E277017</releaseId>
        <upcId>5050582844450</upcId>
      </ids>
      <title>Being John Malkovich [Blu-ray]</title>
      <studio>Universal</studio>
      <rating>9</rating>
      <formats>
        <a:string>Blu-ray</a:string>
      </formats>
      <year/>
      <hasCommentary>true</hasCommentary>
      <isPurchasable>false</isPurchasable>
    </MovieRelease>
    <MovieRelease>
      <ids>
        <movieReleaseId i:nil="true"/>
        <releaseId>E 7888</releaseId>
        <upcId>025192266522</upcId>
      </ids>
      <title>Being John Malkovich</title>
      <studio>Polygram USA Video</studio>
      <rating>9</rating>
      <formats>
        <a:string>DVD</a:string>
      </formats>
      <year>2000 05 02</year>
      <hasCommentary>false</hasCommentary>
      <isPurchasable>true</isPurchasable>
    </MovieRelease>
    <MovieRelease>
      <ids>
        <movieReleaseId i:nil="true"/>
        <releaseId>E105134</releaseId>
        <upcId>5035822007147</upcId>
      </ids>
      <title>Being John Malkovich</title>
      <studio>Columbia Tristar</studio>
      <rating>9</rating>
      <formats>
        <a:string>DVD</a:string>
      </formats>
      <year>2000 09 18</year>
      <hasCommentary>false</hasCommentary>
      <isPurchasable>false</isPurchasable>
    </MovieRelease>
    <MovieRelease>
      <ids>
        <movieReleaseId i:nil="true"/>
        <releaseId>E116967</releaseId>
        <upcId>5050582036930</upcId>
      </ids>
      <title>Being John Malkovich</title>
      <studio>Universal</studio>
      <rating>9</rating>
      <formats>
        <a:string>DVD</a:string>
      </formats>
      <year>2003 08 11</year>
      <hasCommentary>false</hasCommentary>
      <isPurchasable>false</isPurchasable>
    </MovieRelease>
    <MovieRelease>
      <ids>
        <movieReleaseId i:nil="true"/>
        <releaseId>E160870</releaseId>
        <upcId>025195010191</upcId>
      </ids>
      <title>Being John Malkovich [HD]</title>
      <studio>Universal Studios</studio>
      <rating>9</rating>
      <formats>
        <a:string>Hi Def</a:string>
      </formats>
      <year>2007 06 26</year>
      <hasCommentary>true</hasCommentary>
      <isPurchasable>true</isPurchasable>
    </MovieRelease>
    <MovieRelease>
      <ids>
        <movieReleaseId i:nil="true"/>
        <releaseId>E272590</releaseId>
        <upcId>5050582843699</upcId>
      </ids>
      <title>Being John Malkovich [Blu-ray]</title>
      <studio>Ais</studio>
      <rating>9</rating>
      <formats>
        <a:string>Blu-ray</a:string>
      </formats>
      <year>2011 10 04</year>
      <hasCommentary>false</hasCommentary>
      <isPurchasable>true</isPurchasable>
    </MovieRelease>
    <MovieRelease>
      <ids>
        <movieReleaseId i:nil="true"/>
        <releaseId>E280074</releaseId>
        <upcId>715515095419</upcId>
      </ids>
      <title>Being John Malkovich [Criterion Collection] [2 Discs]</title>
      <studio>Criterion</studio>
      <rating>9</rating>
      <formats>
        <a:string>DVD</a:string>
      </formats>
      <year>2012 05 15</year>
      <hasCommentary>false</hasCommentary>
      <isPurchasable>true</isPurchasable>
    </MovieRelease>
    <MovieRelease>
      <ids>
        <movieReleaseId i:nil="true"/>
        <releaseId>E280078</releaseId>
        <upcId>715515095310</upcId>
      </ids>
      <title>Being John Malkovich [Criterion Collection] [Blu-ray]</title>
      <studio>Criterion</studio>
      <rating>9</rating>
      <formats>
        <a:string>Blu-ray</a:string>
      </formats>
      <year>2012 05 15</year>
      <hasCommentary>false</hasCommentary>
      <isPurchasable>true</isPurchasable>
    </MovieRelease>
  </releases>
</MovieReleases>


See Also

↑ Top

Personal tools