Implementation Guide - Movies

LEGACY Documentation for deprecated API version. For current documentation and up-to-date technical info, please visit here.
Recommended Implementation

When implementing movies using the API IVA recommends the following approach:

  1. Use /Movies/All endpoint to get and cache all the movie objects. Be sure to include any additonal objects as needed.
  2. Use the /Changes/Movies/History endpoint to get Movie IDs of any movie object that has changes.
  3. Use the /Movies/{Id} endpoint to get the updated movie object and replace what is stored in cache.
  4. (Optional): Use one of the /ExternalId/ endpoints to get a list of 3rd party Id and IVA Movie ID pairs. This allows developers to link 3rd party ids to the IVA Movie IDs, Image IDs, People IDs, and Video IDs. Some 3rd party IDs require special permissions for access (Tivo, Webedia, etc.).
Alternate Methods

These alternate methods are only recommended for testing and small data sets. IVA does impose rate limits to the API on a per customer basis starting at 5/second. If you are unsure of your rate limit please contact us.

  • /Find/Movie - Can be used with a 3rd party ID to look up an IVA Movie.
  • /Movies/SearchAndDiscover - Can be used to search Title, Director, Alternate Titles, Cast, etc.
  • /Movies/Match - Can be used to match based on title, year, director, and cast information. Contact us if you are interested in setting up matching.
Get All Movies

Start with GetAllMovies(/Movies/All) paging through all the results. Include any additional objects (Videos, Images, Genres, Descriptions, etc.) to be returned. Store each movie object in a database for easy updating.


Usage and SDK Samples

curl -X get -H "Ocp-Apim-Subscription-Key: [[apiKey]]" ""

Get Updated Movie Id's

Use one of the Changes APIs, GetMovieChangeHistory(/Changes/Movies/History) or GetMovieChangeHistoryWithEntity(/Changes/Movies/HistoryWithEntity) to keep the data up-to-date. IVA's staff is continually updating the data, adding images, and adding video. IVA recommends updating once an hour or more.


Usage and SDK Samples

curl -X get -H "Ocp-Apim-Subscription-Key: [[apiKey]]" ""

Update Movie

For each MovieId that has been updated, update the data in your database by calling GetMovie(/Movies/{Id}) and replacing the full object. Developers are encouraged to check for updates often to keep the data fresh and to be aware of new video assets and images added to the library.


Usage and SDK Samples

curl -X get -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "{Id}?includes="