openapi: 3.0.3
info:
title: Spotify Web API
description: >
You can use Spotify's Web API to discover music and podcasts, manage your
Spotify library, control audio playback, and much more. Browse our available
Web API endpoints using the sidebar at left, or via the navigation bar on
top of this page on smaller screens.
In order to make successful Web API requests your app will need a valid
access token. One can be obtained through OAuth
2.0.
The base URI for all Web API requests is `https://api.spotify.com/v1`.
Need help? See our Web API
guides for more information, or visit the Spotify
for Developers community forum to ask questions and connect with other
developers.
version: 1.0.0
termsOfService: https://developer.spotify.com/terms/
contact:
name: Spotify for Developers Community
url: >-
https://community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotify_Developer
x-konfig-ignore:
object-with-no-properties: true
servers:
- url: https://api.spotify.com/v1
tags:
- name: Library
- name: Tracks
- name: Playlists
- name: Player
- name: Users
- name: Albums
- name: Artists
- name: Audiobooks
- name: Episodes
- name: Shows
- name: Categories
- name: Chapters
- name: Genres
- name: Markets
- name: Search
paths:
/albums/{id}:
get:
tags:
- Albums
summary: |
Get Album
operationId: Albums_getInformation
security:
- oauth_2_0: []
description: |
Get Spotify catalog information for a single album.
parameters:
- $ref: '#/components/parameters/PathAlbumId'
- $ref: '#/components/parameters/QueryMarket'
responses:
'200':
$ref: '#/components/responses/OneAlbum'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/metadataPolicyList'
/albums:
get:
tags:
- Albums
summary: |
Get Several Albums
operationId: Albums_listSeveral
security:
- oauth_2_0: []
description: >
Get Spotify catalog information for multiple albums identified by their
Spotify IDs.
parameters:
- $ref: '#/components/parameters/QueryAlbumIds'
- $ref: '#/components/parameters/QueryMarket'
responses:
'200':
$ref: '#/components/responses/ManyAlbums'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/metadataPolicyList'
/albums/{id}/tracks:
get:
tags:
- Albums
- Tracks
summary: |
Get Album Tracks
operationId: Albums_getTracksById
security:
- oauth_2_0: []
description: |
Get Spotify catalog information about an album’s tracks.
Optional parameters can be used to limit the number of tracks returned.
parameters:
- $ref: '#/components/parameters/PathAlbumId'
- $ref: '#/components/parameters/QueryMarket'
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryOffset'
responses:
'200':
$ref: '#/components/responses/PagingSimplifiedTrackObject'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/metadataPolicyList'
/artists/{id}:
get:
tags:
- Artists
summary: |
Get Artist
operationId: Artists_getCatalogInfo
security:
- oauth_2_0: []
description: >
Get Spotify catalog information for a single artist identified by their
unique Spotify ID.
parameters:
- $ref: '#/components/parameters/PathArtistId'
responses:
'200':
$ref: '#/components/responses/OneArtist'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/metadataPolicyList'
/artists:
get:
tags:
- Artists
summary: |
Get Several Artists
operationId: Artists_getCatalogInfo
security:
- oauth_2_0: []
description: >
Get Spotify catalog information for several artists based on their
Spotify IDs.
parameters:
- name: ids
required: true
in: query
schema:
title: Spotify Artist IDs
description: >
A comma-separated list of the [Spotify
IDs](/documentation/web-api/concepts/spotify-uris-ids) for the
artists. Maximum: 100 IDs.
example: >-
2CIMQHirSU0MQqyYHq0eOx,57dN52uHvrHOxijzpIgu3E,1vCWHaC5f2uS3yhpwWbIA6
type: string
responses:
'200':
$ref: '#/components/responses/ManyArtists'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/metadataPolicyList'
/artists/{id}/albums:
get:
tags:
- Artists
- Albums
summary: |
Get Artist's Albums
operationId: Artists_getAlbumsById
security:
- oauth_2_0: []
description: |
Get Spotify catalog information about an artist's albums.
parameters:
- $ref: '#/components/parameters/PathArtistId'
- $ref: '#/components/parameters/QueryIncludeGroups'
- $ref: '#/components/parameters/QueryMarket'
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryOffset'
responses:
'200':
$ref: '#/components/responses/PagingArtistDiscographyAlbumObject'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/metadataPolicyList'
/artists/{id}/top-tracks:
get:
tags:
- Artists
- Tracks
summary: |
Get Artist's Top Tracks
operationId: Artists_getTopTracks
security:
- oauth_2_0: []
description: |
Get Spotify catalog information about an artist's top tracks by country.
parameters:
- $ref: '#/components/parameters/PathArtistId'
- $ref: '#/components/parameters/QueryMarket'
responses:
'200':
$ref: '#/components/responses/ManyTracks'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/metadataPolicyList'
/artists/{id}/related-artists:
get:
tags:
- Artists
summary: |
Get Artist's Related Artists
operationId: Artists_getRelatedArtists
security:
- oauth_2_0: []
description: >
Get Spotify catalog information about artists similar to a given artist.
Similarity is based on analysis of the Spotify community's listening
history.
parameters:
- $ref: '#/components/parameters/PathArtistId'
responses:
'200':
$ref: '#/components/responses/ManyArtists'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/metadataPolicyList'
/shows/{id}:
get:
tags:
- Shows
summary: |
Get Show
operationId: Shows_getInformation
security:
- oauth_2_0:
- user-read-playback-position
description: |
Get Spotify catalog information for a single show identified by its
unique Spotify ID.
parameters:
- $ref: '#/components/parameters/QueryMarket'
- $ref: '#/components/parameters/PathShowId'
responses:
'200':
$ref: '#/components/responses/OneShow'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/metadataPolicyList'
/shows:
get:
tags:
- Shows
summary: |
Get Several Shows
operationId: Shows_getMultipleShowsInfo
security:
- oauth_2_0: []
description: >
Get Spotify catalog information for several shows based on their Spotify
IDs.
parameters:
- $ref: '#/components/parameters/QueryMarket'
- $ref: '#/components/parameters/QueryShowIds'
responses:
'200':
$ref: '#/components/responses/ManySimplifiedShows'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/metadataPolicyList'
/shows/{id}/episodes:
get:
tags:
- Shows
- Episodes
summary: |
Get Show Episodes
operationId: Shows_getEpisodesById
security:
- oauth_2_0:
- user-read-playback-position
description: >
Get Spotify catalog information about an show’s episodes. Optional
parameters can be used to limit the number of episodes returned.
parameters:
- $ref: '#/components/parameters/PathShowId'
- $ref: '#/components/parameters/QueryMarket'
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryOffset'
responses:
'200':
$ref: '#/components/responses/PagingSimplifiedEpisodeObject'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/metadataPolicyList'
/episodes/{id}:
get:
tags:
- Episodes
summary: |
Get Episode
operationId: Episodes_getSingleById
security:
- oauth_2_0:
- user-read-playback-position
description: |
Get Spotify catalog information for a single episode identified by its
unique Spotify ID.
parameters:
- name: id
required: true
in: path
schema:
title: Get an Episode
description: >-
The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids)
for the episode.
example: 512ojhOuo1ktJprKbVcKyQ
type: string
- $ref: '#/components/parameters/QueryMarket'
responses:
'200':
$ref: '#/components/responses/OneEpisode'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/metadataPolicyList'
/episodes:
get:
tags:
- Episodes
summary: |
Get Several Episodes
operationId: Episodes_getSeveral
security:
- oauth_2_0:
- user-read-playback-position
description: >
Get Spotify catalog information for several episodes based on their
Spotify IDs.
parameters:
- name: ids
required: true
in: query
schema:
title: Ids
description: >
A comma-separated list of the [Spotify
IDs](/documentation/web-api/concepts/spotify-uris-ids) for the
episodes. Maximum: 50 IDs.
example: 77o6BIVlYM3msb4MMIL1jH,0Q86acNRm6V9GYx55SXKwf
type: string
- $ref: '#/components/parameters/QueryMarket'
responses:
'200':
$ref: '#/components/responses/ManyEpisodes'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/metadataPolicyList'
/audiobooks/{id}:
get:
tags:
- Audiobooks
summary: |
Get an Audiobook
operationId: Audiobooks_getCatalogInfo
security:
- oauth_2_0: []
description: >
Get Spotify catalog information for a single audiobook. Audiobooks are
only available within the US, UK, Canada, Ireland, New Zealand and
Australia markets.
parameters:
- $ref: '#/components/parameters/PathAudiobookId'
- $ref: '#/components/parameters/QueryMarket'
responses:
'200':
$ref: '#/components/responses/OneAudiobook'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/metadataPolicyList'
/audiobooks:
get:
tags:
- Audiobooks
summary: |
Get Several Audiobooks
operationId: Audiobooks_getSeveral
security:
- oauth_2_0: []
description: >
Get Spotify catalog information for several audiobooks identified by
their Spotify IDs. Audiobooks are only available within the US, UK,
Canada, Ireland, New Zealand and Australia markets.
parameters:
- $ref: '#/components/parameters/QueryAudiobookIds'
- $ref: '#/components/parameters/QueryMarket'
responses:
'200':
$ref: '#/components/responses/ManyAudiobooks'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/metadataPolicyList'
/audiobooks/{id}/chapters:
get:
tags:
- Audiobooks
- Chapters
summary: |
Get Audiobook Chapters
operationId: Audiobooks_getChaptersById
security:
- oauth_2_0: []
description: >
Get Spotify catalog information about an audiobook's chapters.
Audiobooks are only available within the US, UK, Canada, Ireland, New
Zealand and Australia markets.
parameters:
- $ref: '#/components/parameters/PathAudiobookId'
- $ref: '#/components/parameters/QueryMarket'
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryOffset'
responses:
'200':
$ref: '#/components/responses/PagingSimplifiedChapterObject'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/metadataPolicyList'
/me/audiobooks:
get:
tags:
- Audiobooks
- Library
summary: |
Get User's Saved Audiobooks
operationId: Audiobooks_listSaved
security:
- oauth_2_0:
- user-library-read
description: >
Get a list of the audiobooks saved in the current Spotify user's 'Your
Music' library.
parameters:
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryOffset'
responses:
'200':
$ref: '#/components/responses/PagingSimplifiedAudiobookObject'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
put:
tags:
- Audiobooks
- Library
summary: |
Save Audiobooks for Current User
operationId: Audiobooks_saveCurrentUserLibrary
security:
- oauth_2_0:
- user-library-modify
description: |
Save one or more audiobooks to the current Spotify user's library.
parameters:
- $ref: '#/components/parameters/QueryAudiobookIds'
responses:
'200':
description: Audiobook(s) are saved to the library
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
delete:
tags:
- Audiobooks
- Library
summary: |
Remove User's Saved Audiobooks
operationId: Audiobooks_removeFromLibrary
security:
- oauth_2_0:
- user-library-modify
description: |
Remove one or more audiobooks from the Spotify user's library.
parameters:
- $ref: '#/components/parameters/QueryAudiobookIds'
responses:
'200':
description: Audiobook(s) have been removed from the library
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/me/audiobooks/contains:
get:
tags:
- Audiobooks
- Library
summary: |
Check User's Saved Audiobooks
operationId: Audiobooks_checkUserSaved
security:
- oauth_2_0:
- user-library-read
description: >
Check if one or more audiobooks are already saved in the current Spotify
user's library.
parameters:
- $ref: '#/components/parameters/QueryAudiobookIds'
responses:
'200':
$ref: '#/components/responses/ArrayOfBooleans'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/chapters/{id}:
get:
tags:
- Chapters
summary: |
Get a Chapter
operationId: Chapters_getChapterInfo
security:
- oauth_2_0: []
description: >
Get Spotify catalog information for a single audiobook chapter. Chapters
are only available within the US, UK, Canada, Ireland, New Zealand and
Australia markets.
parameters:
- $ref: '#/components/parameters/PathChapterId'
- $ref: '#/components/parameters/QueryMarket'
responses:
'200':
$ref: '#/components/responses/OneChapter'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/metadataPolicyList'
/chapters:
get:
tags:
- Chapters
summary: |
Get Several Chapters
operationId: Chapters_getMultipleByIds
security:
- oauth_2_0: []
description: >
Get Spotify catalog information for several audiobook chapters
identified by their Spotify IDs. Chapters are only available within the
US, UK, Canada, Ireland, New Zealand and Australia markets.
parameters:
- $ref: '#/components/parameters/QueryChapterIds'
- $ref: '#/components/parameters/QueryMarket'
responses:
'200':
$ref: '#/components/responses/ManyChapters'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/metadataPolicyList'
/tracks/{id}:
get:
tags:
- Tracks
summary: |
Get Track
operationId: Tracks_getBySpotifyId
security:
- oauth_2_0: []
description: |
Get Spotify catalog information for a single track identified by its
unique Spotify ID.
parameters:
- name: id
required: true
in: path
schema:
title: Spotify Track ID
description: |
The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids)
for the track.
example: 11dFghVXANMlKmJXsNCbNl
type: string
- $ref: '#/components/parameters/QueryMarket'
responses:
'200':
$ref: '#/components/responses/OneTrack'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/metadataWithMachineLearningPolicyList'
/tracks:
get:
tags:
- Tracks
summary: |
Get Several Tracks
operationId: Tracks_getMultipleByIds
security:
- oauth_2_0: []
description: >
Get Spotify catalog information for multiple tracks based on their
Spotify IDs.
parameters:
- $ref: '#/components/parameters/QueryMarket'
- name: ids
required: true
in: query
schema:
title: Spotify Track IDs
description: >
A comma-separated list of the [Spotify
IDs](/documentation/web-api/concepts/spotify-uris-ids). For
example: `ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M`.
Maximum: 100 IDs.
example: >-
7ouMYWpwJ422jRcDASZB7P,4VqPOruhp5EdPBeR92t6lQ,2takcwOaAZWiXQijPHIx7B
type: string
responses:
'200':
$ref: '#/components/responses/ManyTracks'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/metadataWithMachineLearningPolicyList'
/search:
get:
tags:
- Search
summary: |
Search for Item
operationId: Search_spotifyCatalogInfo
security:
- oauth_2_0: []
description: >
Get Spotify catalog information about albums, artists, playlists,
tracks, shows, episodes or audiobooks
that match a keyword string. Audiobooks are only available within the
US, UK, Canada, Ireland, New Zealand and Australia markets.
parameters:
- name: q
required: true
in: query
schema:
title: Query
description: >
Your search query.
You can narrow down your search using field filters. The available
filters are `album`, `artist`, `track`, `year`, `upc`,
`tag:hipster`, `tag:new`, `isrc`, and `genre`. Each field filter
only applies to certain result types.
The `artist` and `year` filters can be used while searching
albums, artists and tracks. You can filter on a single `year` or a
range (e.g. 1955-1960).
The `album` filter can be used while searching albums and
tracks.
The `genre` filter can be used while searching artists and
tracks.
The `isrc` and `track` filters can be used while searching
tracks.
The `upc`, `tag:new` and `tag:hipster` filters can only be used
while searching albums. The `tag:new` filter will return albums
released in the past two weeks and `tag:hipster` can be used to
return only albums with the lowest 10% popularity.
example: remaster%20track:Doxy%20artist:Miles%20Davis
type: string
- name: type
required: true
explode: false
in: query
schema:
title: Item type
description: >
A comma-separated list of item types to search across. Search
results include hits
from all the specified item types. For example:
`q=abacab&type=album,track` returns
both albums and tracks matching "abacab".
items:
type: string
enum:
- album
- artist
- playlist
- track
- show
- episode
- audiobook
type: array
- $ref: '#/components/parameters/QueryMarket'
- name: limit
required: false
in: query
schema:
title: Limit
description: |
The maximum number of results to return in each item type.
default: 20
example: 10
type: integer
minimum: 0
maximum: 50
- name: offset
required: false
in: query
schema:
title: Offset
description: |
The index of the first result to return. Use
with limit to get the next page of search results.
default: 0
minimum: 0
maximum: 1000
example: 5
type: integer
- name: include_external
required: false
in: query
schema:
title: Include External
description: >
If `include_external=audio` is specified it signals that the
client can play externally hosted audio content, and marks
the content as playable in the response. By default externally
hosted audio content is marked as unplayable in the response.
type: string
enum:
- audio
responses:
'200':
$ref: '#/components/responses/SearchItems'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
- $ref: '#/components/x-spotify-policy/policies/MachineLearning'
/me:
get:
tags:
- Users
summary: |
Get Current User's Profile
operationId: Users_getCurrentUserProfile
security:
- oauth_2_0:
- user-read-private
- user-read-email
description: |
Get detailed profile information about the current user (including the
current user's username).
responses:
'200':
$ref: '#/components/responses/OnePrivateUser'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/playlists/{playlist_id}:
get:
tags:
- Playlists
summary: |
Get Playlist
operationId: Playlists_getPlaylistById
security:
- oauth_2_0: []
description: |
Get a playlist owned by a Spotify user.
parameters:
- $ref: '#/components/parameters/PathPlaylistId'
- $ref: '#/components/parameters/QueryMarket'
- name: fields
required: false
in: query
schema:
title: Fields
description: >
Filters for the query: a comma-separated list of the
fields to return. If omitted, all fields are returned. For
example, to get
just the playlist''s description and URI:
`fields=description,uri`. A dot
separator can be used to specify non-reoccurring fields, while
parentheses
can be used to specify reoccurring fields within objects. For
example, to
get just the added date and user ID of the adder:
`fields=tracks.items(added_at,added_by.id)`.
Use multiple parentheses to drill down into nested objects, for
example: `fields=tracks.items(track(name,href,album(name,href)))`.
Fields can be excluded by prefixing them with an exclamation mark,
for example:
`fields=tracks.items(track(name,href,album(!name,href)))`
example: items(added_by.id,track(name,href,album(name,href)))
type: string
- $ref: '#/components/parameters/QueryAdditionalTypes'
responses:
'200':
$ref: '#/components/responses/OnePlaylist'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/metadataWithMachineLearningPolicyList'
put:
tags:
- Playlists
- Library
summary: |
Change Playlist Details
operationId: Playlists_updateDetails
security:
- oauth_2_0:
- playlist-modify-public
- playlist-modify-private
description: |
Change a playlist's name and public/private state. (The user must, of
course, own the playlist.)
parameters:
- $ref: '#/components/parameters/PathPlaylistId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PlaylistsUpdateDetailsRequest'
responses:
'200':
description: Playlist updated
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/playlists/{playlist_id}/tracks:
get:
tags:
- Playlists
- Tracks
summary: |
Get Playlist Items
operationId: Playlists_getPlaylistItems
security:
- oauth_2_0:
- playlist-read-private
description: |
Get full details of the items of a playlist owned by a Spotify user.
parameters:
- $ref: '#/components/parameters/PathPlaylistId'
- $ref: '#/components/parameters/QueryMarket'
- name: fields
required: false
in: query
schema:
title: Fields
description: >
Filters for the query: a comma-separated list of the
fields to return. If omitted, all fields are returned. For
example, to get
just the total number of items and the request
limit:
`fields=total,limit`
A
dot separator can be used to specify non-reoccurring fields, while
parentheses
can be used to specify reoccurring fields within objects. For
example, to
get just the added date and user ID of the
adder:
`fields=items(added_at,added_by.id)`
Use
multiple parentheses to drill down into nested objects, for
example:
`fields=items(track(name,href,album(name,href)))`
Fields
can be excluded by prefixing them with an exclamation mark, for
example:
`fields=items.track.album(!external_urls,images)`
example: items(added_by.id,track(name,href,album(name,href)))
type: string
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryOffset'
- $ref: '#/components/parameters/QueryAdditionalTypes'
responses:
'200':
$ref: '#/components/responses/PagingPlaylistTrackObject'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/metadataWithMachineLearningPolicyList'
post:
tags:
- Playlists
- Tracks
summary: |
Add Items to Playlist
operationId: Playlists_addItems
security:
- oauth_2_0:
- playlist-modify-public
- playlist-modify-private
description: |
Add one or more items to a user's playlist.
parameters:
- $ref: '#/components/parameters/PathPlaylistId'
- name: position
required: false
in: query
schema:
title: Position (append by default)
description: >
The position to insert the items, a zero-based index. For example,
to insert the items in the first position: `position=0`; to insert
the items in the third position: `position=2`. If omitted, the
items will be appended to the playlist. Items are added in the
order they are listed in the query string or request body.
example: 0
type: integer
- name: uris
required: false
in: query
schema:
title: Spotify Track URIs
description: >
A comma-separated list of [Spotify
URIs](/documentation/web-api/concepts/spotify-uris-ids) to add,
can be track or episode URIs. For
example:
`uris=spotify:track:4iV5W9uYEdYUVa79Axb7Rh,
spotify:track:1301WleyT98MSxVHPZCA6M,
spotify:episode:512ojhOuo1ktJprKbVcKyQ`
A maximum of 100 items
can be added in one request.
_**Note**: it is likely that passing a large number of item URIs
as a query parameter will exceed the maximum length of the request
URI. When adding a large number of items, it is recommended to
pass them in the request body, see below._
example: >-
spotify:track:4iV5W9uYEdYUVa79Axb7Rh,spotify:track:1301WleyT98MSxVHPZCA6M
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PlaylistsAddItemsRequest'
responses:
'201':
$ref: '#/components/responses/PlaylistSnapshotId'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
put:
tags:
- Playlists
- Tracks
summary: |
Update Playlist Items
operationId: Playlists_updatePlaylistItems
security:
- oauth_2_0:
- playlist-modify-public
- playlist-modify-private
description: >
Either reorder or replace items in a playlist depending on the request's
parameters.
To reorder items, include `range_start`, `insert_before`, `range_length`
and `snapshot_id` in the request's body.
To replace items, include `uris` as either a query parameter or in the
request's body.
Replacing items in a playlist will overwrite its existing items. This
operation can be used for replacing or clearing items in a playlist.
**Note**: Replace and reorder are mutually exclusive operations which
share the same endpoint, but have different parameters.
These operations can't be applied together in a single request.
parameters:
- $ref: '#/components/parameters/PathPlaylistId'
- name: uris
required: false
in: query
schema:
title: Spotify Track URIs
description: >
A comma-separated list of [Spotify
URIs](/documentation/web-api/concepts/spotify-uris-ids) to set,
can be track or episode URIs. For example:
`uris=spotify:track:4iV5W9uYEdYUVa79Axb7Rh,spotify:track:1301WleyT98MSxVHPZCA6M,spotify:episode:512ojhOuo1ktJprKbVcKyQ`
A
maximum of 100 items can be set in one request.
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PlaylistsUpdatePlaylistItemsRequest'
responses:
'200':
$ref: '#/components/responses/PlaylistSnapshotId'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
delete:
tags:
- Playlists
- Tracks
summary: |
Remove Playlist Items
operationId: Playlists_removeItems
security:
- oauth_2_0:
- playlist-modify-public
- playlist-modify-private
description: |
Remove one or more items from a user's playlist.
parameters:
- $ref: '#/components/parameters/PathPlaylistId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PlaylistsRemoveItemsRequest'
responses:
'200':
$ref: '#/components/responses/PlaylistSnapshotId'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/me/playlists:
get:
tags:
- Playlists
- Library
summary: |
Get Current User's Playlists
operationId: Playlists_getUserPlaylists
security:
- oauth_2_0:
- playlist-read-private
description: |
Get a list of the playlists owned or followed by the current Spotify
user.
parameters:
- $ref: '#/components/parameters/QueryLimit'
- name: offset
required: false
in: query
schema:
title: Offset
description: >
'The index of the first playlist to return. Default:
0 (the first object). Maximum offset: 100.000\. Use with `limit`
to get the
next set of playlists.'
default: 0
example: 5
type: integer
responses:
'200':
$ref: '#/components/responses/PagedPlaylists'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/me/albums:
get:
tags:
- Albums
- Library
summary: |
Get User's Saved Albums
operationId: Albums_getSaved
security:
- oauth_2_0:
- user-library-read
description: >
Get a list of the albums saved in the current Spotify user's 'Your
Music' library.
parameters:
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryOffset'
- $ref: '#/components/parameters/QueryMarket'
responses:
'200':
$ref: '#/components/responses/PagingSavedAlbumObject'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
put:
tags:
- Albums
- Library
summary: |
Save Albums for Current User
operationId: Albums_saveCurrentUserLibrary
security:
- oauth_2_0:
- user-library-modify
description: |
Save one or more albums to the current user's 'Your Music' library.
parameters:
- $ref: '#/components/parameters/QueryAlbumIds'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AlbumsSaveCurrentUserLibraryRequest'
responses:
'200':
description: The album is saved
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
delete:
tags:
- Albums
- Library
summary: |
Remove Users' Saved Albums
operationId: Albums_removeSaved
security:
- oauth_2_0:
- user-library-modify
description: |
Remove one or more albums from the current user's 'Your Music' library.
parameters:
- $ref: '#/components/parameters/QueryAlbumIds'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AlbumsRemoveSavedRequest'
responses:
'200':
description: Album(s) have been removed from the library
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/me/albums/contains:
get:
tags:
- Albums
- Library
summary: |
Check User's Saved Albums
operationId: Albums_checkSaved
security:
- oauth_2_0:
- user-library-read
description: >
Check if one or more albums is already saved in the current Spotify
user's 'Your Music' library.
parameters:
- $ref: '#/components/parameters/QueryAlbumIds'
responses:
'200':
$ref: '#/components/responses/ArrayOfBooleans'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/me/tracks:
get:
tags:
- Tracks
- Library
summary: |
Get User's Saved Tracks
operationId: Tracks_getUserSaved
security:
- oauth_2_0:
- user-library-read
description: >
Get a list of the songs saved in the current Spotify user's 'Your Music'
library.
parameters:
- $ref: '#/components/parameters/QueryMarket'
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryOffset'
responses:
'200':
$ref: '#/components/responses/PagingSavedTrackObject'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
put:
tags:
- Tracks
- Library
summary: |
Save Tracks for Current User
operationId: Tracks_saveForCurrentUser
security:
- oauth_2_0:
- user-library-modify
description: |
Save one or more tracks to the current user's 'Your Music' library.
parameters:
- $ref: '#/components/parameters/QueryTrackIds'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TracksSaveForCurrentUserRequest'
responses:
'200':
description: Track saved
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
delete:
tags:
- Tracks
- Library
summary: |
Remove User's Saved Tracks
operationId: Tracks_removeFromLibrary
security:
- oauth_2_0:
- user-library-modify
description: |
Remove one or more tracks from the current user's 'Your Music' library.
parameters:
- $ref: '#/components/parameters/QueryTrackIds'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TracksRemoveFromLibraryRequest'
responses:
'200':
description: Track removed
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/me/tracks/contains:
get:
tags:
- Tracks
- Library
summary: |
Check User's Saved Tracks
operationId: Tracks_checkSaved
security:
- oauth_2_0:
- user-library-read
description: >
Check if one or more tracks is already saved in the current Spotify
user's 'Your Music' library.
parameters:
- $ref: '#/components/parameters/QueryTrackIds'
responses:
'200':
$ref: '#/components/responses/ArrayOfBooleans'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/me/episodes:
get:
tags:
- Episodes
- Library
summary: |
Get User's Saved Episodes
operationId: Episodes_getUserSavedEpisodes
security:
- oauth_2_0:
- user-library-read
- user-read-playback-position
description: >
Get a list of the episodes saved in the current Spotify user's
library.
This API endpoint is in __beta__ and could change without warning.
Please share any feedback that you have, or issues that you discover, in
our [developer community
forum](https://community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotify_Developer).
parameters:
- $ref: '#/components/parameters/QueryMarket'
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryOffset'
responses:
'200':
$ref: '#/components/responses/PagingSavedEpisodeObject'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
put:
tags:
- Episodes
- Library
summary: |
Save Episodes for Current User
operationId: Episodes_saveCurrentUserLibrary
security:
- oauth_2_0:
- user-library-modify
description: >
Save one or more episodes to the current user's library.
This API endpoint is in __beta__ and could change without warning.
Please share any feedback that you have, or issues that you discover, in
our [developer community
forum](https://community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotify_Developer).
parameters:
- name: ids
required: true
in: query
schema:
title: Spotify Episodes IDs
description: >
A comma-separated list of the [Spotify
IDs](/documentation/web-api/concepts/spotify-uris-ids). Maximum:
50 IDs.
example: 77o6BIVlYM3msb4MMIL1jH,0Q86acNRm6V9GYx55SXKwf
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EpisodesSaveCurrentUserLibraryRequest'
responses:
'200':
description: Episode saved
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
delete:
tags:
- Episodes
- Library
summary: |
Remove User's Saved Episodes
operationId: Episodes_removeFromLibrary
security:
- oauth_2_0:
- user-library-modify
description: >
Remove one or more episodes from the current user's library.
This API endpoint is in __beta__ and could change without warning.
Please share any feedback that you have, or issues that you discover, in
our [developer community
forum](https://community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotify_Developer).
parameters:
- $ref: '#/components/parameters/QueryTrackIds'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EpisodesRemoveFromLibraryRequest'
responses:
'200':
description: Episode removed
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/me/episodes/contains:
get:
tags:
- Episodes
- Library
summary: |
Check User's Saved Episodes
operationId: Episodes_checkSavedEpisodes
security:
- oauth_2_0:
- user-library-read
description: >
Check if one or more episodes is already saved in the current Spotify
user's 'Your Episodes' library.
This API endpoint is in __beta__ and could change without warning.
Please share any feedback that you have, or issues that you discover, in
our [developer community
forum](https://community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotify_Developer)..
parameters:
- name: ids
required: true
in: query
schema:
title: Spotify Episode IDs
description: >
A comma-separated list of the [Spotify
IDs](/documentation/web-api/concepts/spotify-uris-ids) for the
episodes. Maximum: 50 IDs.
example: 77o6BIVlYM3msb4MMIL1jH,0Q86acNRm6V9GYx55SXKwf
type: string
responses:
'200':
$ref: '#/components/responses/ArrayOfBooleans'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/me/shows:
get:
tags:
- Shows
- Library
summary: |
Get User's Saved Shows
operationId: Shows_getUserSavedShows
security:
- oauth_2_0:
- user-library-read
description: >
Get a list of shows saved in the current Spotify user's library.
Optional parameters can be used to limit the number of shows returned.
parameters:
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryOffset'
responses:
'200':
$ref: '#/components/responses/PagingSavedShowObject'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
put:
tags:
- Shows
- Library
summary: |
Save Shows for Current User
operationId: Shows_saveCurrentUserLibrary
security:
- oauth_2_0:
- user-library-modify
description: |
Save one or more shows to current Spotify user's library.
parameters:
- $ref: '#/components/parameters/QueryShowIds'
responses:
'200':
description: Show saved
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
delete:
tags:
- Shows
- Library
summary: |
Remove User's Saved Shows
operationId: Shows_removeUserLibrary
security:
- oauth_2_0:
- user-library-modify
description: |
Delete one or more shows from current Spotify user's library.
parameters:
- $ref: '#/components/parameters/QueryShowIds'
- $ref: '#/components/parameters/QueryMarket'
responses:
'200':
description: Show removed
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/me/shows/contains:
get:
tags:
- Shows
- Library
summary: |
Check User's Saved Shows
operationId: Shows_checkSavedShows
security:
- oauth_2_0:
- user-library-read
description: >
Check if one or more shows is already saved in the current Spotify
user's library.
parameters:
- $ref: '#/components/parameters/QueryShowIds'
responses:
'200':
$ref: '#/components/responses/ArrayOfBooleans'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/me/top/{type}:
get:
tags:
- Users
- Tracks
- Library
summary: |
Get User's Top Items
operationId: Users_getTopItems
security:
- oauth_2_0:
- user-top-read
description: >
Get the current user's top artists or tracks based on calculated
affinity.
parameters:
- name: type
required: true
in: path
schema:
title: Type
description: |
The type of entity to return. Valid values: `artists` or `tracks`
enum:
- artists
- tracks
type: string
- name: time_range
required: false
in: query
schema:
title: Time Range
description: >
Over what time frame the affinities are computed. Valid values:
`long_term` (calculated from ~1 year of data and including all new
data as it becomes available), `medium_term` (approximately last 6
months), `short_term` (approximately last 4 weeks). Default:
`medium_term`
default: medium_term
example: medium_term
type: string
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryOffset'
responses:
'200':
$ref: '#/components/responses/PagingArtistOrTrackObject'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/users/{user_id}:
get:
tags:
- Users
summary: |
Get User's Profile
operationId: Users_getUserProfile
security:
- oauth_2_0: []
description: |
Get public profile information about a Spotify user.
parameters:
- $ref: '#/components/parameters/PathUserId'
responses:
'200':
$ref: '#/components/responses/OnePublicUser'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/users/{user_id}/playlists:
get:
tags:
- Playlists
- Users
summary: |
Get User's Playlists
operationId: Playlists_getUserPlaylists
security:
- oauth_2_0:
- playlist-read-private
- playlist-read-collaborative
description: |
Get a list of the playlists owned or followed by a Spotify user.
parameters:
- $ref: '#/components/parameters/PathUserId'
- $ref: '#/components/parameters/QueryLimit'
- name: offset
required: false
in: query
schema:
title: Offset
description: >
The index of the first playlist to return. Default:
0 (the first object). Maximum offset: 100.000\. Use with `limit`
to get the
next set of playlists.
default: 0
example: 5
type: integer
responses:
'200':
$ref: '#/components/responses/PagedPlaylists'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
post:
tags:
- Playlists
- Library
summary: |
Create Playlist
operationId: Playlists_createPlaylist
security:
- oauth_2_0:
- playlist-modify-public
- playlist-modify-private
description: >
Create a playlist for a Spotify user. (The playlist will be empty until
you [add
tracks](/documentation/web-api/reference/add-tracks-to-playlist).)
Each user is generally limited to a maximum of 11000 playlists.
parameters:
- $ref: '#/components/parameters/PathUserId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PlaylistsCreatePlaylistRequest'
responses:
'201':
$ref: '#/components/responses/OnePlaylist'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/playlists/{playlist_id}/followers:
put:
tags:
- Users
- Playlists
summary: |
Follow Playlist
operationId: Users_followPlaylist
security:
- oauth_2_0:
- playlist-modify-public
- playlist-modify-private
description: |
Add the current user as a follower of a playlist.
parameters:
- $ref: '#/components/parameters/PathPlaylistId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UsersFollowPlaylistRequest'
responses:
'200':
description: Playlist followed
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
delete:
tags:
- Users
- Playlists
summary: |
Unfollow Playlist
operationId: Users_unfollowPlaylist
security:
- oauth_2_0:
- playlist-modify-public
- playlist-modify-private
description: |
Remove the current user as a follower of a playlist.
parameters:
- $ref: '#/components/parameters/PathPlaylistId'
responses:
'200':
description: Playlist unfollowed
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/browse/featured-playlists:
get:
tags:
- Playlists
summary: |
Get Featured Playlists
operationId: Playlists_getFeatured
security:
- oauth_2_0: []
description: >
Get a list of Spotify featured playlists (shown, for example, on a
Spotify player's 'Browse' tab).
parameters:
- name: locale
required: false
in: query
schema:
title: Locale
description: >
The desired language, consisting of an [ISO
639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code and
an [ISO 3166-1 alpha-2 country
code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), joined by
an underscore. For example: `es_MX`, meaning "Spanish
(Mexico)". Provide this parameter if you want the category
strings returned in a particular language.
_**Note**: if
`locale` is not supplied, or if the specified language is not
available, the category strings returned will be in the Spotify
default language (American English)._
example: sv_SE
type: string
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryOffset'
responses:
'200':
$ref: '#/components/responses/PagedFeaturedPlaylists'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
- $ref: '#/components/x-spotify-policy/policies/MultipleIntegrations'
/browse/categories:
get:
tags:
- Categories
summary: |
Get Several Browse Categories
operationId: Categories_listSeveral
security:
- oauth_2_0: []
description: >
Get a list of categories used to tag items in Spotify (on, for example,
the Spotify player’s “Browse” tab).
parameters:
- name: locale
required: false
in: query
schema:
title: Locale
description: >
The desired language, consisting of an [ISO
639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code and
an [ISO 3166-1 alpha-2 country
code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), joined by
an underscore. For example: `es_MX`, meaning "Spanish
(Mexico)". Provide this parameter if you want the category
strings returned in a particular language.
_**Note**: if
`locale` is not supplied, or if the specified language is not
available, the category strings returned will be in the Spotify
default language (American English)._
example: sv_SE
type: string
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryOffset'
responses:
'200':
$ref: '#/components/responses/PagedCategories'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/browse/categories/{category_id}:
get:
tags:
- Categories
summary: |
Get Single Browse Category
operationId: Categories_getSingle
security:
- oauth_2_0: []
description: >
Get a single category used to tag items in Spotify (on, for example, the
Spotify player’s “Browse” tab).
parameters:
- name: category_id
required: true
in: path
schema:
title: Category ID
description: >
The [Spotify category
ID](/documentation/web-api/concepts/spotify-uris-ids) for the
category.
example: dinner
type: string
- name: locale
required: false
in: query
schema:
title: Locale
description: >
The desired language, consisting of an [ISO
639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code and
an [ISO 3166-1 alpha-2 country
code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), joined by
an underscore. For example: `es_MX`, meaning "Spanish
(Mexico)". Provide this parameter if you want the category
strings returned in a particular language.
_**Note**: if
`locale` is not supplied, or if the specified language is not
available, the category strings returned will be in the Spotify
default language (American English)._
example: sv_SE
type: string
responses:
'200':
$ref: '#/components/responses/OneCategory'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/browse/categories/{category_id}/playlists:
get:
tags:
- Playlists
- Categories
summary: |
Get Category's Playlists
operationId: Playlists_getCategoryPlaylists
security:
- oauth_2_0: []
description: |
Get a list of Spotify playlists tagged with a particular category.
parameters:
- name: category_id
required: true
in: path
schema:
title: Category ID
description: >
The [Spotify category
ID](/documentation/web-api/concepts/spotify-uris-ids) for the
category.
example: dinner
type: string
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryOffset'
responses:
'200':
$ref: '#/components/responses/PagedFeaturedPlaylists'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/playlists/{playlist_id}/images:
get:
tags:
- Playlists
summary: |
Get Playlist Cover Image
operationId: Playlists_getCoverImage
security:
- oauth_2_0: []
description: |
Get the current image associated with a specific playlist.
parameters:
- $ref: '#/components/parameters/PathPlaylistId'
responses:
'200':
$ref: '#/components/responses/ArrayOfImages'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/metadataWithMachineLearningPolicyList'
put:
tags:
- Playlists
summary: |
Add Custom Playlist Cover Image
operationId: Playlists_replaceCoverImage
security:
- oauth_2_0:
- ugc-image-upload
- playlist-modify-public
- playlist-modify-private
description: |
Replace the image used to represent a specific playlist.
parameters:
- $ref: '#/components/parameters/PathPlaylistId'
requestBody:
content:
image/jpeg:
schema:
$ref: '#/components/schemas/PlaylistsReplaceCoverImageRequest'
responses:
'202':
description: Image uploaded
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/browse/new-releases:
get:
tags:
- Albums
summary: |
Get New Releases
operationId: Albums_getNewReleases
security:
- oauth_2_0: []
description: >
Get a list of new album releases featured in Spotify (shown, for
example, on a Spotify player’s “Browse” tab).
parameters:
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryOffset'
responses:
'200':
$ref: '#/components/responses/PagedAlbums'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
- $ref: '#/components/x-spotify-policy/policies/MultipleIntegrations'
/me/following:
get:
tags:
- Users
- Library
- Artists
summary: |
Get Followed Artists
operationId: Users_getFollowedArtists
security:
- oauth_2_0:
- user-follow-read
description: |
Get the current user's followed artists.
parameters:
- name: type
required: true
in: query
schema:
title: Item Type
description: |
The ID type: currently only `artist` is supported.
enum:
- artist
example: artist
type: string
- name: after
required: false
in: query
schema:
title: After
description: |
The last artist ID retrieved from the previous request.
example: 0I2XqVXqHScXjHhk6AYYRe
type: string
- name: limit
required: false
in: query
schema:
title: Limit
description: >
The maximum number of items to return. Default: 20\. Minimum: 1\.
Maximum: 50\.
default: 20
example: 10
type: integer
minimum: 0
maximum: 50
responses:
'200':
$ref: '#/components/responses/CursorPagedArtists'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
put:
tags:
- Users
- Artists
- Library
summary: |
Follow Artists or Users
operationId: Users_followArtistsOrUsers
security:
- oauth_2_0:
- user-follow-modify
description: >
Add the current user as a follower of one or more artists or other
Spotify users.
parameters:
- name: type
required: true
in: query
schema:
title: Item Type
description: |
The ID type.
enum:
- artist
- user
example: artist
type: string
- name: ids
required: true
in: query
schema:
title: Spotify IDs
description: >
A comma-separated list of the artist or the user [Spotify
IDs](/documentation/web-api/concepts/spotify-uris-ids).
A maximum of 50 IDs can be sent in one request.
example: >-
2CIMQHirSU0MQqyYHq0eOx,57dN52uHvrHOxijzpIgu3E,1vCWHaC5f2uS3yhpwWbIA6
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UsersFollowArtistsOrUsersRequest'
responses:
'204':
description: Artist or user followed
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
delete:
tags:
- Users
- Artists
- Library
summary: |
Unfollow Artists or Users
operationId: Users_unfollowArtistsUsers
security:
- oauth_2_0:
- user-follow-modify
description: >
Remove the current user as a follower of one or more artists or other
Spotify users.
parameters:
- name: type
required: true
in: query
schema:
title: Item Type
description: |
The ID type: either `artist` or `user`.
enum:
- artist
- user
example: artist
type: string
- name: ids
required: true
in: query
schema:
title: Spotify IDs
description: >
A comma-separated list of the artist or the user [Spotify
IDs](/documentation/web-api/concepts/spotify-uris-ids). For
example: `ids=74ASZWbe4lXaubB36ztrGX,08td7MxkoHQkXnWAYD8d6Q`. A
maximum of 50 IDs can be sent in one request.
example: >-
2CIMQHirSU0MQqyYHq0eOx,57dN52uHvrHOxijzpIgu3E,1vCWHaC5f2uS3yhpwWbIA6
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UsersUnfollowArtistsUsersRequest'
responses:
'200':
description: Artist or user unfollowed
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/me/following/contains:
get:
tags:
- Users
- Artists
- Library
summary: |
Check If User Follows Artists or Users
operationId: Users_checkFollowingArtistsUsers
security:
- oauth_2_0:
- user-follow-read
description: >
Check to see if the current user is following one or more artists or
other Spotify users.
parameters:
- name: type
required: true
in: query
schema:
title: Item Type
description: |
The ID type: either `artist` or `user`.
enum:
- artist
- user
example: artist
type: string
- name: ids
required: true
in: query
schema:
title: Spotify IDs
description: >
A comma-separated list of the artist or the user [Spotify
IDs](/documentation/web-api/concepts/spotify-uris-ids) to check.
For example: `ids=74ASZWbe4lXaubB36ztrGX,08td7MxkoHQkXnWAYD8d6Q`.
A maximum of 50 IDs can be sent in one request.
example: >-
2CIMQHirSU0MQqyYHq0eOx,57dN52uHvrHOxijzpIgu3E,1vCWHaC5f2uS3yhpwWbIA6
type: string
responses:
'200':
$ref: '#/components/responses/ArrayOfBooleans'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/playlists/{playlist_id}/followers/contains:
get:
tags:
- Users
- Playlists
summary: |
Check if Users Follow Playlist
operationId: Users_checkIfFollowsPlaylist
security:
- oauth_2_0: []
description: >
Check to see if one or more Spotify users are following a specified
playlist.
parameters:
- $ref: '#/components/parameters/PathPlaylistId'
- name: ids
required: true
in: query
schema:
title: Spotify user IDs
description: >
A comma-separated list of [Spotify User
IDs](/documentation/web-api/concepts/spotify-uris-ids) ; the ids
of the users that you want to check to see if they follow the
playlist. Maximum: 5 ids.
example: jmperezperez,thelinmichael,wizzler
type: string
responses:
'200':
$ref: '#/components/responses/ArrayOfBooleans'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/audio-features:
get:
tags:
- Tracks
summary: |
Get Several Tracks' Audio Features
operationId: Tracks_getMultipleAudioFeatures
security:
- oauth_2_0: []
description: |
Get audio features for multiple tracks based on their Spotify IDs.
parameters:
- name: ids
required: true
in: query
schema:
title: Spotify Track IDs
description: >
A comma-separated list of the [Spotify
IDs](/documentation/web-api/concepts/spotify-uris-ids)
for the tracks. Maximum: 100 IDs.
example: >-
7ouMYWpwJ422jRcDASZB7P,4VqPOruhp5EdPBeR92t6lQ,2takcwOaAZWiXQijPHIx7B
type: string
responses:
'200':
$ref: '#/components/responses/ManyAudioFeatures'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
- $ref: '#/components/x-spotify-policy/policies/MachineLearning'
/audio-features/{id}:
get:
tags:
- Tracks
summary: |
Get Track's Audio Features
operationId: Tracks_getAudioFeaturesById
security:
- oauth_2_0: []
description: >
Get audio feature information for a single track identified by its
unique
Spotify ID.
parameters:
- name: id
required: true
in: path
schema:
title: Spotify Track ID
description: >
The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids)
for the track.
example: 11dFghVXANMlKmJXsNCbNl
type: string
responses:
'200':
$ref: '#/components/responses/OneAudioFeatures'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
- $ref: '#/components/x-spotify-policy/policies/MachineLearning'
/audio-analysis/{id}:
get:
tags:
- Tracks
summary: |
Get Track's Audio Analysis
operationId: Tracks_getAudioAnalysis
security:
- oauth_2_0: []
description: >
Get a low-level audio analysis for a track in the Spotify catalog. The
audio analysis describes the track’s structure and musical content,
including rhythm, pitch, and timbre.
parameters:
- name: id
required: true
in: path
schema:
title: Spotify Track ID
description: |
The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids)
for the track.
example: 11dFghVXANMlKmJXsNCbNl
type: string
responses:
'200':
$ref: '#/components/responses/OneAudioAnalysis'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/recommendations:
get:
tags:
- Tracks
summary: |
Get Recommendations
operationId: Tracks_getRecommendations
security:
- oauth_2_0: []
description: >
Recommendations are generated based on the available information for a
given seed entity and matched against similar artists and tracks. If
there is sufficient information about the provided seeds, a list of
tracks will be returned together with pool size details.
For artists and tracks that are very new or obscure there might not be
enough data to generate a list of tracks.
parameters:
- name: limit
required: false
in: query
schema:
title: Limit
description: >
The target size of the list of recommended tracks. For seeds with
unusually small pools or when highly restrictive filtering is
applied, it may be impossible to generate the requested number of
recommended tracks. Debugging information for such cases is
available in the response. Default: 20\. Minimum: 1\. Maximum:
100.
default: 20
example: 10
type: integer
minimum: 1
maximum: 100
- $ref: '#/components/parameters/QueryMarket'
- name: seed_artists
required: true
in: query
schema:
title: Spotify Artist ID Seeds
description: >
A comma separated list of [Spotify
IDs](/documentation/web-api/concepts/spotify-uris-ids) for seed
artists. Up to 5 seed values may be provided in any combination
of `seed_artists`, `seed_tracks` and `seed_genres`.
_**Note**: only required if `seed_genres` and `seed_tracks` are
not set_.
example: 4NHQUGzhtTLFvgF5SZesLK
type: string
- name: seed_genres
required: true
in: query
schema:
title: Genres Seeds
description: >
A comma separated list of any genres in the set of [available
genre
seeds](/documentation/web-api/reference/get-recommendation-genres).
Up to 5 seed values may be provided in any combination of
`seed_artists`, `seed_tracks` and `seed_genres`.
_**Note**:
only required if `seed_artists` and `seed_tracks` are not set_.
example: classical,country
type: string
- name: seed_tracks
required: true
in: query
schema:
title: Spotify Track ID Seeds
description: >
A comma separated list of [Spotify
IDs](/documentation/web-api/concepts/spotify-uris-ids) for a seed
track. Up to 5 seed values may be provided in any combination of
`seed_artists`, `seed_tracks` and `seed_genres`.
_**Note**:
only required if `seed_artists` and `seed_genres` are not set_.
example: 0c6xIDDpzE81m2q797ordA
type: string
- name: min_acousticness
required: false
in: query
schema:
title: Min. Acousticness
description: >
For each tunable track attribute, a hard floor on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`min_tempo=140` would restrict results to only those tracks with a
tempo of greater than 140 beats per minute.
type: number
minimum: 0
maximum: 1
- name: max_acousticness
required: false
in: query
schema:
title: Max. Acousticness
description: >
For each tunable track attribute, a hard ceiling on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`max_instrumentalness=0.35` would filter out most tracks that are
likely to be instrumental.
type: number
minimum: 0
maximum: 1
- name: target_acousticness
required: false
in: query
schema:
title: Target Acousticness
description: >
For each of the tunable track attributes (below) a target value
may be provided. Tracks with the attribute values nearest to the
target values will be preferred. For example, you might request
`target_energy=0.6` and `target_danceability=0.8`. All target
values will be weighed equally in ranking results.
type: number
minimum: 0
maximum: 1
- name: min_danceability
required: false
in: query
schema:
title: Min. Danceability
description: >
For each tunable track attribute, a hard floor on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`min_tempo=140` would restrict results to only those tracks with a
tempo of greater than 140 beats per minute.
type: number
minimum: 0
maximum: 1
- name: max_danceability
required: false
in: query
schema:
title: Max. Danceability
description: >
For each tunable track attribute, a hard ceiling on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`max_instrumentalness=0.35` would filter out most tracks that are
likely to be instrumental.
type: number
minimum: 0
maximum: 1
- name: target_danceability
required: false
in: query
schema:
title: Target Danceability
description: >
For each of the tunable track attributes (below) a target value
may be provided. Tracks with the attribute values nearest to the
target values will be preferred. For example, you might request
`target_energy=0.6` and `target_danceability=0.8`. All target
values will be weighed equally in ranking results.
type: number
minimum: 0
maximum: 1
- name: min_duration_ms
required: false
in: query
schema:
title: Min. Duration (ms)
description: >
For each tunable track attribute, a hard floor on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`min_tempo=140` would restrict results to only those tracks with a
tempo of greater than 140 beats per minute.
type: integer
- name: max_duration_ms
required: false
in: query
schema:
title: Max. Duration (ms)
description: >
For each tunable track attribute, a hard ceiling on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`max_instrumentalness=0.35` would filter out most tracks that are
likely to be instrumental.
type: integer
- name: target_duration_ms
required: false
in: query
schema:
title: Target Duration (ms)
description: Target duration of the track (ms)
type: integer
- name: min_energy
required: false
in: query
schema:
title: Min. Energy
description: >
For each tunable track attribute, a hard floor on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`min_tempo=140` would restrict results to only those tracks with a
tempo of greater than 140 beats per minute.
type: number
minimum: 0
maximum: 1
- name: max_energy
required: false
in: query
schema:
title: Max. Energy
description: >
For each tunable track attribute, a hard ceiling on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`max_instrumentalness=0.35` would filter out most tracks that are
likely to be instrumental.
type: number
minimum: 0
maximum: 1
- name: target_energy
required: false
in: query
schema:
title: Target Energy
description: >
For each of the tunable track attributes (below) a target value
may be provided. Tracks with the attribute values nearest to the
target values will be preferred. For example, you might request
`target_energy=0.6` and `target_danceability=0.8`. All target
values will be weighed equally in ranking results.
type: number
minimum: 0
maximum: 1
- name: min_instrumentalness
required: false
in: query
schema:
title: Min. Instrumentalness
description: >
For each tunable track attribute, a hard floor on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`min_tempo=140` would restrict results to only those tracks with a
tempo of greater than 140 beats per minute.
type: number
minimum: 0
maximum: 1
- name: max_instrumentalness
required: false
in: query
schema:
title: Max. Instrumentalness
description: >
For each tunable track attribute, a hard ceiling on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`max_instrumentalness=0.35` would filter out most tracks that are
likely to be instrumental.
type: number
minimum: 0
maximum: 1
- name: target_instrumentalness
required: false
in: query
schema:
title: Target Instrumentalness
description: >
For each of the tunable track attributes (below) a target value
may be provided. Tracks with the attribute values nearest to the
target values will be preferred. For example, you might request
`target_energy=0.6` and `target_danceability=0.8`. All target
values will be weighed equally in ranking results.
type: number
minimum: 0
maximum: 1
- name: min_key
required: false
in: query
schema:
title: Min. Key
description: >
For each tunable track attribute, a hard floor on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`min_tempo=140` would restrict results to only those tracks with a
tempo of greater than 140 beats per minute.
type: integer
minimum: 0
maximum: 11
- name: max_key
required: false
in: query
schema:
title: Max. Key
description: >
For each tunable track attribute, a hard ceiling on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`max_instrumentalness=0.35` would filter out most tracks that are
likely to be instrumental.
type: integer
minimum: 0
maximum: 11
- name: target_key
required: false
in: query
schema:
title: Target Key
description: >
For each of the tunable track attributes (below) a target value
may be provided. Tracks with the attribute values nearest to the
target values will be preferred. For example, you might request
`target_energy=0.6` and `target_danceability=0.8`. All target
values will be weighed equally in ranking results.
type: integer
minimum: 0
maximum: 11
- name: min_liveness
required: false
in: query
schema:
title: Min. Liveness
description: >
For each tunable track attribute, a hard floor on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`min_tempo=140` would restrict results to only those tracks with a
tempo of greater than 140 beats per minute.
type: number
minimum: 0
maximum: 1
- name: max_liveness
required: false
in: query
schema:
title: Max. Liveness
description: >
For each tunable track attribute, a hard ceiling on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`max_instrumentalness=0.35` would filter out most tracks that are
likely to be instrumental.
type: number
minimum: 0
maximum: 1
- name: target_liveness
required: false
in: query
schema:
title: Target Liveness
description: >
For each of the tunable track attributes (below) a target value
may be provided. Tracks with the attribute values nearest to the
target values will be preferred. For example, you might request
`target_energy=0.6` and `target_danceability=0.8`. All target
values will be weighed equally in ranking results.
type: number
minimum: 0
maximum: 1
- name: min_loudness
required: false
in: query
schema:
title: Min. Loudness
description: >
For each tunable track attribute, a hard floor on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`min_tempo=140` would restrict results to only those tracks with a
tempo of greater than 140 beats per minute.
type: number
- name: max_loudness
required: false
in: query
schema:
title: Max. Loudness
description: >
For each tunable track attribute, a hard ceiling on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`max_instrumentalness=0.35` would filter out most tracks that are
likely to be instrumental.
type: number
- name: target_loudness
required: false
in: query
schema:
title: Target Loudness
description: >
For each of the tunable track attributes (below) a target value
may be provided. Tracks with the attribute values nearest to the
target values will be preferred. For example, you might request
`target_energy=0.6` and `target_danceability=0.8`. All target
values will be weighed equally in ranking results.
type: number
- name: min_mode
required: false
in: query
schema:
title: Min. Mode
description: >
For each tunable track attribute, a hard floor on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`min_tempo=140` would restrict results to only those tracks with a
tempo of greater than 140 beats per minute.
type: integer
minimum: 0
maximum: 1
- name: max_mode
required: false
in: query
schema:
title: Max. Mode
description: >
For each tunable track attribute, a hard ceiling on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`max_instrumentalness=0.35` would filter out most tracks that are
likely to be instrumental.
type: integer
minimum: 0
maximum: 1
- name: target_mode
required: false
in: query
schema:
title: Target Mode
description: >
For each of the tunable track attributes (below) a target value
may be provided. Tracks with the attribute values nearest to the
target values will be preferred. For example, you might request
`target_energy=0.6` and `target_danceability=0.8`. All target
values will be weighed equally in ranking results.
type: integer
minimum: 0
maximum: 1
- name: min_popularity
required: false
in: query
schema:
title: Min. Popularity
description: >
For each tunable track attribute, a hard floor on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`min_tempo=140` would restrict results to only those tracks with a
tempo of greater than 140 beats per minute.
type: integer
minimum: 0
maximum: 100
- name: max_popularity
required: false
in: query
schema:
title: Max. Popularity
description: >
For each tunable track attribute, a hard ceiling on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`max_instrumentalness=0.35` would filter out most tracks that are
likely to be instrumental.
type: integer
minimum: 0
maximum: 100
- name: target_popularity
required: false
in: query
schema:
title: Target Popularity
description: >
For each of the tunable track attributes (below) a target value
may be provided. Tracks with the attribute values nearest to the
target values will be preferred. For example, you might request
`target_energy=0.6` and `target_danceability=0.8`. All target
values will be weighed equally in ranking results.
type: integer
minimum: 0
maximum: 100
- name: min_speechiness
required: false
in: query
schema:
title: Min. Speechiness
description: >
For each tunable track attribute, a hard floor on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`min_tempo=140` would restrict results to only those tracks with a
tempo of greater than 140 beats per minute.
type: number
minimum: 0
maximum: 1
- name: max_speechiness
required: false
in: query
schema:
title: Max. Speechiness
description: >
For each tunable track attribute, a hard ceiling on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`max_instrumentalness=0.35` would filter out most tracks that are
likely to be instrumental.
type: number
minimum: 0
maximum: 1
- name: target_speechiness
required: false
in: query
schema:
title: Target Speechiness
description: >
For each of the tunable track attributes (below) a target value
may be provided. Tracks with the attribute values nearest to the
target values will be preferred. For example, you might request
`target_energy=0.6` and `target_danceability=0.8`. All target
values will be weighed equally in ranking results.
type: number
minimum: 0
maximum: 1
- name: min_tempo
required: false
in: query
schema:
title: Min. Tempo
description: >
For each tunable track attribute, a hard floor on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`min_tempo=140` would restrict results to only those tracks with a
tempo of greater than 140 beats per minute.
type: number
- name: max_tempo
required: false
in: query
schema:
title: Max. Tempo
description: >
For each tunable track attribute, a hard ceiling on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`max_instrumentalness=0.35` would filter out most tracks that are
likely to be instrumental.
type: number
- name: target_tempo
required: false
in: query
schema:
title: Target Tempo
description: Target tempo (BPM)
type: number
- name: min_time_signature
required: false
in: query
schema:
title: Min. Time Signature
description: >
For each tunable track attribute, a hard floor on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`min_tempo=140` would restrict results to only those tracks with a
tempo of greater than 140 beats per minute.
type: integer
maximum: 11
- name: max_time_signature
required: false
in: query
schema:
title: Max. Time Signature
description: >
For each tunable track attribute, a hard ceiling on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`max_instrumentalness=0.35` would filter out most tracks that are
likely to be instrumental.
type: integer
- name: target_time_signature
required: false
in: query
schema:
title: Target Time Signature
description: >
For each of the tunable track attributes (below) a target value
may be provided. Tracks with the attribute values nearest to the
target values will be preferred. For example, you might request
`target_energy=0.6` and `target_danceability=0.8`. All target
values will be weighed equally in ranking results.
type: integer
- name: min_valence
required: false
in: query
schema:
title: Min. Valence
description: >
For each tunable track attribute, a hard floor on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`min_tempo=140` would restrict results to only those tracks with a
tempo of greater than 140 beats per minute.
type: number
minimum: 0
maximum: 1
- name: max_valence
required: false
in: query
schema:
title: Max. Valence
description: >
For each tunable track attribute, a hard ceiling on the selected
track attribute’s value can be provided. See tunable track
attributes below for the list of available options. For example,
`max_instrumentalness=0.35` would filter out most tracks that are
likely to be instrumental.
type: number
minimum: 0
maximum: 1
- name: target_valence
required: false
in: query
schema:
title: Target Valence
description: >
For each of the tunable track attributes (below) a target value
may be provided. Tracks with the attribute values nearest to the
target values will be preferred. For example, you might request
`target_energy=0.6` and `target_danceability=0.8`. All target
values will be weighed equally in ranking results.
type: number
minimum: 0
maximum: 1
responses:
'200':
$ref: '#/components/responses/OneRecommendations'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
- $ref: '#/components/x-spotify-policy/policies/MachineLearning'
/recommendations/available-genre-seeds:
get:
tags:
- Genres
summary: |
Get Available Genre Seeds
operationId: Genres_getAvailableSeeds
security:
- oauth_2_0: []
description: >
Retrieve a list of available genres seed parameter values for
[recommendations](/documentation/web-api/reference/get-recommendations).
responses:
'200':
$ref: '#/components/responses/ManyGenres'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/me/player:
get:
tags:
- Player
summary: |
Get Playback State
operationId: Player_getCurrentPlaybackState
security:
- oauth_2_0:
- user-read-playback-state
description: >
Get information about the user’s current playback state, including track
or episode, progress, and active device.
parameters:
- $ref: '#/components/parameters/QueryMarket'
- $ref: '#/components/parameters/QueryAdditionalTypes'
responses:
'200':
$ref: '#/components/responses/OneCurrentlyPlaying'
'204':
description: Playback not available or active
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/playerPolicyList'
put:
tags:
- Player
summary: |
Transfer Playback
operationId: Player_transferPlaybackToNewDevice
security:
- oauth_2_0:
- user-modify-playback-state
description: >
Transfer playback to a new device and optionally begin playback. This
API only works for users who have Spotify Premium. The order of
execution is not guaranteed when you use this API with other Player API
endpoints.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PlayerTransferPlaybackToNewDeviceRequest'
responses:
'204':
description: Playback transferred
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/playerPolicyList'
/me/player/devices:
get:
tags:
- Player
summary: |
Get Available Devices
operationId: Player_getAvailableDevices
security:
- oauth_2_0:
- user-read-playback-state
description: >
Get information about a user’s available Spotify Connect devices. Some
device models are not supported and will not be listed in the API
response.
responses:
'200':
$ref: '#/components/responses/ManyDevices'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/me/player/currently-playing:
get:
tags:
- Player
summary: |
Get Currently Playing Track
operationId: Player_getCurrentlyPlayingTrack
security:
- oauth_2_0:
- user-read-currently-playing
description: |
Get the object currently being played on the user's Spotify account.
parameters:
- $ref: '#/components/parameters/QueryMarket'
- $ref: '#/components/parameters/QueryAdditionalTypes'
responses:
'200':
$ref: '#/components/responses/OneCurrentlyPlayingTrack'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/playerPolicyList'
/me/player/play:
put:
tags:
- Player
summary: |
Start/Resume Playback
operationId: Player_startPlayback
security:
- oauth_2_0:
- user-modify-playback-state
description: >
Start a new context or resume current playback on the user's active
device. This API only works for users who have Spotify Premium. The
order of execution is not guaranteed when you use this API with other
Player API endpoints.
parameters:
- name: device_id
required: false
in: query
schema:
title: Device ID
description: >-
The id of the device this command is targeting. If not supplied,
the user's currently active device is the target.
example: 0d1841b0976bae2a3a310dd74c0f3df354899bc8
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PlayerStartPlaybackRequest'
responses:
'204':
description: Playback started
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/playerPolicyList'
/me/player/pause:
put:
tags:
- Player
summary: |
Pause Playback
operationId: Player_pausePlayback
security:
- oauth_2_0:
- user-modify-playback-state
description: >
Pause playback on the user's account. This API only works for users who
have Spotify Premium. The order of execution is not guaranteed when you
use this API with other Player API endpoints.
parameters:
- name: device_id
required: false
in: query
schema:
title: Device ID
description: >
The id of the device this command is targeting. If not supplied,
the user's currently active device is the target.
example: 0d1841b0976bae2a3a310dd74c0f3df354899bc8
type: string
responses:
'204':
description: Playback paused
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/playerPolicyList'
/me/player/next:
post:
tags:
- Player
summary: |
Skip To Next
operationId: Player_skipToNextTrack
security:
- oauth_2_0:
- user-modify-playback-state
description: >
Skips to next track in the user’s queue. This API only works for users
who have Spotify Premium. The order of execution is not guaranteed when
you use this API with other Player API endpoints.
parameters:
- name: device_id
required: false
in: query
schema:
title: Device ID
description: >-
The id of the device this command is targeting. If not supplied,
the user's currently active device is the target.
example: 0d1841b0976bae2a3a310dd74c0f3df354899bc8
type: string
responses:
'204':
description: Command sent
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/playerPolicyList'
/me/player/previous:
post:
tags:
- Player
summary: |
Skip To Previous
operationId: Player_skipToPreviousTrack
security:
- oauth_2_0:
- user-modify-playback-state
description: >
Skips to previous track in the user’s queue. This API only works for
users who have Spotify Premium. The order of execution is not guaranteed
when you use this API with other Player API endpoints.
parameters:
- name: device_id
required: false
in: query
schema:
title: Device ID
description: |
The id of the device this command is targeting. If
not supplied, the user's currently active device is the target.
example: 0d1841b0976bae2a3a310dd74c0f3df354899bc8
type: string
responses:
'204':
description: Command sent
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/playerPolicyList'
/me/player/seek:
put:
tags:
- Player
summary: |
Seek To Position
operationId: Player_seekToPosition
security:
- oauth_2_0:
- user-modify-playback-state
description: >
Seeks to the given position in the user’s currently playing track. This
API only works for users who have Spotify Premium. The order of
execution is not guaranteed when you use this API with other Player API
endpoints.
parameters:
- name: position_ms
required: true
in: query
schema:
title: Position (ms)
description: >
The position in milliseconds to seek to. Must be a
positive number. Passing in a position that is greater than the
length of
the track will cause the player to start playing the next song.
example: 25000
type: integer
- name: device_id
required: false
in: query
schema:
title: Device ID
description: |
The id of the device this command is targeting. If
not supplied, the user's currently active device is the target.
example: 0d1841b0976bae2a3a310dd74c0f3df354899bc8
type: string
responses:
'204':
description: Command sent
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/playerPolicyList'
/me/player/repeat:
put:
tags:
- Player
summary: |
Set Repeat Mode
operationId: Player_setRepeatMode
security:
- oauth_2_0:
- user-modify-playback-state
description: >
Set the repeat mode for the user's playback. This API only works for
users who have Spotify Premium. The order of execution is not guaranteed
when you use this API with other Player API endpoints.
parameters:
- name: state
required: true
in: query
schema:
title: State
description: |
**track**, **context** or **off**.
**track** will repeat the current track.
**context** will repeat the current context.
**off** will turn repeat off.
example: context
type: string
- name: device_id
required: false
in: query
schema:
title: Device ID
description: |
The id of the device this command is targeting. If
not supplied, the user's currently active device is the target.
example: 0d1841b0976bae2a3a310dd74c0f3df354899bc8
type: string
responses:
'204':
description: Command sent
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/me/player/volume:
put:
tags:
- Player
summary: |
Set Playback Volume
operationId: Player_setPlaybackVolume
security:
- oauth_2_0:
- user-modify-playback-state
description: >
Set the volume for the user’s current playback device. This API only
works for users who have Spotify Premium. The order of execution is not
guaranteed when you use this API with other Player API endpoints.
parameters:
- name: volume_percent
required: true
in: query
schema:
title: Volume %
description: |
The volume to set. Must be a value from 0 to 100 inclusive.
example: 50
type: integer
- name: device_id
required: false
in: query
schema:
title: Device ID
description: >
The id of the device this command is targeting. If not supplied,
the user's currently active device is the target.
example: 0d1841b0976bae2a3a310dd74c0f3df354899bc8
type: string
responses:
'204':
description: Command sent
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/me/player/shuffle:
put:
tags:
- Player
summary: |
Toggle Playback Shuffle
operationId: Player_togglePlaybackShuffle
security:
- oauth_2_0:
- user-modify-playback-state
description: >
Toggle shuffle on or off for user’s playback. This API only works for
users who have Spotify Premium. The order of execution is not guaranteed
when you use this API with other Player API endpoints.
parameters:
- name: state
required: true
in: query
schema:
title: State
description: |
**true** : Shuffle user's playback.
**false** : Do not shuffle user's playback.
example: true
type: boolean
- name: device_id
required: false
in: query
schema:
title: Device ID
description: |
The id of the device this command is targeting. If
not supplied, the user's currently active device is the target.
example: 0d1841b0976bae2a3a310dd74c0f3df354899bc8
type: string
responses:
'204':
description: Command sent
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/me/player/recently-played:
get:
tags:
- Player
summary: |
Get Recently Played Tracks
operationId: Player_getRecentlyPlayedTracks
security:
- oauth_2_0:
- user-read-recently-played
description: |
Get tracks from the current user's recently played tracks.
_**Note**: Currently doesn't support podcast episodes._
parameters:
- name: limit
required: false
in: query
schema:
title: Limit
description: >
The maximum number of items to return. Default: 20. Minimum: 1.
Maximum: 50.
default: 20
example: 10
type: integer
minimum: 0
maximum: 50
- name: after
required: false
in: query
schema:
title: After
description: >
A Unix timestamp in milliseconds. Returns all items
after (but not including) this cursor position. If `after` is
specified, `before`
must not be specified.
example: 1484811043508
type: integer
- name: before
required: false
in: query
schema:
title: Before
description: >
A Unix timestamp in milliseconds. Returns all items
before (but not including) this cursor position. If `before` is
specified,
`after` must not be specified.
type: integer
responses:
'200':
$ref: '#/components/responses/CursorPagedPlayHistory'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/playerPolicyList'
/me/player/queue:
get:
tags:
- Player
summary: |
Get the User's Queue
operationId: Player_getUserQueue
security:
- oauth_2_0:
- user-read-currently-playing
- user-read-playback-state
description: |
Get the list of objects that make up the user's queue.
responses:
'200':
$ref: '#/components/responses/Queue'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/playerPolicyList'
post:
tags:
- Player
summary: |
Add Item to Playback Queue
operationId: Player_addItemToQueue
security:
- oauth_2_0:
- user-modify-playback-state
description: >
Add an item to the end of the user's current playback queue. This API
only works for users who have Spotify Premium. The order of execution is
not guaranteed when you use this API with other Player API endpoints.
parameters:
- name: uri
required: true
in: query
schema:
title: Spotify URI
description: >
The uri of the item to add to the queue. Must be a track or an
episode uri.
example: spotify:track:4iV5W9uYEdYUVa79Axb7Rh
type: string
- name: device_id
required: false
in: query
schema:
title: Device ID
description: |
The id of the device this command is targeting. If
not supplied, the user's currently active device is the target.
example: 0d1841b0976bae2a3a310dd74c0f3df354899bc8
type: string
responses:
'204':
description: Command received
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
x-spotify-policy-list:
$ref: '#/components/x-spotify-policy/playerPolicyList'
/markets:
get:
tags:
- Markets
summary: |
Get Available Markets
operationId: Markets_listAvailable
security:
- oauth_2_0: []
description: |
Get the list of markets where Spotify is available.
responses:
'200':
description: A markets object with an array of country codes
content:
application/json:
schema:
$ref: '#/components/schemas/MarketsListAvailableResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
components:
parameters:
PathAlbumId:
in: path
name: id
required: true
schema:
title: Spotify Album ID
description: >
The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of
the album.
example: 4aawyAB9vmqN3uQ7FjRGTy
type: string
PathPlaylistId:
name: playlist_id
required: true
in: path
schema:
title: Playlist ID
description: >
The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of
the playlist.
example: 3cEYpjA9oz9GiPac4AsH4n
type: string
QueryMarket:
name: market
required: false
in: query
schema:
title: Market
description: >
An [ISO 3166-1 alpha-2 country
code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_**Note**: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the [account settings](https://www.spotify.com/se/account/overview/).
example: ES
type: string
QueryLimit:
name: limit
required: false
in: query
schema:
title: Limit
description: >
The maximum number of items to return. Default: 20. Minimum: 1.
Maximum: 50.
default: 20
example: 10
type: integer
minimum: 0
maximum: 50
QueryOffset:
name: offset
required: false
in: query
schema:
title: Offset
description: >
The index of the first item to return. Default: 0 (the first item).
Use with limit to get the next set of items.
default: 0
example: 5
type: integer
QueryAdditionalTypes:
name: additional_types
required: false
in: query
schema:
title: Additional Types
description: >
A comma-separated list of item types that your client supports besides
the default `track` type. Valid types are: `track` and `episode`.
_**Note**: This parameter was introduced to allow existing clients to
maintain their current behaviour and might be deprecated in the
future._
In addition to providing this parameter, make sure that your client
properly handles cases of new types in the future by checking against
the `type` field of each object.
type: string
QueryAlbumIds:
name: ids
required: true
in: query
schema:
title: Spotify Album IDs
description: >
A comma-separated list of the [Spotify
IDs](/documentation/web-api/concepts/spotify-uris-ids) for the albums.
Maximum: 20 IDs.
example: 382ObEPsp2rxGrnsizN5TX,1A2GTWGtFfWp7KSQTwWOyo,2noRn2Aes5aoNVsU6iWThc
type: string
PathArtistId:
name: id
required: true
in: path
schema:
title: Spotify Artist ID
description: >
The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of
the artist.
example: 0TnOYISbd1XYRBk9myaseg
type: string
PathShowId:
name: id
required: true
in: path
schema:
title: Spotify Show ID
description: |
The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids)
for the show.
example: 38bS44xjbVVZ3No3ByF1dJ
type: string
PathAudiobookId:
name: id
required: true
in: path
schema:
title: Spotify Audiobook ID
description: |
The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids)
for the audiobook.
example: 7iHfbu1YPACw6oZPAFJtqe
type: string
QueryAudiobookIds:
name: ids
required: true
in: query
schema:
title: Spotify Audiobook IDs
description: >
A comma-separated list of the [Spotify
IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
`ids=18yVqkdbdRvS24c0Ilj2ci,1HGw3J3NxZO1TP1BTtVhpZ`. Maximum: 50 IDs.
example: 18yVqkdbdRvS24c0Ilj2ci,1HGw3J3NxZO1TP1BTtVhpZ,7iHfbu1YPACw6oZPAFJtqe
type: string
PathChapterId:
name: id
required: true
in: path
schema:
title: Spotify Chapter ID
description: |
The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids)
for the chapter.
example: 0D5wENdkdwbqlrHoaJ9g29
type: string
QueryChapterIds:
name: ids
required: true
in: query
schema:
title: Spotify Chapter IDs
description: >
A comma-separated list of the [Spotify
IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
`ids=0IsXVP0JmcB2adSE338GkK,3ZXb8FKZGU0EHALYX6uCzU`. Maximum: 50 IDs.
example: 0IsXVP0JmcB2adSE338GkK,3ZXb8FKZGU0EHALYX6uCzU,0D5wENdkdwbqlrHoaJ9g29
type: string
QueryTrackIds:
name: ids
required: true
in: query
schema:
title: Spotify Track IDs
description: >
A comma-separated list of the [Spotify
IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
`ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M`. Maximum: 50 IDs.
example: 7ouMYWpwJ422jRcDASZB7P,4VqPOruhp5EdPBeR92t6lQ,2takcwOaAZWiXQijPHIx7B
type: string
QueryIncludeGroups:
name: include_groups
required: false
in: query
schema:
title: Groups to include (single, album, appears_on, compilation)
description: >
A comma-separated list of keywords that will be used to filter the
response. If not supplied, all album types will be returned.
Valid values are:
- `album`
- `single`
-
`appears_on`
- `compilation`
For example:
`include_groups=album,single`.
example: single,appears_on
type: string
QueryShowIds:
name: ids
required: true
in: query
schema:
title: Ids
description: >
A comma-separated list of the [Spotify
IDs](/documentation/web-api/concepts/spotify-uris-ids) for the shows.
Maximum: 50 IDs.
example: 5CfCWKI5pZ28U0uOzXkDHe,5as3aKmN2k11yfDDDSrvaZ
type: string
PathUserId:
name: user_id
required: true
in: path
schema:
title: User ID
description: >
The user's [Spotify user
ID](/documentation/web-api/concepts/spotify-uris-ids).
example: smedjan
type: string
responses:
Unauthorized:
description: |
Bad or expired token. This can happen if the user revoked a token or
the access token has expired. You should re-authenticate the user.
content:
application/json:
schema:
$ref: '#/components/schemas/AlbumsGetInformationResponse'
Forbidden:
description: >
Bad OAuth request (wrong consumer key, bad nonce, expired
timestamp...). Unfortunately, re-authenticating the user won't help
here.
content:
application/json:
schema:
$ref: '#/components/schemas/AlbumsGetInformation403Response'
NotFound:
description: |
The requested resource cannot be found.
content:
application/json:
schema:
$ref: '#/components/schemas/AudiobooksGetCatalogInfo404Response'
BadRequest:
description: |
The request contains malformed data in path, query parameters, or body.
content:
application/json:
schema:
$ref: '#/components/schemas/AudiobooksGetCatalogInfoResponse'
TooManyRequests:
description: |
The app has exceeded its rate limits.
content:
application/json:
schema:
$ref: '#/components/schemas/AlbumsGetInformation429Response'
ManyAlbums:
description: A set of albums
content:
application/json:
schema:
$ref: '#/components/schemas/AlbumsListSeveralResponse'
ManyAudiobooks:
description: >-
A set of audiobooks. If one of the requested audiobooks is unavailable
then you'll find a `null` item in the `audiobooks` array where the
audiobook object would otherwise be.
content:
application/json:
schema:
$ref: '#/components/schemas/AudiobooksGetSeveralResponse'
ManyChapters:
description: A set of chapters
content:
application/json:
schema:
$ref: '#/components/schemas/ChaptersGetMultipleByIdsResponse'
ManyDevices:
description: A set of devices
content:
application/json:
schema:
$ref: '#/components/schemas/PlayerGetAvailableDevicesResponse'
PagedAlbums:
description: A paged set of albums
content:
application/json:
schema:
$ref: '#/components/schemas/AlbumsGetNewReleasesResponse'
PagedPlaylists:
description: A paged set of playlists
content:
application/json:
schema:
$ref: '#/components/schemas/PagingPlaylistObject'
PagedFeaturedPlaylists:
description: A paged set of playlists
content:
application/json:
schema:
$ref: '#/components/schemas/PagingFeaturedPlaylistObject'
PagedCategories:
description: A paged set of categories
content:
application/json:
schema:
$ref: '#/components/schemas/CategoriesListSeveralResponse'
CursorPagedArtists:
description: A paged set of artists
content:
application/json:
schema:
$ref: '#/components/schemas/UsersGetFollowedArtistsResponse'
CursorPagedPlayHistory:
description: A paged set of tracks
content:
application/json:
schema:
$ref: '#/components/schemas/CursorPagingPlayHistoryObject'
ManyArtists:
description: A set of artists
content:
application/json:
schema:
$ref: '#/components/schemas/ArtistsGetCatalogInfoResponse'
ManyAudioFeatures:
description: A set of audio features
content:
application/json:
schema:
$ref: '#/components/schemas/TracksGetMultipleAudioFeaturesResponse'
ManyEpisodes:
description: A set of episodes
content:
application/json:
schema:
$ref: '#/components/schemas/EpisodesGetSeveralResponse'
ManyGenres:
description: A set of genres
content:
application/json:
schema:
$ref: '#/components/schemas/GenresGetAvailableSeedsResponse'
OneEpisode:
description: An episode
content:
application/json:
schema:
$ref: '#/components/schemas/EpisodeObject'
OneChapter:
description: A Chapter
content:
application/json:
schema:
$ref: '#/components/schemas/ChapterObject'
OneAudiobook:
description: An Audiobook
content:
application/json:
schema:
$ref: '#/components/schemas/AudiobookObject'
OneAlbum:
description: An album
content:
application/json:
schema:
$ref: '#/components/schemas/AlbumObject'
ArrayOfImages:
description: A set of images
content:
application/json:
schema:
$ref: '#/components/schemas/PlaylistsGetCoverImageResponse'
OnePrivateUser:
description: A user
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateUserObject'
OnePublicUser:
description: A user
content:
application/json:
schema:
$ref: '#/components/schemas/PublicUserObject'
OneTrack:
description: A track
content:
application/json:
schema:
$ref: '#/components/schemas/TrackObject'
OneShow:
description: A show
content:
application/json:
schema:
$ref: '#/components/schemas/ShowObject'
OneCategory:
description: A category
content:
application/json:
schema:
$ref: '#/components/schemas/CategoryObject'
OnePlaylist:
description: A playlist
content:
application/json:
schema:
$ref: '#/components/schemas/PlaylistObject'
OneAudioFeatures:
description: Audio features for one track
content:
application/json:
schema:
$ref: '#/components/schemas/AudioFeaturesObject'
OneAudioAnalysis:
description: Audio analysis for one track
content:
application/json:
schema:
$ref: '#/components/schemas/AudioAnalysisObject'
OneArtist:
description: An artist
content:
application/json:
schema:
$ref: '#/components/schemas/ArtistObject'
ManyTracks:
description: A set of tracks
content:
application/json:
schema:
$ref: '#/components/schemas/ArtistsGetTopTracksResponse'
ManySimplifiedShows:
description: A set of shows
content:
application/json:
schema:
$ref: '#/components/schemas/ShowsGetMultipleShowsInfoResponse'
PagingSimplifiedTrackObject:
description: Pages of tracks
content:
application/json:
schema:
$ref: '#/components/schemas/PagingSimplifiedTrackObject'
PagingSavedTrackObject:
description: Pages of tracks
content:
application/json:
schema:
$ref: '#/components/schemas/PagingSavedTrackObject'
PagingPlaylistTrackObject:
description: Pages of tracks
content:
application/json:
schema:
$ref: '#/components/schemas/PagingPlaylistTrackObject'
PagingArtistDiscographyAlbumObject:
description: Pages of albums
content:
application/json:
schema:
$ref: '#/components/schemas/PagingArtistDiscographyAlbumObject'
PagingSavedAlbumObject:
description: Pages of albums
content:
application/json:
schema:
$ref: '#/components/schemas/PagingSavedAlbumObject'
PagingSavedShowObject:
description: Pages of shows
content:
application/json:
schema:
$ref: '#/components/schemas/PagingSavedShowObject'
PagingSimplifiedEpisodeObject:
description: Pages of episodes
content:
application/json:
schema:
$ref: '#/components/schemas/PagingSimplifiedEpisodeObject'
PagingSavedEpisodeObject:
description: Pages of episodes
content:
application/json:
schema:
$ref: '#/components/schemas/PagingSavedEpisodeObject'
PagingSimplifiedAudiobookObject:
description: Pages of audiobooks
content:
application/json:
schema:
$ref: '#/components/schemas/PagingSimplifiedAudiobookObject'
PagingSimplifiedChapterObject:
description: Pages of chapters
content:
application/json:
schema:
$ref: '#/components/schemas/PagingSimplifiedChapterObject'
PagingArtistOrTrackObject:
description: Pages of artists or tracks
content:
application/json:
schema:
$ref: '#/components/schemas/UsersGetTopItemsResponse'
SearchItems:
description: Search response
content:
application/json:
schema:
$ref: '#/components/schemas/SearchSpotifyCatalogInfoResponse'
OneRecommendations:
description: A set of recommendations
content:
application/json:
schema:
$ref: '#/components/schemas/RecommendationsObject'
ArrayOfBooleans:
description: Array of booleans
content:
application/json:
schema:
$ref: '#/components/schemas/AudiobooksCheckUserSavedResponse'
Queue:
description: Information about the queue
content:
application/json:
schema:
$ref: '#/components/schemas/QueueObject'
OneCurrentlyPlaying:
description: Information about playback
content:
application/json:
schema:
$ref: '#/components/schemas/CurrentlyPlayingContextObject'
OneCurrentlyPlayingTrack:
description: Information about the currently playing track
content:
application/json:
schema:
$ref: '#/components/schemas/CurrentlyPlayingContextObject'
PlaylistSnapshotId:
description: A snapshot ID for the playlist
content:
application/json:
schema:
$ref: '#/components/schemas/PlaylistsRemoveItemsResponse'
securitySchemes:
oauth_2_0:
description: Spotify supports OAuth 2.0 for authenticating all API requests.
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://accounts.spotify.com/authorize
tokenUrl: https://accounts.spotify.com/api/token
scopes:
app-remote-control: |
Communicate with the Spotify app on your device.
playlist-read-private: |
Access your private playlists.
playlist-read-collaborative: |
Access your collaborative playlists.
playlist-modify-public: |
Manage your public playlists.
playlist-modify-private: |
Manage your private playlists.
user-library-read: |
Access your saved content.
user-library-modify: |
Manage your saved content.
user-read-private: |
Access your subscription details.
user-read-email: |
Get your real email address.
user-follow-read: |
Access your followers and who you are following.
user-follow-modify: |
Manage your saved content.
user-top-read: |
Read your top artists and content.
user-read-playback-position: |
Read your position in content you have played.
user-read-playback-state: >
Read your currently playing content and Spotify Connect devices
information.
user-read-recently-played: |
Access your recently played items.
user-read-currently-playing: |
Read your currently playing content.
user-modify-playback-state: >
Control playback on your Spotify clients and Spotify Connect
devices.
ugc-image-upload: |
Upload images to Spotify on your behalf.
streaming: |
Play content and control playback on your other devices.
x-spotify-policy:
metadataPolicyList:
- $ref: '#/components/x-spotify-policy/policies/Downloading'
- $ref: '#/components/x-spotify-policy/policies/VisualAlteration'
- $ref: '#/components/x-spotify-policy/policies/Attribution'
metadataWithMachineLearningPolicyList:
- $ref: '#/components/x-spotify-policy/policies/Downloading'
- $ref: '#/components/x-spotify-policy/policies/VisualAlteration'
- $ref: '#/components/x-spotify-policy/policies/Attribution'
- $ref: '#/components/x-spotify-policy/policies/MachineLearning'
playerPolicyList:
- $ref: '#/components/x-spotify-policy/policies/CommercialStreaming'
- $ref: '#/components/x-spotify-policy/policies/ContentAlteration'
- $ref: '#/components/x-spotify-policy/policies/Synchronization'
- $ref: '#/components/x-spotify-policy/policies/Broadcasting'
downloading:
$ref: '#/components/x-spotify-policy/policies/Downloading'
schemas:
LinkedTrackObject:
type: object
x-spotify-docs-type: LinkedTrackObject
properties:
external_urls:
$ref: '#/components/schemas/ExternalUrlObject'
href:
description: |
A link to the Web API endpoint providing full details of the track.
type: string
id:
description: >
The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids)
for the track.
type: string
type:
description: |
The object type: "track".
type: string
uri:
description: >
The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids)
for the track.
type: string
x-konfig-properties:
external_urls:
description: |
Known external URLs for this track.
TrackRestrictionObject:
type: object
x-spotify-docs-type: TrackRestrictionObject
properties:
reason:
description: >
The reason for the restriction. Supported values:
- `market` - The content item is not available in the given market.
- `product` - The content item is not available for the user's
subscription type.
- `explicit` - The content item is explicit and the user's account
is set to not play explicit content.
Additional reasons may be added in the future.
**Note**: If you use this field, make sure that your application
safely handles unknown values.
type: string
AlbumRestrictionObject:
type: object
x-spotify-docs-type: AlbumRestrictionObject
properties:
reason:
description: >
The reason for the restriction. Albums may be restricted if the
content is not available in a given market, to the user's
subscription type, or when the user's account is set to not play
explicit content.
Additional reasons may be added in the future.
type: string
enum:
- market
- product
- explicit
EpisodeRestrictionObject:
type: object
x-spotify-docs-type: EpisodeRestrictionObject
properties:
reason:
description: >
The reason for the restriction. Supported values:
- `market` - The content item is not available in the given market.
- `product` - The content item is not available for the user's
subscription type.
- `explicit` - The content item is explicit and the user's account
is set to not play explicit content.
Additional reasons may be added in the future.
**Note**: If you use this field, make sure that your application
safely handles unknown values.
type: string
ChapterRestrictionObject:
type: object
x-spotify-docs-type: ChapterRestrictionObject
properties:
reason:
description: >
The reason for the restriction. Supported values:
- `market` - The content item is not available in the given market.
- `product` - The content item is not available for the user's
subscription type.
- `explicit` - The content item is explicit and the user's account
is set to not play explicit content.
- `payment_required` - Payment is required to play the content item.
Additional reasons may be added in the future.
**Note**: If you use this field, make sure that your application
safely handles unknown values.
type: string
ArtistObject:
type: object
x-spotify-docs-type: ArtistObject
properties:
external_urls:
$ref: '#/components/schemas/ExternalUrlObject'
followers:
$ref: '#/components/schemas/FollowersObject'
genres:
description: >
A list of the genres the artist is associated with. If not yet
classified, the array is empty.
type: array
items:
type: string
example:
- Prog rock
- Grunge
href:
description: |
A link to the Web API endpoint providing full details of the artist.
type: string
id:
description: >
The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids)
for the artist.
type: string
images:
description: |
Images of the artist in various sizes, widest first.
type: array
items:
$ref: '#/components/schemas/ImageObject'
name:
description: |
The name of the artist.
type: string
popularity:
description: >
The popularity of the artist. The value will be between 0 and 100,
with 100 being the most popular. The artist's popularity is
calculated from the popularity of all the artist's tracks.
type: integer
type:
description: |
The object type.
type: string
enum:
- artist
uri:
description: >
The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids)
for the artist.
type: string
x-konfig-properties:
external_urls:
description: |
Known external URLs for this artist.
followers:
description: |
Information about the followers of the artist.
SimplifiedArtistObject:
type: object
x-spotify-docs-type: SimplifiedArtistObject
properties:
external_urls:
$ref: '#/components/schemas/ExternalUrlObject'
href:
description: |
A link to the Web API endpoint providing full details of the artist.
type: string
id:
description: >
The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids)
for the artist.
type: string
name:
description: |
The name of the artist.
type: string
type:
description: |
The object type.
type: string
enum:
- artist
uri:
description: >
The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids)
for the artist.
type: string
x-konfig-properties:
external_urls:
description: |
Known external URLs for this artist.
PlayHistoryObject:
type: object
x-spotify-docs-type: PlayHistoryObject
properties:
track:
$ref: '#/components/schemas/TrackObject'
played_at:
description: The date and time the track was played.
type: string
format: date-time
x-spotify-docs-type: Timestamp
context:
$ref: '#/components/schemas/ContextObject'
x-konfig-properties:
track:
description: The track the user listened to.
context:
description: The context the track was played from.
PlaylistTrackObject:
type: object
x-spotify-docs-type: PlaylistTrackObject
properties:
added_at:
description: >
The date and time the track or episode was added. _**Note**: some
very old playlists may return `null` in this field._
type: string
format: date-time
x-spotify-docs-type: Timestamp
added_by:
$ref: '#/components/schemas/PlaylistUserObject'
is_local:
description: >
Whether this track or episode is a [local
file](/documentation/web-api/concepts/playlists/#local-files) or
not.
type: boolean
track:
description: Information about the track or episode.
oneOf:
- $ref: '#/components/schemas/TrackObject'
- $ref: '#/components/schemas/EpisodeObject'
x-spotify-docs-type: TrackObject | EpisodeObject
discriminator:
propertyName: type
x-konfig-properties:
added_by:
description: >
The Spotify user who added the track or episode. _**Note**: some
very old playlists may return `null` in this field._
QueueObject:
type: object
x-spotify-docs-type: QueueObject
properties:
currently_playing:
description: The currently playing track or episode. Can be `null`.
oneOf:
- $ref: '#/components/schemas/TrackObject'
- $ref: '#/components/schemas/EpisodeObject'
discriminator:
propertyName: type
x-spotify-docs-type: TrackObject | EpisodeObject
queue:
description: The tracks or episodes in the queue. Can be empty.
type: array
items:
oneOf:
- $ref: '#/components/schemas/TrackObject'
- $ref: '#/components/schemas/EpisodeObject'
discriminator:
propertyName: type
x-spotify-docs-type: TrackObject | EpisodeObject
CurrentlyPlayingContextObject:
type: object
x-spotify-docs-type: CurrentlyPlayingContextObject
properties:
device:
$ref: '#/components/schemas/DeviceObject'
repeat_state:
description: off, track, context
type: string
shuffle_state:
description: If shuffle is on or off.
type: boolean
context:
$ref: '#/components/schemas/ContextObject'
timestamp:
description: Unix Millisecond Timestamp when data was fetched.
type: integer
progress_ms:
description: Progress into the currently playing track or episode. Can be `null`.
type: integer
is_playing:
description: If something is currently playing, return `true`.
type: boolean
item:
description: The currently playing track or episode. Can be `null`.
oneOf:
- $ref: '#/components/schemas/TrackObject'
- $ref: '#/components/schemas/EpisodeObject'
discriminator:
propertyName: type
x-spotify-docs-type: TrackObject | EpisodeObject
currently_playing_type:
description: >
The object type of the currently playing item. Can be one of
`track`, `episode`, `ad` or `unknown`.
type: string
actions:
$ref: '#/components/schemas/DisallowsObject'
x-konfig-properties:
device:
description: |
The device that is currently active.
context:
description: A Context Object. Can be `null`.
actions:
description: >
Allows to update the user interface based on which playback actions
are available within the current context.
DisallowsObject:
type: object
x-spotify-docs-type: DisallowsObject
properties:
interrupting_playback:
description: Interrupting playback. Optional field.
type: boolean
pausing:
description: Pausing. Optional field.
type: boolean
resuming:
description: Resuming. Optional field.
type: boolean
seeking:
description: Seeking playback location. Optional field.
type: boolean
skipping_next:
description: Skipping to the next context. Optional field.
type: boolean
skipping_prev:
description: Skipping to the previous context. Optional field.
type: boolean
toggling_repeat_context:
description: Toggling repeat context flag. Optional field.
type: boolean
toggling_shuffle:
description: Toggling shuffle flag. Optional field.
type: boolean
toggling_repeat_track:
description: Toggling repeat track flag. Optional field.
type: boolean
transferring_playback:
description: Transfering playback between devices. Optional field.
type: boolean
ErrorObject:
type: object
x-spotify-docs-type: ErrorObject
required:
- status
- message
properties:
status:
description: >
The HTTP status code (also returned in the response header; see
[Response Status
Codes](/documentation/web-api/concepts/api-calls#response-status-codes)
for more information).
type: integer
minimum: 400
maximum: 599
message:
description: |
A short description of the cause of the error.
type: string
PrivateUserObject:
type: object
x-spotify-docs-type: PrivateUserObject
properties:
country:
description: >
The country of the user, as set in the user's account profile. An
[ISO 3166-1 alpha-2 country
code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). _This field
is only available when the current user has granted access to the
[user-read-private](/documentation/web-api/concepts/scopes/#list-of-scopes)
scope._
type: string
display_name:
description: |
The name displayed on the user's profile. `null` if not available.
type: string
email:
description: >
The user's email address, as entered by the user when creating their
account. _**Important!** This email address is unverified; there is
no proof that it actually belongs to the user._ _This field is only
available when the current user has granted access to the
[user-read-email](/documentation/web-api/concepts/scopes/#list-of-scopes)
scope._
type: string
explicit_content:
$ref: '#/components/schemas/ExplicitContentSettingsObject'
external_urls:
$ref: '#/components/schemas/ExternalUrlObject'
followers:
$ref: '#/components/schemas/FollowersObject'
href:
description: |
A link to the Web API endpoint for this user.
type: string
id:
description: >
The [Spotify user
ID](/documentation/web-api/concepts/spotify-uris-ids) for the user.
type: string
images:
description: The user's profile image.
type: array
items:
$ref: '#/components/schemas/ImageObject'
product:
description: >
The user's Spotify subscription level: "premium", "free", etc. (The
subscription level "open" can be considered the same as "free".)
_This field is only available when the current user has granted
access to the
[user-read-private](/documentation/web-api/concepts/scopes/#list-of-scopes)
scope._
type: string
type:
description: |
The object type: "user"
type: string
uri:
description: >
The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids)
for the user.
type: string
x-konfig-properties:
explicit_content:
description: >
The user's explicit content settings. _This field is only available
when the current user has granted access to the
[user-read-private](/documentation/web-api/concepts/scopes/#list-of-scopes)
scope._
external_urls:
description: Known external URLs for this user.
followers:
description: Information about the followers of the user.
PublicUserObject:
type: object
x-spotify-docs-type: PublicUserObject
properties:
display_name:
description: |
The name displayed on the user's profile. `null` if not available.
type: string
nullable: true
external_urls:
$ref: '#/components/schemas/ExternalUrlObject'
followers:
$ref: '#/components/schemas/FollowersObject'
href:
description: |
A link to the Web API endpoint for this user.
type: string
id:
description: >
The [Spotify user
ID](/documentation/web-api/concepts/spotify-uris-ids) for this user.
type: string
images:
description: |
The user's profile image.
type: array
items:
$ref: '#/components/schemas/ImageObject'
type:
description: |
The object type.
type: string
enum:
- user
uri:
description: >
The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids)
for this user.
type: string
x-konfig-properties:
external_urls:
description: |
Known public external URLs for this user.
followers:
description: |
Information about the followers of this user.
AudioAnalysisObject:
type: object
x-spotify-docs-type: AudioAnalysisObject
properties:
meta:
type: object
properties:
analyzer_version:
description: The version of the Analyzer used to analyze this track.
type: string
example: 4.0.0
platform:
description: The platform used to read the track's audio data.
type: string
example: Linux
detailed_status:
description: >-
A detailed status code for this track. If analysis data is
missing, this code may explain why.
type: string
example: OK
status_code:
description: >-
The return code of the analyzer process. 0 if successful, 1 if
any errors occurred.
type: integer
example: 0
timestamp:
description: >-
The Unix timestamp (in seconds) at which this track was
analyzed.
type: integer
example: 1495193577
analysis_time:
description: The amount of time taken to analyze this track.
type: number
example: 6.93906
input_process:
description: The method used to read the track's audio data.
type: string
example: libvorbisfile L+R 44100->22050
track:
type: object
properties:
num_samples:
description: >-
The exact number of audio samples analyzed from this track. See
also `analysis_sample_rate`.
type: integer
example: 4585515
duration:
description: Length of the track in seconds.
type: number
example: 207.95985
sample_md5:
description: This field will always contain the empty string.
type: string
offset_seconds:
description: >-
An offset to the start of the region of the track that was
analyzed. (As the entire track is analyzed, this should always
be 0.)
type: integer
example: 0
window_seconds:
description: >-
The length of the region of the track was analyzed, if a subset
of the track was analyzed. (As the entire track is analyzed,
this should always be 0.)
type: integer
example: 0
analysis_sample_rate:
description: >-
The sample rate used to decode and analyze this track. May
differ from the actual sample rate of this track available on
Spotify.
type: integer
example: 22050
analysis_channels:
description: >-
The number of channels used for analysis. If 1, all channels are
summed together to mono before analysis.
type: integer
example: 1
end_of_fade_in:
description: >-
The time, in seconds, at which the track's fade-in period ends.
If the track has no fade-in, this will be 0.0.
type: number
example: 0
start_of_fade_out:
description: >-
The time, in seconds, at which the track's fade-out period
starts. If the track has no fade-out, this should match the
track's length.
type: number
example: 201.13705
loudness:
$ref: '#/components/schemas/Loudness'
tempo:
$ref: '#/components/schemas/Tempo'
tempo_confidence:
description: >-
The confidence, from 0.0 to 1.0, of the reliability of the
`tempo`.
type: number
example: 0.73
minimum: 0
maximum: 1
time_signature:
$ref: '#/components/schemas/TimeSignature'
time_signature_confidence:
description: >-
The confidence, from 0.0 to 1.0, of the reliability of the
`time_signature`.
type: number
example: 0.994
minimum: 0
maximum: 1
key:
$ref: '#/components/schemas/Key'
key_confidence:
description: >-
The confidence, from 0.0 to 1.0, of the reliability of the
`key`.
type: number
example: 0.408
minimum: 0
maximum: 1
mode:
$ref: '#/components/schemas/Mode'
mode_confidence:
description: >-
The confidence, from 0.0 to 1.0, of the reliability of the
`mode`.
type: number
example: 0.485
minimum: 0
maximum: 1
codestring:
description: >-
An [Echo Nest Musical Fingerprint
(ENMFP)](https://academiccommons.columbia.edu/doi/10.7916/D8Q248M4)
codestring for this track.
type: string
code_version:
description: >-
A version number for the Echo Nest Musical Fingerprint format
used in the codestring field.
type: number
example: 3.15
echoprintstring:
description: >-
An [EchoPrint](https://github.com/spotify/echoprint-codegen)
codestring for this track.
type: string
echoprint_version:
description: >-
A version number for the EchoPrint format used in the
echoprintstring field.
type: number
example: 4.15
synchstring:
description: >-
A [Synchstring](https://github.com/echonest/synchdata) for this
track.
type: string
synch_version:
description: >-
A version number for the Synchstring used in the synchstring
field.
type: number
example: 1
rhythmstring:
description: >-
A Rhythmstring for this track. The format of this string is
similar to the Synchstring.
type: string
rhythm_version:
description: >-
A version number for the Rhythmstring used in the rhythmstring
field.
type: number
example: 1
bars:
description: >-
The time intervals of the bars throughout the track. A bar (or
measure) is a segment of time defined as a given number of beats.
type: array
items:
$ref: '#/components/schemas/TimeIntervalObject'
beats:
description: >-
The time intervals of beats throughout the track. A beat is the
basic time unit of a piece of music; for example, each tick of a
metronome. Beats are typically multiples of tatums.
type: array
items:
$ref: '#/components/schemas/TimeIntervalObject'
sections:
description: >-
Sections are defined by large variations in rhythm or timbre, e.g.
chorus, verse, bridge, guitar solo, etc. Each section contains its
own descriptions of tempo, key, mode, time_signature, and loudness.
type: array
items:
$ref: '#/components/schemas/SectionObject'
segments:
description: >-
Each segment contains a roughly conisistent sound throughout its
duration.
type: array
items:
$ref: '#/components/schemas/SegmentObject'
tatums:
description: >-
A tatum represents the lowest regular pulse train that a listener
intuitively infers from the timing of perceived musical events
(segments).
type: array
items:
$ref: '#/components/schemas/TimeIntervalObject'
TimeIntervalObject:
type: object
properties:
start:
description: The starting point (in seconds) of the time interval.
type: number
example: 0.49567
duration:
description: The duration (in seconds) of the time interval.
type: number
example: 2.18749
confidence:
description: The confidence, from 0.0 to 1.0, of the reliability of the interval.
type: number
example: 0.925
minimum: 0
maximum: 1
SectionObject:
type: object
properties:
start:
description: The starting point (in seconds) of the section.
type: number
example: 0
duration:
description: The duration (in seconds) of the section.
type: number
example: 6.97092
confidence:
description: >-
The confidence, from 0.0 to 1.0, of the reliability of the section's
"designation".
type: number
example: 1
minimum: 0
maximum: 1
loudness:
description: >-
The overall loudness of the section in decibels (dB). Loudness
values are useful for comparing relative loudness of sections within
tracks.
type: number
example: -14.938
tempo:
description: >-
The overall estimated tempo of the section in beats per minute
(BPM). In musical terminology, tempo is the speed or pace of a given
piece and derives directly from the average beat duration.
type: number
example: 113.178
tempo_confidence:
description: >-
The confidence, from 0.0 to 1.0, of the reliability of the tempo.
Some tracks contain tempo changes or sounds which don't contain
tempo (like pure speech) which would correspond to a low value in
this field.
type: number
example: 0.647
minimum: 0
maximum: 1
key:
description: >-
The estimated overall key of the section. The values in this field
ranging from 0 to 11 mapping to pitches using standard Pitch Class
notation (E.g. 0 = C, 1 = C♯/D♭, 2 = D, and so on). If no key was
detected, the value is -1.
type: integer
example: 9
key_confidence:
description: >-
The confidence, from 0.0 to 1.0, of the reliability of the key.
Songs with many key changes may correspond to low values in this
field.
type: number
example: 0.297
minimum: 0
maximum: 1
mode:
description: >-
Indicates the modality (major or minor) of a section, the type of
scale from which its melodic content is derived. This field will
contain a 0 for "minor", a 1 for "major", or a -1 for no result.
Note that the major key (e.g. C major) could more likely be confused
with the minor key at 3 semitones lower (e.g. A minor) as both keys
carry the same pitches.
type: number
enum:
- -1
- 0
- 1
mode_confidence:
description: The confidence, from 0.0 to 1.0, of the reliability of the `mode`.
type: number
example: 0.471
minimum: 0
maximum: 1
time_signature:
$ref: '#/components/schemas/TimeSignature'
time_signature_confidence:
description: >-
The confidence, from 0.0 to 1.0, of the reliability of the
`time_signature`. Sections with time signature changes may
correspond to low values in this field.
type: number
example: 1
minimum: 0
maximum: 1
SegmentObject:
type: object
properties:
start:
description: The starting point (in seconds) of the segment.
type: number
example: 0.70154
duration:
description: The duration (in seconds) of the segment.
type: number
example: 0.19891
confidence:
description: >
The confidence, from 0.0 to 1.0, of the reliability of the
segmentation. Segments of the song which are difficult to logically
segment (e.g: noise) may correspond to low values in this field.
type: number
example: 0.435
minimum: 0
maximum: 1
loudness_start:
description: >-
The onset loudness of the segment in decibels (dB). Combined with
`loudness_max` and `loudness_max_time`, these components can be used
to describe the "attack" of the segment.
type: number
example: -23.053
loudness_max:
description: >-
The peak loudness of the segment in decibels (dB). Combined with
`loudness_start` and `loudness_max_time`, these components can be
used to describe the "attack" of the segment.
type: number
example: -14.25
loudness_max_time:
description: >-
The segment-relative offset of the segment peak loudness in seconds.
Combined with `loudness_start` and `loudness_max`, these components
can be used to desctibe the "attack" of the segment.
type: number
example: 0.07305
loudness_end:
description: >-
The offset loudness of the segment in decibels (dB). This value
should be equivalent to the loudness_start of the following segment.
type: number
example: 0
pitches:
description: >
Pitch content is given by a “chroma” vector, corresponding to the 12
pitch classes C, C#, D to B, with values ranging from 0 to 1 that
describe the relative dominance of every pitch in the chromatic
scale. For example a C Major chord would likely be represented by
large values of C, E and G (i.e. classes 0, 4, and 7).
Vectors are normalized to 1 by their strongest dimension, therefore
noisy sounds are likely represented by values that are all close to
1, while pure tones are described by one value at 1 (the pitch) and
others near 0.
As can be seen below, the 12 vector indices are a combination of
low-power spectrum values at their respective pitch frequencies.

type: array
items:
type: number
minimum: 0
maximum: 1
example:
- 0.212
- 0.141
- 0.294
timbre:
description: >
Timbre is the quality of a musical note or sound that distinguishes
different types of musical instruments, or voices. It is a complex
notion also referred to as sound color, texture, or tone quality,
and is derived from the shape of a segment’s spectro-temporal
surface, independently of pitch and loudness. The timbre feature is
a vector that includes 12 unbounded values roughly centered around
0. Those values are high level abstractions of the spectral surface,
ordered by degree of importance.
For completeness however, the first dimension represents the average
loudness of the segment; second emphasizes brightness; third is more
closely correlated to the flatness of a sound; fourth to sounds with
a stronger attack; etc. See an image below representing the 12 basis
functions (i.e. template segments).

The actual timbre of the segment is best described as a linear
combination of these 12 basis functions weighted by the coefficient
values: timbre = c1 x b1 + c2 x b2 + ... + c12 x b12, where c1 to
c12 represent the 12 coefficients and b1 to b12 the 12 basis
functions as displayed below. Timbre vectors are best used in
comparison with each other.
type: array
items:
type: number
example:
- 42.115
- 64.373
- -0.233
TimeSignature:
description: >-
An estimated time signature. The time signature (meter) is a notational
convention to specify how many beats are in each bar (or measure). The
time signature ranges from 3 to 7 indicating time signatures of "3/4",
to "7/4".
type: integer
example: 4
minimum: 3
maximum: 7
Tempo:
description: >
The overall estimated tempo of a track in beats per minute (BPM). In
musical terminology, tempo is the speed or pace of a given piece and
derives directly from the average beat duration.
type: number
example: 118.211
format: float
x-spotify-docs-type: Float
Loudness:
description: >
The overall loudness of a track in decibels (dB). Loudness values are
averaged across the entire track and are useful for comparing relative
loudness of tracks. Loudness is the quality of a sound that is the
primary psychological correlate of physical strength (amplitude). Values
typically range between -60 and 0 db.
type: number
example: -5.883
format: float
x-spotify-docs-type: Float
Key:
description: >
The key the track is in. Integers map to pitches using standard [Pitch
Class notation](https://en.wikipedia.org/wiki/Pitch_class). E.g. 0 = C,
1 = C♯/D♭, 2 = D, and so on. If no key was detected, the value is -1.
type: integer
example: 9
minimum: -1
maximum: 11
Mode:
description: >
Mode indicates the modality (major or minor) of a track, the type of
scale from which its melodic content is derived. Major is represented by
1 and minor is 0.
type: integer
example: 0
AudioFeaturesObject:
type: object
x-spotify-docs-type: AudioFeaturesObject
properties:
acousticness:
description: >
A confidence measure from 0.0 to 1.0 of whether the track is
acoustic. 1.0 represents high confidence the track is acoustic.
type: number
format: float
example: 0.00242
minimum: 0
maximum: 1
x-spotify-docs-type: Float
analysis_url:
description: >
A URL to access the full audio analysis of this track. An access
token is required to access this data.
type: string
example: |
https://api.spotify.com/v1/audio-analysis/2takcwOaAZWiXQijPHIx7B
danceability:
description: >
Danceability describes how suitable a track is for dancing based on
a combination of musical elements including tempo, rhythm stability,
beat strength, and overall regularity. A value of 0.0 is least
danceable and 1.0 is most danceable.
type: number
example: 0.585
format: float
x-spotify-docs-type: Float
duration_ms:
description: |
The duration of the track in milliseconds.
type: integer
example: 237040
energy:
description: >
Energy is a measure from 0.0 to 1.0 and represents a perceptual
measure of intensity and activity. Typically, energetic tracks feel
fast, loud, and noisy. For example, death metal has high energy,
while a Bach prelude scores low on the scale. Perceptual features
contributing to this attribute include dynamic range, perceived
loudness, timbre, onset rate, and general entropy.
type: number
example: 0.842
format: float
x-spotify-docs-type: Float
id:
description: |
The Spotify ID for the track.
type: string
example: 2takcwOaAZWiXQijPHIx7B
instrumentalness:
description: >
Predicts whether a track contains no vocals. "Ooh" and "aah" sounds
are treated as instrumental in this context. Rap or spoken word
tracks are clearly "vocal". The closer the instrumentalness value is
to 1.0, the greater likelihood the track contains no vocal content.
Values above 0.5 are intended to represent instrumental tracks, but
confidence is higher as the value approaches 1.0.
type: number
example: 0.00686
format: float
x-spotify-docs-type: Float
key:
$ref: '#/components/schemas/Key'
liveness:
description: >
Detects the presence of an audience in the recording. Higher
liveness values represent an increased probability that the track
was performed live. A value above 0.8 provides strong likelihood
that the track is live.
type: number
example: 0.0866
format: float
x-spotify-docs-type: Float
loudness:
$ref: '#/components/schemas/Loudness'
mode:
$ref: '#/components/schemas/Mode'
speechiness:
description: >
Speechiness detects the presence of spoken words in a track. The
more exclusively speech-like the recording (e.g. talk show, audio
book, poetry), the closer to 1.0 the attribute value. Values above
0.66 describe tracks that are probably made entirely of spoken
words. Values between 0.33 and 0.66 describe tracks that may contain
both music and speech, either in sections or layered, including such
cases as rap music. Values below 0.33 most likely represent music
and other non-speech-like tracks.
type: number
example: 0.0556
format: float
x-spotify-docs-type: Float
tempo:
$ref: '#/components/schemas/Tempo'
time_signature:
$ref: '#/components/schemas/TimeSignature'
track_href:
description: |
A link to the Web API endpoint providing full details of the track.
type: string
example: |
https://api.spotify.com/v1/tracks/2takcwOaAZWiXQijPHIx7B
type:
description: |
The object type.
type: string
enum:
- audio_features
uri:
description: |
The Spotify URI for the track.
type: string
example: spotify:track:2takcwOaAZWiXQijPHIx7B
valence:
description: >
A measure from 0.0 to 1.0 describing the musical positiveness
conveyed by a track. Tracks with high valence sound more positive
(e.g. happy, cheerful, euphoric), while tracks with low valence
sound more negative (e.g. sad, depressed, angry).
type: number
example: 0.428
minimum: 0
maximum: 1
format: float
x-spotify-docs-type: Float
SimplifiedTrackObject:
type: object
x-spotify-docs-type: SimplifiedTrackObject
properties:
artists:
description: >-
The artists who performed the track. Each artist object includes a
link in `href` to more detailed information about the artist.
type: array
items:
$ref: '#/components/schemas/SimplifiedArtistObject'
available_markets:
description: >
A list of the countries in which the track can be played, identified
by their [ISO 3166-1
alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code.
type: array
items:
type: string
disc_number:
description: >-
The disc number (usually `1` unless the album consists of more than
one disc).
type: integer
duration_ms:
description: The track length in milliseconds.
type: integer
explicit:
description: >-
Whether or not the track has explicit lyrics ( `true` = yes it does;
`false` = no it does not OR unknown).
type: boolean
external_urls:
$ref: '#/components/schemas/ExternalUrlObject'
href:
description: A link to the Web API endpoint providing full details of the track.
type: string
id:
description: >
The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids)
for the track.
type: string
is_playable:
description: >
Part of the response when [Track
Relinking](/documentation/web-api/concepts/track-relinking/) is
applied. If `true`, the track is playable in the given market.
Otherwise `false`.
type: boolean
linked_from:
$ref: '#/components/schemas/LinkedTrackObject'
restrictions:
$ref: '#/components/schemas/TrackRestrictionObject'
name:
description: The name of the track.
type: string
preview_url:
description: |
A URL to a 30 second preview (MP3 format) of the track.
type: string
nullable: true
x-spotify-policy-list:
- $ref: '#/components/x-spotify-policy/policies/StandalonePreview'
track_number:
description: >
The number of the track. If an album has several discs, the track
number is the number on the specified disc.
type: integer
type:
description: |
The object type: "track".
type: string
uri:
description: >
The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids)
for the track.
type: string
is_local:
description: |
Whether or not the track is from a local file.
type: boolean
x-konfig-properties:
external_urls:
description: |
External URLs for this track.
linked_from:
description: >-
Part of the response when [Track
Relinking](/documentation/web-api/concepts/track-relinking/) is
applied and is only part of the response if the track linking, in
fact, exists. The requested track has been replaced with a different
track. The track in the `linked_from` object contains information
about the originally requested track.
restrictions:
description: |
Included in the response when a content restriction is applied.
DeviceObject:
type: object
x-spotify-docs-type: DeviceObject
properties:
id:
description: >-
The device ID. This ID is unique and persistent to some extent.
However, this is not guaranteed and any cached `device_id` should
periodically be cleared out and refetched as necessary.
type: string
nullable: true
is_active:
description: If this device is the currently active device.
type: boolean
is_private_session:
description: If this device is currently in a private session.
type: boolean
is_restricted:
description: >-
Whether controlling this device is restricted. At present if this is
"true" then no Web API commands will be accepted by this device.
type: boolean
name:
description: >-
A human-readable name for the device. Some devices have a name that
the user can configure (e.g. \"Loudest speaker\") and some devices
have a generic name associated with the manufacturer or device
model.
type: string
example: Kitchen speaker
type:
description: Device type, such as "computer", "smartphone" or "speaker".
type: string
example: computer
volume_percent:
description: The current volume in percent.
type: integer
minimum: 0
example: 59
maximum: 100
nullable: true
supports_volume:
description: If this device can be used to set the volume.
type: boolean
CursorObject:
type: object
x-spotify-docs-type: CursorObject
properties:
after:
description: The cursor to use as key to find the next page of items.
type: string
before:
description: The cursor to use as key to find the previous page of items.
type: string
CursorPagingObject:
type: object
x-spotify-docs-type: CursorPagingObject
properties:
href:
description: >-
A link to the Web API endpoint returning the full result of the
request.
type: string
limit:
description: >-
The maximum number of items in the response (as set in the query or
by default).
type: integer
next:
description: URL to the next page of items. ( `null` if none)
type: string
cursors:
$ref: '#/components/schemas/CursorObject'
total:
description: The total number of items available to return.
type: integer
x-konfig-properties:
cursors:
description: The cursors used to find the next set of items.
CursorPagingPlayHistoryObject:
type: object
x-spotify-docs-type: PagingTrackObject
allOf:
- $ref: '#/components/schemas/CursorPagingObject'
- type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/PlayHistoryObject'
CursorPagingSimplifiedArtistObject:
type: object
x-spotify-docs-type: PagingArtistObject
allOf:
- $ref: '#/components/schemas/CursorPagingObject'
- type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/ArtistObject'
PagingObject:
type: object
x-spotify-docs-type: PagingObject
required:
- href
- items
- limit
- next
- offset
- previous
- total
properties:
href:
description: >
A link to the Web API endpoint returning the full result of the
request
type: string
example: |
https://api.spotify.com/v1/me/shows?offset=0&limit=20
limit:
description: >
The maximum number of items in the response (as set in the query or
by default).
type: integer
example: 20
next:
description: |
URL to the next page of items. ( `null` if none)
type: string
example: https://api.spotify.com/v1/me/shows?offset=1&limit=1
nullable: true
offset:
description: |
The offset of the items returned (as set in the query or by default)
type: integer
example: 0
previous:
description: |
URL to the previous page of items. ( `null` if none)
type: string
example: https://api.spotify.com/v1/me/shows?offset=1&limit=1
nullable: true
total:
description: |
The total number of items available to return.
type: integer
example: 4
PagingPlaylistObject:
type: object
x-spotify-docs-type: PagingPlaylistObject
allOf:
- $ref: '#/components/schemas/PagingObject'
- type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SimplifiedPlaylistObject'
PagingFeaturedPlaylistObject:
type: object
x-spotify-docs-type: PagingFeaturedPlaylistObject
properties:
message:
description: |
The localized message of a playlist.
type: string
example: Popular Playlists
playlists:
$ref: '#/components/schemas/PagingPlaylistObject'
PagingArtistDiscographyAlbumObject:
type: object
x-spotify-docs-type: PagingArtistDiscographyAlbumObject
allOf:
- $ref: '#/components/schemas/PagingObject'
- type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/ArtistDiscographyAlbumObject'
PagingSimplifiedAlbumObject:
type: object
x-spotify-docs-type: PagingAlbumObject
allOf:
- $ref: '#/components/schemas/PagingObject'
- type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SimplifiedAlbumObject'
PagingSavedAlbumObject:
type: object
x-spotify-docs-type: PagingSavedAlbumObject
allOf:
- $ref: '#/components/schemas/PagingObject'
- type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SavedAlbumObject'
PagingSimplifiedTrackObject:
type: object
x-spotify-docs-type: PagingTrackObject
allOf:
- $ref: '#/components/schemas/PagingObject'
- type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SimplifiedTrackObject'
PagingSavedTrackObject:
type: object
x-spotify-docs-type: PagingTrackObject
allOf:
- $ref: '#/components/schemas/PagingObject'
- type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SavedTrackObject'
PagingTrackObject:
type: object
x-spotify-docs-type: PagingTrackObject
allOf:
- $ref: '#/components/schemas/PagingObject'
- type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/TrackObject'
PagingPlaylistTrackObject:
type: object
x-spotify-docs-type: PagingPlaylistTrackObject
allOf:
- $ref: '#/components/schemas/PagingObject'
- type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/PlaylistTrackObject'
PagingSimplifiedShowObject:
type: object
x-spotify-docs-type: PagingShowObject
allOf:
- $ref: '#/components/schemas/PagingObject'
- type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SimplifiedShowObject'
PagingSavedShowObject:
type: object
x-spotify-docs-type: PagingShowObject
allOf:
- $ref: '#/components/schemas/PagingObject'
- type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SavedShowObject'
PagingSimplifiedEpisodeObject:
type: object
x-spotify-docs-type: PagingEpisodeObject
allOf:
- $ref: '#/components/schemas/PagingObject'
- type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SimplifiedEpisodeObject'
PagingSavedEpisodeObject:
type: object
x-spotify-docs-type: PagingEpisodeObject
allOf:
- $ref: '#/components/schemas/PagingObject'
- type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SavedEpisodeObject'
PagingSimplifiedAudiobookObject:
type: object
x-spotify-docs-type: PagingAudiobookObject
allOf:
- $ref: '#/components/schemas/PagingObject'
- type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SimplifiedAudiobookObject'
PagingArtistObject:
type: object
x-spotify-docs-type: PagingArtistObject
allOf:
- $ref: '#/components/schemas/PagingObject'
- type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/ArtistObject'
PagingSimplifiedChapterObject:
type: object
x-spotify-docs-type: PagingSimplifiedChapterObject
allOf:
- $ref: '#/components/schemas/PagingObject'
- type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SimplifiedChapterObject'
RecommendationsObject:
type: object
x-spotify-docs-type: RecommendationsObject
required:
- seeds
- tracks
properties:
seeds:
description: |
An array of recommendation seed objects.
type: array
items:
$ref: '#/components/schemas/RecommendationSeedObject'
tracks:
description: >
An array of track object (simplified) ordered according to the
parameters supplied.
type: array
items:
$ref: '#/components/schemas/TrackObject'
RecommendationSeedObject:
type: object
x-spotify-docs-type: RecommendationSeedObject
properties:
afterFilteringSize:
description: >
The number of tracks available after min\_\* and max\_\* filters
have been applied.
type: integer
afterRelinkingSize:
description: >
The number of tracks available after relinking for regional
availability.
type: integer
href:
description: >
A link to the full track or artist data for this seed. For tracks
this will be a link to a Track Object. For artists a link to an
Artist Object. For genre seeds, this value will be `null`.
type: string
id:
description: >
The id used to select this seed. This will be the same as the string
used in the `seed_artists`, `seed_tracks` or `seed_genres`
parameter.
type: string
initialPoolSize:
description: |
The number of recommended tracks available for this seed.
type: integer
type:
description: |
The entity type of this seed. One of `artist`, `track` or `genre`.
type: string
SavedAlbumObject:
type: object
x-spotify-docs-type: SavedAlbumObject
properties:
added_at:
description: >
The date and time the album was saved
Timestamps are returned in ISO 8601 format as Coordinated Universal
Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ.
If the time is imprecise (for example, the date/time of an album
release), an additional field indicates the precision; see for
example, release_date in an album object.
type: string
format: date-time
x-spotify-docs-type: Timestamp
album:
$ref: '#/components/schemas/AlbumObject'
x-konfig-properties:
album:
description: Information about the album.
SavedTrackObject:
type: object
x-spotify-docs-type: SavedTrackObject
properties:
added_at:
description: >
The date and time the track was saved.
Timestamps are returned in ISO 8601 format as Coordinated Universal
Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ.
If the time is imprecise (for example, the date/time of an album
release), an additional field indicates the precision; see for
example, release_date in an album object.
type: string
format: date-time
x-spotify-docs-type: Timestamp
track:
$ref: '#/components/schemas/TrackObject'
x-konfig-properties:
track:
description: Information about the track.
SavedEpisodeObject:
type: object
x-spotify-docs-type: SavedEpisodeObject
properties:
added_at:
description: >
The date and time the episode was saved.
Timestamps are returned in ISO 8601 format as Coordinated Universal
Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ.
type: string
format: date-time
x-spotify-docs-type: Timestamp
episode:
$ref: '#/components/schemas/EpisodeObject'
x-konfig-properties:
episode:
description: Information about the episode.
SavedShowObject:
type: object
x-spotify-docs-type: SavedShowObject
properties:
added_at:
description: >
The date and time the show was saved.
Timestamps are returned in ISO 8601 format as Coordinated Universal
Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ.
If the time is imprecise (for example, the date/time of an album
release), an additional field indicates the precision; see for
example, release_date in an album object.
type: string
format: date-time
x-spotify-docs-type: Timestamp
show:
$ref: '#/components/schemas/SimplifiedShowObject'
x-konfig-properties:
show:
description: Information about the show.
PlaylistObject:
type: object
x-spotify-docs-type: PlaylistObject
properties:
description:
description: >
The playlist description. _Only returned for modified, verified
playlists, otherwise_ `null`.
type: string
nullable: true
collaborative:
description: |
`true` if the owner allows other users to modify the playlist.
type: boolean
external_urls:
$ref: '#/components/schemas/ExternalUrlObject'
followers:
$ref: '#/components/schemas/FollowersObject'
href:
description: >
A link to the Web API endpoint providing full details of the
playlist.
type: string
id:
description: >
The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids)
for the playlist.
type: string
images:
description: >
Images for the playlist. The array may be empty or contain up to
three images. The images are returned by size in descending order.
See [Working with
Playlists](/documentation/web-api/concepts/playlists). _**Note**: If
returned, the source URL for the image (`url`) is temporary and will
expire in less than a day._
type: array
items:
$ref: '#/components/schemas/ImageObject'
name:
description: |
The name of the playlist.
type: string
owner:
$ref: '#/components/schemas/PlaylistOwnerObject'
public:
description: >
The playlist's public/private status: `true` the playlist is public,
`false` the playlist is private, `null` the playlist status is not
relevant. For more about public/private status, see [Working with
Playlists](/documentation/web-api/concepts/playlists)
type: boolean
snapshot_id:
description: >
The version identifier for the current playlist. Can be supplied in
other requests to target a specific playlist version
type: string
tracks:
$ref: '#/components/schemas/PagingPlaylistTrackObject'
type:
description: |
The object type: "playlist"
type: string
uri:
description: >
The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids)
for the playlist.
type: string
x-konfig-properties:
external_urls:
description: |
Known external URLs for this playlist.
followers:
description: Information about the followers of the playlist.
owner:
description: |
The user who owns the playlist
tracks:
description: |
The tracks of the playlist.
type: object
SimplifiedPlaylistObject:
type: object
x-spotify-docs-type: SimplifiedPlaylistObject
properties:
description:
description: >
The playlist description. _Only returned for modified, verified
playlists, otherwise_ `null`.
type: string
collaborative:
description: |
`true` if the owner allows other users to modify the playlist.
type: boolean
external_urls:
$ref: '#/components/schemas/ExternalUrlObject'
href:
description: >
A link to the Web API endpoint providing full details of the
playlist.
type: string
id:
description: >
The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids)
for the playlist.
type: string
images:
description: >
Images for the playlist. The array may be empty or contain up to
three images. The images are returned by size in descending order.
See [Working with
Playlists](/documentation/web-api/concepts/playlists). _**Note**: If
returned, the source URL for the image (`url`) is temporary and will
expire in less than a day._
type: array
items:
$ref: '#/components/schemas/ImageObject'
name:
description: |
The name of the playlist.
type: string
owner:
$ref: '#/components/schemas/PlaylistOwnerObject'
public:
description: >
The playlist's public/private status: `true` the playlist is public,
`false` the playlist is private, `null` the playlist status is not
relevant. For more about public/private status, see [Working with
Playlists](/documentation/web-api/concepts/playlists)
type: boolean
snapshot_id:
description: >
The version identifier for the current playlist. Can be supplied in
other requests to target a specific playlist version
type: string
tracks:
$ref: '#/components/schemas/PlaylistTracksRefObject'
type:
description: |
The object type: "playlist"
type: string
uri:
description: >
The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids)
for the playlist.
type: string
x-konfig-properties:
external_urls:
description: |
Known external URLs for this playlist.
owner:
description: |
The user who owns the playlist
tracks:
description: >
A collection containing a link ( `href` ) to the Web API endpoint
where full details of the playlist's tracks can be retrieved, along
with the `total` number of tracks in the playlist. Note, a track
object may be `null`. This can happen if a track is no longer
available.
PlaylistTracksRefObject:
type: object
x-spotify-docs-type: PlaylistTracksRefObject
properties:
href:
description: >
A link to the Web API endpoint where full details of the playlist's
tracks can be retrieved.
type: string
total:
description: |
Number of tracks in the playlist.
type: integer
PlaylistUserObject:
type: object
x-spotify-docs-type: PlaylistUserObject
properties:
external_urls:
$ref: '#/components/schemas/ExternalUrlObject'
followers:
$ref: '#/components/schemas/FollowersObject'
href:
description: |
A link to the Web API endpoint for this user.
type: string
id:
description: >
The [Spotify user
ID](/documentation/web-api/concepts/spotify-uris-ids) for this user.
type: string
type:
description: |
The object type.
type: string
enum:
- user
uri:
description: >
The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids)
for this user.
type: string
x-konfig-properties:
external_urls:
description: |
Known public external URLs for this user.
followers:
description: |
Information about the followers of this user.
PlaylistOwnerObject:
allOf:
- $ref: '#/components/schemas/PlaylistUserObject'
- type: object
properties:
display_name:
description: >
The name displayed on the user's profile. `null` if not
available.
type: string
nullable: true
CategoryObject:
type: object
x-spotify-docs-type: CategoryObject
required:
- href
- icons
- id
- name
properties:
href:
description: >
A link to the Web API endpoint returning full details of the
category.
type: string
icons:
description: |
The category icon, in various sizes.
type: array
items:
$ref: '#/components/schemas/ImageObject'
id:
description: >
The [Spotify category
ID](/documentation/web-api/concepts/spotify-uris-ids) of the
category.
type: string
example: equal
name:
description: |
The name of the category.
type: string
example: EQUAL
TrackObject:
type: object
x-spotify-docs-type: TrackObject
properties:
album:
$ref: '#/components/schemas/SimplifiedAlbumObject'
artists:
description: >
The artists who performed the track. Each artist object includes a
link in `href` to more detailed information about the artist.
type: array
items:
$ref: '#/components/schemas/ArtistObject'
available_markets:
description: >
A list of the countries in which the track can be played, identified
by their [ISO 3166-1
alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code.
type: array
items:
type: string
disc_number:
description: >
The disc number (usually `1` unless the album consists of more than
one disc).
type: integer
duration_ms:
description: |
The track length in milliseconds.
type: integer
explicit:
description: >
Whether or not the track has explicit lyrics ( `true` = yes it does;
`false` = no it does not OR unknown).
type: boolean
external_ids:
$ref: '#/components/schemas/ExternalIdObject'
external_urls:
$ref: '#/components/schemas/ExternalUrlObject'
href:
description: |
A link to the Web API endpoint providing full details of the track.
type: string
id:
description: >
The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids)
for the track.
type: string
is_playable:
description: >
Part of the response when [Track
Relinking](/documentation/web-api/concepts/track-relinking) is
applied. If `true`, the track is playable in the given market.
Otherwise `false`.
type: boolean
linked_from:
description: >
Part of the response when [Track
Relinking](/documentation/web-api/concepts/track-relinking) is
applied, and the requested track has been replaced with different
track. The track in the `linked_from` object contains information
about the originally requested track.
type: object
restrictions:
$ref: '#/components/schemas/TrackRestrictionObject'
name:
description: |
The name of the track.
type: string
popularity:
description: >
The popularity of the track. The value will be between 0 and 100,
with 100 being the most popular.
The popularity of a track is a
value between 0 and 100, with 100 being the most popular. The
popularity is calculated by algorithm and is based, in the most
part, on the total number of plays the track has had and how recent
those plays are.
Generally speaking, songs that are being played
a lot now will have a higher popularity than songs that were played
a lot in the past. Duplicate tracks (e.g. the same track from a
single and an album) are rated independently. Artist and album
popularity is derived mathematically from track popularity.
_**Note**: the popularity value may lag actual popularity by a few
days: the value is not updated in real time._
type: integer
preview_url:
description: >
A link to a 30 second preview (MP3 format) of the track. Can be
`null`
type: string
nullable: true
x-spotify-policy-list:
- $ref: '#/components/x-spotify-policy/policies/StandalonePreview'
track_number:
description: >
The number of the track. If an album has several discs, the track
number is the number on the specified disc.
type: integer
type:
description: |
The object type: "track".
type: string
enum:
- track
uri:
description: >
The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids)
for the track.
type: string
is_local:
description: |
Whether or not the track is from a local file.
type: boolean
x-konfig-properties:
album:
description: >
The album on which the track appears. The album object includes a
link in `href` to full information about the album.
external_ids:
description: |
Known external IDs for the track.
external_urls:
description: |
Known external URLs for this track.
restrictions:
description: |
Included in the response when a content restriction is applied.
EpisodeObject:
x-spotify-docs-type: EpisodeObject
type: object
allOf:
- $ref: '#/components/schemas/EpisodeBase'
- type: object
required:
- show
properties:
show:
$ref: '#/components/schemas/SimplifiedShowObject'
x-konfig-properties:
show:
description: |
The show on which the episode belongs.
SimplifiedEpisodeObject:
x-spotify-docs-type: SimplifiedEpisodeObject
type: object
allOf:
- $ref: '#/components/schemas/EpisodeBase'
- type: object
EpisodeBase:
type: object
required:
- audio_preview_url
- description
- html_description
- duration_ms
- explicit
- external_urls
- href
- id
- images
- is_externally_hosted
- is_playable
- languages
- name
- release_date
- release_date_precision
- type
- uri
properties:
description:
description: >
A description of the episode. HTML tags are stripped away from this
field, use `html_description` field in case HTML tags are needed.
type: string
example: >
A Spotify podcast sharing fresh insights on important topics of the
moment—in a way only Spotify can. You’ll hear from experts in the
music, podcast and tech industries as we discover and uncover
stories about our work and the world around us.
audio_preview_url:
description: >
A URL to a 30 second preview (MP3 format) of the episode. `null` if
not available.
type: string
nullable: true
example: >-
https://p.scdn.co/mp3-preview/2f37da1d4221f40b9d1a98cd191f4d6f1646ad17
x-spotify-policy-list:
- $ref: '#/components/x-spotify-policy/policies/StandalonePreview'
html_description:
description: |
A description of the episode. This field may contain HTML tags.
type: string
example: >
A Spotify podcast sharing fresh insights on important topics of the moment—in a way only Spotify can. You’ll hear from experts in the music, podcast and tech industries as we discover and uncover stories about our work and the world around us.
duration_ms: description: | The episode length in milliseconds. type: integer example: 1686230 explicit: description: > Whether or not the episode has explicit content (true = yes it does; false = no it does not OR unknown). type: boolean external_urls: $ref: '#/components/schemas/ExternalUrlObject' href: description: > A link to the Web API endpoint providing full details of the episode. type: string example: https://api.spotify.com/v1/episodes/5Xt5DXGzch68nYYamXrNxZ id: description: > The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the episode. type: string example: 5Xt5DXGzch68nYYamXrNxZ images: description: | The cover art for the episode in various sizes, widest first. type: array items: $ref: '#/components/schemas/ImageObject' is_externally_hosted: description: | True if the episode is hosted outside of Spotify's CDN. type: boolean is_playable: description: > True if the episode is playable in the given market. Otherwise false. type: boolean language: description: > The language used in the episode, identified by a [ISO 639](https://en.wikipedia.org/wiki/ISO_639) code. This field is deprecated and might be removed in the future. Please use the `languages` field instead. type: string deprecated: true example: en languages: description: > A list of the languages used in the episode, identified by their [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639) code. type: array items: type: string example: - fr - en name: description: | The name of the episode. type: string example: > Starting Your Own Podcast: Tips, Tricks, and Advice From Anchor Creators release_date: description: > The date the episode was first released, for example `"1981-12-15"`. Depending on the precision, it might be shown as `"1981"` or `"1981-12"`. type: string example: '1981-12-15' release_date_precision: description: | The precision with which `release_date` value is known. type: string example: day enum: - year - month - day resume_point: $ref: '#/components/schemas/ResumePointObject' type: description: | The object type. type: string enum: - episode uri: description: > The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the episode. type: string example: spotify:episode:0zLhl3WsOCQHbe1BPTiHgr restrictions: $ref: '#/components/schemas/EpisodeRestrictionObject' x-konfig-properties: external_urls: description: | External URLs for this episode. resume_point: description: > The user's most recent position in the episode. Set if the supplied access token is a user token and has the scope 'user-read-playback-position'. restrictions: description: | Included in the response when a content restriction is applied. ResumePointObject: type: object x-spotify-docs-type: ResumePointObject properties: fully_played: description: | Whether or not the episode has been fully played by the user. type: boolean resume_position_ms: description: | The user's most recent position in the episode in milliseconds. type: integer ShowBase: type: object required: - available_markets - copyrights - description - explicit - external_urls - href - html_description - id - images - is_externally_hosted - languages - media_type - name - publisher - total_episodes - type - uri properties: description: description: > A description of the show. HTML tags are stripped away from this field, use `html_description` field in case HTML tags are needed. type: string available_markets: description: > A list of the countries in which the show can be played, identified by their [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code. type: array items: type: string copyrights: description: | The copyright statements of the show. type: array items: $ref: '#/components/schemas/CopyrightObject' html_description: description: | A description of the show. This field may contain HTML tags. type: string explicit: description: > Whether or not the show has explicit content (true = yes it does; false = no it does not OR unknown). type: boolean external_urls: $ref: '#/components/schemas/ExternalUrlObject' href: description: | A link to the Web API endpoint providing full details of the show. type: string id: description: > The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the show. type: string images: description: | The cover art for the show in various sizes, widest first. type: array items: $ref: '#/components/schemas/ImageObject' is_externally_hosted: description: > True if all of the shows episodes are hosted outside of Spotify's CDN. This field might be `null` in some cases. type: boolean languages: description: > A list of the languages used in the show, identified by their [ISO 639](https://en.wikipedia.org/wiki/ISO_639) code. type: array items: type: string media_type: description: | The media type of the show. type: string name: description: | The name of the episode. type: string publisher: description: | The publisher of the show. type: string type: description: | The object type. type: string enum: - show uri: description: > The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the show. type: string total_episodes: description: | The total number of episodes in the show. type: integer x-konfig-properties: external_urls: description: | External URLs for this show. ShowObject: x-spotify-docs-type: ShowObject allOf: - $ref: '#/components/schemas/ShowBase' - type: object required: - episodes properties: episodes: $ref: '#/components/schemas/PagingSimplifiedEpisodeObject' x-konfig-properties: episodes: description: | The episodes of the show. type: object SimplifiedShowObject: x-spotify-docs-type: SimplifiedShowObject allOf: - $ref: '#/components/schemas/ShowBase' - type: object AudiobookBase: type: object required: - authors - available_markets - copyrights - description - explicit - external_urls - href - html_description - id - images - languages - media_type - name - narrators - publisher - total_chapters - type - uri properties: description: description: > A description of the audiobook. HTML tags are stripped away from this field, use `html_description` field in case HTML tags are needed. type: string authors: description: | The author(s) for the audiobook. type: array items: $ref: '#/components/schemas/AuthorObject' available_markets: description: > A list of the countries in which the audiobook can be played, identified by their [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code. type: array items: type: string copyrights: description: | The copyright statements of the audiobook. type: array items: $ref: '#/components/schemas/CopyrightObject' html_description: description: | A description of the audiobook. This field may contain HTML tags. type: string edition: description: | The edition of the audiobook. type: string example: Unabridged explicit: description: > Whether or not the audiobook has explicit content (true = yes it does; false = no it does not OR unknown). type: boolean external_urls: $ref: '#/components/schemas/ExternalUrlObject' href: description: > A link to the Web API endpoint providing full details of the audiobook. type: string id: description: > The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the audiobook. type: string images: description: | The cover art for the audiobook in various sizes, widest first. type: array items: $ref: '#/components/schemas/ImageObject' languages: description: > A list of the languages used in the audiobook, identified by their [ISO 639](https://en.wikipedia.org/wiki/ISO_639) code. type: array items: type: string media_type: description: | The media type of the audiobook. type: string name: description: | The name of the audiobook. type: string narrators: description: | The narrator(s) for the audiobook. type: array items: $ref: '#/components/schemas/NarratorObject' publisher: description: | The publisher of the audiobook. type: string type: description: | The object type. type: string enum: - audiobook uri: description: > The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the audiobook. type: string total_chapters: description: | The number of chapters in this audiobook. type: integer x-konfig-properties: external_urls: description: | External URLs for this audiobook. AudiobookObject: x-spotify-docs-type: AudiobookObject allOf: - $ref: '#/components/schemas/AudiobookBase' - type: object required: - chapters properties: chapters: $ref: '#/components/schemas/PagingSimplifiedChapterObject' x-konfig-properties: chapters: description: | The chapters of the audiobook. type: object SimplifiedAudiobookObject: x-spotify-docs-type: SimplifiedAudiobookObject allOf: - $ref: '#/components/schemas/AudiobookBase' - type: object AlbumBase: type: object required: - album_type - total_tracks - available_markets - external_urls - href - id - images - name - release_date - release_date_precision - type - uri properties: album_type: description: | The type of the album. type: string enum: - album - single - compilation example: compilation total_tracks: description: The number of tracks in the album. type: integer example: 9 available_markets: description: > The markets in which the album is available: [ISO 3166-1 alpha-2 country codes](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). _**NOTE**: an album is considered available in a market when at least 1 of its tracks is available in that market._ type: array items: type: string example: - CA - BR - IT external_urls: $ref: '#/components/schemas/ExternalUrlObject' href: description: | A link to the Web API endpoint providing full details of the album. type: string id: description: > The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the album. type: string example: 2up3OPMp9Tb4dAKM2erWXQ images: description: | The cover art for the album in various sizes, widest first. type: array items: $ref: '#/components/schemas/ImageObject' name: description: > The name of the album. In case of an album takedown, the value may be an empty string. type: string release_date: description: | The date the album was first released. type: string example: 1981-12 release_date_precision: description: | The precision with which `release_date` value is known. type: string enum: - year - month - day example: year restrictions: $ref: '#/components/schemas/AlbumRestrictionObject' type: description: | The object type. type: string enum: - album uri: description: > The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the album. type: string example: spotify:album:2up3OPMp9Tb4dAKM2erWXQ x-konfig-properties: external_urls: description: | Known external URLs for this album. restrictions: description: | Included in the response when a content restriction is applied. SimplifiedAlbumObject: x-spotify-docs-type: SimplifiedAlbumObject allOf: - $ref: '#/components/schemas/AlbumBase' - type: object required: - artists properties: artists: description: > The artists of the album. Each artist object includes a link in `href` to more detailed information about the artist. type: array items: $ref: '#/components/schemas/SimplifiedArtistObject' ArtistDiscographyAlbumObject: x-spotify-docs-type: ArtistDiscographyAlbumObject allOf: - $ref: '#/components/schemas/SimplifiedAlbumObject' - type: object required: - album_group properties: album_group: description: > This field describes the relationship between the artist and the album. type: string enum: - album - single - compilation - appears_on example: compilation ChapterObject: x-spotify-docs-type: ChapterObject type: object allOf: - $ref: '#/components/schemas/ChapterBase' - type: object required: - audiobook properties: audiobook: $ref: '#/components/schemas/SimplifiedAudiobookObject' x-konfig-properties: audiobook: description: | The audiobook for which the chapter belongs. SimplifiedChapterObject: x-spotify-docs-type: SimplifiedChapterObject type: object allOf: - $ref: '#/components/schemas/ChapterBase' - type: object ChapterBase: type: object required: - audio_preview_url - chapter_number - description - html_description - duration_ms - explicit - external_urls - href - id - images - is_playable - languages - name - release_date - release_date_precision - type - uri properties: description: description: > A description of the chapter. HTML tags are stripped away from this field, use `html_description` field in case HTML tags are needed. type: string example: > We kept on ascending, with occasional periods of quick descent, but in the main always ascending. Suddenly, I became conscious of the fact that the driver was in the act of pulling up the horses in the courtyard of a vast ruined castle, from whose tall black windows came no ray of light, and whose broken battlements showed a jagged line against the moonlit sky. audio_preview_url: description: > A URL to a 30 second preview (MP3 format) of the chapter. `null` if not available. type: string nullable: true example: >- https://p.scdn.co/mp3-preview/2f37da1d4221f40b9d1a98cd191f4d6f1646ad17 x-spotify-policy-list: - $ref: '#/components/x-spotify-policy/policies/StandalonePreview' available_markets: description: > A list of the countries in which the chapter can be played, identified by their [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code. type: array items: type: string chapter_number: description: | The number of the chapter type: integer example: 1 html_description: description: | A description of the chapter. This field may contain HTML tags. type: string example: >We kept on ascending, with occasional periods of quick descent, but in the main always ascending. Suddenly, I became conscious of the fact that the driver was in the act of pulling up the horses in the courtyard of a vast ruined castle, from whose tall black windows came no ray of light, and whose broken battlements showed a jagged line against the moonlit sky.
duration_ms: description: | The chapter length in milliseconds. type: integer example: 1686230 explicit: description: > Whether or not the chapter has explicit content (true = yes it does; false = no it does not OR unknown). type: boolean external_urls: $ref: '#/components/schemas/ExternalUrlObject' href: description: > A link to the Web API endpoint providing full details of the chapter. type: string example: https://api.spotify.com/v1/episodes/5Xt5DXGzch68nYYamXrNxZ id: description: > The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the chapter. type: string example: 5Xt5DXGzch68nYYamXrNxZ images: description: | The cover art for the chapter in various sizes, widest first. type: array items: $ref: '#/components/schemas/ImageObject' is_playable: description: > True if the chapter is playable in the given market. Otherwise false. type: boolean languages: description: > A list of the languages used in the chapter, identified by their [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639) code. type: array items: type: string example: - fr - en name: description: | The name of the chapter. type: string example: > Starting Your Own Podcast: Tips, Tricks, and Advice From Anchor Creators release_date: description: > The date the chapter was first released, for example `"1981-12-15"`. Depending on the precision, it might be shown as `"1981"` or `"1981-12"`. type: string example: '1981-12-15' release_date_precision: description: | The precision with which `release_date` value is known. type: string example: day enum: - year - month - day resume_point: $ref: '#/components/schemas/ResumePointObject' type: description: | The object type. type: string enum: - episode uri: description: > The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the chapter. type: string example: spotify:episode:0zLhl3WsOCQHbe1BPTiHgr restrictions: $ref: '#/components/schemas/ChapterRestrictionObject' x-konfig-properties: external_urls: description: | External URLs for this chapter. resume_point: description: > The user's most recent position in the chapter. Set if the supplied access token is a user token and has the scope 'user-read-playback-position'. restrictions: description: | Included in the response when a content restriction is applied. AlbumObject: x-spotify-docs-type: AlbumObject required: - artists - tracks - copyrights - external_ids - genres - label - popularity allOf: - $ref: '#/components/schemas/AlbumBase' - type: object properties: artists: description: > The artists of the album. Each artist object includes a link in `href` to more detailed information about the artist. type: array items: $ref: '#/components/schemas/SimplifiedArtistObject' tracks: $ref: '#/components/schemas/PagingSimplifiedTrackObject' copyrights: description: | The copyright statements of the album. type: array items: $ref: '#/components/schemas/CopyrightObject' external_ids: $ref: '#/components/schemas/ExternalIdObject' genres: description: > A list of the genres the album is associated with. If not yet classified, the array is empty. type: array items: type: string example: - Egg punk - Noise rock label: description: | The label associated with the album. type: string popularity: description: > The popularity of the album. The value will be between 0 and 100, with 100 being the most popular. type: integer x-konfig-properties: tracks: description: | The tracks of the album. external_ids: description: | Known external IDs for the album. ContextObject: type: object x-spotify-docs-type: ContextObject properties: type: description: | The object type, e.g. "artist", "playlist", "album", "show". type: string href: description: A link to the Web API endpoint providing full details of the track. type: string external_urls: $ref: '#/components/schemas/ExternalUrlObject' uri: description: > The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the context. type: string x-konfig-properties: external_urls: description: External URLs for this context. CopyrightObject: type: object x-spotify-docs-type: CopyrightObject properties: text: description: | The copyright text for this content. type: string type: description: > The type of copyright: `C` = the copyright, `P` = the sound recording (performance) copyright. type: string AuthorObject: type: object x-spotify-docs-type: AuthorObject properties: name: description: | The name of the author. type: string NarratorObject: type: object x-spotify-docs-type: NarratorObject properties: name: description: | The name of the Narrator. type: string ExternalIdObject: type: object x-spotify-docs-type: ExternalIdObject properties: isrc: description: > [International Standard Recording Code](http://en.wikipedia.org/wiki/International_Standard_Recording_Code) type: string ean: description: > [International Article Number](http://en.wikipedia.org/wiki/International_Article_Number_%28EAN%29) type: string upc: description: > [Universal Product Code](http://en.wikipedia.org/wiki/Universal_Product_Code) type: string ExternalUrlObject: type: object x-spotify-docs-type: ExternalUrlObject properties: spotify: description: > The [Spotify URL](/documentation/web-api/concepts/spotify-uris-ids) for the object. type: string FollowersObject: type: object x-spotify-docs-type: FollowersObject properties: href: description: > This will always be set to null, as the Web API does not support it at the moment. type: string nullable: true total: description: | The total number of followers. type: integer ImageObject: type: object x-spotify-docs-type: ImageObject required: - url - height - width properties: url: description: | The source URL of the image. type: string example: | https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228 height: description: | The image height in pixels. type: integer example: 300 nullable: true width: description: | The image width in pixels. type: integer example: 300 nullable: true ExplicitContentSettingsObject: type: object x-spotify-docs-type: ExplicitContentSettingsObject properties: filter_enabled: description: | When `true`, indicates that explicit content should not be played. type: boolean filter_locked: description: > When `true`, indicates that the explicit content setting is locked and can't be changed by the user. type: boolean PlaylistsUpdateDetailsRequest: example: description: Updated playlist description name: Updated Playlist Name public: false type: object additionalProperties: true properties: description: description: > Value for playlist description as displayed in Spotify Clients and in the Web API. type: string name: description: | The new name for the playlist, for example `"My New Playlist Title"` type: string public: description: > If `true` the playlist will be public, if `false` it will be private. type: boolean collaborative: description: > If `true`, the playlist will become collaborative and other users will be able to modify the playlist in their Spotify client.