Reference / @open-music-sdk/client-user / getSongRating

Function: getSongRating()

function getSongRating(
   client, 
   id, 
   options?
): Promise<tRatingsResponse>;

Defined in: clients/client-user/src/ratings.ts:71

The listener's rating of the song with an id. A song the listener never rated is answered 404, an ApiError, as it was against the live API on 18 October 2026.

Parameters

client

tAppleMusicClient

The listener's client to ask with.

id

string

The song's id.

options?

tEndpointOptions<tRatingsResponse, object, object>

The language to answer in, and what else to send with the request.

Returns

Promise<tRatingsResponse>

What Apple answered: the rating under data.

Throws

TypeError if client is no client or an argument is not what it should be, before Apple is asked.

Throws

AppleMusicError if Apple, the network, or a token provider fails, or a schema finds issues; _tag says which.

Throws

The reason options.signal aborted with, when it does.

Throws

Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.