Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://api.spotify.com/v1
/me/albums
Remove one or more albums from the current user's 'Your Music' library.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlbumsRemoveSavedRequest"
}
}
}
}
DELETE /me/albums
/me/audiobooks
Remove one or more audiobooks from the Spotify user's library.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
DELETE /me/audiobooks
/me/episodes
Remove one or more episodes from the current user's library.<br/> 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).
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EpisodesRemoveFromLibraryRequest"
}
}
}
}
DELETE /me/episodes
/playlists/{playlist_id}/tracks
Remove one or more items from a user's playlist.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaylistsRemoveItemsRequest"
}
}
}
}
DELETE /playlists/{playlist_id}/tracks
/me/shows
Delete one or more shows from current Spotify user's library.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional |
DELETE /me/shows
/me/tracks
Remove one or more tracks from the current user's 'Your Music' library.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TracksRemoveFromLibraryRequest"
}
}
}
}
DELETE /me/tracks
/me/following
Remove the current user as a follower of one or more artists or other Spotify users.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| type | query | required | string | |
| ids | query | required | string |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsersUnfollowArtistsUsersRequest"
}
}
}
}
DELETE /me/following
/playlists/{playlist_id}/followers
Remove the current user as a follower of a playlist.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
DELETE /playlists/{playlist_id}/followers
AlbumBase
{
"type": "object",
"required": [
"album_type",
"total_tracks",
"available_markets",
"external_urls",
"href",
"id",
"images",
"name",
"release_date",
"release_date_precision",
"type",
"uri"
],
"properties": {
"id": {
"type": "string",
"example": "2up3OPMp9Tb4dAKM2erWXQ",
"description": "The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the album.\n"
},
"uri": {
"type": "string",
"example": "spotify:album:2up3OPMp9Tb4dAKM2erWXQ",
"description": "The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the album.\n"
},
"href": {
"type": "string",
"description": "A link to the Web API endpoint providing full details of the album.\n"
},
"name": {
"type": "string",
"description": "The name of the album. In case of an album takedown, the value may be an empty string.\n"
},
"type": {
"enum": [
"album"
],
"type": "string",
"description": "The object type.\n"
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageObject"
},
"description": "The cover art for the album in various sizes, widest first.\n"
},
"album_type": {
"enum": [
"album",
"single",
"compilation"
],
"type": "string",
"example": "compilation",
"description": "The type of the album.\n"
},
"release_date": {
"type": "string",
"example": "1981-12",
"description": "The date the album was first released.\n"
},
"restrictions": {
"$ref": "#/components/schemas/AlbumRestrictionObject"
},
"total_tracks": {
"type": "integer",
"example": 9,
"description": "The number of tracks in the album."
},
"external_urls": {
"$ref": "#/components/schemas/ExternalUrlObject"
},
"available_markets": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"CA",
"BR",
"IT"
],
"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._\n"
},
"release_date_precision": {
"enum": [
"year",
"month",
"day"
],
"type": "string",
"example": "year",
"description": "The precision with which `release_date` value is known.\n"
}
},
"x-konfig-properties": {
"restrictions": {
"description": "Included in the response when a content restriction is applied.\n"
},
"external_urls": {
"description": "Known external URLs for this album.\n"
}
}
}
AlbumObject
{
"allOf": [
{
"$ref": "#/components/schemas/AlbumBase"
},
{
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The label associated with the album.\n"
},
"genres": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"Egg punk",
"Noise rock"
],
"description": "A list of the genres the album is associated with. If not yet classified, the array is empty.\n"
},
"tracks": {
"$ref": "#/components/schemas/PagingSimplifiedTrackObject"
},
"artists": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SimplifiedArtistObject"
},
"description": "The artists of the album. Each artist object includes a link in `href` to more detailed information about the artist.\n"
},
"copyrights": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CopyrightObject"
},
"description": "The copyright statements of the album.\n"
},
"popularity": {
"type": "integer",
"description": "The popularity of the album. The value will be between 0 and 100, with 100 being the most popular.\n"
},
"external_ids": {
"$ref": "#/components/schemas/ExternalIdObject"
}
},
"x-konfig-properties": {
"tracks": {
"description": "The tracks of the album.\n"
},
"external_ids": {
"description": "Known external IDs for the album.\n"
}
}
}
],
"required": [
"artists",
"tracks",
"copyrights",
"external_ids",
"genres",
"label",
"popularity"
],
"x-spotify-docs-type": "AlbumObject"
}
AlbumRestrictionObject
{
"type": "object",
"properties": {
"reason": {
"enum": [
"market",
"product",
"explicit"
],
"type": "string",
"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.\nAdditional reasons may be added in the future.\n"
}
},
"x-spotify-docs-type": "AlbumRestrictionObject"
}
AlbumsGetInformation403Response
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"$ref": "#/components/schemas/ErrorObject"
}
}
}
AlbumsGetInformation429Response
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"$ref": "#/components/schemas/ErrorObject"
}
}
}
AlbumsGetInformationResponse
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"$ref": "#/components/schemas/ErrorObject"
}
}
}
AlbumsGetNewReleasesResponse
{
"type": "object",
"required": [
"albums"
],
"properties": {
"albums": {
"$ref": "#/components/schemas/PagingSimplifiedAlbumObject"
}
}
}
AlbumsListSeveralResponse
{
"type": "object",
"required": [
"albums"
],
"properties": {
"albums": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AlbumObject"
}
}
}
}
AlbumsRemoveSavedRequest
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "A JSON array of the [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example: `[\"4iV5W9uYEdYUVa79Axb7Rh\", \"1301WleyT98MSxVHPZCA6M\"]`<br/>A maximum of 50 items can be specified in one request. _**Note**: if the `ids` parameter is present in the query string, any IDs listed here in the body will be ignored._\n"
}
},
"additionalProperties": true
}
AlbumsSaveCurrentUserLibraryRequest
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "A JSON array of the [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example: `[\"4iV5W9uYEdYUVa79Axb7Rh\", \"1301WleyT98MSxVHPZCA6M\"]`<br/>A maximum of 50 items can be specified in one request. _**Note**: if the `ids` parameter is present in the query string, any IDs listed here in the body will be ignored._\n"
}
},
"additionalProperties": true
}
ArtistDiscographyAlbumObject
{
"allOf": [
{
"$ref": "#/components/schemas/SimplifiedAlbumObject"
},
{
"type": "object",
"required": [
"album_group"
],
"properties": {
"album_group": {
"enum": [
"album",
"single",
"compilation",
"appears_on"
],
"type": "string",
"example": "compilation",
"description": "This field describes the relationship between the artist and the album.\n"
}
}
}
],
"x-spotify-docs-type": "ArtistDiscographyAlbumObject"
}
ArtistObject
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the artist.\n"
},
"uri": {
"type": "string",
"description": "The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the artist.\n"
},
"href": {
"type": "string",
"description": "A link to the Web API endpoint providing full details of the artist.\n"
},
"name": {
"type": "string",
"description": "The name of the artist.\n"
},
"type": {
"enum": [
"artist"
],
"type": "string",
"description": "The object type.\n"
},
"genres": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"Prog rock",
"Grunge"
],
"description": "A list of the genres the artist is associated with. If not yet classified, the array is empty.\n"
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageObject"
},
"description": "Images of the artist in various sizes, widest first.\n"
},
"followers": {
"$ref": "#/components/schemas/FollowersObject"
},
"popularity": {
"type": "integer",
"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.\n"
},
"external_urls": {
"$ref": "#/components/schemas/ExternalUrlObject"
}
},
"x-konfig-properties": {
"followers": {
"description": "Information about the followers of the artist.\n"
},
"external_urls": {
"description": "Known external URLs for this artist.\n"
}
},
"x-spotify-docs-type": "ArtistObject"
}
ArtistsGetCatalogInfoResponse
{
"type": "object",
"required": [
"artists"
],
"properties": {
"artists": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArtistObject"
}
}
}
}
ArtistsGetTopTracksResponse
{
"type": "object",
"required": [
"tracks"
],
"properties": {
"tracks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TrackObject"
}
}
}
}
AudioAnalysisObject
{
"type": "object",
"properties": {
"bars": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimeIntervalObject"
},
"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."
},
"meta": {
"type": "object",
"properties": {
"platform": {
"type": "string",
"example": "Linux",
"description": "The platform used to read the track's audio data."
},
"timestamp": {
"type": "integer",
"example": 1495193577,
"description": "The Unix timestamp (in seconds) at which this track was analyzed."
},
"status_code": {
"type": "integer",
"example": 0,
"description": "The return code of the analyzer process. 0 if successful, 1 if any errors occurred."
},
"analysis_time": {
"type": "number",
"example": 6.93906,
"description": "The amount of time taken to analyze this track."
},
"input_process": {
"type": "string",
"example": "libvorbisfile L+R 44100->22050",
"description": "The method used to read the track's audio data."
},
"detailed_status": {
"type": "string",
"example": "OK",
"description": "A detailed status code for this track. If analysis data is missing, this code may explain why."
},
"analyzer_version": {
"type": "string",
"example": "4.0.0",
"description": "The version of the Analyzer used to analyze this track."
}
}
},
"beats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimeIntervalObject"
},
"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."
},
"track": {
"type": "object",
"properties": {
"key": {
"$ref": "#/components/schemas/Key"
},
"mode": {
"$ref": "#/components/schemas/Mode"
},
"tempo": {
"$ref": "#/components/schemas/Tempo"
},
"duration": {
"type": "number",
"example": 207.95985,
"description": "Length of the track in seconds."
},
"loudness": {
"$ref": "#/components/schemas/Loudness"
},
"codestring": {
"type": "string",
"description": "An [Echo Nest Musical Fingerprint (ENMFP)](https://academiccommons.columbia.edu/doi/10.7916/D8Q248M4) codestring for this track."
},
"sample_md5": {
"type": "string",
"description": "This field will always contain the empty string."
},
"num_samples": {
"type": "integer",
"example": 4585515,
"description": "The exact number of audio samples analyzed from this track. See also `analysis_sample_rate`."
},
"synchstring": {
"type": "string",
"description": "A [Synchstring](https://github.com/echonest/synchdata) for this track."
},
"code_version": {
"type": "number",
"example": 3.15,
"description": "A version number for the Echo Nest Musical Fingerprint format used in the codestring field."
},
"rhythmstring": {
"type": "string",
"description": "A Rhythmstring for this track. The format of this string is similar to the Synchstring."
},
"synch_version": {
"type": "number",
"example": 1,
"description": "A version number for the Synchstring used in the synchstring field."
},
"end_of_fade_in": {
"type": "number",
"example": 0,
"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."
},
"key_confidence": {
"type": "number",
"example": 0.408,
"maximum": 1,
"minimum": 0,
"description": "The confidence, from 0.0 to 1.0, of the reliability of the `key`."
},
"offset_seconds": {
"type": "integer",
"example": 0,
"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.)"
},
"rhythm_version": {
"type": "number",
"example": 1,
"description": "A version number for the Rhythmstring used in the rhythmstring field."
},
"time_signature": {
"$ref": "#/components/schemas/TimeSignature"
},
"window_seconds": {
"type": "integer",
"example": 0,
"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.)"
},
"echoprintstring": {
"type": "string",
"description": "An [EchoPrint](https://github.com/spotify/echoprint-codegen) codestring for this track."
},
"mode_confidence": {
"type": "number",
"example": 0.485,
"maximum": 1,
"minimum": 0,
"description": "The confidence, from 0.0 to 1.0, of the reliability of the `mode`."
},
"tempo_confidence": {
"type": "number",
"example": 0.73,
"maximum": 1,
"minimum": 0,
"description": "The confidence, from 0.0 to 1.0, of the reliability of the `tempo`."
},
"analysis_channels": {
"type": "integer",
"example": 1,
"description": "The number of channels used for analysis. If 1, all channels are summed together to mono before analysis."
},
"echoprint_version": {
"type": "number",
"example": 4.15,
"description": "A version number for the EchoPrint format used in the echoprintstring field."
},
"start_of_fade_out": {
"type": "number",
"example": 201.13705,
"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."
},
"analysis_sample_rate": {
"type": "integer",
"example": 22050,
"description": "The sample rate used to decode and analyze this track. May differ from the actual sample rate of this track available on Spotify."
},
"time_signature_confidence": {
"type": "number",
"example": 0.994,
"maximum": 1,
"minimum": 0,
"description": "The confidence, from 0.0 to 1.0, of the reliability of the `time_signature`."
}
}
},
"tatums": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimeIntervalObject"
},
"description": "A tatum represents the lowest regular pulse train that a listener intuitively infers from the timing of perceived musical events (segments)."
},
"sections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SectionObject"
},
"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."
},
"segments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SegmentObject"
},
"description": "Each segment contains a roughly conisistent sound throughout its duration."
}
},
"x-spotify-docs-type": "AudioAnalysisObject"
}
AudioFeaturesObject
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "2takcwOaAZWiXQijPHIx7B",
"description": "The Spotify ID for the track.\n"
},
"key": {
"$ref": "#/components/schemas/Key"
},
"uri": {
"type": "string",
"example": "spotify:track:2takcwOaAZWiXQijPHIx7B",
"description": "The Spotify URI for the track.\n"
},
"mode": {
"$ref": "#/components/schemas/Mode"
},
"type": {
"enum": [
"audio_features"
],
"type": "string",
"description": "The object type.\n"
},
"tempo": {
"$ref": "#/components/schemas/Tempo"
},
"energy": {
"type": "number",
"format": "float",
"example": 0.842,
"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.\n",
"x-spotify-docs-type": "Float"
},
"valence": {
"type": "number",
"format": "float",
"example": 0.428,
"maximum": 1,
"minimum": 0,
"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).\n",
"x-spotify-docs-type": "Float"
},
"liveness": {
"type": "number",
"format": "float",
"example": 0.0866,
"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.\n",
"x-spotify-docs-type": "Float"
},
"loudness": {
"$ref": "#/components/schemas/Loudness"
},
"track_href": {
"type": "string",
"example": "https://api.spotify.com/v1/tracks/2takcwOaAZWiXQijPHIx7B\n",
"description": "A link to the Web API endpoint providing full details of the track.\n"
},
"duration_ms": {
"type": "integer",
"example": 237040,
"description": "The duration of the track in milliseconds.\n"
},
"speechiness": {
"type": "number",
"format": "float",
"example": 0.0556,
"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.\n",
"x-spotify-docs-type": "Float"
},
"acousticness": {
"type": "number",
"format": "float",
"example": 0.00242,
"maximum": 1,
"minimum": 0,
"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.\n",
"x-spotify-docs-type": "Float"
},
"analysis_url": {
"type": "string",
"example": "https://api.spotify.com/v1/audio-analysis/2takcwOaAZWiXQijPHIx7B\n",
"description": "A URL to access the full audio analysis of this track. An access token is required to access this data.\n"
},
"danceability": {
"type": "number",
"format": "float",
"example": 0.585,
"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.\n",
"x-spotify-docs-type": "Float"
},
"time_signature": {
"$ref": "#/components/schemas/TimeSignature"
},
"instrumentalness": {
"type": "number",
"format": "float",
"example": 0.00686,
"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.\n",
"x-spotify-docs-type": "Float"
}
},
"x-spotify-docs-type": "AudioFeaturesObject"
}
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": {
"id": {
"type": "string",
"description": "The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the audiobook.\n"
},
"uri": {
"type": "string",
"description": "The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the audiobook.\n"
},
"href": {
"type": "string",
"description": "A link to the Web API endpoint providing full details of the audiobook.\n"
},
"name": {
"type": "string",
"description": "The name of the audiobook.\n"
},
"type": {
"enum": [
"audiobook"
],
"type": "string",
"description": "The object type.\n"
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageObject"
},
"description": "The cover art for the audiobook in various sizes, widest first.\n"
},
"authors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuthorObject"
},
"description": "The author(s) for the audiobook.\n"
},
"edition": {
"type": "string",
"example": "Unabridged",
"description": "The edition of the audiobook.\n"
},
"explicit": {
"type": "boolean",
"description": "Whether or not the audiobook has explicit content (true = yes it does; false = no it does not OR unknown).\n"
},
"languages": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of the languages used in the audiobook, identified by their [ISO 639](https://en.wikipedia.org/wiki/ISO_639) code.\n"
},
"narrators": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarratorObject"
},
"description": "The narrator(s) for the audiobook.\n"
},
"publisher": {
"type": "string",
"description": "The publisher of the audiobook.\n"
},
"copyrights": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CopyrightObject"
},
"description": "The copyright statements of the audiobook.\n"
},
"media_type": {
"type": "string",
"description": "The media type of the audiobook.\n"
},
"description": {
"type": "string",
"description": "A description of the audiobook. HTML tags are stripped away from this field, use `html_description` field in case HTML tags are needed.\n"
},
"external_urls": {
"$ref": "#/components/schemas/ExternalUrlObject"
},
"total_chapters": {
"type": "integer",
"description": "The number of chapters in this audiobook.\n"
},
"html_description": {
"type": "string",
"description": "A description of the audiobook. This field may contain HTML tags.\n"
},
"available_markets": {
"type": "array",
"items": {
"type": "string"
},
"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.\n"
}
},
"x-konfig-properties": {
"external_urls": {
"description": "External URLs for this audiobook.\n"
}
}
}
AudiobookObject
{
"allOf": [
{
"$ref": "#/components/schemas/AudiobookBase"
},
{
"type": "object",
"required": [
"chapters"
],
"properties": {
"chapters": {
"$ref": "#/components/schemas/PagingSimplifiedChapterObject"
}
},
"x-konfig-properties": {
"chapters": {
"type": "object",
"description": "The chapters of the audiobook.\n"
}
}
}
],
"x-spotify-docs-type": "AudiobookObject"
}
AudiobooksCheckUserSavedResponse
{
"type": "array",
"items": {
"type": "boolean"
},
"example": [
false,
true
]
}
AudiobooksGetCatalogInfo404Response
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"$ref": "#/components/schemas/ErrorObject"
}
}
}
AudiobooksGetCatalogInfoResponse
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"$ref": "#/components/schemas/ErrorObject"
}
}
}
AudiobooksGetSeveralResponse
{
"type": "object",
"required": [
"audiobooks"
],
"properties": {
"audiobooks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudiobookObject"
}
}
}
}
AuthorObject
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the author.\n"
}
},
"x-spotify-docs-type": "AuthorObject"
}
CategoriesListSeveralResponse
{
"type": "object",
"required": [
"categories"
],
"properties": {
"categories": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PagingObject"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CategoryObject"
}
}
}
}
]
}
}
}
CategoryObject
{
"type": "object",
"required": [
"href",
"icons",
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"example": "equal",
"description": "The [Spotify category ID](/documentation/web-api/concepts/spotify-uris-ids) of the category.\n"
},
"href": {
"type": "string",
"description": "A link to the Web API endpoint returning full details of the category.\n"
},
"name": {
"type": "string",
"example": "EQUAL",
"description": "The name of the category.\n"
},
"icons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageObject"
},
"description": "The category icon, in various sizes.\n"
}
},
"x-spotify-docs-type": "CategoryObject"
}
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": {
"id": {
"type": "string",
"example": "5Xt5DXGzch68nYYamXrNxZ",
"description": "The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the chapter.\n"
},
"uri": {
"type": "string",
"example": "spotify:episode:0zLhl3WsOCQHbe1BPTiHgr",
"description": "The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the chapter.\n"
},
"href": {
"type": "string",
"example": "https://api.spotify.com/v1/episodes/5Xt5DXGzch68nYYamXrNxZ",
"description": "A link to the Web API endpoint providing full details of the chapter.\n"
},
"name": {
"type": "string",
"example": "Starting Your Own Podcast: Tips, Tricks, and Advice From Anchor Creators\n",
"description": "The name of the chapter.\n"
},
"type": {
"enum": [
"episode"
],
"type": "string",
"description": "The object type.\n"
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageObject"
},
"description": "The cover art for the chapter in various sizes, widest first.\n"
},
"explicit": {
"type": "boolean",
"description": "Whether or not the chapter has explicit content (true = yes it does; false = no it does not OR unknown).\n"
},
"languages": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"fr",
"en"
],
"description": "A list of the languages used in the chapter, identified by their [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639) code.\n"
},
"description": {
"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.\n",
"description": "A description of the chapter. HTML tags are stripped away from this field, use `html_description` field in case HTML tags are needed.\n"
},
"duration_ms": {
"type": "integer",
"example": 1686230,
"description": "The chapter length in milliseconds.\n"
},
"is_playable": {
"type": "boolean",
"description": "True if the chapter is playable in the given market. Otherwise false.\n"
},
"release_date": {
"type": "string",
"example": "1981-12-15",
"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\"`.\n"
},
"restrictions": {
"$ref": "#/components/schemas/ChapterRestrictionObject"
},
"resume_point": {
"$ref": "#/components/schemas/ResumePointObject"
},
"external_urls": {
"$ref": "#/components/schemas/ExternalUrlObject"
},
"chapter_number": {
"type": "integer",
"example": 1,
"description": "The number of the chapter\n"
},
"html_description": {
"type": "string",
"example": "<p>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.</p>\n",
"description": "A description of the chapter. This field may contain HTML tags.\n"
},
"audio_preview_url": {
"type": "string",
"example": "https://p.scdn.co/mp3-preview/2f37da1d4221f40b9d1a98cd191f4d6f1646ad17",
"nullable": true,
"description": "A URL to a 30 second preview (MP3 format) of the chapter. `null` if not available.\n",
"x-spotify-policy-list": [
{
"$ref": "#/components/x-spotify-policy/policies/StandalonePreview"
}
]
},
"available_markets": {
"type": "array",
"items": {
"type": "string"
},
"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.\n"
},
"release_date_precision": {
"enum": [
"year",
"month",
"day"
],
"type": "string",
"example": "day",
"description": "The precision with which `release_date` value is known.\n"
}
},
"x-konfig-properties": {
"restrictions": {
"description": "Included in the response when a content restriction is applied.\n"
},
"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'.\n"
},
"external_urls": {
"description": "External URLs for this chapter.\n"
}
}
}
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.\n"
}
}
}
],
"x-spotify-docs-type": "ChapterObject"
}
ChapterRestrictionObject
{
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "The reason for the restriction. Supported values:\n- `market` - The content item is not available in the given market.\n- `product` - The content item is not available for the user's subscription type.\n- `explicit` - The content item is explicit and the user's account is set to not play explicit content.\n- `payment_required` - Payment is required to play the content item.\n\nAdditional reasons may be added in the future.\n**Note**: If you use this field, make sure that your application safely handles unknown values.\n"
}
},
"x-spotify-docs-type": "ChapterRestrictionObject"
}
ChaptersGetMultipleByIdsResponse
{
"type": "object",
"required": [
"chapters"
],
"properties": {
"chapters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChapterObject"
}
}
}
}
ContextObject
{
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the context.\n"
},
"href": {
"type": "string",
"description": "A link to the Web API endpoint providing full details of the track."
},
"type": {
"type": "string",
"description": "The object type, e.g. \"artist\", \"playlist\", \"album\", \"show\".\n"
},
"external_urls": {
"$ref": "#/components/schemas/ExternalUrlObject"
}
},
"x-konfig-properties": {
"external_urls": {
"description": "External URLs for this context."
}
},
"x-spotify-docs-type": "ContextObject"
}
CopyrightObject
{
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "The copyright text for this content.\n"
},
"type": {
"type": "string",
"description": "The type of copyright: `C` = the copyright, `P` = the sound recording (performance) copyright.\n"
}
},
"x-spotify-docs-type": "CopyrightObject"
}
CurrentlyPlayingContextObject
{
"type": "object",
"properties": {
"item": {
"oneOf": [
{
"$ref": "#/components/schemas/TrackObject"
},
{
"$ref": "#/components/schemas/EpisodeObject"
}
],
"description": "The currently playing track or episode. Can be `null`.",
"discriminator": {
"propertyName": "type"
},
"x-spotify-docs-type": "TrackObject | EpisodeObject"
},
"device": {
"$ref": "#/components/schemas/DeviceObject"
},
"actions": {
"$ref": "#/components/schemas/DisallowsObject"
},
"context": {
"$ref": "#/components/schemas/ContextObject"
},
"timestamp": {
"type": "integer",
"description": "Unix Millisecond Timestamp when data was fetched."
},
"is_playing": {
"type": "boolean",
"description": "If something is currently playing, return `true`."
},
"progress_ms": {
"type": "integer",
"description": "Progress into the currently playing track or episode. Can be `null`."
},
"repeat_state": {
"type": "string",
"description": "off, track, context"
},
"shuffle_state": {
"type": "boolean",
"description": "If shuffle is on or off."
},
"currently_playing_type": {
"type": "string",
"description": "The object type of the currently playing item. Can be one of `track`, `episode`, `ad` or `unknown`.\n"
}
},
"x-konfig-properties": {
"device": {
"description": "The device that is currently active.\n"
},
"actions": {
"description": "Allows to update the user interface based on which playback actions are available within the current context.\n"
},
"context": {
"description": "A Context Object. Can be `null`."
}
},
"x-spotify-docs-type": "CurrentlyPlayingContextObject"
}
CursorObject
{
"type": "object",
"properties": {
"after": {
"type": "string",
"description": "The cursor to use as key to find the next page of items."
},
"before": {
"type": "string",
"description": "The cursor to use as key to find the previous page of items."
}
},
"x-spotify-docs-type": "CursorObject"
}
CursorPagingObject
{
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "A link to the Web API endpoint returning the full result of the request."
},
"next": {
"type": "string",
"description": "URL to the next page of items. ( `null` if none)"
},
"limit": {
"type": "integer",
"description": "The maximum number of items in the response (as set in the query or by default)."
},
"total": {
"type": "integer",
"description": "The total number of items available to return."
},
"cursors": {
"$ref": "#/components/schemas/CursorObject"
}
},
"x-konfig-properties": {
"cursors": {
"description": "The cursors used to find the next set of items."
}
},
"x-spotify-docs-type": "CursorPagingObject"
}
CursorPagingPlayHistoryObject
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/CursorPagingObject"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlayHistoryObject"
}
}
}
}
],
"x-spotify-docs-type": "PagingTrackObject"
}
CursorPagingSimplifiedArtistObject
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/CursorPagingObject"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArtistObject"
}
}
}
}
],
"x-spotify-docs-type": "PagingArtistObject"
}
DeviceObject
{
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true,
"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."
},
"name": {
"type": "string",
"example": "Kitchen speaker",
"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": {
"type": "string",
"example": "computer",
"description": "Device type, such as \"computer\", \"smartphone\" or \"speaker\"."
},
"is_active": {
"type": "boolean",
"description": "If this device is the currently active device."
},
"is_restricted": {
"type": "boolean",
"description": "Whether controlling this device is restricted. At present if this is \"true\" then no Web API commands will be accepted by this device."
},
"volume_percent": {
"type": "integer",
"example": 59,
"maximum": 100,
"minimum": 0,
"nullable": true,
"description": "The current volume in percent."
},
"supports_volume": {
"type": "boolean",
"description": "If this device can be used to set the volume."
},
"is_private_session": {
"type": "boolean",
"description": "If this device is currently in a private session."
}
},
"x-spotify-docs-type": "DeviceObject"
}
DisallowsObject
{
"type": "object",
"properties": {
"pausing": {
"type": "boolean",
"description": "Pausing. Optional field."
},
"seeking": {
"type": "boolean",
"description": "Seeking playback location. Optional field."
},
"resuming": {
"type": "boolean",
"description": "Resuming. Optional field."
},
"skipping_next": {
"type": "boolean",
"description": "Skipping to the next context. Optional field."
},
"skipping_prev": {
"type": "boolean",
"description": "Skipping to the previous context. Optional field."
},
"toggling_shuffle": {
"type": "boolean",
"description": "Toggling shuffle flag. Optional field."
},
"interrupting_playback": {
"type": "boolean",
"description": "Interrupting playback. Optional field."
},
"toggling_repeat_track": {
"type": "boolean",
"description": "Toggling repeat track flag. Optional field."
},
"transferring_playback": {
"type": "boolean",
"description": "Transfering playback between devices. Optional field."
},
"toggling_repeat_context": {
"type": "boolean",
"description": "Toggling repeat context flag. Optional field."
}
},
"x-spotify-docs-type": "DisallowsObject"
}
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": {
"id": {
"type": "string",
"example": "5Xt5DXGzch68nYYamXrNxZ",
"description": "The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the episode.\n"
},
"uri": {
"type": "string",
"example": "spotify:episode:0zLhl3WsOCQHbe1BPTiHgr",
"description": "The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the episode.\n"
},
"href": {
"type": "string",
"example": "https://api.spotify.com/v1/episodes/5Xt5DXGzch68nYYamXrNxZ",
"description": "A link to the Web API endpoint providing full details of the episode.\n"
},
"name": {
"type": "string",
"example": "Starting Your Own Podcast: Tips, Tricks, and Advice From Anchor Creators\n",
"description": "The name of the episode.\n"
},
"type": {
"enum": [
"episode"
],
"type": "string",
"description": "The object type.\n"
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageObject"
},
"description": "The cover art for the episode in various sizes, widest first.\n"
},
"explicit": {
"type": "boolean",
"description": "Whether or not the episode has explicit content (true = yes it does; false = no it does not OR unknown).\n"
},
"language": {
"type": "string",
"example": "en",
"deprecated": true,
"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.\n"
},
"languages": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"fr",
"en"
],
"description": "A list of the languages used in the episode, identified by their [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639) code.\n"
},
"description": {
"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.\n",
"description": "A description of the episode. HTML tags are stripped away from this field, use `html_description` field in case HTML tags are needed.\n"
},
"duration_ms": {
"type": "integer",
"example": 1686230,
"description": "The episode length in milliseconds.\n"
},
"is_playable": {
"type": "boolean",
"description": "True if the episode is playable in the given market. Otherwise false.\n"
},
"release_date": {
"type": "string",
"example": "1981-12-15",
"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\"`.\n"
},
"restrictions": {
"$ref": "#/components/schemas/EpisodeRestrictionObject"
},
"resume_point": {
"$ref": "#/components/schemas/ResumePointObject"
},
"external_urls": {
"$ref": "#/components/schemas/ExternalUrlObject"
},
"html_description": {
"type": "string",
"example": "<p>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.</p>\n",
"description": "A description of the episode. This field may contain HTML tags.\n"
},
"audio_preview_url": {
"type": "string",
"example": "https://p.scdn.co/mp3-preview/2f37da1d4221f40b9d1a98cd191f4d6f1646ad17",
"nullable": true,
"description": "A URL to a 30 second preview (MP3 format) of the episode. `null` if not available.\n",
"x-spotify-policy-list": [
{
"$ref": "#/components/x-spotify-policy/policies/StandalonePreview"
}
]
},
"is_externally_hosted": {
"type": "boolean",
"description": "True if the episode is hosted outside of Spotify's CDN.\n"
},
"release_date_precision": {
"enum": [
"year",
"month",
"day"
],
"type": "string",
"example": "day",
"description": "The precision with which `release_date` value is known.\n"
}
},
"x-konfig-properties": {
"restrictions": {
"description": "Included in the response when a content restriction is applied.\n"
},
"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'.\n"
},
"external_urls": {
"description": "External URLs for this episode.\n"
}
}
}
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.\n"
}
}
}
],
"x-spotify-docs-type": "EpisodeObject"
}
EpisodeRestrictionObject
{
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "The reason for the restriction. Supported values:\n- `market` - The content item is not available in the given market.\n- `product` - The content item is not available for the user's subscription type.\n- `explicit` - The content item is explicit and the user's account is set to not play explicit content.\n\nAdditional reasons may be added in the future.\n**Note**: If you use this field, make sure that your application safely handles unknown values.\n"
}
},
"x-spotify-docs-type": "EpisodeRestrictionObject"
}
EpisodesGetSeveralResponse
{
"type": "object",
"required": [
"episodes"
],
"properties": {
"episodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EpisodeObject"
}
}
}
}
EpisodesRemoveFromLibraryRequest
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "A JSON array of the [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). <br/>A maximum of 50 items can be specified in one request. _**Note**: if the `ids` parameter is present in the query string, any IDs listed here in the body will be ignored._\n"
}
},
"additionalProperties": true
}
EpisodesSaveCurrentUserLibraryRequest
{
"type": "object",
"required": [
"uris"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "A JSON array of the [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). <br/>A maximum of 50 items can be specified in one request. _**Note**: if the `ids` parameter is present in the query string, any IDs listed here in the body will be ignored._\n"
}
},
"additionalProperties": true
}
ErrorObject
{
"type": "object",
"required": [
"status",
"message"
],
"properties": {
"status": {
"type": "integer",
"maximum": 599,
"minimum": 400,
"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).\n"
},
"message": {
"type": "string",
"description": "A short description of the cause of the error.\n"
}
},
"x-spotify-docs-type": "ErrorObject"
}
ExplicitContentSettingsObject
{
"type": "object",
"properties": {
"filter_locked": {
"type": "boolean",
"description": "When `true`, indicates that the explicit content setting is locked and can't be changed by the user.\n"
},
"filter_enabled": {
"type": "boolean",
"description": "When `true`, indicates that explicit content should not be played.\n"
}
},
"x-spotify-docs-type": "ExplicitContentSettingsObject"
}
ExternalIdObject
{
"type": "object",
"properties": {
"ean": {
"type": "string",
"description": "[International Article Number](http://en.wikipedia.org/wiki/International_Article_Number_%28EAN%29)\n"
},
"upc": {
"type": "string",
"description": "[Universal Product Code](http://en.wikipedia.org/wiki/Universal_Product_Code)\n"
},
"isrc": {
"type": "string",
"description": "[International Standard Recording Code](http://en.wikipedia.org/wiki/International_Standard_Recording_Code)\n"
}
},
"x-spotify-docs-type": "ExternalIdObject"
}
ExternalUrlObject
{
"type": "object",
"properties": {
"spotify": {
"type": "string",
"description": "The [Spotify URL](/documentation/web-api/concepts/spotify-uris-ids) for the object.\n"
}
},
"x-spotify-docs-type": "ExternalUrlObject"
}
FollowersObject
{
"type": "object",
"properties": {
"href": {
"type": "string",
"nullable": true,
"description": "This will always be set to null, as the Web API does not support it at the moment.\n"
},
"total": {
"type": "integer",
"description": "The total number of followers.\n"
}
},
"x-spotify-docs-type": "FollowersObject"
}
GenresGetAvailableSeedsResponse
{
"type": "object",
"required": [
"genres"
],
"properties": {
"genres": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"alternative",
"samba"
]
}
}
}
ImageObject
{
"type": "object",
"required": [
"url",
"height",
"width"
],
"properties": {
"url": {
"type": "string",
"example": "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228\n",
"description": "The source URL of the image.\n"
},
"width": {
"type": "integer",
"example": 300,
"nullable": true,
"description": "The image width in pixels.\n"
},
"height": {
"type": "integer",
"example": 300,
"nullable": true,
"description": "The image height in pixels.\n"
}
},
"x-spotify-docs-type": "ImageObject"
}
Key
{
"type": "integer",
"example": 9,
"maximum": 11,
"minimum": -1,
"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.\n"
}
LinkedTrackObject
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the track.\n"
},
"uri": {
"type": "string",
"description": "The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the track.\n"
},
"href": {
"type": "string",
"description": "A link to the Web API endpoint providing full details of the track.\n"
},
"type": {
"type": "string",
"description": "The object type: \"track\".\n"
},
"external_urls": {
"$ref": "#/components/schemas/ExternalUrlObject"
}
},
"x-konfig-properties": {
"external_urls": {
"description": "Known external URLs for this track.\n"
}
},
"x-spotify-docs-type": "LinkedTrackObject"
}
Loudness
{
"type": "number",
"format": "float",
"example": -5.883,
"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.\n",
"x-spotify-docs-type": "Float"
}
MarketsListAvailableResponse
{
"type": "object",
"properties": {
"markets": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"CA",
"BR",
"IT"
]
}
}
}
Mode
{
"type": "integer",
"example": 0,
"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.\n"
}
NarratorObject
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the Narrator.\n"
}
},
"x-spotify-docs-type": "NarratorObject"
}
PagingArtistDiscographyAlbumObject
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PagingObject"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArtistDiscographyAlbumObject"
}
}
}
}
],
"x-spotify-docs-type": "PagingArtistDiscographyAlbumObject"
}
PagingArtistObject
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PagingObject"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArtistObject"
}
}
}
}
],
"x-spotify-docs-type": "PagingArtistObject"
}
PagingFeaturedPlaylistObject
{
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Popular Playlists",
"description": "The localized message of a playlist.\n"
},
"playlists": {
"$ref": "#/components/schemas/PagingPlaylistObject"
}
},
"x-spotify-docs-type": "PagingFeaturedPlaylistObject"
}
PagingObject
{
"type": "object",
"required": [
"href",
"items",
"limit",
"next",
"offset",
"previous",
"total"
],
"properties": {
"href": {
"type": "string",
"example": "https://api.spotify.com/v1/me/shows?offset=0&limit=20\n",
"description": "A link to the Web API endpoint returning the full result of the request\n"
},
"next": {
"type": "string",
"example": "https://api.spotify.com/v1/me/shows?offset=1&limit=1",
"nullable": true,
"description": "URL to the next page of items. ( `null` if none)\n"
},
"limit": {
"type": "integer",
"example": 20,
"description": "The maximum number of items in the response (as set in the query or by default).\n"
},
"total": {
"type": "integer",
"example": 4,
"description": "The total number of items available to return.\n"
},
"offset": {
"type": "integer",
"example": 0,
"description": "The offset of the items returned (as set in the query or by default)\n"
},
"previous": {
"type": "string",
"example": "https://api.spotify.com/v1/me/shows?offset=1&limit=1",
"nullable": true,
"description": "URL to the previous page of items. ( `null` if none)\n"
}
},
"x-spotify-docs-type": "PagingObject"
}
PagingPlaylistObject
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PagingObject"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SimplifiedPlaylistObject"
}
}
}
}
],
"x-spotify-docs-type": "PagingPlaylistObject"
}
PagingPlaylistTrackObject
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PagingObject"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlaylistTrackObject"
}
}
}
}
],
"x-spotify-docs-type": "PagingPlaylistTrackObject"
}
PagingSavedAlbumObject
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PagingObject"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SavedAlbumObject"
}
}
}
}
],
"x-spotify-docs-type": "PagingSavedAlbumObject"
}
PagingSavedEpisodeObject
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PagingObject"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SavedEpisodeObject"
}
}
}
}
],
"x-spotify-docs-type": "PagingEpisodeObject"
}
PagingSavedShowObject
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PagingObject"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SavedShowObject"
}
}
}
}
],
"x-spotify-docs-type": "PagingShowObject"
}
PagingSavedTrackObject
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PagingObject"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SavedTrackObject"
}
}
}
}
],
"x-spotify-docs-type": "PagingTrackObject"
}
PagingSimplifiedAlbumObject
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PagingObject"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SimplifiedAlbumObject"
}
}
}
}
],
"x-spotify-docs-type": "PagingAlbumObject"
}
PagingSimplifiedAudiobookObject
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PagingObject"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SimplifiedAudiobookObject"
}
}
}
}
],
"x-spotify-docs-type": "PagingAudiobookObject"
}
PagingSimplifiedChapterObject
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PagingObject"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SimplifiedChapterObject"
}
}
}
}
],
"x-spotify-docs-type": "PagingSimplifiedChapterObject"
}
PagingSimplifiedEpisodeObject
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PagingObject"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SimplifiedEpisodeObject"
}
}
}
}
],
"x-spotify-docs-type": "PagingEpisodeObject"
}
PagingSimplifiedShowObject
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PagingObject"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SimplifiedShowObject"
}
}
}
}
],
"x-spotify-docs-type": "PagingShowObject"
}
PagingSimplifiedTrackObject
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PagingObject"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SimplifiedTrackObject"
}
}
}
}
],
"x-spotify-docs-type": "PagingTrackObject"
}
PagingTrackObject
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PagingObject"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TrackObject"
}
}
}
}
],
"x-spotify-docs-type": "PagingTrackObject"
}
PlayHistoryObject
{
"type": "object",
"properties": {
"track": {
"$ref": "#/components/schemas/TrackObject"
},
"context": {
"$ref": "#/components/schemas/ContextObject"
},
"played_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the track was played.",
"x-spotify-docs-type": "Timestamp"
}
},
"x-konfig-properties": {
"track": {
"description": "The track the user listened to."
},
"context": {
"description": "The context the track was played from."
}
},
"x-spotify-docs-type": "PlayHistoryObject"
}
PlayerGetAvailableDevicesResponse
{
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceObject"
}
}
}
}
PlayerStartPlaybackRequest
{
"type": "object",
"example": {
"offset": {
"position": 5
},
"context_uri": "spotify:album:5ht7ItJgpBH7W6vJ5BqpPr",
"position_ms": 0
},
"properties": {
"uris": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional. A JSON array of the Spotify track URIs to play.\nFor example: `{\"uris\": [\"spotify:track:4iV5W9uYEdYUVa79Axb7Rh\", \"spotify:track:1301WleyT98MSxVHPZCA6M\"]}`\n"
},
"offset": {
"type": "object",
"description": "Optional. Indicates from where in the context playback should start. Only available when context_uri corresponds to an album or playlist object\n\"position\" is zero based and can’t be negative. Example: `\"offset\": {\"position\": 5}`\n\"uri\" is a string representing the uri of the item to start at. Example: `\"offset\": {\"uri\": \"spotify:track:1301WleyT98MSxVHPZCA6M\"}`\n",
"additionalProperties": true
},
"context_uri": {
"type": "string",
"description": "Optional. Spotify URI of the context to play.\nValid contexts are albums, artists & playlists.\n`{context_uri:\"spotify:album:1Je1IMUlBXcx1Fz0WE7oPT\"}`\n",
"additionalProperties": true
},
"position_ms": {
"type": "integer",
"description": "integer",
"additionalProperties": true
}
},
"additionalProperties": true
}
PlayerTransferPlaybackToNewDeviceRequest
{
"type": "object",
"example": {
"device_ids": [
"74ASZWbe4lXaubB36ztrGX"
]
},
"required": [
"device_ids"
],
"properties": {
"play": {
"type": "boolean",
"description": "**true**: ensure playback happens on new device.<br/>**false** or not provided: keep the current playback state.\n",
"additionalProperties": true
},
"device_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "A JSON array containing the ID of the device on which playback should be started/transferred.<br/>For example:`{device_ids:[\"74ASZWbe4lXaubB36ztrGX\"]}`<br/>_**Note**: Although an array is accepted, only a single device_id is currently supported. Supplying more than one will return `400 Bad Request`_\n"
}
},
"additionalProperties": true
}
PlaylistObject
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the playlist.\n"
},
"uri": {
"type": "string",
"description": "The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the playlist.\n"
},
"href": {
"type": "string",
"description": "A link to the Web API endpoint providing full details of the playlist.\n"
},
"name": {
"type": "string",
"description": "The name of the playlist.\n"
},
"type": {
"type": "string",
"description": "The object type: \"playlist\"\n"
},
"owner": {
"$ref": "#/components/schemas/PlaylistOwnerObject"
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageObject"
},
"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._\n"
},
"public": {
"type": "boolean",
"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)\n"
},
"tracks": {
"$ref": "#/components/schemas/PagingPlaylistTrackObject"
},
"followers": {
"$ref": "#/components/schemas/FollowersObject"
},
"description": {
"type": "string",
"nullable": true,
"description": "The playlist description. _Only returned for modified, verified playlists, otherwise_ `null`.\n"
},
"snapshot_id": {
"type": "string",
"description": "The version identifier for the current playlist. Can be supplied in other requests to target a specific playlist version\n"
},
"collaborative": {
"type": "boolean",
"description": "`true` if the owner allows other users to modify the playlist.\n"
},
"external_urls": {
"$ref": "#/components/schemas/ExternalUrlObject"
}
},
"x-konfig-properties": {
"owner": {
"description": "The user who owns the playlist\n"
},
"tracks": {
"type": "object",
"description": "The tracks of the playlist.\n"
},
"followers": {
"description": "Information about the followers of the playlist."
},
"external_urls": {
"description": "Known external URLs for this playlist.\n"
}
},
"x-spotify-docs-type": "PlaylistObject"
}
PlaylistOwnerObject
{
"allOf": [
{
"$ref": "#/components/schemas/PlaylistUserObject"
},
{
"type": "object",
"properties": {
"display_name": {
"type": "string",
"nullable": true,
"description": "The name displayed on the user's profile. `null` if not available.\n"
}
}
}
]
}
PlaylistTrackObject
{
"type": "object",
"properties": {
"track": {
"oneOf": [
{
"$ref": "#/components/schemas/TrackObject"
},
{
"$ref": "#/components/schemas/EpisodeObject"
}
],
"description": "Information about the track or episode.",
"discriminator": {
"propertyName": "type"
},
"x-spotify-docs-type": "TrackObject | EpisodeObject"
},
"added_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the track or episode was added. _**Note**: some very old playlists may return `null` in this field._\n",
"x-spotify-docs-type": "Timestamp"
},
"added_by": {
"$ref": "#/components/schemas/PlaylistUserObject"
},
"is_local": {
"type": "boolean",
"description": "Whether this track or episode is a [local file](/documentation/web-api/concepts/playlists/#local-files) or not.\n"
}
},
"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._\n"
}
},
"x-spotify-docs-type": "PlaylistTrackObject"
}
PlaylistTracksRefObject
{
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "A link to the Web API endpoint where full details of the playlist's tracks can be retrieved.\n"
},
"total": {
"type": "integer",
"description": "Number of tracks in the playlist.\n"
}
},
"x-spotify-docs-type": "PlaylistTracksRefObject"
}
PlaylistUserObject
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The [Spotify user ID](/documentation/web-api/concepts/spotify-uris-ids) for this user.\n"
},
"uri": {
"type": "string",
"description": "The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for this user.\n"
},
"href": {
"type": "string",
"description": "A link to the Web API endpoint for this user.\n"
},
"type": {
"enum": [
"user"
],
"type": "string",
"description": "The object type.\n"
},
"followers": {
"$ref": "#/components/schemas/FollowersObject"
},
"external_urls": {
"$ref": "#/components/schemas/ExternalUrlObject"
}
},
"x-konfig-properties": {
"followers": {
"description": "Information about the followers of this user.\n"
},
"external_urls": {
"description": "Known public external URLs for this user.\n"
}
},
"x-spotify-docs-type": "PlaylistUserObject"
}
PlaylistsAddItemsRequest
{
"type": "object",
"properties": {
"uris": {
"type": "array",
"items": {
"type": "string"
},
"description": "A JSON array of the [Spotify URIs](/documentation/web-api/concepts/spotify-uris-ids) to add. For example: `{\"uris\": [\"spotify:track:4iV5W9uYEdYUVa79Axb7Rh\",\"spotify:track:1301WleyT98MSxVHPZCA6M\", \"spotify:episode:512ojhOuo1ktJprKbVcKyQ\"]}`<br/>A maximum of 100 items can be added in one request. _**Note**: if the `uris` parameter is present in the query string, any URIs listed here in the body will be ignored._\n"
},
"position": {
"type": "integer",
"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 appear in the uris array. For example: `{\"uris\": [\"spotify:track:4iV5W9uYEdYUVa79Axb7Rh\",\"spotify:track:1301WleyT98MSxVHPZCA6M\"], \"position\": 3}`\n"
}
},
"additionalProperties": true
}
PlaylistsCreatePlaylistRequest
{
"type": "object",
"example": {
"name": "New Playlist",
"public": false,
"description": "New playlist description"
},
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name for the new playlist, for example `\"Your Coolest Playlist\"`. This name does not need to be unique; a user may have several playlists with the same name.\n"
},
"public": {
"type": "boolean",
"description": "Defaults to `true`. If `true` the playlist will be public, if `false` it will be private. To be able to create private playlists, the user must have granted the `playlist-modify-private` [scope](/documentation/web-api/concepts/scopes/#list-of-scopes)\n"
},
"description": {
"type": "string",
"description": "value for playlist description as displayed in Spotify Clients and in the Web API.\n"
},
"collaborative": {
"type": "boolean",
"description": "Defaults to `false`. If `true` the playlist will be collaborative. _**Note**: to create a collaborative playlist you must also set `public` to `false`. To create collaborative playlists you must have granted `playlist-modify-private` and `playlist-modify-public` [scopes](/documentation/web-api/concepts/scopes/#list-of-scopes)._\n"
}
},
"additionalProperties": true
}
PlaylistsGetCoverImageResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageObject"
}
}
PlaylistsRemoveItemsRequest
{
"type": "object",
"required": [
"tracks"
],
"properties": {
"tracks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "Spotify URI"
}
}
},
"description": "An array of objects containing [Spotify URIs](/documentation/web-api/concepts/spotify-uris-ids) of the tracks or episodes to remove.\nFor example: `{ \"tracks\": [{ \"uri\": \"spotify:track:4iV5W9uYEdYUVa79Axb7Rh\" },{ \"uri\": \"spotify:track:1301WleyT98MSxVHPZCA6M\" }] }`. A maximum of 100 objects can be sent at once.\n"
},
"snapshot_id": {
"type": "string",
"description": "The playlist's snapshot ID against which you want to make the changes.\nThe API will validate that the specified items exist and in the specified positions and make the changes,\neven if more recent changes have been made to the playlist.\n"
}
}
}
PlaylistsRemoveItemsResponse
{
"type": "object",
"properties": {
"snapshot_id": {
"type": "string",
"example": "abc"
}
}
}
PlaylistsReplaceCoverImageRequest
{
"type": "string",
"format": "byte",
"example": "/9j/2wCEABoZGSccJz4lJT5CLy8vQkc9Ozs9R0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0cBHCcnMyYzPSYmPUc9Mj1HR0dEREdHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR//dAAQAAf/uAA5BZG9iZQBkwAAAAAH/wAARCAABAAEDACIAAREBAhEB/8QASwABAQAAAAAAAAAAAAAAAAAAAAYBAQAAAAAAAAAAAAAAAAAAAAAQAQAAAAAAAAAAAAAAAAAAAAARAQAAAAAAAAAAAAAAAAAAAAD/2gAMAwAAARECEQA/AJgAH//Z",
"required": true,
"description": "Base64 encoded JPEG image data, maximum payload size is 256 KB."
}
PlaylistsUpdateDetailsRequest
{
"type": "object",
"example": {
"name": "Updated Playlist Name",
"public": false,
"description": "Updated playlist description"
},
"properties": {
"name": {
"type": "string",
"description": "The new name for the playlist, for example `\"My New Playlist Title\"`\n"
},
"public": {
"type": "boolean",
"description": "If `true` the playlist will be public, if `false` it will be private.\n"
},
"description": {
"type": "string",
"description": "Value for playlist description as displayed in Spotify Clients and in the Web API.\n"
},
"collaborative": {
"type": "boolean",
"description": "If `true`, the playlist will become collaborative and other users will be able to modify the playlist in their Spotify client. <br/>\n_**Note**: You can only set `collaborative` to `true` on non-public playlists._\n"
}
},
"additionalProperties": true
}
PlaylistsUpdatePlaylistItemsRequest
{
"type": "object",
"example": {
"range_start": 1,
"range_length": 2,
"insert_before": 3
},
"properties": {
"uris": {
"type": "array",
"items": {
"type": "string"
}
},
"range_start": {
"type": "integer",
"description": "The position of the first item to be reordered.\n"
},
"snapshot_id": {
"type": "string",
"description": "The playlist's snapshot ID against which you want to make the changes.\n"
},
"range_length": {
"type": "integer",
"description": "The amount of items to be reordered. Defaults to 1 if not set.<br/>The range of items to be reordered begins from the _range_start_ position, and includes the _range_length_ subsequent items.<br/>Example:<br/>To move the items at index 9-10 to the start of the playlist, _range_start_ is set to 9, and _range_length_ is set to 2.\n"
},
"insert_before": {
"type": "integer",
"description": "The position where the items should be inserted.<br/>To reorder the items to the end of the playlist, simply set _insert_before_ to the position after the last item.<br/>Examples:<br/>To reorder the first item to the last position in a playlist with 10 items, set _range_start_ to 0, and _insert_before_ to 10.<br/>To reorder the last item in a playlist with 10 items to the start of the playlist, set _range_start_ to 9, and _insert_before_ to 0.\n"
}
},
"additionalProperties": true
}
PrivateUserObject
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The [Spotify user ID](/documentation/web-api/concepts/spotify-uris-ids) for the user.\n"
},
"uri": {
"type": "string",
"description": "The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the user.\n"
},
"href": {
"type": "string",
"description": "A link to the Web API endpoint for this user.\n"
},
"type": {
"type": "string",
"description": "The object type: \"user\"\n"
},
"email": {
"type": "string",
"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._\n"
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageObject"
},
"description": "The user's profile image."
},
"country": {
"type": "string",
"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._\n"
},
"product": {
"type": "string",
"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._\n"
},
"followers": {
"$ref": "#/components/schemas/FollowersObject"
},
"display_name": {
"type": "string",
"description": "The name displayed on the user's profile. `null` if not available.\n"
},
"external_urls": {
"$ref": "#/components/schemas/ExternalUrlObject"
},
"explicit_content": {
"$ref": "#/components/schemas/ExplicitContentSettingsObject"
}
},
"x-konfig-properties": {
"followers": {
"description": "Information about the followers of the user."
},
"external_urls": {
"description": "Known external URLs for this user."
},
"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._\n"
}
},
"x-spotify-docs-type": "PrivateUserObject"
}
PublicUserObject
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The [Spotify user ID](/documentation/web-api/concepts/spotify-uris-ids) for this user.\n"
},
"uri": {
"type": "string",
"description": "The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for this user.\n"
},
"href": {
"type": "string",
"description": "A link to the Web API endpoint for this user.\n"
},
"type": {
"enum": [
"user"
],
"type": "string",
"description": "The object type.\n"
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageObject"
},
"description": "The user's profile image.\n"
},
"followers": {
"$ref": "#/components/schemas/FollowersObject"
},
"display_name": {
"type": "string",
"nullable": true,
"description": "The name displayed on the user's profile. `null` if not available.\n"
},
"external_urls": {
"$ref": "#/components/schemas/ExternalUrlObject"
}
},
"x-konfig-properties": {
"followers": {
"description": "Information about the followers of this user.\n"
},
"external_urls": {
"description": "Known public external URLs for this user.\n"
}
},
"x-spotify-docs-type": "PublicUserObject"
}
QueueObject
{
"type": "object",
"properties": {
"queue": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/TrackObject"
},
{
"$ref": "#/components/schemas/EpisodeObject"
}
],
"discriminator": {
"propertyName": "type"
},
"x-spotify-docs-type": "TrackObject | EpisodeObject"
},
"description": "The tracks or episodes in the queue. Can be empty."
},
"currently_playing": {
"oneOf": [
{
"$ref": "#/components/schemas/TrackObject"
},
{
"$ref": "#/components/schemas/EpisodeObject"
}
],
"description": "The currently playing track or episode. Can be `null`.",
"discriminator": {
"propertyName": "type"
},
"x-spotify-docs-type": "TrackObject | EpisodeObject"
}
},
"x-spotify-docs-type": "QueueObject"
}
RecommendationSeedObject
{
"type": "object",
"properties": {
"id": {
"type": "string",
"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.\n"
},
"href": {
"type": "string",
"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`.\n"
},
"type": {
"type": "string",
"description": "The entity type of this seed. One of `artist`, `track` or `genre`.\n"
},
"initialPoolSize": {
"type": "integer",
"description": "The number of recommended tracks available for this seed.\n"
},
"afterFilteringSize": {
"type": "integer",
"description": "The number of tracks available after min\\_\\* and max\\_\\* filters have been applied.\n"
},
"afterRelinkingSize": {
"type": "integer",
"description": "The number of tracks available after relinking for regional availability.\n"
}
},
"x-spotify-docs-type": "RecommendationSeedObject"
}
RecommendationsObject
{
"type": "object",
"required": [
"seeds",
"tracks"
],
"properties": {
"seeds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecommendationSeedObject"
},
"description": "An array of recommendation seed objects.\n"
},
"tracks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TrackObject"
},
"description": "An array of track object (simplified) ordered according to the parameters supplied.\n"
}
},
"x-spotify-docs-type": "RecommendationsObject"
}
ResumePointObject
{
"type": "object",
"properties": {
"fully_played": {
"type": "boolean",
"description": "Whether or not the episode has been fully played by the user.\n"
},
"resume_position_ms": {
"type": "integer",
"description": "The user's most recent position in the episode in milliseconds.\n"
}
},
"x-spotify-docs-type": "ResumePointObject"
}
SavedAlbumObject
{
"type": "object",
"properties": {
"album": {
"$ref": "#/components/schemas/AlbumObject"
},
"added_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the album was saved\nTimestamps are returned in ISO 8601 format as Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ.\nIf 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.\n",
"x-spotify-docs-type": "Timestamp"
}
},
"x-konfig-properties": {
"album": {
"description": "Information about the album."
}
},
"x-spotify-docs-type": "SavedAlbumObject"
}
SavedEpisodeObject
{
"type": "object",
"properties": {
"episode": {
"$ref": "#/components/schemas/EpisodeObject"
},
"added_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the episode was saved.\nTimestamps are returned in ISO 8601 format as Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ.\n",
"x-spotify-docs-type": "Timestamp"
}
},
"x-konfig-properties": {
"episode": {
"description": "Information about the episode."
}
},
"x-spotify-docs-type": "SavedEpisodeObject"
}
SavedShowObject
{
"type": "object",
"properties": {
"show": {
"$ref": "#/components/schemas/SimplifiedShowObject"
},
"added_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the show was saved.\nTimestamps are returned in ISO 8601 format as Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ.\nIf 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.\n",
"x-spotify-docs-type": "Timestamp"
}
},
"x-konfig-properties": {
"show": {
"description": "Information about the show."
}
},
"x-spotify-docs-type": "SavedShowObject"
}
SavedTrackObject
{
"type": "object",
"properties": {
"track": {
"$ref": "#/components/schemas/TrackObject"
},
"added_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the track was saved.\nTimestamps are returned in ISO 8601 format as Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ.\nIf 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.\n",
"x-spotify-docs-type": "Timestamp"
}
},
"x-konfig-properties": {
"track": {
"description": "Information about the track."
}
},
"x-spotify-docs-type": "SavedTrackObject"
}
SearchSpotifyCatalogInfoResponse
{
"type": "object",
"properties": {
"shows": {
"$ref": "#/components/schemas/PagingSimplifiedShowObject"
},
"albums": {
"$ref": "#/components/schemas/PagingSimplifiedAlbumObject"
},
"tracks": {
"$ref": "#/components/schemas/PagingTrackObject"
},
"artists": {
"$ref": "#/components/schemas/PagingArtistObject"
},
"episodes": {
"$ref": "#/components/schemas/PagingSimplifiedEpisodeObject"
},
"playlists": {
"$ref": "#/components/schemas/PagingPlaylistObject"
},
"audiobooks": {
"$ref": "#/components/schemas/PagingSimplifiedAudiobookObject"
}
}
}
SectionObject
{
"type": "object",
"properties": {
"key": {
"type": "integer",
"example": 9,
"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."
},
"mode": {
"enum": [
-1,
0,
1
],
"type": "number",
"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."
},
"start": {
"type": "number",
"example": 0,
"description": "The starting point (in seconds) of the section."
},
"tempo": {
"type": "number",
"example": 113.178,
"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."
},
"duration": {
"type": "number",
"example": 6.97092,
"description": "The duration (in seconds) of the section."
},
"loudness": {
"type": "number",
"example": -14.938,
"description": "The overall loudness of the section in decibels (dB). Loudness values are useful for comparing relative loudness of sections within tracks."
},
"confidence": {
"type": "number",
"example": 1,
"maximum": 1,
"minimum": 0,
"description": "The confidence, from 0.0 to 1.0, of the reliability of the section's \"designation\"."
},
"key_confidence": {
"type": "number",
"example": 0.297,
"maximum": 1,
"minimum": 0,
"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."
},
"time_signature": {
"$ref": "#/components/schemas/TimeSignature"
},
"mode_confidence": {
"type": "number",
"example": 0.471,
"maximum": 1,
"minimum": 0,
"description": "The confidence, from 0.0 to 1.0, of the reliability of the `mode`."
},
"tempo_confidence": {
"type": "number",
"example": 0.647,
"maximum": 1,
"minimum": 0,
"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."
},
"time_signature_confidence": {
"type": "number",
"example": 1,
"maximum": 1,
"minimum": 0,
"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."
}
}
}
SegmentObject
{
"type": "object",
"properties": {
"start": {
"type": "number",
"example": 0.70154,
"description": "The starting point (in seconds) of the segment."
},
"timbre": {
"type": "array",
"items": {
"type": "number"
},
"example": [
42.115,
64.373,
-0.233
],
"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.\n\nFor 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).\n\n\nThe 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.\n"
},
"pitches": {
"type": "array",
"items": {
"type": "number",
"maximum": 1,
"minimum": 0
},
"example": [
0.212,
0.141,
0.294
],
"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).\n\nVectors 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.\nAs can be seen below, the 12 vector indices are a combination of low-power spectrum values at their respective pitch frequencies.\n\n"
},
"duration": {
"type": "number",
"example": 0.19891,
"description": "The duration (in seconds) of the segment."
},
"confidence": {
"type": "number",
"example": 0.435,
"maximum": 1,
"minimum": 0,
"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.\n"
},
"loudness_end": {
"type": "number",
"example": 0,
"description": "The offset loudness of the segment in decibels (dB). This value should be equivalent to the loudness_start of the following segment."
},
"loudness_max": {
"type": "number",
"example": -14.25,
"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."
},
"loudness_start": {
"type": "number",
"example": -23.053,
"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."
},
"loudness_max_time": {
"type": "number",
"example": 0.07305,
"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."
}
}
}
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": {
"id": {
"type": "string",
"description": "The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the show.\n"
},
"uri": {
"type": "string",
"description": "The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the show.\n"
},
"href": {
"type": "string",
"description": "A link to the Web API endpoint providing full details of the show.\n"
},
"name": {
"type": "string",
"description": "The name of the episode.\n"
},
"type": {
"enum": [
"show"
],
"type": "string",
"description": "The object type.\n"
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageObject"
},
"description": "The cover art for the show in various sizes, widest first.\n"
},
"explicit": {
"type": "boolean",
"description": "Whether or not the show has explicit content (true = yes it does; false = no it does not OR unknown).\n"
},
"languages": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of the languages used in the show, identified by their [ISO 639](https://en.wikipedia.org/wiki/ISO_639) code.\n"
},
"publisher": {
"type": "string",
"description": "The publisher of the show.\n"
},
"copyrights": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CopyrightObject"
},
"description": "The copyright statements of the show.\n"
},
"media_type": {
"type": "string",
"description": "The media type of the show.\n"
},
"description": {
"type": "string",
"description": "A description of the show. HTML tags are stripped away from this field, use `html_description` field in case HTML tags are needed.\n"
},
"external_urls": {
"$ref": "#/components/schemas/ExternalUrlObject"
},
"total_episodes": {
"type": "integer",
"description": "The total number of episodes in the show.\n"
},
"html_description": {
"type": "string",
"description": "A description of the show. This field may contain HTML tags.\n"
},
"available_markets": {
"type": "array",
"items": {
"type": "string"
},
"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.\n"
},
"is_externally_hosted": {
"type": "boolean",
"description": "True if all of the shows episodes are hosted outside of Spotify's CDN. This field might be `null` in some cases.\n"
}
},
"x-konfig-properties": {
"external_urls": {
"description": "External URLs for this show.\n"
}
}
}
ShowObject
{
"allOf": [
{
"$ref": "#/components/schemas/ShowBase"
},
{
"type": "object",
"required": [
"episodes"
],
"properties": {
"episodes": {
"$ref": "#/components/schemas/PagingSimplifiedEpisodeObject"
}
},
"x-konfig-properties": {
"episodes": {
"type": "object",
"description": "The episodes of the show.\n"
}
}
}
],
"x-spotify-docs-type": "ShowObject"
}
ShowsGetMultipleShowsInfoResponse
{
"type": "object",
"required": [
"shows"
],
"properties": {
"shows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SimplifiedShowObject"
}
}
}
}
SimplifiedAlbumObject
{
"allOf": [
{
"$ref": "#/components/schemas/AlbumBase"
},
{
"type": "object",
"required": [
"artists"
],
"properties": {
"artists": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SimplifiedArtistObject"
},
"description": "The artists of the album. Each artist object includes a link in `href` to more detailed information about the artist.\n"
}
}
}
],
"x-spotify-docs-type": "SimplifiedAlbumObject"
}
SimplifiedArtistObject
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the artist.\n"
},
"uri": {
"type": "string",
"description": "The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the artist.\n"
},
"href": {
"type": "string",
"description": "A link to the Web API endpoint providing full details of the artist.\n"
},
"name": {
"type": "string",
"description": "The name of the artist.\n"
},
"type": {
"enum": [
"artist"
],
"type": "string",
"description": "The object type.\n"
},
"external_urls": {
"$ref": "#/components/schemas/ExternalUrlObject"
}
},
"x-konfig-properties": {
"external_urls": {
"description": "Known external URLs for this artist.\n"
}
},
"x-spotify-docs-type": "SimplifiedArtistObject"
}
SimplifiedAudiobookObject
{
"allOf": [
{
"$ref": "#/components/schemas/AudiobookBase"
},
{
"type": "object"
}
],
"x-spotify-docs-type": "SimplifiedAudiobookObject"
}
SimplifiedChapterObject
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ChapterBase"
},
{
"type": "object"
}
],
"x-spotify-docs-type": "SimplifiedChapterObject"
}
SimplifiedEpisodeObject
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/EpisodeBase"
},
{
"type": "object"
}
],
"x-spotify-docs-type": "SimplifiedEpisodeObject"
}
SimplifiedPlaylistObject
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the playlist.\n"
},
"uri": {
"type": "string",
"description": "The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the playlist.\n"
},
"href": {
"type": "string",
"description": "A link to the Web API endpoint providing full details of the playlist.\n"
},
"name": {
"type": "string",
"description": "The name of the playlist.\n"
},
"type": {
"type": "string",
"description": "The object type: \"playlist\"\n"
},
"owner": {
"$ref": "#/components/schemas/PlaylistOwnerObject"
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageObject"
},
"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._\n"
},
"public": {
"type": "boolean",
"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)\n"
},
"tracks": {
"$ref": "#/components/schemas/PlaylistTracksRefObject"
},
"description": {
"type": "string",
"description": "The playlist description. _Only returned for modified, verified playlists, otherwise_ `null`.\n"
},
"snapshot_id": {
"type": "string",
"description": "The version identifier for the current playlist. Can be supplied in other requests to target a specific playlist version\n"
},
"collaborative": {
"type": "boolean",
"description": "`true` if the owner allows other users to modify the playlist.\n"
},
"external_urls": {
"$ref": "#/components/schemas/ExternalUrlObject"
}
},
"x-konfig-properties": {
"owner": {
"description": "The user who owns the playlist\n"
},
"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.\n"
},
"external_urls": {
"description": "Known external URLs for this playlist.\n"
}
},
"x-spotify-docs-type": "SimplifiedPlaylistObject"
}
SimplifiedShowObject
{
"allOf": [
{
"$ref": "#/components/schemas/ShowBase"
},
{
"type": "object"
}
],
"x-spotify-docs-type": "SimplifiedShowObject"
}
SimplifiedTrackObject
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the track.\n"
},
"uri": {
"type": "string",
"description": "The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the track.\n"
},
"href": {
"type": "string",
"description": "A link to the Web API endpoint providing full details of the track."
},
"name": {
"type": "string",
"description": "The name of the track."
},
"type": {
"type": "string",
"description": "The object type: \"track\".\n"
},
"artists": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SimplifiedArtistObject"
},
"description": "The artists who performed the track. Each artist object includes a link in `href` to more detailed information about the artist."
},
"explicit": {
"type": "boolean",
"description": "Whether or not the track has explicit lyrics ( `true` = yes it does; `false` = no it does not OR unknown)."
},
"is_local": {
"type": "boolean",
"description": "Whether or not the track is from a local file.\n"
},
"disc_number": {
"type": "integer",
"description": "The disc number (usually `1` unless the album consists of more than one disc)."
},
"duration_ms": {
"type": "integer",
"description": "The track length in milliseconds."
},
"is_playable": {
"type": "boolean",
"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`.\n"
},
"linked_from": {
"$ref": "#/components/schemas/LinkedTrackObject"
},
"preview_url": {
"type": "string",
"nullable": true,
"description": "A URL to a 30 second preview (MP3 format) of the track.\n",
"x-spotify-policy-list": [
{
"$ref": "#/components/x-spotify-policy/policies/StandalonePreview"
}
]
},
"restrictions": {
"$ref": "#/components/schemas/TrackRestrictionObject"
},
"track_number": {
"type": "integer",
"description": "The number of the track. If an album has several discs, the track number is the number on the specified disc.\n"
},
"external_urls": {
"$ref": "#/components/schemas/ExternalUrlObject"
},
"available_markets": {
"type": "array",
"items": {
"type": "string"
},
"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.\n"
}
},
"x-konfig-properties": {
"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.\n"
},
"external_urls": {
"description": "External URLs for this track.\n"
}
},
"x-spotify-docs-type": "SimplifiedTrackObject"
}
Tempo
{
"type": "number",
"format": "float",
"example": 118.211,
"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.\n",
"x-spotify-docs-type": "Float"
}
TimeIntervalObject
{
"type": "object",
"properties": {
"start": {
"type": "number",
"example": 0.49567,
"description": "The starting point (in seconds) of the time interval."
},
"duration": {
"type": "number",
"example": 2.18749,
"description": "The duration (in seconds) of the time interval."
},
"confidence": {
"type": "number",
"example": 0.925,
"maximum": 1,
"minimum": 0,
"description": "The confidence, from 0.0 to 1.0, of the reliability of the interval."
}
}
}
TimeSignature
{
"type": "integer",
"example": 4,
"maximum": 7,
"minimum": 3,
"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\"."
}
TrackObject
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the track.\n"
},
"uri": {
"type": "string",
"description": "The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the track.\n"
},
"href": {
"type": "string",
"description": "A link to the Web API endpoint providing full details of the track.\n"
},
"name": {
"type": "string",
"description": "The name of the track.\n"
},
"type": {
"enum": [
"track"
],
"type": "string",
"description": "The object type: \"track\".\n"
},
"album": {
"$ref": "#/components/schemas/SimplifiedAlbumObject"
},
"artists": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArtistObject"
},
"description": "The artists who performed the track. Each artist object includes a link in `href` to more detailed information about the artist.\n"
},
"explicit": {
"type": "boolean",
"description": "Whether or not the track has explicit lyrics ( `true` = yes it does; `false` = no it does not OR unknown).\n"
},
"is_local": {
"type": "boolean",
"description": "Whether or not the track is from a local file.\n"
},
"popularity": {
"type": "integer",
"description": "The popularity of the track. The value will be between 0 and 100, with 100 being the most popular.<br/>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.<br/>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._\n"
},
"disc_number": {
"type": "integer",
"description": "The disc number (usually `1` unless the album consists of more than one disc).\n"
},
"duration_ms": {
"type": "integer",
"description": "The track length in milliseconds.\n"
},
"is_playable": {
"type": "boolean",
"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`.\n"
},
"linked_from": {
"type": "object",
"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.\n"
},
"preview_url": {
"type": "string",
"nullable": true,
"description": "A link to a 30 second preview (MP3 format) of the track. Can be `null`\n",
"x-spotify-policy-list": [
{
"$ref": "#/components/x-spotify-policy/policies/StandalonePreview"
}
]
},
"external_ids": {
"$ref": "#/components/schemas/ExternalIdObject"
},
"restrictions": {
"$ref": "#/components/schemas/TrackRestrictionObject"
},
"track_number": {
"type": "integer",
"description": "The number of the track. If an album has several discs, the track number is the number on the specified disc.\n"
},
"external_urls": {
"$ref": "#/components/schemas/ExternalUrlObject"
},
"available_markets": {
"type": "array",
"items": {
"type": "string"
},
"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.\n"
}
},
"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.\n"
},
"external_ids": {
"description": "Known external IDs for the track.\n"
},
"restrictions": {
"description": "Included in the response when a content restriction is applied.\n"
},
"external_urls": {
"description": "Known external URLs for this track.\n"
}
},
"x-spotify-docs-type": "TrackObject"
}
TrackRestrictionObject
{
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "The reason for the restriction. Supported values:\n- `market` - The content item is not available in the given market.\n- `product` - The content item is not available for the user's subscription type.\n- `explicit` - The content item is explicit and the user's account is set to not play explicit content.\n\nAdditional reasons may be added in the future.\n**Note**: If you use this field, make sure that your application safely handles unknown values.\n"
}
},
"x-spotify-docs-type": "TrackRestrictionObject"
}
TracksGetMultipleAudioFeaturesResponse
{
"type": "object",
"required": [
"audio_features"
],
"properties": {
"audio_features": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudioFeaturesObject"
}
}
}
}
TracksRemoveFromLibraryRequest
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "A JSON array of the [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example: `[\"4iV5W9uYEdYUVa79Axb7Rh\", \"1301WleyT98MSxVHPZCA6M\"]`<br/>A maximum of 50 items can be specified in one request. _**Note**: if the `ids` parameter is present in the query string, any IDs listed here in the body will be ignored._\n"
}
},
"additionalProperties": true
}
TracksSaveForCurrentUserRequest
{
"type": "object",
"required": [
"uris"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "A JSON array of the [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example: `[\"4iV5W9uYEdYUVa79Axb7Rh\", \"1301WleyT98MSxVHPZCA6M\"]`<br/>A maximum of 50 items can be specified in one request. _**Note**: if the `ids` parameter is present in the query string, any IDs listed here in the body will be ignored._\n"
}
},
"additionalProperties": true
}
UsersFollowArtistsOrUsersRequest
{
"type": "object",
"required": [
"ids"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "A JSON array of the artist or user [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids).\nFor example: `{ids:[\"74ASZWbe4lXaubB36ztrGX\", \"08td7MxkoHQkXnWAYD8d6Q\"]}`. A maximum of 50 IDs can be sent in one request. _**Note**: if the `ids` parameter is present in the query string, any IDs listed here in the body will be ignored._\n"
}
},
"additionalProperties": true
}
UsersFollowPlaylistRequest
{
"type": "object",
"example": {
"public": false
},
"properties": {
"public": {
"type": "boolean",
"description": "Defaults to `true`. If `true` the playlist will be included in user's public playlists, if `false` it will remain private.\n"
}
},
"additionalProperties": true
}
UsersGetFollowedArtistsResponse
{
"type": "object",
"required": [
"artists"
],
"properties": {
"artists": {
"$ref": "#/components/schemas/CursorPagingSimplifiedArtistObject"
}
}
}
UsersGetTopItemsResponse
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PagingObject"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/ArtistObject"
},
{
"$ref": "#/components/schemas/TrackObject"
}
],
"discriminator": {
"propertyName": "type"
}
}
}
}
}
]
}
UsersUnfollowArtistsUsersRequest
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "A JSON array of the artist or 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. _**Note**: if the `ids` parameter is present in the query string, any IDs listed here in the body will be ignored._\n"
}
},
"additionalProperties": true
}