Searches titles or names in Rovi Cloud Services and returns results in order of popularity and similarity to the search query.
endpoint/search?apikey=apikey&sig=sig&query=query&entitytype=entitytype [&filter=filter] [&include=include] [&facet=facet] [&format=format] [&country=country] [&language=language] [&offset=offset] [&size=size]
♫ 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 to search.
| |||||||||||||||||||||||||||||||||||||||||||
entitytype | Yes | Type of content to search for.
| |||||||||||||||||||||||||||||||||||||||||||
query | Yes | The search string. Replace spaces with plus (+) or percent20 (%20) symbols. Character case does not affect the results (search is not case-sensitive). | |||||||||||||||||||||||||||||||||||||||||||
sig | Yes | A calculated authorization code. To perform the calculation, execute the MD5 function on the concatenation of the following three strings:
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. | |||||||||||||||||||||||||||||||||||||||||||
country | No | Country of the language of the response. The current release of the API supports only US. | |||||||||||||||||||||||||||||||||||||||||||
facet | No | Count of items available to be returned.
| |||||||||||||||||||||||||||||||||||||||||||
filter | No | Field content that determines which results are returned. Like a WHERE clause in an SQL statement, this parameter selects only results with fields that meet your criteria.
Examples:
The selection operators include:
For the And operation, specify another filter parameter like this: filter=releasedate>:20070101& The following shows which fields you can select for each entity type. If you specify a filter that does not apply to an entity type, no data will be returned for that entity type.
| |||||||||||||||||||||||||||||||||||||||||||
format | No | Format of the returned data: json or xml. The default is JSON. | |||||||||||||||||||||||||||||||||||||||||||
include | No | Additional data to include in each result returned. To include cast members in movie results, for example, specify include=movie:cast. For multiple includes, separate the values with commas like this: include=movie:moods,crew. For multiple entity types, specify separate parameters like this: include=movie:cast,crew&include=tvseries:cast,crew. A request can contain up to 20 include values.
* Notice: Do not include Credits or Factsheets in a production application. They are currently in alpha release and responses may change. | |||||||||||||||||||||||||||||||||||||||||||
language | No | Language of the response data. This request supports only en (English). | |||||||||||||||||||||||||||||||||||||||||||
offset | No | Number of items at the start of the returned list to skip. The default is zero.
Use offset and size to paginate the response. | |||||||||||||||||||||||||||||||||||||||||||
size | No | The number of items you want to be returned. The default is 20. |
Response | Type | Description |
---|---|---|
controlSet | ControlSet | The HTTP response status. |
id | String | Server transaction ID for the response. |
Response | Type | Description |
---|---|---|
facetCounts | facetCounts [ ] | Number of results available to be returned in each genre or entity type, as requested by the facet parameter. |
results | result [ ] | The search results listed in order of popularity and similarity and the filters specified in the request. |
totalResultCounts | Integer | Total number of results found. |
Error Codes
Code | Description |
---|---|
400 | Incorrect or invalid request. The reason is shown in the Message object in ControlSet. |
502 | No results found. The Message object in ControlSet returns the following:
{ "code": "Empty Result", "name": "No results available for this request" } |