Sorts up to 20 names, songs, albums, movies, or TV shows by priorities such as newness, current popularity, and all-time popularity, and makes available extensive amounts of data for each result.
This request returns a large amount of data, especially if you use the include parameter to return additional data. To speed data transmission, do the following:
endpoint/sort? | nameid=nameid trackid=trackid albumid=albumid amgvideoid=amgvideoid cosmoprogramid=cosmoprogramid |
&apikey=apikey&sig=sig&sort=sort [&include=include] [&country=country] [&language=language] [&format=format] |
♫ Music-related requests 日 Movie-related requests ⊑⊒ TV-related requests
Parameter | Required | Description | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apikey | Yes | Access code that authorizes your request for data from Rovi. | ||||||||||||||||||||||||||||
endpoint | Yes | Database of the item.
| ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
sort | Yes | Priority to sort on, in ascending or descending order.
Examples:
The priorities you can sort on are:
| ||||||||||||||||||||||||||||
albumid | Conditional | Rovi Music ID for an album, consisting of the prefix MW followed by a ten-digit number, specified like this: albumid=MW0000056882. Requires an endpoint of music.
You can grab album IDs from responses to the following requests:
Condition: The request must specify from 1 to 20 values for just one of these parameters:
| ||||||||||||||||||||||||||||
amgvideoid | Conditional | All Media Guide (AMG) database ID for a movie or TV series, consisting of a ten-character string that starts with V and is followed by 9 digits with leading spaces, specified like this: amgvideoid=V+++295550. Requires an endpoint of amgvideo.
Your application can grab amgvideo IDs from responses to the following requests:
Condition: The request must specify from 1 to 20 values for just one of these parameters:
| ||||||||||||||||||||||||||||
cosmoprogramid | Conditional | Cosmo database ID for a movie or television program, specified like this: cosmoprogramid=3899277. Requires an endpoint of video. Cosmo is a database of television information.
Your application can grab Cosmo IDs from responses to the following requests: Condition: The request must specify from 1 to 20 values for just one of these parameters:
| ||||||||||||||||||||||||||||
nameid | Conditional | Rovi Name ID for a person or group, consisting of the prefix MN followed by a ten-digit number, specified like this: nameid=MN0000114342. Requires an endpoint of music.
Your application can grab name IDs from responses to Search and from Info, Credits, Tracks, and Recommendations requests. For a complete list of requests that return name IDs, click here. Condition: The request must specify from 1 to 20 values for just one of these parameters:
| ||||||||||||||||||||||||||||
trackid | Conditional | Rovi Music ID for a song, consisting of the prefix MT followed by a ten-digit number, specified like this: trackid=MT0009472348. Requires an endpoint of music.
Your application can grab track IDs from responses to the following requests: Condition: The request must specify from 1 to 20 values for just one of these parameters:
| ||||||||||||||||||||||||||||
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.
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. | ||||||||||||||||||||||||||||
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.
| ||||||||||||||||||||||||||||
language | No | Language of the response data. This request supports only en (English). |
Response | Type | Description |
---|---|---|
controlSet | ControlSet | The HTTP response status. |
id | string | Server transaction ID for the response. |
Response | Type | Description |
---|---|---|
results | result [ ] | Information about the items specified in the request, listed in order of the specified priority. |
Code | Description |
---|---|
400 | Incorrect or invalid request. The reason is shown in the Message object in ControlSet. |