Contents

Get Multiple Personal Library Music Video Ratings

Fetch the user’s ratings for one or more library music videos by using the library music videos’ identifiers.

URL

GET https://api.music.apple.com/v1/me/ratings/library-music-videos

Query Parameters

NameTypeDescription
ids Required[string]

The unique identifiers for the library music videos.

include Optional[string]

Additional relationships to include in the fetch.

l Optionalstring

The localization to use, specified by a language tag. The possible values are in the supportedLanguageTags array belonging to the Storefront object specified by storefront. Otherwise, the default is defaultLanguageTag in Storefront.

extend Optional[string]

A list of attribute extensions to apply to resources in the response.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
RatingsResponse

The request was successful.

401Unauthorized
Content-Type: application/json
UnauthorizedResponse

A response indicating an incorrect Authorization header.

403Forbidden
Content-Type: application/json
ForbiddenResponse

A response indicating invalid or insufficient authentication.

500Internal Server Error
Content-Type: application/json
ErrorsResponse

A response indicating an error occurred on the server.

Discussion

This endpoint requires a music user token. For more information, see User Authentication for MusicKit.

A rating indicates whether a user likes (1) or dislikes (-1) the music video. These are the only two ratings supported.

For a particular music video, the personal ratings for that video’s catalog ID and library ID (if the video is in the library) stay synced.

Example

See Also

Related Documentation

Requesting Library Ratings