/item/{ids}?appid=...&catalog=...&ratings=...&response=...&callback=...&format=...
GET
Returns detailed metadata for the specified release(s).
Example: http://us.music.yahooapis.com/release/v1/item/36113766?appid=[yourapplicationidhere]
Responses: “Release List Response (application/xml - ym:Releases)”
Required Parameters
| Parameter | Value | Description |
|---|---|---|
| ids | string | Comma-separated list of release IDs. |
| appid | string | YDN Application ID. See Application IDs for more information. |
Optional Parameters
| Parameter | Value | Default / Possible values | Description | |
|---|---|---|---|---|
| catalog | int | 123 | Catalog ID to use for resolving the release IDs. Defaults to using the Yahoo Music catalog ID (123) | |
| ratings | long | Yahoo! Music User ID of the user whose ratings should be returned in the result. Requires BBAuth. | ||
| response | string | artists |
Comma-separated list of release response chunks to return. For format=rss response parameter is ignored. See “Release List Response (application/xml - ym:Releases)” for possible values. |
|
| callback | string | If output is json, wraps the result in the specified callback function. | ||
| format | string |
|
Format of the result. |
/list/recommended/{ymid}?appid=...&category=...&maxAge=...&maxYahooAge=...&ratings=...&response=...&callback=...&format=...&start=...&count=...&intersectWith=...&flagWith=...&sort=...
GET
Returns the user's recommended releases (based on ratings and similarities).
Requires BBAuth for authentication
Example: http://us.music.yahooapis.com/release/v1/list/recommended/1905196?appid=[yourapplicationidhere]
Responses: “Release List Response (application/xml - ym:Releases)”
Required Parameters
| Parameter | Value | Description |
|---|---|---|
| ymid | long | Yahoo! Music User ID |
| appid | string | YDN Application ID. See Application IDs for more information. |
Optional Parameters
| Parameter | Value | Default / Possible values | Description | ||
|---|---|---|---|---|---|
| category | int | Category ID with which to filter recommendations | |||
| maxAge | int | >=2 | Maximum number of days since an album was released in order for it to be eligible for inclusion in the results. Must be at least 2. | ||
| maxYahooAge | int | >=2 | Maximum number of days since an album was added to the Yahoo! Music library in order for it to be eligible for inclusion in the results. Must be at least 2. | ||
| ratings | long | Yahoo! Music User ID of the user whose ratings should be returned in the result. Requires BBAuth. | |||
| response | string | artists |
Comma-separated list of release response chunks to return. For format=rss response parameter is ignored. See “Release List Response (application/xml - ym:Releases)” for possible values. |
||
| callback | string | If output is json, wraps the result in the specified callback function. | |||
| format | string |
|
Format of the result. format=rss is RSS 2.0 feed. These may include Yahoo!-published charts or editorial lists. See “Release RSS Response (application/xml - rss:rss)” for RSS output. For format=rss response parameter is ignored. | ||
| start | nonNegativeInteger | 1 | Start index in the list. | ||
| count | nonNegativeInteger | 25 | Max 100. Number of items to return from start. | ||
| intersectWith | string | Examples:
|
A URL-encoded list URI to intersect results with, starting with "/list/". This is the relative URI path of the list. | ||
| flagWith | string | A list URI to flag results with (same format as intersectWith). If an item also exists in the flagWith list, that item will contain a <FlaggedWith id=[listURI] /> element in the result. | |||
| sort | string | Example: artistName+ | Sort order desired, with '+' or '-' suffix to indicate ascending or descending. Ex: artistName+ Use response=sorts to get the available sort orders for the list |
/list/published/{id}?appid=...&ratings=...&response=...&callback=...&format=...&start=...&count=...&intersectWith=...&flagWith=...&sort=...
GET
Returns releases for a given published release list. These may include Yahoo!-published charts or editorial lists.
Example: http://us.music.yahooapis.com/release/v1/list/published/popular?appid=[yourapplicationidhere]
Responses: “Release List Response (application/xml - ym:Releases)”
Required Parameters
| Parameter | Value | Default / Possible values | Description |
|---|---|---|---|
| id | string |
|
Published release list ID. |
| appid | string | YDN Application ID. See Application IDs for more information. |
Optional Parameters
| Parameter | Value | Default / Possible values | Description | ||
|---|---|---|---|---|---|
| ratings | long | Yahoo! Music User ID of the user whose ratings should be returned in the result. Requires BBAuth. | |||
| response | string | artists |
Comma-separated list of release response chunks to return. For format=rss response parameter is ignored. See Release List Response for possible values. |
||
| callback | string | If output is json, wraps the result in the specified callback function. | |||
| format | string |
|
Format of the result. format=rss is RSS 2.0 feed. These may include Yahoo!-published charts or editorial lists. See “Release RSS Response (application/xml - rss:rss)” for RSS output. For format=rss response parameter is ignored. | ||
| start | nonNegativeInteger | 1 | Start index in the list. | ||
| count | nonNegativeInteger | 25 | Max 100. Number of items to return from start. | ||
| intersectWith | string | Examples:
|
A URL-encoded list URI to intersect results with, starting with "/list/". This is the relative URI path of the list. | ||
| flagWith | string | A list URI to flag results with (same format as intersectWith). If an item also exists in the flagWith list, that item will contain a <FlaggedWith id=[listURI] /> element in the result. | |||
| sort | string | Example: artistName+ | Sort order desired, with '+' or '-' suffix to indicate ascending or descending. Ex: artistName+ Use response=sorts to get the available sort orders for the list |
/list/category/{id}?appid=...&ratings=...&response=...&callback=...&format=...&start=...&count=...&intersectWith=...&flagWith=...&sort=...
GET
Returns artists for a given category (ie. genre, theme, era).
Example: http://us.music.yahooapis.com/release/v1/list/category/7318647?appid=[yourapplicationidhere]
Responses: “Release List Response (application/xml - ym:Releases)”
Required Parameters
| Parameter | Value | Description |
|---|---|---|
| id | string | Category ID |
| appid | string | YDN Application ID. See Application IDs for more information. |
Optional Parameters
| Parameter | Value | Default / Possible values | Description | ||
|---|---|---|---|---|---|
| ratings | long | Yahoo! Music User ID of the user whose ratings should be returned in the result. Requires BBAuth. | Yahoo! Music User ID of the user whose ratings should be returned in the result. | ||
| response | string | artists |
Comma-separated list of release response chunks to return. For format=rss response parameter is ignored. See “Release List Response (application/xml - ym:Releases)” for possible values. |
||
| callback | string | If output is json, wraps the result in the specified callback function. | |||
| format | string |
|
Format of the result. format=rss is RSS 2.0 feed. These may include Yahoo!-published charts or editorial lists. See “Release RSS Response (application/xml - rss:rss)” RSS output. For format=rss response parameter is ignored. | ||
| start | nonNegativeInteger | 1 | Start index in the list. | ||
| count | nonNegativeInteger | 25 | Max 100. Number of items to return from start. | ||
| intersectWith | string | Examples:
|
A URL-encoded list URI to intersect results with, starting with "/list/". This is the relative URI path of the list. | ||
| flagWith | string | A list URI to flag results with (same format as intersectWith). If an item also exists in the flagWith list, that item will contain a <FlaggedWith id=[listURI] /> element in the result. | |||
| sort | string | Example: artistName+ | Sort order desired, with '+' or '-' suffix to indicate ascending or descending. Ex: artistName+ Use response=sorts to get the available sort orders for the list |
/list/artist/{id}?appid=...&ratings=...&response=...&callback=...&format=...&start=...&count=...&intersectWith=...&flagWith=...&sort=...
GET
Returns releases for given artist.
Example: http://us.music.yahooapis.com/release/v1/list/artist/256352?appid=[yourapplicationidhere]
Responses: “Release List Response (application/xml - ym:Releases)”
Required Parameters
| Parameter | Value | Description |
|---|---|---|
| id | int | Artist ID |
| appid | string | YDN Application ID. See Application IDs for more information. |
Optional Parameters
| Parameter | Value | Default / Possible values | Description | ||
|---|---|---|---|---|---|
| ratings | long | Yahoo! Music User ID of the user whose ratings should be returned in the result. Requires BBAuth. | |||
| response | string | artists | Comma-separated list of release
response chunks to return. Default is artists. For format=rss
this parameter is ignored. See “Release List Response (application/xml - ym:Releases)” for possible values. |
Comma-separated list of release
response chunks to return. Default is artists. For output=rss
this parameter is ignored. See “Release List Response (application/xml - ym:Releases)” for possible values. |
|
| callback | string | If output is json, wraps the result in the specified callback function. | |||
| format | string |
|
Format of the result. "format=rss" is RSS 2.0 feed. These may include Yahoo!-published charts or editorial lists. See “Release RSS Response (application/xml - rss:rss)” for RSS output. For format=rss reponse parameters is ignored. | ||
| start | nonNegativeInteger | 1 | Start index in the list. | ||
| count | nonNegativeInteger | 25 | Max 100. Number of items to return from start. | ||
| intersectWith | string | Examples:
|
A URL-encoded list URI to intersect results with, starting with "/list/". This is the relative URI path of the list. | ||
| flagWith | string | A list URI to flag results with (same format as intersectWith). If an item also exists in the flagWith list, that item will contain a <FlaggedWith id=[listURI] /> element in the result. | |||
| sort | string | Sort order desired, with '+' or '-' suffix to indicate ascending or descending. Ex: artistName+ Use response=sorts to get the available sort orders for the list. |
/list/rated/{ymid}?appid=...&minRating=...&maxRating=...&ratings=...&response=...&callback=...&format=...&start=...&count=...&intersectWith=...&flagWith=...&sort=...
GET
Returns releases that user has rated.
Requires BBAuth for authentication
Example: http://us.music.yahooapis.com/release/v1/list/rated/1905196?appid=[yourapplicationidhere]
Responses: “Release List Response (application/xml - ym:Releases)”
Required Parameters
| Parameter | Value | Description |
|---|---|---|
| ymid | int | Yahoo! Music User ID |
| appid | string | YDN Application ID. See Application IDs for more information. |
Optional Parameters
| Parameter | Value | Default / Possible values | Description | ||
|---|---|---|---|---|---|
| minRating | int | 0 | All ratings returned will be equal or higher than this value. | ||
| maxRating | int | 100 | All ratings returned will be equal or lower than this value. | ||
| ratings | long | Yahoo! Music User ID of the user whose ratings should be returned in the result. Requires BBAuth. | |||
| response | string | artists | Comma-separated list of release
response chunks to return. Default is artists. For format=rss
this parameter is ignored. See “Release List Response (application/xml - ym:Releases)” for possible values. |
||
| callback | string | If output is json, wraps the result in the specified callback function. | |||
| format | string |
|
Format of the result. "format=rss" is RSS 2.0 feed. These may include Yahoo!-published charts or editorial lists. See “Release RSS Response (application/xml - rss:rss)” for RSS output. For format=rss reponse parameters is ignored. | ||
| start | nonNegativeInteger | 1 | Start index in the list. | ||
| count | nonNegativeInteger | 25 | Max 100. Number of items to return from start. | ||
| intersectWith | string | Examples:
|
A URL-encoded list URI to intersect results with, starting with "/list/". This is the relative URI path of the list. | ||
| flagWith | string | A list URI to flag results with (same format as intersectWith). If an item also exists in the flagWith list, that item will contain a <FlaggedWith id=[listURI] /> element in the result. | |||
| sort | string | Sort order desired, with '+' or '-' suffix to indicate ascending or descending. Ex: artistName+ Use response=sorts to get the available sort orders for the list. |
/list/search/{searchmode}/{keyword}?appid=...&ratings=...&response=...&callback=...&format=...&start=...&count=...&intersectWith=...&flagWith=...&clientid=...&censor=...&spelltoken=...
GET
Returns releases matching a search keyword on a given searchmode.
Example: http://us.music.yahooapis.com/release/v1/list/search/release/aqua?appid=[yourapplicationidhere]
Responses:
Required Parameters
| Parameter | Value | Default / Possible values | Description |
|---|---|---|---|
| searchmode | string | all | Field to search on (only all is currently supported). |
| keyword | string | Keyword to search for (must be properly URL-encoded). | |
| appid | string | YDN Application ID. See Application IDs for more information. |
Optional Parameters
| Parameter | Value | Default / Possible values | Description | ||
|---|---|---|---|---|---|
| ratings | long | Yahoo! Music User ID of the user whose ratings should be returned in the result. Requires BBAuth. | |||
| response | string | artists | Comma-separated list of release
response chunks to return. Default is artists. For format=rss
this parameter is ignored. See “Release List Response (application/xml - ym:Releases)” for possible values. |
||
| callback | string | If output is json, wraps the result in the specified callback function. | |||
| format | string |
|
Format of the result. "format=rss" is RSS 2.0 feed. These may include Yahoo!-published charts or editorial lists. See “Release RSS Response (application/xml - rss:rss)” for RSS output. For format=rss reponse parameters is ignored. | ||
| start | nonNegativeInteger | 1 | Start index in the list. | ||
| count | nonNegativeInteger | 25 | Max 100. Number of items to return from start. | ||
| intersectWith | string | Examples:
|
A URL-encoded list URI to intersect results with, starting with "/list/". This is the relative URI path of the list. | ||
| flagWith | string | A list URI to flag results with (same format as intersectWith). If an item also exists in the flagWith list, that item will contain a <FlaggedWith id=[listURI] /> element in the result. | |||
| censor | boolean | 0 | If 1, will return only 'Family Friendly' results. Else, it will return all results. It is legacy parameter. | ||
| spelltoken | string | Spell token only comes into picture when there are spelling suggestions. Spelling token is passed to client when ever there are spelling suggestions. There could be multiple suggestions. When client search for keyword and get back SpellResult. Out of these results client request one of them back. Client needs to pass the "token" as "spelltoken" when firing query with spelling suggestions. Example Client searched for "aqau"(/release/v1/list/search/release/aqau). As this is a incorrect spelling client gets back the SpellResult and attribute token="n-839755038_q-M.qxPBEeiZrVMvYwKwTLIAAAAA@@". Out of these suggestions client select "aqua" as correct spelling suggestion. It needs to pass token like /release/v1/list/search/release/aqua?spelltoken=n-839755038_qM.qxPBEeiZrVMvYwKwTLIAAAAA@@. |