Home | Index

Yahoo! Music API Guide

Chapter 5. Rating Service

Table of Contents

Services
Get a user's ratings
Set a user's ratings
Rating Request Post XML (application/xml - ym:Ratings)
Rating List Response (application/xml - ym:Ratings)
ratings
artists

Services

Get a user's ratings

/item/{ymid}/{type}?appid=...&id=...&machineID=...&incremental=...&format=...&callback=...

GET

Returns a user's ratings for one or more types of media.

Requires BBAuth for authentication

Example: http://us.music.yahooapis.com/rating/v1/item/4501956/artist?appid=[yourapplicationidhere]

Responses: “Rating List Response (application/xml - ym:Ratings)”

Required Parameters

Parameter Value Description
ymid long Yahoo! Music User ID
type One of: artist / release / track / video / category / playlist
  • artist

  • release

  • track

  • video

  • category

  • playlist

The type of rating being given.
appid string YDN Application ID. See Application IDs for more information.

Optional Parameters

Parameter Value Default / Possible values Description
id string   Comma-separated list of item IDs to return ratings for (depends on type). If none are passed, returns all ratings for the given type (except playlist). To get all playlist ratings, see machineID and incremental description.
machineId string   GUID of the machine ID for receiving incremental updates
incremental int
  • 1 - returns incremental updates for the given machineID

  • 0 - returns all.

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

  • json

Format of the result.

Set a user's ratings

/item/{ymid}/{type}?appid=...&

POST

Returns a user's ratings for one or more types of media.

Requires BBAuth for authentication

Request: “Rating Request Post XML (application/xml - ym:Ratings)”

Responses: None

Required Parameters

Parameter Value Description
ymid long Yahoo! Music User ID
type One of: artist / release / track / video / category / playlist The type of rating.
appid string YDN Application ID. See Application IDs for more information.

Optional Parameters

Field Description Attributes
Ratings List of Ratings
  • sourceID: The source from where the rating(s) got generated.

Rating Rating for an item. POST data must contain one or more.
  • id: Item ID

  • value: Rating value. Any value from 0 to 100, or -1 (unrated)