Home | Index

Yahoo! Music API Guide

Chapter 10. Video Service

Table of Contents

Services
Video(s) by ID
Videos for a given artist
Videos for a given artist letter
Videos for a given published list/chart ***
Sequence of videos for playback purposes
User's favorite videos (read)
User's favorite videos (write)
User's favorite videos (delete)
User's recently played videos
Search for videos
Videos for a category
Videos for a category station
Similar videos
User's recommended videos
User's rated videos
Responses
Video List Response (application/xml - ym:Video)
main
artists
releases
tracks
categories
playback
sorts
Video Spelling Response (application/xml - ym:Artists)
SpellResults
Video RSS Response (application/xml - rss:rss)
Rss

Services

Video(s) by ID

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

GET

Returns detailed metadata for the specified video(s).

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

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

Required Parameters

Parameter Value Description
ids string Comma-separated list of video 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 artists,releases,tracks,categories Comma-separated list of video response chunks to return. Default is artists,releases,tracks,categories. For format=rss response parameter is ignored. See “Video List Response (application/xml - ym:Video)” 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. format=rss is RSS 2.0 feed. See “Video RSS Response (application/xml - rss:rss)” for RSS output. For format=rss, response and verboseLevel parameters are ignored.

Videos for a given artist

/list/artist/{id}?appid=...&sort=...&start=...&count=...&intersectWith=...&flagWith=...&format=...&ratings=...&response=...&callback=...

GET

Returns videos for a given artist.

Example: http://us.music.yahooapis.com/video/v1/list/artist/289282?appid=[yourappidhere]

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

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,releases,tracks,categories Comma-separated list of video response chunks to return. Default is artists,releases,tracks,categories. For format=rss response parameter is ignored. See “Video List Response (application/xml - ym:Video)” for possible values.
callback string   If output is json, wraps the result in the specified callback function.
format string
  • xml (default)

  • json

  • rss

Format of the result. format=rss is RSS 2.0 feed. These may include Yahoo!-published charts or editorial lists. See video rss response for RSS output. For format=rss, response and verboseLevel parameters are ignored.
start nonNegativeInteger 1 Start index in the list.
count nonNegativeInteger 25 Max 100. Number of items to return from start.
intersectWith string Examples:
  • %2Flist%2FrecentlyPlayed%2F4596611

  • %2Flist%2Fpublished%2Fpopular%3Bcount=20

  • %2Flist%2Fsearch%2Fall%2Fmadonna

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.

Videos for a given artist letter

/list/artist/alpha/{letter}?appid=...&sort=...&start=...&count=...&intersectWith=...&flagWith=...&format=...&ratings=...&response=...&callback=...

GET

Returns videos for artists whose sort name start with the given letter. '0' indicates all non-alpha characters.

Example: http://us.music.yahooapis.com/video/v1/list/artist/alpha/a?appid=[yourapplicationidhere]

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

Required Parameters

Parameter Value Description
letter string Alphabet like a, b..z or 0.
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,releases,tracks,categories Comma-separated list of video response chunks to return. Default is artists,releases,tracks,categories. For format=rss response parameter is ignored. See “Video List Response (application/xml - ym:Video)” for possible values.
callback string   If output is json, wraps the result in the specified callback function.
format string
  • xml (default)

  • json

  • rss

Format of the result. format=rss is RSS 2.0 feed. These may include Yahoo!-published charts or editorial lists. See video rss response for RSS output. For format=rss, response and verboseLevel parameters are ignored.
start nonNegativeInteger 1 Start index in the list.
count nonNegativeInteger 25 Max 100. Number of items to return from start.
intersectWith string Examples:
  • %2Flist%2FrecentlyPlayed%2F4596611

  • %2Flist%2Fpublished%2Fpopular%3Bcount=20

  • %2Flist%2Fsearch%2Fall%2Fmadonna

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.

Videos for a given published list/chart ***

/list/published/{id}?appid=...&sort=...&start=...&count=...&intersectWith=...&flagWith=...&format=...&ratings=...&response=...&callback=...

GET

Returns videos for a given published video list. These may include Yahoo!-published charts or editorial lists.

Example: http://us.music.yahooapis.com/video/v1/list/published/popular?appid=[yourapplicationidhere]

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

Required Parameters

Parameter Value Default / Possible values Description
id string Possible values
  • popular (Most Popular Videos)

  • new (Recently Added Videos)

Published video 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. Yahoo! Music User ID of the user whose ratings should be returned in the result.
response string artists,releases,tracks,categories Comma-separated list of video response chunks to return. Default is artists,releases,tracks,categories. For format=rss response parameter is ignored. See “Video List Response (application/xml - ym:Video)” for possible values.  
callback string   If output is json, wraps the result in the specified callback function.  
format string
  • xml (default)

  • json

  • rss

Format of the result. format=rss is RSS 2.0 feed. These may include Yahoo!-published charts or editorial lists. See video rss response for RSS output. For format=rss, response and verboseLevel parameters are ignored.  
start nonNegativeInteger 1 Start index in the list.  
count nonNegativeInteger 25 Max 100. Number of items to return from start.  
intersectWith string Examples:
  • %2Flist%2FrecentlyPlayed%2F4596611

  • %2Flist%2Fpublished%2Fpopular%3Bcount=20

  • %2Flist%2Fsearch%2Fall%2Fmadonna

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  

Sequence of videos for playback purposes

/list/playsequence/{ymid}?appid=...&stationID=...&videoID=...&start=...&count=...&intersectWith=...&flagWith=...&format=...&ratings=...&response=...&callback=...

POST

Returns a sequence of videos for playback purposes. Can be Autoplay (built around an initial seed video), personalized, or based on an editorially defined station.

Requires BBAuth for authentication

Example: http://us.music.yahooapis.com/video/v1/list/playsequence/1905196?appid=[yourapplicationidhere]

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

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
ratings long   Yahoo! Music User ID of the user whose ratings should be returned in the result. Requires BBAuth.
response string artists,releases,tracks,categories Comma-separated list of video response chunks to return. Default is artists,releases,tracks,categories. For format=rss response parameter is ignored. See “Video List Response (application/xml - ym:Video)” for possible values.
callback string   If output is json, wraps the result in the specified callback function.
format string
  • xml (default)

  • json

  • rss

Format of the result. format=rss is RSS 2.0 feed. These may include Yahoo!-published charts or editorial lists. See “Video RSS Response (application/xml - rss:rss)” for RSS output. For format=rss, response and verboseLevel parameters are ignored.
start nonNegativeInteger 1 Start index in the list.
count nonNegativeInteger 25 Max 100. Number of items to return from start.
intersectWith string Examples:
  • %2Flist%2FrecentlyPlayed%2F4596611

  • %2Flist%2Fpublished%2Fpopular%3Bcount=20

  • %2Flist%2Fsearch%2Fall%2Fmadonna

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.
stationID int   ID of an editorial video station
videoID int   Video ID of the "seed" video for Autoplay (usually this is the first video).

User's favorite videos (read)

/list/favorites/{ymid}/{ids}?appid=...&incrementalDate=...&incrementalID=...&sort=...&start=...&count=...&intersectWith=...&flagWith=...&format=...&ratings=...&response=...&callback=...

GET

Returns the user's favorite videos.

Requires BBAuth for authentication

Example: http://us.music.yahooapis.com/video/v1/list/favorites/1905196?appid=[yourapplicationidhere]

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

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
ratings long   Yahoo! Music User ID of the user whose ratings should be returned in the result. Requires BBAuth.
response string artists,releases,tracks,categories Comma-separated list of video response chunks to return. Default is artists,releases,tracks,categories. For format=rss response parameter is ignored. See “Video List Response (application/xml - ym:Video)” for possible values.
callback string   If output is json, wraps the result in the specified callback function.
format string
  • xml (default)

  • json

  • rss

Format of the result. format=rss is RSS 2.0 feed. These may include Yahoo!-published charts or editorial lists. See “Video RSS Response (application/xml - rss:rss)” for RSS output. For format=rss, response and verboseLevel parameters are ignored.
start nonNegativeInteger 1 Start index in the list.
count nonNegativeInteger 25 Max 100. Number of items to return from start.
intersectWith string Examples:
  • %2Flist%2FrecentlyPlayed%2F4596611

  • %2Flist%2Fpublished%2Fpopular%3Bcount=20

  • %2Flist%2Fsearch%2Fall%2Fmadonna

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
incrementalDate dateTime Example: "2005-12-03T07:35:02Z" Return only results that are newer than this date. Must be a GMT date/time, of the format "yyyy-MM-dd'T'HH:mm:ss'Z'". Example: "2005-12-03T07:35:02Z"
incrementalID int   Requires incrementalDate. ID of the last item retrieved in a previous incremental call. The first item retrieved in this call will be the item immediately following that one.

User's favorite videos (write)

/list/favorites/{ymid}/{ids}?appid=...

POST

Saves the specified video(s) to the user's favorite videos.

Requires BBAuth for authentication

Example:

Responses: None

Required Parameters

Parameter Value Description
ymid long Yahoo! Music User ID
ids string Comma-separated list of video IDs. Required for POST and DELETE. Must not appear for GET.
appid string YDN Application ID. See Application IDs for more information.

User's favorite videos (delete)

/list/favorites/{ymid}/{ids}?appid=...

DELETE

Deletes the specified video(s) from the user's favorite videos.

Requires BBAuth for authentication

Example:

Responses: None

Required Parameters

Parameter Value Description
ymid long Yahoo! Music User ID
ids string Comma-separated list of video IDs. Required for POST and DELETE. Must not appear for GET.
appid string YDN Application ID. See Application IDs for more information.

User's recently played videos

/list/recentlyplayed/{ymid}?appid=...&history=...&sort=...&start=...&count=...&intersectWith=...&flagWith=...&format=...&ratings=...&response=...&callback=...

GET

Returns the user's recently played videos. For yahoo logged in users, the Y/T cookie authentication needs to match the ymid on the URL. This call may set the YMT cookie if it isn't passed on the request, needs to be updated or is passed but not valid (or not in sync with the Y/T cookies). B-Cookie need to be passed for trail users.

Requires BBAuth for authentication

Example: http://us.music.yahooapis.com/video/v1/list/recentlyplayed/1905196?appid=[yourapplicationidhere]

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

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
ratings long   Yahoo! Music User ID of the user whose ratings should be returned in the result. Requires BBAuth.
response string artists,releases,tracks,categories Comma-separated list of video response chunks to return. Default is artists,releases,tracks,categories. For format=rss response parameter is ignored. See “Video List Response (application/xml - ym:Video)” for possible values.
callback string   If output is json, wraps the result in the specified callback function.
format string
  • xml (default)

  • json

  • rss

Format of the result. format=rss is RSS 2.0 feed. These may include Yahoo!-published charts or editorial lists. See artist rss response 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:
  • %2Flist%2FrecentlyPlayed%2F4596611

  • %2Flist%2Fpublished%2Fpopular%3Bcount=20

  • %2Flist%2Fsearch%2Fall%2Fmadonna

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
history string 100 Calls the play history for specified time period. For example 30d indicates all plays in last 30 days. A m, h, d suffix may follow where m is minutes, h is hours, and d is days. A number without a suffix like 100 will be treated as an absolute, returning 100 recently played items.

Search for videos

/list/search/{searchmode}/{keyword}?appid=...&ratings=...&response=...&callback=...&format=...&start=...&count=...&intersectWith=...&flagWith=...&clientid=...&censor=...&spelltoken=...

GET

Returns videos matching a search keyword on a given field.

Example: http://us.music.yahooapis.com/video/v1/list/search/all/Madonna?appid=[yourapplicationidhere]

Responses:

Required Parameters

Parameter Value Default / Possible values Description
searchmode string video, all Field to search on.
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,releases,tracks,categories Comma-separated list of video response chunks to return. Default is artists,releases,tracks,categories. For format=rss response parameter is ignored. See “Video List Response (application/xml - ym:Video)” for possible values.
callback string   If output is json, wraps the result in the specified callback function.
format string
  • xml (default)

  • json

  • rss

Format of the result. format=rss is RSS 2.0 feed. These may include Yahoo!-published charts or editorial lists. See “Video RSS Response (application/xml - rss:rss)” for RSS output. For format=rss, response and verboseLevel parameters are ignored.
start nonNegativeInteger 1 Start index in the list.
count nonNegativeInteger 25 Max 100. Number of items to return from start.
intersectWith string Examples:
  • %2Flist%2FrecentlyPlayed%2F4596611

  • %2Flist%2Fpublished%2Fpopular%3Bcount=20

  • %2Flist%2Fsearch%2Fall%2Fmadonna

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   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 "madona"(/artist/v1/list/search/artist/madona). 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 "madonna" as correct spelling suggestion. It needs to pass token like /artist/v1/list/search/artist/madonna?spelltoken=n-839755038_qM.qxPBEeiZrVMvYwKwTLIAAAAA@@
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.

Videos for a category

/list/category/{id}?appid=...&sort=...&start=...&count=...&intersectWith=...&flagWith=...&format=...&ratings=...&response=...&callback=...

GET

Returns videos for a given category (ie. genre, theme, era).

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

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

Required Parameters

Parameter Value Description
id int 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.
response string artists,releases,tracks,categories. Comma-separated list of video response chunks to return. Default is artists,releases,tracks,categories. For format=rss response parameter is ignored. See “Video List Response (application/xml - ym:Video)” for possible values.
callback string   If output is json, wraps the result in the specified callback function.
format string
  • xml (default)

  • json

  • rss

Format of the result. format=rss is RSS 2.0 feed. These may include Yahoo!-published charts or editorial lists. See “Video RSS Response (application/xml - rss:rss)” for RSS output. For format=rss, response and verboseLevel parameters are ignored.
start nonNegativeInteger 1 Start index in the list.
count nonNegativeInteger 25 Max 100. Number of items to return from start.
intersectWith string Examples:
  • %2Flist%2FrecentlyPlayed%2F4596611

  • %2Flist%2Fpublished%2Fpopular%3Bcount=20

  • %2Flist%2Fsearch%2Fall%2Fmadonna

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

Videos for a category station

/list/station/category/{id}?appid=...&sort=...&start=...&count=...&intersectWith=...&flagWith=...&format=...&ratings=...&response=...&callback=...

GET

Returns videos for a given video category station.

Example: http://us.music.yahooapis.com/video/v1/list/station/category/40469072?appid=[yourapplicationidhere]

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

Required Parameters

Parameter Value Description
id int 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.
response string artists,releases,tracks,categories Comma-separated list of video response chunks to return. Default is artists,releases,tracks,categories. For format=rss response parameter is ignored. See “Video List Response (application/xml - ym:Video)” for possible values.
callback string   If output is json, wraps the result in the specified callback function.
format string
  • xml (default)

  • json

  • rss

Format of the result. format=rss is RSS 2.0 feed. These may include Yahoo!-published charts or editorial lists. See “Video RSS Response (application/xml - rss:rss)” for RSS output. For format=rss, response and verboseLevel parameters are ignored.
start nonNegativeInteger 1 Start index in the list.
count nonNegativeInteger 25 Max 100. Number of items to return from start.
intersectWith string Examples:
  • %2Flist%2FrecentlyPlayed%2F4596611

  • %2Flist%2Fpublished%2Fpopular%3Bcount=20

  • %2Flist%2Fsearch%2Fall%2Fmadonna

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.

Similar videos

/list/similar/{id}?appid=...&sort=...&start=...&count=...&intersectWith=...&flagWith=...&format=...&ratings=...&response=...&callback=...

GET

Returns videos similar to the one passed in.

Example: http://us.music.yahooapis.com/video/v1/list/similar/2158463?appid=[yourapplicationidhere]

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

Required Parameters

Parameter Value Description
id int Video 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,releases,tracks,categories Comma-separated list of video response chunks to return. Default is artists,releases,tracks,categories. For format=rss response parameter is ignored. See “Video List Response (application/xml - ym:Video)” for possible values.
callback string   If output is json, wraps the result in the specified callback function.
format string
  • xml (default)

  • json

  • rss

Format of the result. format=rss is RSS 2.0 feed. These may include Yahoo!-published charts or editorial lists. See “Video RSS Response (application/xml - rss:rss)” for RSS output. For format=rss, response and verboseLevel parameters are ignored.
start nonNegativeInteger 1 Start index in the list.
count nonNegativeInteger 25 Max 100. Number of items to return from start.
intersectWith string Examples:
  • %2Flist%2FrecentlyPlayed%2F4596611

  • %2Flist%2Fpublished%2Fpopular%3Bcount=20

  • %2Flist%2Fsearch%2Fall%2Fmadonna

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.

User's recommended videos

/list/recommended/{ymid}?appid=...&recentness=...&includeRated=...&sample=...&source=...&sort=...&format=...&start=...&count=...&intersectWith=...&flagWith=...&ratings=...&response=...&callback=...

GET

Returns the user's recommended videos (based on ratings and similarities).

Requires BBAuth for authentication

Example: http://us.music.yahooapis.com/video/v1/list/recommended/1905196?appid=[yourapplicationidhere]

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

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
recentness int   Number of days back for which to apply recentness bias.
includeRated boolean   Whether or not to include rated items in the candidate pool.
sample string top Name of the algorithm to use when sampling recommended videos.
  • top

    Returns top items by score

  • partition

    Scored items are divided into n separate partitions (n=3 for now) simply by choosing every n-th video for each partition, starting from the 1st,2nd,...(n-1)th video in the list sorted by score. The partition to return is determined currently by (day of year) mod n, so that a different set of recs will be returned on successive days.

  • geometric

    Samples the scored pool randomly, trying to get a geometric distribution of videos by score (a geometric distribution is a discrete exponential distribution, and can be described by P(n) = p*(1-p)^n.) This gives a variety of recommendations across scores, while still favoring highly scored items.

  • clustering

    Videos are divided into several bins by score and then sampled randomly, again according to a geometric distribution. The difference between this and the previous method is that will better handle the case where the video scores are not distributed evenly from 0-100. The prior method, for example, might return fewer than the requested number of videos if there are no scores > 70, while this method should.

source string One of:
  • popular

  • new

Restricts recommendations to either popular or new videos. The default behavior is to use all available sources, which is the union of popular videos, new videos, videos by rated artists, videos from rated genres, videos similar to current items, and power-rated videos.
ratings long   Yahoo! Music User ID of the user whose ratings should be returned in the result. Requires BBAuth.
response string artists,releases,tracks,categories Comma-separated list of video response chunks to return. Default is artists,releases,tracks,categories. For format=rss response parameter is ignored. See “Video List Response (application/xml - ym:Video)” for possible values.
callback string   If output is json, wraps the result in the specified callback function.
format string
  • xml (default)

  • json

  • rss

Format of the result. format=rss is RSS 2.0 feed. These may include Yahoo!-published charts or editorial lists. See “Video RSS Response (application/xml - rss:rss)” for RSS output. For format=rss, response and verboseLevel parameters are ignored.
start nonNegativeInteger 1 Start index in the list.
count nonNegativeInteger 25 Max 100. Number of items to return from start.
intersectWith string Examples:
  • %2Flist%2FrecentlyPlayed%2F4596611

  • %2Flist%2Fpublished%2Fpopular%3Bcount=20

  • %2Flist%2Fsearch%2Fall%2Fmadonna

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.

User's rated videos

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

GET

Returns videos that the user has rated.

Requires BBAuth for authentication

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

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

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
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,releases,tracks,categories Comma-separated list of video response chunks to return. Default is artists,releases,tracks,categories. For format=rss response parameter is ignored. “Video List Response (application/xml - ym:Video)” for possible values.
callback string   If output is json, wraps the result in the specified callback function.
format string
  • xml (default)

  • json

  • rss

Format of the result. format=rss is RSS 2.0 feed. These may include Yahoo!-published charts or editorial lists. See “Video RSS Response (application/xml - rss:rss)” for RSS output. For format=rss, response and verboseLevel parameters are ignored.
start nonNegativeInteger 1 Start index in the list.
count nonNegativeInteger 25 Max 100. Number of items to return from start.
intersectWith string Examples:
  • %2Flist%2FrecentlyPlayed%2F4596611

  • %2Flist%2Fpublished%2Fpopular%3Bcount=20

  • %2Flist%2Fsearch%2Fall%2Fmadonna

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.