Home | Index

Yahoo! Music API Guide

Yahoo! Music API Guide

Abstract

The Yahoo! Music API gives developers access to the Yahoo! Music catalog of artists, albums, tracks, videos, ratings and more. It provides numerous ways to browse the catalog: through charts, search, similarities, genres, artists, and user recommendations and ratings. Adding content to your site becomes simple when using our API and video player.

This Guide contains all the necessary documentation for developers to start building cool new music applications, including the API reference, best practices and examples. Happy hacking!

For developer assistance with the Music API, please check out the Music API Forums


Table of Contents

1. Getting Started
API Design
Important Parameters
Authentication
Supported Locales
Embedding Videos in Your Application
Linking to Yahoo! Music site
Terms of Use
2. Artist Service
Services
Artist(s) by ID
Artists for a given published list/chart
Artists for a category
User's recommended artists
Similar artists
User's rated artists
Search for artists
Responses
Artist List Response (application/xml - ym:Artists)
main
categories
releases
toptracks
topsimilar
radio
fans
videos
sorts
Artists Spelling Response (application/xml - ym:Artists)
SpellResults
Artist RSS Response (application/xml - rss:rss)
Rss
3. Category Service
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
4. Image Service
Services
Video image
Video Station image
Responses
5. Rating Service
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
6. Release Service
Services
Album release(s) by ID
User's recommended releases
Releases for a given published list/chart
Releases for a category
Artist's releases
User's rated releases
Search for releases
Responses
Release List Response (application/xml - ym:Releases)
main
tracks
artists
categories
fans
reviews
sorts
Releases Spelling Response (application/xml - ym:Releases)
SpellResults
Release RSS Response (application/xml - rss:rss)
Rss
7. Station Service
Services
Category radio station(s) by ID
Artist "Fan" radio station(s) by artist ID
User's radio station(s) by user ID
Radio stations for a published list/chart
Category video station(s) by ID
Video stations for a published list/chart
Responses
Station List Response (application/xml - ym:Stations)
main
shortdesc
longdesc
artists
moods
videos
8. Track Service
Services
Track(s) by ID
User's favorite tracks (read)
User's favorite tracks (write)
User's favorite tracks (delete)
Tracks for a given published list/chart
User's recommended tracks
Artist's tracks
Tracks for a category
User's recently played tracks
User's rated tracks
Search for tracks
Responses
Track List Response (application/xml - ym:Tracks)
main
artists
releases
categories
fans
sorts
mappings
videos
Tracks Spelling Response (application/xml - ym:Artists)
SpellResults
Track RSS Response (application/xml - rss:rss)
RSS
9. User Service
Services
User information
Responses
User Auth Response (application/xml - ym:User)
guest
member
User Item Response (application/xml - ym:User)
member/guest
10. Video Service
Services
Video(s) by ID
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
11. XML Response Block documentation
XML Response Blocks
Album XML Block
Artist XML Block
BrandCode XML Block
BrandCodes XML Block
Bumper XML Block
Category XML Block
CountryCode XML Block
Fan XML Block
Fans XML Block
LongDescription XML Block
Mapping XML Block
Mappings XML Block
Media XML Block
Mood XML Block
Moods XML Block
Order XML Block
Package XML Block
Packages XML Block
PaymentLabel XML Block
PlaylistCounts XML Block
PremiumInfo XML Block
Profile XML Block
RadioStations XML Block
RatingCounts XML Block
Rating XML Block
Ratings XML Block
Release XML Block
Releases XML Block
Review XML Block
ShortDescription XML Block
Sort XML Block
Sorts XML Block
SpellResult XML Block
SpellResults XML Block
Station XML Block
TopSimilarArtists XML Block
TopTracks XML Block
Track XML Block
User XML Block
Video XML Block
12. Video Player API
Video Player HTML Example
Required Video Player Variables
Optional Video Player Variables
Video Player Methods
Video Player Events