Request Parameters

 A

---

Query String	Schema Type	Description	Values
apiKey	apiKey	The API key is issued to developers after they have completed both the Registration form and the API Application form. The API key provides authentication and authorization services, and allows developers to invoke eMusic API methods on the eMusic API. It is a required field with each request. Example: ?apiKey=myKey	(any valid API key)

 C

---

Query String	Schema Type	Description	Values
callback	callback	The callback method is the name of a JavaScript method for responses formatted using JSONP. The method names are supplied by the developer with each request and are required for JSONP responses. (Also see "responseFormat".) Example: ?format=jsonp&callback=someMethod	(any JS method name)

 E

---

Query String	Schema Type	Description	Values
exact	boolean	The "exact" flag is used in conjunction with the "name" field. When exact is set to "true", a method will only return an object (album, artist, book, etc.) if its name exactly matches the name value. If more than one object matches the name parameter, the first object is returned. If no object exactly matches the name parameter, the method throws an exception. (Also see "id" and "name".) Example: ?name=bob+marley&exact=true	true false

 F

---

Query String	Schema Type	Description	Values
filter	filter	Methods with the "filter" parameter allow developers to quickly browse advanced search categories such as "live", "new" and "exclusive" music, etc. It is an optional parameter. Example: ?filter=editorsPicks	advance downloadedThisMonth downloadedThisWeek downloadedToday editorsPicks eMusicLive exclusive hasFreeTracks live new newFreshlyRipped newLast60Days newThisMonth newThisWeek
format	responseFormat	The response format indicates the format of the data returned for a request. Unless otherwise specified, the response is returned as XML. However, all responses can additionally be returned as either JSON or JSONP. If JSONP is requested, a callback method name must also be supplied. (Also see "callback".) Example: ?format=json	xml json jsonp
fref	fref	The FREF (foreign reference) is a value assigned to eMusic developers, upon request. It is used to calculate and pay commissions based on partner links that generate subscriptions. The FREF value is specified by the developer with each request and, as a convenience, the FREF name/value pair is then automatically added to all appropriate eMusic links in the response. Example: ?fref=400060	(any valid fref)

 I

---

Query String	Schema Type	Description	Values
id	id	Many methods require a specific object ID. IDs are always a positive integer, and always uniquely reference a single object. The query string name is prepended with the object type (artist, album, book, etc.) Example: ?albumId=11002212 Example: ?artistId=10559083	(any valid integer)
include	include	The include paramater instructs a method to include extra data in addition to the core response data. For example, artist ratings aren't typically included with album/info -- but they can be included using include=artistRating for this method. Multiple include values can be concatenated together using commas. This parameter is optional. Example: ?include=artistRating Example: ?include=artistRating,albumEditorial	artistEditorial albumEditorial albumRating artist artistRating label relatedArtists
imageSize	imageSize	eMusic manages multiple resolutions of images for artists, albums, etc. The developer may specify the preferred image size with each request. The eMusic API will calculate and return the appropriate image links in the response. The default value is "small". Not all images are available at all sizes! Example: ?imageSize=large	thumbnail small medium large huge

 N

---

Query String	Schema Type	Description	Values
name	searchName	A name is a string value that can be used in place of an ID for methods that require either a name or an ID. Similar to ID, it is prepended with the object type (artist, album, book, etc.) It is important to note that an ID always uniquely references an object, but a name may match more than one object. In the case where a name matches multiple objects, only the first object is returned. If the parameter "exact=true" is also included, the method will return the first object that exactly matches the name, or it will return an exception. (Also see "id" and "exact".) Please remember that query string values must be URL encoded. Example: ?name=bob+marley	(any valid string)

 P

---

Query String	Schema Type	Description	Values
page	integer	Page is used to specify the starting page index for methods that return a list of results. ("search" methods typically return a list of results.) Page is a one-based index (i.e., the first page is 1, the second page is 2). The default value is 1. (Also see "perPage".)	(any valid integer)
perPage	integer	perPage is the number of entries returned for methods that return a list of results. ("search" methods typically return a list of results.) The minimum value for perPage is 1. The maximum value for perPage is 100. The default value is 20. (Also see "page".)	(any valid integer)

 T

---

Query String	Schema Type	Description	Values
term	searchTerm	The search term is a string value that is commonly used for the various search methods. It is a required field when invoking search methods. Please remember that query string values must be URL encoded. Example: ?term=bob+marley	(any valid string)