Web Service Endpoint

Get Heavy Rotation Content

Fetch the resources in heavy rotation for the user.

URL

GET https://api.music.apple.com/v1/me/history/heavy-rotation

Query Parameters

l
string

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 storefront’s defaultLanguageTag is used.

limit
integer

The limit on the number of objects, or number of objects in the specified relationship, that are returned.

offset
integer

The next page or group of objects to fetch.

Response Codes

OK

The request was successful.

Discussion

If successful, the HTTP status code is 200 (OK) and the data array in the ResponseRoot object contains an array of Resource objects. If unsuccessful, the HTTP status code indicates the error and the details are in the errors array. See Handle a Response.

This endpoint requires a music user token. See Getting Keys and Creating Tokens.

Example

https://api.music.apple.com/v1/me/history/heavy-rotation?limit=1
{ "data": [ { "attributes": { "artistName": "C\u00e9line Dion", "artwork": { "bgColor": "121413", "height": 600, "textColor1": "fefefe", "textColor2": "d5d5d5", "textColor3": "cfcfcf", "textColor4": "aeaeae", "url": "https://example.mzstatic.com/image/thumb/Music/v4/88/23/5b/88235b62-fc2f-e457-c55e-0fe689fb467b/source/{w}x{h}bb.jpeg", "width": 604 }, "copyright": "\u2117 Compilation (P) 2008 Sony Music Entertainment Canada Inc.", "genreNames": [ "Pop", "Music", "Adult Contemporary", "Soft Rock", "Vocal", "Rock" ], "isComplete": true, "isMasteredForItunes": false, "isSingle": false, "name": "The Essential Celine Dion", "playParams": { "id": "464056948", "kind": "album" }, "releaseDate": "2008", "trackCount": 27, "url": "https://itunes.apple.com/us/album/the-essential-celine-dion/id464056948" }, "href": "/v1/catalog/us/albums/464056948", "id": "464056948", "type": "albums" } ], "href": "/v1/me/history/heavy-rotation?limit=1", "next": "/v1/me/history/heavy-rotation?offset=1"}

See Also

Recent History

Get Recently Played Resources

Fetch the recently played resources for the user.

Get Recently Played Stations

Fetch recently played radio stations for the user.

Get Recently Added Resources

Fetch the resources recently added to the library.