Apple Music API Objects

Object models for requests, responses, and resources in the Apple Music API.

Topics

Core Objects

object Error

Information about an error that occurred while processing a request.

object Resource

A resource—such as an album, song, or playlist—in the Apple Music catalog or iCloud Music Library.

HTTP Status Codes

Reference error codes returned by the Apple Music API.

object Relationship

A to-one or to-many relationship from one resource object to others.

object ResponseRoot

The JSON root object contained in every response.

Resource Objects

object Activity

A Resource object that represents an activity.

object Album

A Resource object that represents an album.

object AppleCurator

A Resource object that represents an Apple curator.

object Artist

A Resource object that represents an artist of an album where an artist can be one or more persons.

object Curator

A Resource object that represents a curator of resources.

object Genre

An object that represents a genre for resources.

object MusicVideo

A Resource object that represents a music video.

object Playlist

A Resource object that represents a playlist.

object Rating

An object that represents a rating for a Resource.

object Recommendation

A Resource object that represents recommended resources for a user calculated using their selected preferences.

object Song

A Resource object that represents a song.

object Station

A Resource object that represents a station.

object Storefront

A Resource object that represents a storefront, an iTunes Store territory that the content is available in.

Attribute Objects

object Artwork

An object that represents artwork.

object EditorialNotes

An object that represents notes.

object PlayParameters

An object that represents play parameters for resources.

object Preview

An object that represents a preview for resources.

Results Objects

object Chart

A Resource object that represents a chart, or a collection of the top songs, albums, or other types of resources.

object SearchResults

An object that represents the results of a catalog search query.

object SearchHints

An object that represents the autocompletion options for the hint.

object LibrarySearchResults

An object that represents the results of a library search query.

Library Resource Objects

object LibraryAlbum

A Resource object that represents a library album.

object LibraryArtist

A Resource object that represents a library artist.

object LibraryMusicVideo

A Resource object that represents a library music video.

object LibraryPlaylist

A Resource object that represents a library playlist.

object LibrarySong

A Resource object that represents a library song.

Relationship Objects

object AlbumRelationship

An object that represents the album relationship for a Resource object.

object ArtistRelationship

An object that represents the artist relationship for a Resource object.

object CuratorRelationship

An object that represents the curator relationship for a Resource object.

object GenreRelationship

An object that represents the genre relationship for a Resource object.

object LibraryAlbumRelationship

An object that represents the library album relationship for a Resource object.

object LibraryArtistRelationship

An object that represents the library artist relationship for a Resource object.

object LibraryTrackRelationship

An object that represents the library track relationship for a Resource object.

object MusicVideoRelationship

An object that represents the music video relationship for a Resource object.

object PlaylistRelationship

An object that represents the playlist relationship for a Resource object.

object StationRelationship

An object that represents the station relationship for a Resource object.

object TrackRelationship

An object that represents the track relationship for a Resource object.

Request Objects

object LibraryPlaylistCreationRequest

A request to create a new playlist in a user's library.

object LibraryPlaylistTracksRequest

A request to add tracks to a library playlist.

object LibraryPlaylistRequestTrack

An object that represents a single track when added to a library playlist in a request.

object RatingRequest

A request containing the data for a rating.

Response Objects

object ActivityResponse

The response to an activity request.

object AlbumResponse

The response to an album request.

object AppleCuratorResponse

The response to an Apple curator request.

object ArtistResponse

The response to an artist request.

object ChartResponse

The response to a chart request.

object CuratorResponse

The response to a curator request.

object GenreResponse

The response to a genre request.

object HistoryResponse

The response to a history request.

object LibraryAlbumResponse

The response to a library album request.

object LibraryArtistResponse

The response to a library artist request.

object LibraryMusicVideoResponse

The response to a library music video request.

object LibrarySearchResponse

The response to a library search request.

object LibrarySongResponse

The response to a library song request.

object MusicVideoResponse

The response to a music video request.

object RecentlyAddedResponse

The response to a recently added request.

object RecommendationResponse

The response to a recommendation request.

object SearchHintsResponse

The response to a search hints request.

object SearchResponse

The response to a search request.

object SongResponse

The response to a song request.

object StationResponse

The response to a station request.

object StorefrontResponse

The response to a storefront request.

object LibraryPlaylistResponse

The response to a library playlist request.

object PlaylistResponse

The response to a playlist request.

object RatingResponse

The response to a rating request.