Returns basic information about a person, group, or organization, plus customized requests for all of the other content that is available through the Name API. These customized requests are designed to make your programming easy and efficient: in a single step you both verify availability of data and capture the request. You just add the sig parameter and execute the request.
The name/info request also provides optional arguments to include responses from any or all of the other Name API requests. This may return a large amount of data. To speed data transmission, do the following:
Optional parameters for this call give you control over several features:
Upcoming broadcast schedule | Data returned | Response format |
---|---|---|
|
|
|
name/info? | name=name nameid=nameid cosmoid=cosmoid amgpopid=amgpopid amgmovieid=amgmovieid amgclassicalid=amgclassicalid |
&apikey=apikey&sig=sig [&include=include] [&format=format] [&country=country] [&language=language] [&type=type] [&formatid=formatid] [&serviceid=serviceid] [&starttime=starttime] [&duration=duration] [&inprogress=inprogress] [&sourceid=sourceid] [&sourceinclude=sourceinclude] [&sourceexclude=sourceexclude] |
Click to re-sort ♫ Music-related requests 日 DVDs-related requests ⊑⊒ Video-related requests
Parameter | ♫ | 日 | ⊑⊒ | Required | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apikey | ♫ | 日 | ⊑⊒ | Yes | Access code that authorizes your request for data from Rovi. | ||||||||||
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. | ||||||||||
amgclassicalid | ♫ | Conditional | All Media Guide (AMG) ID for a classical music artist, consisting of a ten-character string that starts with Q and is followed by nine digits with leading spaces. For example: Q 9065. When using an AMG Classical ID in a request, replace any spaces in the ID with plus (+) or percent20 (%20) symbols, like this: Q+++++9065. AMG is a legacy database of entertainment information. Condition: The request must contain just one of these parameters:
| ||||||||||||
amgmovieid | 日 | Conditional | All Media Guide (AMG) ID for a person who works in movies, consisting of a seven-character string that starts with P and is followed by 6 digits with leading spaces. For example: P 30474. When using an AMG Movie ID in a request, replace any spaces in the ID with plus (+) or percent20 (%20) symbols, like this: P+30474. Condition: The request must contain just one of these parameters:
| ||||||||||||
amgpopid | ♫ | Conditional | All Media Guide (AMG) ID for a popular music artist, consisting of a ten-character string that starts with P and is followed by 9 digits with leading spaces. For example: P 84363. When using an AMG Pop ID in a request, replace any spaces in the ID with plus (+) or percent20 (%20) symbols, like this: P++++84363. Condition: The request must contain just one of these parameters:
| ||||||||||||
cosmoid | 日 | ⊑⊒ | Conditional | Cosmo database ID for a person, group, or organization. You can get Cosmo IDs with Search requests. Cosmo is a database of television data.
Condition: The request must contain just one of these parameters:
| |||||||||||
name | ♫ | 日 | ⊑⊒ | Conditional | Name of the person or group. This returns the top search result for that name. Replace any spaces with plus (+) or percent20 (%20) symbols.
Condition: The request must contain just one of these parameters:
| ||||||||||
nameid | ♫ | Conditional | Rovi Music ID for a person, group, or organization, consisting of the prefix MN followed by a ten-digit number. For example: MN0000114342. 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 contain just one of these parameters:
| ||||||||||||
serviceid | ⊑⊒ | Conditional | Database ID of a television service for an area. Returns a schedule, or a request for a schedule, of upcoming broadcasts the person appears in. You can get service IDs of television services for an area with Services or GetServices.
You can limit a returned schedule with the following optional parameters:
Condition: Required to return:
| ||||||||||||
country | ♫ | 日 | ⊑⊒ | No | Country of the language of the response. The current release of the API supports only US. | ||||||||||
duration | ⊑⊒ | No | If you specify a serviceid for a schedule of broadcasts the person appears in, duration determines the number of minutes the schedule will cover. You can specify 1 to 20160; the default is 20160 (14 days).
Note: The schedule is determined by duration, inprogress, and starttime. A duration shorter than 5 minutes may miss shows starting just before or after a half-hour point. | ||||||||||||
format | ♫ | 日 | ⊑⊒ | No | Format of the returned data: json or xml. The default is JSON. | ||||||||||
formatid | ♫ | 日 | ⊑⊒ | No | If you specify All or Images in the include parameter, formatid specifies the size and file format of returned images. The format IDs available are shown in the Format IDs table. To select multiple format IDs, specify the IDs as a comma-separated list like this formatid=36,44,51.
Note: Your access to images is governed by your subscription level. | ||||||||||
include | ♫ | 日 | ⊑⊒ | No | Any content to include from other Name API requests. For example, to include the list of songs in the response, add include=songs. For multiple include values, separate the values with commas like this: include=songs,musiccredits. You can also include the contents of all Name API requests with include=all. The possible values are:
For information about a request, please see the documentation for the request. Reminder: These options may return a large amount of data. To speed data transmission, do the following:
| ||||||||||
inprogress | ⊑⊒ | No | If you specify serviceid for a schedule of broadcasts the person appears in, inprogress determines whether shows that are in progress at starttime are included in the schedule: true or false. Default is false.
Note: The schedule is determined by duration, inprogress, and starttime. | ||||||||||||
language | ♫ | 日 | ⊑⊒ | No | Language of the response data. This request supports only en (English). | ||||||||||
sourceid | ⊑⊒ | No | If you specify serviceid for a schedule of broadcasts the person appears in, sourceid determines which channels will appear on the schedule. You can get source IDs from responses to a GetServiceDetails request. Note: a single television source may supply content to multiple channels.
You can specify multiple source IDs in either of the following ways:
| ||||||||||||
sourceexclude | ⊑⊒ | No | If you specify sourceid to select the television sources to be returned, sourceexclude specifies attributes of the channels in the source ID list that you want to eliminate from the channels returned. The possible values are:
You can specify multiple sourceexclude values in either of the following ways:
| ||||||||||||
sourceinclude | ⊑⊒ | No | If you specify sourceid to select the television sources to be returned, sourceinclude specifies an attribute of the channels in the source ID list that you want to include in the list of channels returned. The possible values are:
| ||||||||||||
starttime | ⊑⊒ | No | If you specify serviceid for a schedule of broadcasts the person appears in, starttime determines the starting time of the schedule. The time must be specified as a DateTime value between the time of the request and two weeks in the future. The default is the time of the request.
Note: The schedule is determined by duration, inprogress, and starttime. | ||||||||||||
type | ♫ | No | If you request Discography in the include parameter, type specifies what types of discography to return. To include only videos, for example, add type=video. For multiple filters, separate the values with commas like this: type=video,singles. The possible values are:
|
Response | Type | Description |
---|---|---|
build | String | The software release level of the API. |
code | Integer | HTTP status code. See the status field for the text part of the code. |
duration | Integer | Server processing time in milliseconds. The difference between startTime and endTime. |
endTime | String | When the server sent the response (UTC time). |
messages | Message [ ] | Elements of a multiple HTTP response status message. |
parameters | parameters | List of the parameters included in the request. |
serverName | String | Name of the server that processed the request. |
startTime | String | When the server received the request (UTC time). |
status | String | Text part of the HTTP status code that is shown in the code field. |
Response | Type | Description |
---|---|---|
active | String [ ] | Decades in which the person or group was active in music. |
aliases | String [ ] | Other names the person or group has been known by, returned only if the request specified an include=aliases argument. |
aliasesUri | String | The customized Name/Aliases request, returned only if the data is available. |
associatedWith | NameAssociatedWith [ ] | People who participated in the work of the person or group, returned only if the request specified an include=associatedwith argument. |
associatedWithUri | String | The customized Name/AssociatedWith request, returned only if the data is available. |
birth | Birth | Birth date and birth place of an individual, or founding date and founding place of a group or organization. |
classicalBio | classicalBio | Biography of a person, group, or organization involved in classical music, returned only if the request specified an include=classicalbio argument. |
classicalBioUri | String | The customized Name/ClassicalBio request, returned only if the data is available. |
collaboratorWith | NameCollaboratorWith [ ] | Those who collaborated with the person or group, returned only if the request specified an include=collaboratorwith argument. |
collaboratorWithUri | String | The customized Name/CollaboratorWith request, returned only if the data is available. |
compositions | NameComposition [ ] | Classical compositions by the person or group, returned only if the request specified an include=compositions argument. |
compositionsUri | String | The customized Name/Compositions request, returned only if the data is available. |
contemporaries | NameContemporary [ ] | People doing comparable work and living during the same time as the person or group, returned only if the request specified an include=contemporaries argument. |
contemporariesUri | String | The customized Name/Contemporaries request, returned only if the data is available. |
country | String | A group or individual's country of citizenship or an organization's country of incorporation. |
credits | NameCredit [ ] | Movie and television credits the person earned, returned only if the request specified an include=credits argument. |
creditsUri | String | The customized Name/Credits request, returned only if movie or television credits are available. |
death | Death | Date and place of the death of an individual or the dissolution of a group or organization. |
discography | NameAlbum [ ] | Albums the person, group, or organization contributed to, returned only if the request specified an include=discography argument. |
discographyUri | String | The customized Name/Discography request, returned only if the data is available. |
factsheets | NameFactsheet [ ] | Information about the person or group in a fact-sheet format, returned only if the request specified an include=factsheets argument. |
factsheetsUri | String | The customized Name/Factsheets request, returned only if fact sheets are available. |
filmography | NameMovie [ ] | Films the person, group, or organization contributed to, returned only if the request specified an include=filmography argument. |
filmographyUri | String | The customized Name/Filmography request, returned only if the data is available. |
followers | NameFollower [ ] | Those who followed the person or group and were influenced by them, returned only if the request specified an include=followers argument. |
followersUri | String | The customized Name/Followers request, returned only if the data is available. |
groupMembers | NameGroupMember [ ] | Names of members of the group, returned only if the request specified an include=groupmembers argument. |
groupMembersUri | String | The customized Name/GroupMembers request, returned only if the data is available. |
headlineBio | String | Statement that can be used to introduce a feature about the person, group, or organization. |
ids | ids | All of the IDs that are recognized by the API for a person or group. The possible IDs are:
|
images | Image [ ] | URLs to images of the person, group, or organization, returned only if the request specified an include=images argument and your subscription level enables access to images. |
imagesUri | String | The customized Name/Images request, returned only if the data is available. |
influencers | NameInfluencer [ ] | Those who influenced a person or group, returned only if the request specified an include=influencers argument. |
influencersUri | String | The customized Name/Influencers request, returned only if the data is available. |
isGroup | Boolean | Whether the name is that of a group: true or false. |
memberOf | NameMemberOf [ ] | Groups that a person has been a member of, returned only if the request specified an include=memberof argument. |
memberOfUri | String | The customized Name/MemberOf request, returned only if the data is available. |
moods | Mood [ ] | Terms that describe expressive characteristics of the work of the person, group, or organization, returned only if the request specified an include=moods argument. |
moodsUri | String | The customized Name/Moods request, returned only if the data is available. |
movieBio | MovieBio [ ] | Biography of a person or group involved in movies, returned only if the request specified an include=moviebio argument. |
movieBioUri | String | The customized Name/MovieBio request, returned only if the data is available. |
movieGenres | Genre [ ] | Genres of the films the person, group, or organization has been involved in, along with weightings that reflect the relative importance of each genre. |
movieStyles | Style [ ] | Styles relevant to the work of a person or group in movies, returned only if the request specified an include=moviestyles argument. |
movieStylesUri | String | The customized Name/MovieStyles request, returned only if the data is available. |
musicBio | MusicBio [ ] | Biography of a person or group involved in music, returned only if the request specified an include=musicbio argument. |
musicBioUri | String | The customized Name/MusicBio request, returned only if the data is available. |
musicCredits | NameMusicCredit [ ] | Music production credits of a person, group, or organization, returned only if the request specified an include=musiccredits argument. |
musicCreditsUri | String | The customized Name/MusicCredits request, returned only if the data is available. |
musicGenres | Genre [ ] | Genres of music the person, group, or organization has been involved in. |
musicStyles | Style [ ] | Musical styles of a person, group, or organization, returned only if the request specified an include=musicstyles argument. |
musicStylesUri | String | The customized Name/MusicStyles request, returned only if the data is available. |
name | String | Name of the person, group, or organization. |
period | String | Musical period associated with the person, group, or organization. |
primaryMedia | String | The primary entertainment media the person, group, or organization has been involved in:
|
schedule | schedule | Upcoming television broadcasts a person or group appears in, returned only if the request specified the serviceid and include=schedule arguments. |
scheduleUri | String | The customized Name/Schedule request, returned only if serviceid is specified in the request and the person or group is appearing in an upcoming broadcast on the television service. |
similars | NameSimilar [ ] | Similar individuals and groups, returned only if the request specified an include=similars argument. |
similarsUri | String | The customized Name/Similars request, returned only if the data is available. |
songs | NameSong [ ] | Songs a person, group, or organization contributed to, returned only if the request specified an include=songs argument. |
songsUri | String | The customized Name/Songs request, returned only if the data is available. |
themes | Theme [ ] | Topics, feelings, and circumstances that motivate or fit with the person, group, or organization, returned only if the request specified an include=themes argument. |
themesUri | String | The customized Name/Themes request, returned only if the data is available. |
videos | NameVideo [ ] | Data for constructing links to music videos and video clips that are associated with the person or group, returned only if the request specified an include=videos argument. |
videosUri | String | The customized Name/Videos request, returned only if the data is available. |
web | NameTwitter [ ] | Internet information resources about a person or group, returned only if the request specified an include=web argument. |
webUri | String | The customized Name/Web request, returned only if the data is available. |