Amazon Music Web API
Web API Views
Important:
These Amazon Music documents are in preview status. Be aware that content may change. Please use the
developer forum for any questions or comments.
Views
Provides high-level views of Amazon Music catalog content suitable for browsing. For an explanation of the basics of views, see the views overview.
- Home View
- Podcasts View
- Artist Details View
- Album Details View
- Playlist Details View
- Podcast Show Details View
- My Library View
- My Library Albums View
- My Library Artists View
- My Library Songs View
- My Library Playlists View
- My Library Podcasts View
- Recently Played View
Home View
GET
/v1/views/home/{groupId}
The home view surfaces personalized content recommendations for the user such as what they might see on Amazon Music's home page. The content is represented by a collection of entities (music and podcasts) grouped in sections. Optional parameters can be used to limit the number of entities within a single entity group returned.
Path Parameters
| Name | Data Type | Required | Description |
|---|---|---|---|
| groupId | string | Yes | The group ID of the entity group to be retrieved. |
Query Parameters
| Name | Data Type | Required | Description |
|---|---|---|---|
| cursor | string | No | The cursor/token for the page to continue pagination results from. |
| limit | number | No | The maximum number of tracks to return (default: 10). Minimum of 1, maximum of 10. |
Example
curl --request GET '<base url>/v1/views/home?limit=5'
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'
--header 'Accept-Language: <desired locale>'
--header 'amzn-image-style: <desired image style>'
Responses
Amazon Music response object containing a response collection of top tracks for this user.
Example
(Some lines omitted for brevity)
{
"data": {
"_type": "View",
"id": "home",
"images": [],
"content": {
"_type": "ViewContent",
"nextPageToken": "a9634283-7988-428a-a5c7-1d17d61f388e",
"entityGroups": [{
"_type": "EntityGroup",
"id": "mp3-subscription-gateway_mp3YourHeaviestListeningStrategy",
"title": "Your Frequent Plays",
"viewType": "LIST",
"content": {
"_type": "EntityGroupContent",
"nextPageToken": "75edff21-5b28-43f9-8272-f533182fd896",
"entities": [{
"_type": "Album",
"id": "B0BBB43TGW",
"title": "Never Before Seen, Never Again Found [Explicit]",
"artists": [{
"id": "B07VPCLT49",
"name": "Arm's Length"
}],
"images": [{
"url": "https://..."
}],
"playParams": {
"id": "mrn:1.0:catalog:album:asin:B0BBB43TGW?territory=US",
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
}
},
{
"_type": "Artist",
"id": "B07VPCLT49",
"images": [
{
"url": "https://..."
}
],
"name": "Arm's Length",
"playParams": {
"id": "mrn:1.0:catalog:artist:asin:B07VPCLT49?territory=US",
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
}
},
...
},
...
]
}
}
}
Podcasts View
GET
/v1/views/podcasts/{groupId}
The podcast view surfaces personalized podcast recommendations for the user. The content is represented by a collection of podcast entities grouped in sections. Optional parameters can be used to limit the number of entities within a single entity group returned.
Path Parameters
| Name | Data Type | Required | Description |
|---|---|---|---|
| groupId | string | Yes | The group ID of the entity group to be retrieved. |
Query Parameters
| Name | Data Type | Required | Description |
|---|---|---|---|
| cursor | string | No | The cursor/token for the page to continue pagination results from. |
| limit | number | No | The maximum number of tracks to return (default: 10). Minimum of 1, maximum of 10. |
Example
curl --request GET '<base url>/v1/views/podcasts'
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'
--header 'Accept-Language: <desired locale>'
--header 'amzn-image-style: <desired image style>'
Responses
Amazon Music response object containing a response collection of top tracks for this user.
Example
(Some lines omitted for brevity)
{
"data": {
"_type": "View",
"id": "podcasts",
"images": [],
"content": {
"_type": "ViewContent",
"nextPageToken": "%2255271b4e-b314-48f8-8611-0f5781b1481a%22",
"entityGroups": [
{
"_type": "EntityGroup",
"id": "PodcastsYouFollowStrategy-2b0a291c-5e3d-4a46-8bac-26cc70db46a9%23EDITORIAL%23PODCASTS",
"title": "Podcasts You Follow",
"viewType": "LIST",
"content": {
"nextPageToken": null,
"entities": [
{
"_type": "PodcastShow",
"id": "44e24353-f327-49c0-ae75-2d807da67137",
"title": "Software Engineering Daily",
"author": "softwareengineeringdaily.com",
"images": [
{
"url": "https://..."
}
],
"playParams": {
"id": "mrn:1.0:podcast:show:uuid:44e24353-f327-49c0-ae75-2d807da67137",
"selections": [
"PLAY"
]
}
},
{
"_type": "PodcastShow",
"id": "3290ade0-6edf-4efa-b632-2efe2e6a7481",
"title": "Pod Save America",
"author": "Crooked Media",
"images": [
{
"url": "https://..."
}
],
"playParams": {
"id": "mrn:1.0:podcast:show:uuid:3290ade0-6edf-4efa-b632-2efe2e6a7481",
"selections": [
"PLAY"
]
}
},
...
},
...
]
}
}
}
Artist Details View
GET
/v1/views/artist/{id}
The artist details view surfaces recommended content for a specific artist. The content is represented by a collection of music entities grouped in sections (e.g.: Releases, Top Songs, Related Playlists, etc.). Optional parameters can be used to limit the number of entities within a single entity group returned.
Path Parameters
| Name | Data Type | Required | Description |
|---|---|---|---|
| id | string | Yes | The ID of the artist to be retrieved. |
Query Parameters
| Name | Data Type | Required | Description |
|---|---|---|---|
| cursor | string | No | The cursor/token for the page to continue pagination results from. |
| limit | number | No | The maximum number of tracks to return (default: 10). Minimum of 1, maximum of 10. |
Example
curl --request GET '<base url>/v1/views/artist/B000QJJOSO'
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'
--header 'Accept-Language: <desired locale>'
--header 'amzn-image-style: <desired image style>'
Responses
Amazon Music response object containing a response collection of top tracks for this user.
Example
(Some lines omitted for brevity)
{
"data": {
"_type": "View",
"id": "B000QJJOSO",
"title": "Green Day",
"images": [{
"url": "https://..."
}],
"entity": {
"_type": "Artist",
"id": "B000QJJOSO",
"images": [{
"url": "https://..."
}],
"name": "Green Day",
"followerCount": 994491,
"playParams": {
"id": "mrn:1.0:catalog:artist:asin:B000QJJOSO?territory=US",
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
}
},
"content": {
"_type": "ViewContent",
"entityGroups": [{
"_type": "EntityGroup",
"id": "top-songs",
"title": "Top Songs",
"viewType": "TABLE",
"content": {
"_type": "EntityGroupContent",
"nextPageToken": "tcs-V1_ZU3RMV2x",
"entities": [{
"_type": "Track",
"id": "B0011Z4ZDQ",
"isrc": "USRE19900151",
"title": "Basket Case [Explicit]",
"album": {
"id": "B0011Z330C",
"title": "Dookie [Explicit]"
},
"artists": [{
"id": "B000QJJOSO",
"name": "Green Day"
}],
"images": [{
"url": "https://..."
}],
"playParams": {
"id": "mrn:1.0:catalog:track:asin:B0011Z4ZDQ?territory=US",
"containerId": null,
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
}
},
{
"_type": "Track",
"id": "B0011Z8OFG",
"isrc": "USRE19700545",
"title": "Good Riddance (Time of Your Life) [Explicit]",
"album": {
"id": "B0011Z503U",
"title": "Nimrod [Explicit]"
},
"artists": [{
"id": "B000QJJOSO",
"name": "Green Day"
}],
"images": [{
"url": "https://..."
}],
"playParams": {
"id": "mrn:1.0:catalog:track:asin:B0011Z8OFG?territory=US",
"containerId": null,
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
}
},
...
]
}
},
...
]
}
}
}
Album Details View
GET
/v1/views/album/{id}
The album details view surfaces recommended content for a specific album. The content is represented by a collection of music entities grouped in sections (e.g.: Tracks, Related Albums, etc.). Optional parameters can be used to limit the number of entities within a single entity group returned.
Path Parameters
| Name | Data Type | Required | Description |
|---|---|---|---|
| id | string | Yes | The ID of the album to be retrieved. |
Query Parameters
| Name | Data Type | Required | Description |
|---|---|---|---|
| cursor | string | No | The cursor/token for the page to continue pagination results from. |
| limit | number | No | The maximum number of tracks to return (default: 10). Minimum of 1, maximum of 10. |
Example
curl --request GET '<base url>/v1/views/album/B0CKMM9LJF'
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'
--header 'Accept-Language: <desired locale>'
--header 'amzn-image-style: <desired image style>'
Responses
Amazon Music View response object containing music and podcast entities grouped in categories.
Example
(Some lines omitted for brevity)
{
"data": {
"_type": "View",
"id": "B0CKMM9LJF",
"title": "Saviors [Explicit]",
"images": [],
"entity": {
"_type": "Album",
"id": "B0CKMM9LJF",
"images": [{
"url": "https://..."
}],
"title": "Saviors [Explicit]",
"duration": 2763,
"releaseDate": "2024-01-19T05:00:00.000Z",
"trackCount": 15,
"label": "Reprise",
"artists": [{
"id": "B000QJJOSO",
"name": "Green Day"
}],
"playParams": {
"id": "mrn:1.0:catalog:album:asin:B0CKMM9LJF?territory=US",
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
}
},
"content": {
"_type": "ViewContent",
"entityGroups": [{
"_type": "EntityGroup",
"id": "songs",
"viewType": "STACK",
"content": {
"_type": "EntityGroupContent",
"entities": [{
"_type": "Track",
"id": "B0CKMNFPJQ",
"isrc": "USRE12300349",
"title": "The American Dream Is Killing Me [Explicit]",
"album": {
"id": "B0CKMM9LJF",
"title": "Saviors [Explicit]"
},
"artists": [{
"id": "B000QJJOSO",
"name": "Green Day"
}],
"images": [{
"url": "https://..."
}],
"playParams": {
"id": "mrn:1.0:catalog:track:asin:B0CKMNFPJQ?territory=US",
"containerId": "mrn:1.0:catalog:album:asin:B0CKMM9LJF?territory=US",
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
}
},
{
"_type": "Track",
"id": "B0CKMHBJCW",
"isrc": "USRE12201089",
"title": "Look Ma, No Brains! [Explicit]",
"album": {
"id": "B0CKMM9LJF",
"title": "Saviors [Explicit]"
},
"artists": [{
"id": "B000QJJOSO",
"name": "Green Day"
}],
"images": [{
"url": "https://..."
}],
"playParams": {
"id": "mrn:1.0:catalog:track:asin:B0CKMHBJCW?territory=US",
"containerId": "mrn:1.0:catalog:album:asin:B0CKMM9LJF?territory=US",
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
}
},
...
]
}
}]
}
}
}
Playlist Details View
GET
/v1/views/playlist/{id}
The playlist details view surfaces recommended content for a specific playlist. The content is represented by a collection of music entities grouped in sections (e.g.: Tracks, Similar Playlists, etc.). Optional parameters can be used to limit the number of entities within a single entity group returned.
Path Parameters
| Name | Data Type | Required | Description |
|---|---|---|---|
| id | string | Yes | The ID of the playlist to be retrieved. |
Query Parameters
| Name | Data Type | Required | Description |
|---|---|---|---|
| cursor | string | No | The cursor/token for the page to continue pagination results from. |
| limit | number | No | The maximum number of tracks to return (default: 10). Minimum of 1, maximum of 10. |
Example
curl --request GET '<base url>/v1/views/playlist/B00J9PVXBM'
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'
--header 'Accept-Language: <desired locale>'
--header 'amzn-image-style: <desired image style>'
Responses
Amazon Music response object containing a response collection of top tracks for this user.
Example
(Some lines omitted for brevity)
{
"data": {
"_type": "View",
"id": "B00J9PVXBM",
"title": "Upbeat Pop",
"images": [],
"entity": {
"_type": "Playlist",
"id": "B00J9PVXBM",
"images": [
{
"url": "https://..."
}
],
"title": "Upbeat Pop",
"curator": {
"id": null,
"name": "Amazon's Music Experts"
},
"description": "Feel better about life with these smile-inspiring songs.",
"duration": 7594,
"playParams": {
"id": "mrn:1.0:catalog:playlist:asin:B00J9PVXBM?territory=US",
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
}
},
"content": {
"_type": "ViewContent",
"entityGroups": [
{
"_type": "EntityGroup",
"id": "songs",
"viewType": "STACK",
"content": {
"_type": "EntityGroupContent",
"nextPageToken": null,
"entities": [
{
"_type": "Track",
"id": "B0B89BH72Q",
"isrc": "USSM12204574",
"title": "Made You Look",
"album": {
"id": "B0B8B11HK3",
"title": "Takin' It Back [Explicit]"
},
"artists": [
{
"id": "B00322EK68",
"name": "Meghan Trainor"
}
],
"images": [
{
"url": "https://..."
}
],
"playParams": {
"id": "mrn:1.0:catalog:track:asin:B0B89BH72Q?territory=US",
"containerId": "mrn:1.0:catalog:playlist:asin:B00J9PVXBM?territory=US",
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
}
},
{
"_type": "Track",
"id": "B0CJH255DN",
"isrc": "USUG12306677",
"title": "Shake It Off (Taylor's Version)",
"album": {
"id": "B0CJH7JZV8",
"title": "1989 (Taylor's Version)"
},
"artists": [
{
"id": "B00157GJ20",
"name": "Taylor Swift"
}
],
"images": [
{
"url": "https://..."
}
],
"playParams": {
"id": "mrn:1.0:catalog:track:asin:B0CJH255DN?territory=US",
"containerId": "mrn:1.0:catalog:playlist:asin:B00J9PVXBM?territory=US",
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
}
},
...
]
}
}
]
}
}
}
Podcast Show Details View
GET
/v1/views/podcasts/{id}
The album details view surfaces recommended content for a specific podcast show. The content is represented by a collection of music entities grouped in sections (e.g.: Episodes, Similar Podcasts, etc.). Optional parameters can be used to limit the number of entities within a single entity group returned.
Path Parameters
| Name | Data Type | Required | Description |
|---|---|---|---|
| id | string | Yes | The ID of the playlist to be retrieved. |
Query Parameters
| Name | Data Type | Required | Description |
|---|---|---|---|
| cursor | string | No | The cursor/token for the page to continue pagination results from. |
| limit | number | No | The maximum number of tracks to return (default: 10). Minimum of 1, maximum of 10. |
Example
curl --request GET '<base url>/v1/views/podcasts/6d261659-cc8d-478c-b052-19dfeb25dcf5'
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'
--header 'Accept-Language: <desired locale>'
--header 'amzn-image-style: <desired image style>'
Responses
Amazon Music response object containing a response collection of top tracks for this user.
Example
(Some lines omitted for brevity)
{
"data": {
"_type": "View",
"id": "d6e3946e-6b3f-48dc-a3ae-fdc7c9d699f0",
"title": "Crime Junkie",
"images": [],
"entity": {
"_type": "PodcastShow",
"id": "d6e3946e-6b3f-48dc-a3ae-fdc7c9d699f0",
"images": [
{
"url": "https://..."
}
],
"title": "Crime Junkie",
"author": "audiochuck",
"description": "If you can never get enough true crime... Congratulations, you’ve found your people.",
"playParams": {
"id": "mrn:1.0:podcast:show:uuid:d6e3946e-6b3f-48dc-a3ae-fdc7c9d699f0",
"selections": [
"PLAY"
]
}
},
"content": {
"_type": "ViewContent",
"entityGroups": [
{
"_type": "EntityGroup",
"id": "episodes",
"viewType": "STACK",
"content": {
"_type": "EntityGroupContent",
"nextPageToken": "0%3A97ac6538-dc9b-46c8-b617-30b2a89229a9",
"entities": [
{
"_type": "PodcastEpisode",
"id": "57a461ef-6fa6-4f1f-bbef-2be2bcc5c9f6",
"title": "MISSING: Runaway Train Kids",
"author": "audiochuck",
"seasonNumber": null,
"episodeNumber": null,
"releaseDate": "2024-02-06T08:00:00Z",
"duration": 3604,
"images": [
{
"url": "https://..."
}
],
"podcast": {
"id": "d6e3946e-6b3f-48dc-a3ae-fdc7c9d699f0",
"title": "Crime Junkie"
},
"playParams": {
"id": "mrn:1.0:podcast:episode:uuid:57a461ef-6fa6-4f1f-bbef-2be2bcc5c9f6",
"containerId": null,
"selections": [
"PLAY"
]
},
"playbackInformation": {
"progressMilliseconds": null
}
},
{
"_type": "PodcastEpisode",
"id": "78e7f689-8654-441e-8b84-de60c7885f11",
"title": "MISSING: Maura Murray (NEW)",
"author": "audiochuck",
"seasonNumber": null,
"episodeNumber": null,
"releaseDate": "2024-02-05T08:00:00Z",
"duration": 4586,
"images": [
{
"url": "https://..."
}
],
"podcast": {
"id": "d6e3946e-6b3f-48dc-a3ae-fdc7c9d699f0",
"title": "Crime Junkie"
},
"playParams": {
"id": "mrn:1.0:podcast:episode:uuid:78e7f689-8654-441e-8b84-de60c7885f11",
"containerId": null,
"selections": [
"PLAY"
]
},
"playbackInformation": {
"progressMilliseconds": null
}
},
{
"_type": "PodcastEpisode",
"id": "0be89824-30c6-41d4-8307-7f1799cd7184",
"title": "INFAMOUS: Aarushi Talwar & Hemraj Banjade",
"author": "audiochuck",
"seasonNumber": null,
"episodeNumber": null,
"releaseDate": "2024-01-29T08:00:00Z",
"duration": 3025,
"images": [
{
"url": "https://..."
}
],
"podcast": {
"id": "d6e3946e-6b3f-48dc-a3ae-fdc7c9d699f0",
"title": "Crime Junkie"
},
"playParams": {
"id": "mrn:1.0:podcast:episode:uuid:0be89824-30c6-41d4-8307-7f1799cd7184",
"containerId": null,
"selections": [
"PLAY"
]
},
"playbackInformation": {
"progressMilliseconds": null
}
},
{
"_type": "PodcastEpisode",
"id": "7093b438-74a1-446b-b2c4-bacd75f4c105",
"title": "MYSTERIOUS DEATH OF: Lauren Agee",
"author": "audiochuck",
"seasonNumber": null,
"episodeNumber": null,
"releaseDate": "2024-01-22T08:00:00Z",
"duration": 2261,
"images": [
{
"url": "https://..."
}
],
"podcast": {
"id": "d6e3946e-6b3f-48dc-a3ae-fdc7c9d699f0",
"title": "Crime Junkie"
},
"playParams": {
"id": "mrn:1.0:podcast:episode:uuid:7093b438-74a1-446b-b2c4-bacd75f4c105",
"containerId": null,
"selections": [
"PLAY"
]
},
"playbackInformation": {
"progressMilliseconds": null
}
},
{
"_type": "PodcastEpisode",
"id": "97ac6538-dc9b-46c8-b617-30b2a89229a9",
"title": "MURDERED: Christie Mullins",
"author": "audiochuck",
"seasonNumber": null,
"episodeNumber": null,
"releaseDate": "2024-01-15T08:00:00Z",
"duration": 3277,
"images": [
{
"url": "https://..."
}
],
"podcast": {
"id": "d6e3946e-6b3f-48dc-a3ae-fdc7c9d699f0",
"title": "Crime Junkie"
},
"playParams": {
"id": "mrn:1.0:podcast:episode:uuid:97ac6538-dc9b-46c8-b617-30b2a89229a9",
"containerId": null,
"selections": [
"PLAY"
]
},
"playbackInformation": {
"progressMilliseconds": null
}
}
]
}
}
]
}
}
}
My Library View
GET
/v1/views/library/{groupId}
The My Library view surfaces music and podcast content previously added to the user's library. The content is represented by a customer related information (name, profile picture) and by a collection of music and podcast entities grouped in sections (e.g.: My Albums, Podcast Shows You Follow, etc.). Optional parameters can be used to limit the number of entities within a single entity group returned.
Path Parameters
| Name | Data Type | Required | Description |
|---|---|---|---|
| groupId | string | Yes | The group ID of the entity group to be retrieved. |
Query Parameters
| Name | Data Type | Required | Description |
|---|---|---|---|
| cursor | string | No | The cursor/token for the page to continue pagination results from. |
| limit | number | No | The maximum number of tracks to return (default: 10). Minimum of 1, maximum of 10. |
Example
curl --request GET '<base url>/v1/views/library'
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'
--header 'Accept-Language: <desired locale>'
--header 'amzn-image-style: <desired image style>'
Responses
Amazon Music response object containing a response collection of top tracks for this user.
Example
(Some lines omitted for brevity)
{
"data": {
"_type": "View",
"id": "library",
"title": "Library",
"images": [],
"entity": {
"_type": "User",
"id": "2efopvnhmjf7xuujlde55puahq",
"images": [{
"url": "https://..."
}],
"name": "Vic"
},
"content": {
"_type": "ViewContent",
"entityGroups": [{
"_type": "EntityGroup",
"id": "playlists",
"title": "Playlists",
"viewType": "LIST",
"content": {
"_type": "EntityGroupContent",
"nextPageToken": null,
"entities": [{
"_type": "Playlist",
"id": "e45df856-2ab7-424e-ba70-76931f50da47",
"title": "2h company",
"images": [{
"url": "https://..."
}],
"playParams": {
"id": "mrn:1.0:library:playlist:uuid:e45df856-2ab7-424e-ba70-76931f50da47",
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
}
},
{
"_type": "Playlist",
"id": "bb959a05-0697-4934-9766-a7ca7bd11aea",
"title": "carribean vibes",
"images": [{
"url": "https://..."
}],
"playParams": {
"id": "mrn:1.0:library:playlist:uuid:bb959a05-0697-4934-9766-a7ca7bd11aea",
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
}
},
...
]
}
},
...
]
}
}
}
My Library Albums View
GET
/v1/views/library/albums
Retrieve music albums previously added to the user's library. The content is represented by a customer related information (name, profile picture) and by a collection of music albums grouped in sections (e.g.: My Albums). Optional parameters can be used to limit the number of entities within a single entity group returned.
Query Parameters
| Name | Data Type | Required | Description |
|---|---|---|---|
| cursor | string | No | The cursor/token for the page to continue pagination results from. |
| limit | number | No | The maximum number of tracks to return (default: 10). Minimum of 1, maximum of 10. |
Example
curl --request GET '<base url>/v1/views/library/albums'
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'
--header 'Accept-Language: <desired locale>'
--header 'amzn-image-style: <desired image style>'
Responses
Amazon Music response object containing a response collection of top tracks for this user.
Example
(Some lines omitted for brevity)
{
"data": {
"_type": "View",
"id": "library-albums",
"title": "Albums",
"images": [],
"entity": {
"_type": "User",
"id": "2efopvnhmjf7xuujlde55puahq",
"images": [
{
"url": "https://..."
}
],
"name": "Vic"
},
"content": {
"_type": "ViewContent",
"entityGroups": [
{
"_type": "EntityGroup",
"id": "albums",
"viewType": "GRID",
"content": {
"_type": "EntityGroupContent",
"nextPageToken": "tcs-V1_ZU3RMV2xXC3Ay...",
"entities": [
{
"_type": "Album",
"id": "B01D9PGS4E",
"title": "Hooligans United a Tribute to Rancid",
"artists": [
{
"id": "B000QJO93Y",
"name": "VARIOUS ARTISTS"
}
],
"images": [
{
"url": "https://..."
}
],
"playParams": {
"id": "mrn:1.0:library:album:asin:B01D9PGS4E?territory=US",
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
}
},
{
"_type": "Album",
"id": "B07ZMJ4HFR",
"title": "All The Moon Stompers [Explicit]",
"artists": [
{
"id": "B000QJNMIC",
"name": "Rancid"
}
],
"images": [
{
"url": "https://..."
}
],
"playParams": {
"id": "mrn:1.0:library:album:asin:B07ZMJ4HFR?territory=US",
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
}
},
...
]
}
}
]
}
}
}
My Library Artists View
GET
/v1/views/library/artists
Retrieve music artists previously added to the user's library. The content is represented by a customer related information (name, profile picture) and by a collection of artists grouped in sections (e.g.: Artists You Follow). Optional parameters can be used to limit the number of entities within a single entity group returned.
Query Parameters
| Name | Data Type | Required | Description |
|---|---|---|---|
| cursor | string | No | The cursor/token for the page to continue pagination results from. |
| limit | number | No | The maximum number of tracks to return (default: 10). Minimum of 1, maximum of 10. |
Example
curl --request GET '<base url>/v1/views/library/artists'
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'
--header 'Accept-Language: <desired locale>'
--header 'amzn-image-style: <desired image style>'
Responses
Amazon Music response object containing a response collection of top tracks for this user.
Example
(Some lines omitted for brevity)
{
"data": {
"_type": "View",
"id": "library-artists",
"title": "Artists",
"images": [],
"entity": {
"_type": "User",
"id": "2efopvnhmjf7xuujlde55puahq",
"images": [
{
"url": "https://..."
}
],
"name": "Vic"
},
"content": {
"_type": "ViewContent",
"entityGroups": [
{
"_type": "EntityGroup",
"id": "followed-artists",
"viewType": "GRID",
"content": {
"_type": "EntityGroupContent",
"nextPageToken": "eyJzb3VyY2UiOnsiaWQi...",
"entities": [
{
"_type": "Artist",
"id": "B0023RQUXO",
"images": [
{
"url": "https://..."
}
],
"name": "Belmont",
"playParams": {
"id": "mrn:1.0:catalog:artist:asin:B0023RQUXO?territory=US",
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
}
},
{
"_type": "Artist",
"id": "B00FE8SZ0A",
"images": [
{
"url": "https://..."
}
],
"name": "Gibbz",
"playParams": {
"id": "mrn:1.0:catalog:artist:asin:B00FE8SZ0A?territory=US",
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
}
},
{
"_type": "Artist",
"id": "B06X6LND2D",
"images": [
{
"url": "https://..."
}
],
"name": "Naviband",
"playParams": {
"id": "mrn:1.0:catalog:artist:asin:B06X6LND2D?territory=US",
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
}
},
...
]
}
}
]
}
}
}
My Library Songs View
GET
/v1/views/library/songs
Retrieve music songs previously added to the user's library. The content is represented by a customer related information (name, profile picture) and by a collection of songs grouped in sections (e.g.: Songs You Liked). Optional parameters can be used to limit the number of entities within a single entity group returned.
Query Parameters
| Name | Data Type | Required | Description |
|---|---|---|---|
| cursor | string | No | The cursor/token for the page to continue pagination results from. |
| limit | number | No | The maximum number of tracks to return (default: 10). Minimum of 1, maximum of 10. |
Example
curl --request GET '<base url>/v1/views/library/songs'
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'
--header 'Accept-Language: <desired locale>'
--header 'amzn-image-style: <desired image style>'
Responses
Amazon Music response object containing a response collection of top tracks for this user.
Example
(Some lines omitted for brevity)
{
"data": {
"_type": "View",
"id": "library-songs",
"title": "Songs",
"images": [],
"entity": {
"_type": "User",
"id": "2efopvnhmjf7xuujlde55puahq",
"images": [
{
"url": "https://..."
}
],
"name": "Vic"
},
"content": {
"_type": "ViewContent",
"entityGroups": [
{
"_type": "EntityGroup",
"id": "songs",
"viewType": "STACK",
"content": {
"_type": "EntityGroupContent",
"nextPageToken": "tcs-V1_ZU3RMV2xXC3Jlntu...",
"entities": [
{
"_type": "Track",
"id": "B01BO5275A",
"isrc": "uscgh1654835",
"title": "Arcand",
"album": {
"id": "B01BO525YS",
"title": "Disconnect [Explicit]"
},
"artists": [
{
"id": "B00MJV0BZM",
"name": "Calling All Captains"
}
],
"images": [
{
"url": "https://..."
}
],
"playParams": {
"id": "mrn:1.0:catalog:track:asin:B01BO5275A?territory=US",
"containerId": null,
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
}
},
{
"_type": "Track",
"id": "B07CKC4G58",
"isrc": "NLF711403495",
"title": "Are You With Me",
"album": {
"id": "B07CKTDN4X",
"title": "Deep House Top 1000, Vol. 1 - Armada Music"
},
"artists": [
{
"id": "B00LVZCC6I",
"name": "Lost Frequencies"
}
],
"images": [
{
"url": "https://..."
}
],
"playParams": {
"id": "mrn:1.0:catalog:track:asin:B07CKC4G58?territory=US",
"containerId": null,
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
}
},
...
]
}
}
]
}
}
}
My Library Playlists View
GET
/v1/views/library/playlists
Retrieve music playlists followed by the current user. The content is represented by a customer related information (name, profile picture) and by a collection of playlists grouped in sections (e.g.: Playlists You Follow). Optional parameters can be used to limit the number of entities within a single entity group returned.
Query Parameters
| Name | Data Type | Required | Description |
|---|---|---|---|
| cursor | string | No | The cursor/token for the page to continue pagination results from. |
| limit | number | No | The maximum number of tracks to return (default: 10). Minimum of 1, maximum of 10. |
Example
curl --request GET '<base url>/v1/views/library/playlists'
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'
--header 'Accept-Language: <desired locale>'
--header 'amzn-image-style: <desired image style>'
Responses
Amazon Music response object containing a response collection of top tracks for this user.
Example
(Some lines omitted for brevity)
{
"data": {
"_type": "View",
"id": "library-playlists",
"title": "Playlists",
"images": [],
"entity": {
"_type": "User",
"id": "2efopvnhmjf7xuujlde55puahq",
"images": [
{
"url": "https://..."
}
],
"name": "Vic"
},
"content": {
"_type": "ViewContent",
"entityGroups": [
{
"_type": "EntityGroup",
"id": "your-playlists",
"title": "Your Playlists",
"viewType": "LIST",
"content": {
"_type": "EntityGroupContent",
"nextPageToken": null,
"entities": [
{
"_type": "Playlist",
"id": "B07M7FZKWQ",
"title": "Lo-Fi Hip-Hop",
"images": [
{
"url": "https://..."
}
],
"playParams": {
"id": "mrn:1.0:catalog:playlist:asin:B07M7FZKWQ?territory=US",
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
}
},
{
"_type": "Playlist",
"id": "PPF40E8A5DABF148289F3143951A2F4C48",
"title": "My Year in Review 2023",
"images": [
{
"url": "https://..."
}
],
"playParams": {
"id": "mrn:1.0:algorithmic:playlist:playlistid:PPF40E8A5DABF148289F3143951A2F4C48",
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
}
},
{
"_type": "Playlist",
"id": "B092Z6QDQ5",
"title": "Road Trip: Indie",
"images": [
{
"url": "https://..."
}
],
"playParams": {
"id": "mrn:1.0:catalog:playlist:asin:B092Z6QDQ5?territory=US",
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
}
},
...
]
}
}
]
}
}
}
My Library Podcasts View
GET
/v1/views/library/podcasts
Retrieve podcasts shows and episodes followed or liked by the current user. The content is represented by a customer related information (name, profile picture) and by a collection of playlists grouped in sections (e.g.: Shows You Follow). Optional parameters can be used to limit the number of entities within a single entity group returned.
Query Parameters
| Name | Data Type | Required | Description |
|---|---|---|---|
| cursor | string | No | The cursor/token for the page to continue pagination results from. |
| limit | number | No | The maximum number of tracks to return (default: 10). Minimum of 1, maximum of 10. |
Example
curl --request GET '<base url>/v1/views/library/podcasts'
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'
--header 'Accept-Language: <desired locale>'
--header 'amzn-image-style: <desired image style>'
Responses
Amazon Music response object containing a response collection of top tracks for this user.
Example
(Some lines omitted for brevity)
{
"data": {
"_type": "View",
"id": "library-podcasts",
"title": "Podcasts",
"images": [],
"entity": {
"_type": "User",
"id": "2efopvnhmjf7xuujlde55puahq",
"images": [
{
"url": "https://..."
}
],
"name": "Vic"
},
"content": {
"_type": "ViewContent",
"entityGroups": [
{
"_type": "EntityGroup",
"id": "podcast-episodes",
"title": "Jump Back In",
"viewType": "TABLE",
"content": {
"_type": "EntityGroupContent",
"nextPageToken": null,
"entities": [
{
"_type": "PodcastEpisode",
"id": "61c0a230-b2f8-4901-892a-661cdf58f169",
"title": "Zavtracast №238 – To go to the channel",
"author": "Zavtracast",
"seasonNumber": 7,
"episodeNumber": 238,
"releaseDate": "2021-11-10T14:40:08Z",
"duration": 13476,
"images": [
{
"url": "https://..."
}
],
"podcast": {
"id": "da4a9e28-3481-4a3e-b97e-b1afba0e7da5",
"title": "Zavtracast"
},
"playParams": {
"id": "mrn:1.0:podcast:episode:uuid:61c0a230-b2f8-4901-892a-661cdf58f169",
"selections": [
"PLAY"
]
},
"playbackInformation": {
"progressMilliseconds": 13248453
}
}
]
}
},
{
"_type": "EntityGroup",
"id": "podcast-shows",
"title": "Podcast Shows",
"viewType": "LIST",
"content": {
"_type": "EntityGroupContent",
"nextPageToken": null,
"entities": [
{
"_type": "PodcastShow",
"id": "99bbbc8c-7b80-4024-bd0a-bfcbb9649d32",
"title": "How to Keep Time",
"author": "The Atlantic",
"images": [
{
"url": "https://..."
}
],
"playParams": {
"id": "mrn:1.0:podcast:show:uuid:99bbbc8c-7b80-4024-bd0a-bfcbb9649d32",
"selections": [
"PLAY"
]
}
},
{
"_type": "PodcastShow",
"id": "20f102b6-4452-4b47-8fec-cd1d56e81d69",
"title": "How to Be a Better Human",
"author": "TED and PRX",
"images": [
{
"url": "https://..."
}
],
"playParams": {
"id": "mrn:1.0:podcast:show:uuid:20f102b6-4452-4b47-8fec-cd1d56e81d69",
"selections": [
"PLAY"
]
}
},
...
]
}
}
]
}
}
}
Recently Played View
GET
/v1/views/recent
Retrieve audio content previously played on Amazon Music by the current user. The content is represented by a collection of playlists grouped in sections. Optional parameters can be used to limit the number of entities within a single entity group returned.
Path Parameters
| Name | Data Type | Required | Description |
|---|---|---|---|
| groupId | string | No | A group ID to be retrieve independently from the remaining Recently Played content (the See All use case). |
| cursor | string | No | The cursor/token for the page to continue pagination results from. |
| limit | number | No | The maximum number of tracks to return (default: 10). Minimum of 1, maximum of 10. |
Example
curl --request GET '<base url>/v1/views/recent'
--header 'x-api-key: <your client ID>' \
--header 'Authorization: Bearer <your auth token>'
--header 'Accept-Language: <desired locale>'
--header 'amzn-image-style: <desired image style>'
Responses
Amazon Music response object containing a view object of top tracks for this user.
Example
(Some lines omitted for brevity)
{
"data": {
"_type": "View",
"id": "recent",
"title": "Recently Played",
"content": {
"_type": "ViewContent",
"entityGroups": [{
"_type": "EntityGroup",
"id": "recently-played",
"viewType": "GRID",
"content": {
"_type": "EntityGroupContent",
"nextPageToken": "0000...",
"entities": [{
"_type": "Playlist",
"id": "B09JZDGFS7",
"title": "Written by Blood Orange",
"images": [{
"url": "https://..."
}],
"playParams": {
"id": "mrn:1.0:catalog:playlist:asin:B09JZDGFS7?territory=US",
"containerIds": null,
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
}
},
{
"_type": "Station",
"id": "A1QBEFLCLMQ8D6",
"name": "Sleep",
"images": [{
"url": "https://..."
}],
"playParams": {
"id": "mrn:1.0:catalog:station:key:A1QBEFLCLMQ8D6",
"containerIds": null,
"selections": [
"PLAY"
]
}
},
{
"_type": "Station",
"id": "A1ESXGJW9GSMCX",
"name": "My Soundtrack",
"images": [{
"url": "https://..."
}],
"playParams": {
"id": "mrn:1.0:catalog:station:key:A1ESXGJW9GSMCX",
"containerIds": null,
"selections": [
"PLAY"
]
}
},
{
"_type": "Artist",
"id": "B0014DEFTE",
"name": "Adele",
"followerCount": 2772865,
"images": [{
"url": "https://..."
}],
"playParams": {
"id": "mrn:1.0:catalog:artist:asin:B0014DEFTE?territory=US",
"containerIds": null,
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
}
},
{
"_type": "Playlist",
"id": "B06Y1YT7F8",
"title": "Classical for Sleep",
"images": [{
"url": "https://..."
}],
"playParams": {
"id": "mrn:1.0:catalog:playlist:asin:B06Y1YT7F8?territory=US",
"containerIds": null,
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
}
},
...
{
"_type": "Album",
"id": "B0CTKSY168",
"title": "Morning View XXIII",
"images": [{
"url": "https://..."
}],
"artists": [{
"id": "B000QKUHTI",
"name": "Incubus"
}],
"playParams": {
"id": "mrn:1.0:catalog:album:asin:B0CTKSY168?territory=US",
"containerIds": null,
"selections": [
"PLAY",
"SHUFFLE",
"STATION"
]
},
"duration": 3667,
"releaseDate": "2001-10-22T04:00:00.000Z",
"trackCount": 13,
"label": "Incubus"
}
]
}
}]
}
}
}