Skip to content

Enums

enums #

AlbumGroup #

The relationship between the artist and album.

ALBUM #

ALBUM = 'album'

ALbum by the artist.

SINGLE #

SINGLE = 'single'

Single by the artist.

COMPILATION #

COMPILATION = 'compilation'

Compilation by the artist.

APPEARS_ON #

APPEARS_ON = 'appears_on'

Artist is featured in the album/single/compilation.

AlbumType #

The type of an album.

ALBUM #

ALBUM = 'album'

An album.

SINGLE #

SINGLE = 'single'

A single.

COMPILATION #

COMPILATION = 'compilation'

A compilation.

EP #

EP = 'ep'

An EP.

Note

This value is not documented, but is returned frequently in the API so I have included it anyway.

ContextType #

A context's item type.

ARTIST #

ARTIST = 'artist'

An artist.

PLAYLIST #

PLAYLIST = 'playlist'

A playlist.

ALBUM #

ALBUM = 'album'

An album.

SHOW #

SHOW = 'show'

A show.

CopyrightType #

The type of copyright.

COPYRIGHT #

COPYRIGHT = 'C'

The copyright.

PERFORMANCE_COPYRIGHT = 'P'

The sound recording (performance) copyright.

PlayingType #

The type of the currently playing item.

TRACK #

TRACK = 'track'

A track.

EPISODE #

EPISODE = 'episode'

An episode.

AD #

AD = 'ad'

An ad.

UNKNOWN #

UNKNOWN = 'unknown'

Unknown.

Reason #

Restriction reason.

MARKET #

MARKET = 'market'

Content not available in given market.

PRODUCT #

PRODUCT = 'product'

Content not available for user's subscription type.

EXPLICIT #

EXPLICIT = 'explicit'

User's account is set to not play explicit content.

PAYMENT_REQUIRED #

PAYMENT_REQUIRED = 'payment_required'

Payment is required to play the content item.

UNKNOWN #

UNKNOWN = 'unknown'

The restriction reason is unknown.

RecommendationSeedType #

The type of a recommendation seed.

ARTIST #

ARTIST = 'artist'

An artist.

TRACK #

TRACK = 'track'

A track.

GENRE #

GENRE = 'genre'

A genre.

ReleaseDatePrecision #

Precision of a release date.

YEAR #

YEAR = 'year'

Precise to the release year.

MONTH #

MONTH = 'month'

Precise to the release month.

DAY #

DAY = 'day'

Precise to the release day.

RepeatState #

playback repeat state.

OFF #

OFF = 'off'

No repeat.

TRACK #

TRACK = 'track'

Repeating the track.

CONTEXT #

CONTEXT = 'context'

Repeating the context.

Scope #

Authorization Scopes.

UGC_IMAGE_UPLOAD #

UGC_IMAGE_UPLOAD = 'ugc-image-upload'

Write access to user-provided images.

USER_READ_PLAYBACK_STATE #

USER_READ_PLAYBACK_STATE = 'user-read-playback-state'

Read access to a user's player state.

USER_MODIFY_PLAYBACK_STATE #

USER_MODIFY_PLAYBACK_STATE = 'user-modify-playback-state'

Write access to a user's playback state.

USER_READ_CURRENTLY_PLAYING #

USER_READ_CURRENTLY_PLAYING = 'user-read-currently-playing'

Read access to a user's currently playing content.

APP_REMOTE_CONTROL #

APP_REMOTE_CONTROL = 'app-remote-control'

Remote control playback of Spotify. This scope is currently available to Spotify iOS and Android SDKs.

STREAMING #

STREAMING = 'streaming'

Control playback of a Spotify track. This scope is currently available to the Web Playback SDK. The user must have a Spotify Premium account.

PLAYLIST_READ_PRIVATE #

PLAYLIST_READ_PRIVATE = 'playlist-read-private'

Read access to user's private playlists.

PLAYLIST_READ_COLLABORATIVE #

PLAYLIST_READ_COLLABORATIVE = 'playlist-read-collaborative'

Include collaborative playlists when requesting a user's playlists.

PLAYLIST_MODIFY_PRIVATE #

PLAYLIST_MODIFY_PRIVATE = 'playlist-modify-private'

Write access to a user's private playlists.

PLAYLIST_MODIFY_PUBLIC #

PLAYLIST_MODIFY_PUBLIC = 'playlist-modify-public'

Write access to a user's public playlists.

USER_FOLLOW_MODIFY #

USER_FOLLOW_MODIFY = 'user-follow-modify'

Write/delete access to the list of artists and other users that the user follows.

USER_FOLLOW_READ #

USER_FOLLOW_READ = 'user-follow-read'

Read access to the list of artists and other users that the user follows.

USER_READ_PLAYBACK_POSITION #

USER_READ_PLAYBACK_POSITION = 'user-read-playback-position'

Read access to a user's playback position in a content.

USER_TOP_READ #

USER_TOP_READ = 'user-top-read'

Read access to a user's top artists and tracks.

USER_READ_RECENTLY_PLAYED #

USER_READ_RECENTLY_PLAYED = 'user-read-recently-played'

Read access to a user's recently played tracks.

USER_LIBRARY_MODIFY #

USER_LIBRARY_MODIFY = 'user-library-modify'

Write/delete access to a user's "Your Music" library.

USER_LIBRARY_READ #

USER_LIBRARY_READ = 'user-library-read'

Read access to a user's library.

USER_READ_EMAIL #

USER_READ_EMAIL = 'user-read-email'

Read access to user's email address.

USER_READ_PRIVATE #

USER_READ_PRIVATE = 'user-read-private'

Read access to user's subscription details (type of user account).

USER_SOA_LINK = 'user-soa-link'

Link a partner user account to a Spotify user account.

USER_SOA_UNLINK = 'user-soa-unlink'

Unlink a partner user account from a Spotify account.

USER_MANAGE_ENTITLEMENTS #

USER_MANAGE_ENTITLEMENTS = 'user-manage-entitlements'

Modify entitlements for linked users.

USER_MANAGE_PARTNER #

USER_MANAGE_PARTNER = 'user-manage-partner'

Update partner information.

USER_CREATE_PARTNER #

USER_CREATE_PARTNER = 'user-create-partner'

Create new partners, platform partners only.

SearchType #

Search result type.

ALBUM #

ALBUM = 'album'

An album.

ARTIST #

ARTIST = 'artist'

An artist.

PLAYLIST #

PLAYLIST = 'playlist'

A playlist.

TRACK #

TRACK = 'track'

A track.

SHOW #

SHOW = 'show'

A show.

EPISODE #

EPISODE = 'episode'

AN episode.

AUDIOBOOK #

AUDIOBOOK = 'audiobook'

An audiobook.

StatusCode #

Audio analysis metadata status code.

SUCCESSFUL #

SUCCESSFUL = 0

Analysis was successful.

ERRORS #

ERRORS = 1

Analysis errored and was unsuccessful.

SubscriptionLevel #

A user's Spotify subscription level.

PREMIUM #

PREMIUM = 'premium'

Premium subscription.

FREE #

FREE = 'free'

Free subscription.

TimeRange #

Time range.

SHORT_TERM #

SHORT_TERM = 'short_term'

Approximately 4 weeks.

MEDIUM_TERM #

MEDIUM_TERM = 'medium_term'

Approximately 6 months.

LONG_TERM #

LONG_TERM = 'long_term'

Approximately 1 year.

TopItemType #

Type of top item.

ARTISTS #

ARTISTS = 'artists'

Top artists.

TRACKS #

TRACKS = 'tracks'

Top tracks.

TrackMode #

Modality of a track.

MINOR #

MINOR = 0

Minor mode.

MAJOR #

MAJOR = 1

Major mode.

UNKNOWN #

UNKNOWN = -1

Mode is unknown.

UserType #

Type of a user.

ARTIST #

ARTIST = 'artist'

An artist.

USER #

USER = 'user'

A user.