Home | Index

Yahoo! Music API Guide

Chapter 3. Category Service

Table of Contents

Services
Category(s) by ID
Category tree
User's rated category(s)
Responses
Category List Response (application/xml - ym:Categories)
shortdesc
longdesc
artists
radiostation
videostation
sorts

Services

Category(s) by ID

/item/{ids}?appid=...&ratings=...&response=...&callback=...&format=...

GET

Returns detailed metadata for the specified category(s).

Example: http://us.music.yahooapis.com/category/v1/item/7318858?appid=[yourapplicationidhere]

Responses: “Category List Response (application/xml - ym:Categories)”

Required Parameters

Parameter Value Description
ids string Comma-separated list of category IDs.
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   Comma-separated list of category response chunks to return. See

“Category List Response (application/xml - ym:Categories)”

for possible values.
callback string   If output is json, wraps the result in the specified callback function.
format string
  • xml (default)

  • json

Format of the result.

Category tree

/tree/{type}?appid=...&rootID=...&depth=...&ratings=...&format=...&callback=...

GET

Returns the hierarchical tree of categories, or subcategories, for the given category type.

Example: http://us.music.yahooapis.com/category/v1/tree?appid=[yourapplicationidhere]

Responses: “Category List Response (application/xml - ym:Categories)”

Required Parameters

Parameter Value Default / Possible values Description
type string One of:
  • genre

  • era

  • theme

Type of category to return.
appid string   YDN Application ID. See Application IDs for more information.

Optional Parameters

Parameter Value Default / Possible values Description
rootID int   Category ID that should serve as the root of the tree.
depth int   Maximum number of levels to return in the tree.
ratings long   Yahoo! Music User ID of the user whose ratings should be returned in the result. Requires BBAuth.
callback string   If output is json, wraps the result in the specified callback function.
format string
  • xml (default)

  • json

Format of the result.

User's rated category(s)

/list/rated/{ymid}?appid=...&minRating=...&maxRating=...&ratings=...&response=...&format=...&callback=...&start=...&count=...&sort=...

GET

Returns category(s) that user has rated.

Requires BBAuth for authentication

http://us.music.yahooapis.com/category/v1/list/rated/1905196?appid=[yourapplicationidhere]

Responses: “Category List Response (application/xml - ym:Categories)”

Required Parameters

Parameter Value Description
ymid int Yahoo music 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   Comma-separated list of category response chunks to return. See

“Category List Response (application/xml - ym:Categories)”

for possible values.
callback string   If output is json, wraps the result in the specified callback function.
format string
  • xml (default)

  • json

Format of the result.
start nonNegativeInteger 1 Start index in the list.
count nonNegativeInteger 100 Max 100. Number of items to return from start.
sort string One of:
  • categoryName+

  • categoryName-

  • rating+

  • rating- (default)

Sort order desired, with '+' or '-' suffix to indicate ascending or descending. Ex: rating- Use response=sorts to get the available sort orders for the list.