Contents

Get a Personal Song Rating

Fetch a user’s rating for a song by using the song’s identifier.

URL

GET https://api.music.apple.com/v1/me/ratings/songs/{id}

Path Parameters

NameTypeDescription
id Requiredstring

The unique identifier for the song.

Query Parameters

NameTypeDescription
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 song. These are the only two ratings supported.

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

Example

See Also

Related Documentation

Requesting Catalog Ratings