Returns Rovi IDs for a movie, TV series, or TV program in your catalog, based on title and field-level data, along with data you can use to verify a match. Results are returned in order of confidence level.
Note: The primary Rovi IDs you should track are:
For This API . . . | Use this ID. |
---|---|
Rovi Video | cosmoId. |
Rovi TV Listings | cosmoId. |
Rovi DVDs | movieId, also known as amgMovieId. |
catalog/match/video?apikey=apikey&sig=sig&title=title [&entitytype=entitytype] [&rating=rating] [&releaseyear=releaseyear] [&runtime=runtime] [&upc=upc] [&include=include] [&formatid=formatid] [&format=format] [&size=size]
日 Movie-related requests ⊑⊒ TV-related requests
Parameter | Required | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apikey | Yes | Access code that authorizes your request for data from Rovi. | ||||||||||||||||||
catalog | Yes | Database to match against.
| ||||||||||||||||||
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:
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. | ||||||||||||||||||
title | Yes | Title of a movie, television program, or television series, or keywords from the title. This searches for the most popular title with that combination of words. Replace any spaces with plus (+) or percent20 (%20) symbols. Note: This parameter currently returns only US-English results. Support for other countries and languages will be added in the future. | ||||||||||||||||||
entitytype | No | Categories that narrow the type of content to match against. Select one of the following entity types:
The default is to match against all entity types for a catalog. Note: The top results may come from just one of the entity types. Order of results is determined by relevance and is not deliberately balanced across the entity types. | ||||||||||||||||||
format | No | Format of the returned data: json or xml. The default is JSON.
Alternatively you can specify the response format in an HTTP Accept header with either of these Accept field content types:
If you specify both, the format parameter overrides the Accept header. | ||||||||||||||||||
formatid | No | 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.
Specify multiple format IDs in a comma-separated list, like this: formatid=36,44,51. | ||||||||||||||||||
include | No | Additional data to include in each result returned. To include cast members in movie results, for example, specify include=cast. For multiple includes, separate the values with commas like this: include=moods,crew. To include all data, specify include=all. | ||||||||||||||||||
rating | No | MPAA movie rating or US TV rating. Ratings with a dash may be entered with or without the dash.
| ||||||||||||||||||
releaseyear | No | Year the title was released. | ||||||||||||||||||
runtime | No | Length of the title in minutes. | ||||||||||||||||||
size | No | The number of items you want to be returned. The default is 20. | ||||||||||||||||||
upc | No | Universal Product Code (UPC) for the item. Available only for a catalog of amgvideo. |
Response | Type | Description |
---|---|---|
controlSet | ControlSet | The HTTP response status. |
id | String | Server transaction ID for the response. |
Response | Type | Description |
---|---|---|
results | result [ ] | Information about items that match the criteria specified in the request. |
Code | Description |
---|---|
400 | Incorrect or invalid request. The reason is shown in the Message object in ControlSet. |