Resources
Request
Path
| Name | Data Type | Description |
|---|---|---|
id
|
string |
The Spotify ID for the album |
Query
| Name | Data Type | Description |
|---|---|---|
market
|
string |
The market (an ISO 3166-1 alpha-2 country code) |
offset
|
integer Default value: 0
|
The index of the first item to return |
limit
|
integer Default value: 20Minimum: 0 Maximum: 50 |
The maximum number of items to return |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
track-simple-page
|
object |
Properties
total
|
integer |
The total number of items available to return. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
previous
|
string |
URL to the previous page of items. (null if none) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
|
integer |
The offset of the items returned (as set in the query or by default). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
next
|
string |
URL to the next page of items. (null if none) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
limit
|
integer |
The maximum number of items in the response (as set in the query or by default). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items
|
array [track-simple] |
The requested data. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href
|
string |
A link to the Web API endpoint returning the full result of the request. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request
Path
| Name | Data Type | Description |
|---|---|---|
id
|
string |
The Spotify ID for the album |
Query
| Name | Data Type | Description |
|---|---|---|
market
|
string |
The market (an ISO 3166-1 alpha-2 country code) |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
album
|
object |
Properties
uri
|
string |
The Spotify URI for the album. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
|
string |
The object type: 'album'. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tracks
|
track-simple-page | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
release_date_precision
|
string |
The precision with which release_date value is known: 'year', 'month', or 'day'. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
release_date
|
string |
The date the album was first released, for example '1981-12-15'. Depending on the precision, it might be shown as '1981' or '1981-12'. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
popularity
|
integer |
The popularity of the album. The value will be between 0 and 100, with 100 being the most popular. The popularity is calculated from the popularity of the album's individual tracks. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name
|
string |
The name of the album. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
images
|
array [image] |
The cover art for the album in various sizes, widest first. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string |
The Spotify ID for the album. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href
|
string |
A link to the Web API endpoint providing full details of the album. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
genres
|
array [string] |
A list of the genres used to classify the album. For example: 'Prog Rock', 'Post-Grunge'. (If not yet classified, the array is empty.) |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
external_urls
|
object |
Known external URLs for this album. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
external_ids
|
object |
Known external IDs for this album. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
copyrights
|
array [object] |
The copyright statements of the album. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
available_markets
|
array [string] |
The markets in which the album is available: ISO 3166-1 alpha-2 country codes. Note that an album is considered available in a market when at least 1 of its tracks is available in that market. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
artists
|
array [artist] |
The artists of the album. Each artist object includes a link in href to more detailed information about the artist. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
album_type
|
string |
The type of the album: one of 'album', 'single', or 'compilation'. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request
Query
| Name | Data Type | Description |
|---|---|---|
market
|
string |
The market (an ISO 3166-1 alpha-2 country code) |
ids
|
string |
A comma-separated list of IDs |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
body
|
object |
Properties
albums
|
array [album] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request
Path
| Name | Data Type | Description |
|---|---|---|
id
|
string |
The Spotify ID for the artist |
Query
| Name | Data Type | Description |
|---|---|---|
market
|
string |
The market (an ISO 3166-1 alpha-2 country code) |
album_type
|
string |
Filter by album types |
offset
|
integer Default value: 0
|
The index of the first item to return |
limit
|
integer Default value: 20Minimum: 0 Maximum: 50 |
The maximum number of items to return |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
album-simple-page
|
object |
Properties
total
|
integer |
The total number of items available to return. |
|||||||||||||||||||||||||||||||||||||||||||||||
previous
|
string |
URL to the previous page of items. (null if none) |
|||||||||||||||||||||||||||||||||||||||||||||||
offset
|
integer |
The offset of the items returned (as set in the query or by default). |
|||||||||||||||||||||||||||||||||||||||||||||||
next
|
string |
URL to the next page of items. (null if none) |
|||||||||||||||||||||||||||||||||||||||||||||||
limit
|
integer |
The maximum number of items in the response (as set in the query or by default). |
|||||||||||||||||||||||||||||||||||||||||||||||
items
|
array [album-simple] |
The requested data. |
|||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||
href
|
string |
A link to the Web API endpoint returning the full result of the request. |
|||||||||||||||||||||||||||||||||||||||||||||||
Request
Path
| Name | Data Type | Description |
|---|---|---|
id
|
string |
The Spotify ID for the artist |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
body
|
object |
Properties
artists
|
array [artist] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request
Path
| Name | Data Type | Description |
|---|---|---|
id
|
string |
The Spotify ID for the artist |
Query
| Name | Data Type | Description |
|---|---|---|
country
|
string |
The country (an ISO 3166-1 alpha-2 country code) |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
body
|
object |
Properties
tracks
|
array [track] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request
Path
| Name | Data Type | Description |
|---|---|---|
id
|
string |
The Spotify ID for the artist |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
artist
|
object |
Properties
uri
|
string |
The Spotify URI for the artist. |
|||||||||||||
type
|
string |
The object type: 'artist' |
|||||||||||||
popularity
|
integer |
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. |
|||||||||||||
name
|
string |
The name of the artist. |
|||||||||||||
images
|
array [image] |
Images of the artist in various sizes, widest first. |
|||||||||||||
Properties
|
|||||||||||||||
id
|
string |
The Spotify ID for the artist. |
|||||||||||||
href
|
string |
A link to the Web API endpoint providing full details of the artist. |
|||||||||||||
genres
|
array [string] |
A list of the genres the artist is associated with. For example: 'Prog Rock', 'Post-Grunge'. (If not yet classified, the array is empty.) |
|||||||||||||
followers
|
followers | ||||||||||||||
Properties
|
|||||||||||||||
external_urls
|
object |
Known external URLs for this artist. |
|||||||||||||
Request
Query
| Name | Data Type | Description |
|---|---|---|
ids
|
string |
A comma-separated list of IDs |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
body
|
object |
Properties
artists
|
array [artist] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request
Path
| Name | Data Type | Description |
|---|---|---|
category_id
|
string |
The Spotify ID of the category you wish to fetch. |
Query
| Name | Data Type | Description |
|---|---|---|
country
|
string |
The country (an ISO 3166-1 alpha-2 country code) |
offset
|
integer Default value: 0
|
The index of the first item to return |
limit
|
integer Default value: 20Minimum: 0 Maximum: 50 |
The maximum number of items to return |
Header
| Name | Data Type | Description |
|---|---|---|
Accept
|
string |
It is used to set specified media type. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
body
|
object |
Properties
playlists
|
playlist-simple-page | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request
Path
| Name | Data Type | Description |
|---|---|---|
category_id
|
string |
The Spotify ID of the category you wish to fetch. |
Query
| Name | Data Type | Description |
|---|---|---|
locale
|
string |
The desired language, consisting of an ISO 639 language code and an ISO 3166-1 alpha-2 country code, joined by an underscore. For example: es_MX, meaning "Spanish (Mexico)". |
country
|
string |
The country (an ISO 3166-1 alpha-2 country code) |
Header
| Name | Data Type | Description |
|---|---|---|
Accept
|
string |
It is used to set specified media type. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
category
|
object |
Properties
name
|
string |
The name of the category. |
|||||||||||||
id
|
string |
The Spotify category ID of the category. |
|||||||||||||
icons
|
array [image] | ||||||||||||||
Properties
|
|||||||||||||||
href
|
string |
A link to the Web API endpoint returning full details of the category. |
|||||||||||||
Request
Query
| Name | Data Type | Description |
|---|---|---|
locale
|
string |
The desired language, consisting of an ISO 639 language code and an ISO 3166-1 alpha-2 country code, joined by an underscore. For example: es_MX, meaning "Spanish (Mexico)". |
country
|
string |
The country (an ISO 3166-1 alpha-2 country code) |
offset
|
integer Default value: 0
|
The index of the first item to return |
limit
|
integer Default value: 20Minimum: 0 Maximum: 50 |
The maximum number of items to return |
Header
| Name | Data Type | Description |
|---|---|---|
Accept
|
string |
It is used to set specified media type. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
category-page
|
object |
Properties
total
|
integer |
The total number of items available to return. |
||||||||||||||||||||||||||||||||
previous
|
string |
URL to the previous page of items. (null if none) |
||||||||||||||||||||||||||||||||
offset
|
integer |
The offset of the items returned (as set in the query or by default). |
||||||||||||||||||||||||||||||||
next
|
string |
URL to the next page of items. (null if none) |
||||||||||||||||||||||||||||||||
limit
|
integer |
The maximum number of items in the response (as set in the query or by default). |
||||||||||||||||||||||||||||||||
items
|
array [category] |
The requested data. |
||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||
href
|
string |
A link to the Web API endpoint returning the full result of the request. |
||||||||||||||||||||||||||||||||
Request
Query
| Name | Data Type | Description |
|---|---|---|
timestamp
|
string |
A timestamp in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss) with the user's local time to get results tailored to a specific date and time in the day. If not provided, it defaults to the current UTC time. Example: "2014-10-23T09:00:00" for a user whose local time is 9AM. |
locale
|
string |
The desired language, consisting of an ISO 639 language code and an ISO 3166-1 alpha-2 country code, joined by an underscore. For example: es_MX, meaning "Spanish (Mexico)". |
country
|
string |
The country (an ISO 3166-1 alpha-2 country code) |
offset
|
integer Default value: 0
|
The index of the first item to return |
limit
|
integer Default value: 20Minimum: 0 Maximum: 50 |
The maximum number of items to return |
Header
| Name | Data Type | Description |
|---|---|---|
Accept
|
string |
It is used to set specified media type. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
featured-playlists
|
object |
Properties
playlists
|
playlist-simple-page | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
message
|
string |
A sentence describing the context for the featured playlists. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request
Query
| Name | Data Type | Description |
|---|---|---|
country
|
string |
The country (an ISO 3166-1 alpha-2 country code) |
offset
|
integer Default value: 0
|
The index of the first item to return |
limit
|
integer Default value: 20Minimum: 0 Maximum: 50 |
The maximum number of items to return |
Header
| Name | Data Type | Description |
|---|---|---|
Accept
|
string |
It is used to set specified media type. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
album-simple-page
|
object |
Properties
total
|
integer |
The total number of items available to return. |
|||||||||||||||||||||||||||||||||||||||||||||||
previous
|
string |
URL to the previous page of items. (null if none) |
|||||||||||||||||||||||||||||||||||||||||||||||
offset
|
integer |
The offset of the items returned (as set in the query or by default). |
|||||||||||||||||||||||||||||||||||||||||||||||
next
|
string |
URL to the next page of items. (null if none) |
|||||||||||||||||||||||||||||||||||||||||||||||
limit
|
integer |
The maximum number of items in the response (as set in the query or by default). |
|||||||||||||||||||||||||||||||||||||||||||||||
items
|
array [album-simple] |
The requested data. |
|||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||
href
|
string |
A link to the Web API endpoint returning the full result of the request. |
|||||||||||||||||||||||||||||||||||||||||||||||
Request
Query
| Name | Data Type | Description |
|---|---|---|
ids
|
string |
A comma-separated string of the artists or users ids. |
type
|
string Allowed values: - artist- user |
The type to follow. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
body
|
array [boolean] |
Request
Query
| Name | Data Type | Description |
|---|---|---|
ids
|
string |
A comma-separated list of the artists or users ids |
type
|
string Allowed values: - artist- user |
The type to unfollow. |
Responses
Request
Query
| Name | Data Type | Description |
|---|---|---|
after
|
string |
The last artist ID retrieved from the previous request. |
limit
|
integer Default value: 20Minimum: 0 Maximum: 50 |
The maximum number of items to return |
type
|
string Allowed values: - artist |
The ID type, currently only artist is supported. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
user-followed
|
object |
Properties
artists
|
Request
Query
| Name | Data Type | Description |
|---|---|---|
ids
|
string |
A comma-separated list of the artists or users ids |
type
|
string Allowed values: - artist- user |
The type to follow. |
Responses
Request
Query
| Name | Data Type | Description |
|---|---|---|
ids
|
string |
A comma-separated list of IDs |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
body
|
array [boolean] |
Request
Query
| Name | Data Type | Description |
|---|---|---|
ids
|
string |
A comma-separated list of IDs |
Header
| Name | Data Type | Description |
|---|---|---|
Accept
|
string |
It is used to set specified media type. |
Responses
Request
Query
| Name | Data Type | Description |
|---|---|---|
market
|
string |
The market (an ISO 3166-1 alpha-2 country code) |
offset
|
integer Default value: 0
|
The index of the first item to return |
limit
|
integer Default value: 20Minimum: 0 Maximum: 50 |
The maximum number of items to return |
Header
| Name | Data Type | Description |
|---|---|---|
Accept
|
string |
It is used to set specified media type. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
saved-track-page
|
object |
Properties
total
|
integer |
The total number of items available to return. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
previous
|
string |
URL to the previous page of items. (null if none) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
|
integer |
The offset of the items returned (as set in the query or by default). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
next
|
string |
URL to the next page of items. (null if none) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
limit
|
integer |
The maximum number of items in the response (as set in the query or by default). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items
|
array [saved-track] |
The requested data. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href
|
string |
A link to the Web API endpoint returning the full result of the request. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request
Query
| Name | Data Type | Description |
|---|---|---|
ids
|
string |
A comma-separated list of IDs |
Header
| Name | Data Type | Description |
|---|---|---|
Accept
|
string |
It is used to set specified media type. |
Responses
Responses
Body
| Name | Data Type | Description |
|---|---|---|
current-user-profile
|
object |
Properties
uri
|
string |
The Spotify URI for the user. |
||||||||||
type
|
string |
The object type: 'user' |
||||||||||
product
|
string |
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 scope. |
||||||||||
id
|
string |
The Spotify ID for this user. |
||||||||||
href
|
string |
A link to the Web API endpoint for this user. |
||||||||||
followers
|
followers | |||||||||||
Properties
|
||||||||||||
external_urls
|
object |
Known external URLs for this user. |
||||||||||
email
|
string |
The user's email address, as entered by the user when creating their account. 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 scope. |
||||||||||
displayName
|
string |
The name displayed on the user's profile. |
||||||||||
country
|
string |
The country of the user, as set in the user's account profile. An ISO 3166-1 alpha-2 country code. This field is only available when the current user has granted access to the user-read-private scope. |
||||||||||
birthdate
|
string |
The user's date-of-birth. This field is only available when the current user has granted access to the user-read-birthdate scope. |
||||||||||
Request
Query
| Name | Data Type | Description |
|---|---|---|
market
|
string |
The market (an ISO 3166-1 alpha-2 country code). If given, only items with content playable in that market will be returned. |
type
|
string |
A comma-separated list of item types to search across. Search results will include hits from all the specified item types; for example q=name:abacab&type=album,track will return both albums and tracks with "abacab" in their name. |
q
|
string |
The search query's keywords (and optional field filters). The search is not case-sensitive: 'roadhouse' will match 'Roadhouse', 'roadHouse', etc. Keywords will be matched in any order unless surrounded by quotes, thus q=roadhouse&20blues will match both 'Blues Roadhouse' and 'Roadhouse of the Blues'. Quotation marks can be used to limit the match to a phrase: q=roadhouse&20blues will match 'My Roadhouse Blues' but not 'Roadhouse of the Blues'. By default, results are returned when a match is found in any field of the target object type. Searches can be made more specific by specifying an album, artist or track field filter. For example q=album:gold%20artist:abba&type=album will search for albums with the text 'gold' in the album name and the text 'abba' in an artist name. Other possible field filters, depending on object types being searched, include year, genre, upc, and isrc. For example, q=damian%20genre:reggae-pop&type=artist. The asterisk (*) character can, with some limitations, be used as a wildcard (maximum: 2 per query). It will match a variable number of non-white-space characters. It cannot be used in a quoted phrase, in a field filter, or as the first character of the keyword string. Searching for playlists will return results matching the playlist's name and/or description. |
offset
|
integer Default value: 0
|
The index of the first item to return |
limit
|
integer Default value: 20Minimum: 0 Maximum: 50 |
The maximum number of items to return |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
search
|
object |
Properties
tracks
|
||
artists
|
||
albums
|
Request
Path
| Name | Data Type | Description |
|---|---|---|
id
|
string |
Query
| Name | Data Type | Description |
|---|---|---|
market
|
string |
The market (an ISO 3166-1 alpha-2 country code) |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
track
|
object |
Properties
uri
|
string |
The Spotify URI for the track. |
|||||||||||||||||||||||||||||||||||||||||||||||
type
|
string |
The object type: 'track'. |
|||||||||||||||||||||||||||||||||||||||||||||||
track_number
|
integer |
The number of the track. If an album has several discs, the track number is the number on the specified disc. |
|||||||||||||||||||||||||||||||||||||||||||||||
preview_url
|
string |
A URL to a 30 second preview (MP3 format) of the track. |
|||||||||||||||||||||||||||||||||||||||||||||||
name
|
string |
The name of the track. |
|||||||||||||||||||||||||||||||||||||||||||||||
linked_from
|
|||||||||||||||||||||||||||||||||||||||||||||||||
is_playable
|
boolean |
Part of the response when Track Relinking is applied. If true, the track is playable in the given market. Otherwise false. |
|||||||||||||||||||||||||||||||||||||||||||||||
id
|
string |
The Spotify ID for the track. |
|||||||||||||||||||||||||||||||||||||||||||||||
href
|
string |
A link to the Web API endpoint providing full details of the track. |
|||||||||||||||||||||||||||||||||||||||||||||||
external_urls
|
object |
Known external URLs for this track. |
|||||||||||||||||||||||||||||||||||||||||||||||
external_ids
|
object |
Known external IDs for the track. |
|||||||||||||||||||||||||||||||||||||||||||||||
explicit
|
boolean |
Whether or not the track has explicit lyrics (true = yes it does; false = no it does not OR unknown). |
|||||||||||||||||||||||||||||||||||||||||||||||
duration_ms
|
integer |
The track length in milliseconds. |
|||||||||||||||||||||||||||||||||||||||||||||||
disc_number
|
integer |
The disc number (usually 1 unless the album consists of more than one disc). |
|||||||||||||||||||||||||||||||||||||||||||||||
available_markets
|
array [string] |
A list of the countries in which the track can be played, identified by their ISO 3166-1 alpha-2 code. |
|||||||||||||||||||||||||||||||||||||||||||||||
artists
|
array [artist-simple] |
The artists who performed the track. Each artist object includes a link in href to more detailed information about the artist. |
|||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||
album
|
album-simple | ||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||
Request
Query
| Name | Data Type | Description |
|---|---|---|
market
|
string |
The market (an ISO 3166-1 alpha-2 country code) |
ids
|
string |
A comma-separated list of IDs |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
body
|
object |
Properties
tracks
|
array [track] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request
Path
| Name | Data Type | Description |
|---|---|---|
playlist_id
|
string |
The Spotify playlist ID. |
user_id
|
string |
The user's Spotify user ID. |
Query
| Name | Data Type | Description |
|---|---|---|
ids
|
string |
A comma-separated list of users ids |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
body
|
array [boolean] |
Request
Path
| Name | Data Type | Description |
|---|---|---|
playlist_id
|
string |
The Spotify playlist ID. |
user_id
|
string |
The user's Spotify user ID. |
Responses
Request
Path
| Name | Data Type | Description |
|---|---|---|
playlist_id
|
string |
The Spotify playlist ID. |
user_id
|
string |
The user's Spotify user ID. |
Body
| Name | Data Type | Description |
|---|---|---|
body
|
object |
Properties
public
|
boolean |
Responses
Request
Path
| Name | Data Type | Description |
|---|---|---|
playlist_id
|
string |
The Spotify playlist ID. |
user_id
|
string |
The user's Spotify user ID. |
Header
| Name | Data Type | Description |
|---|---|---|
Accept
|
string |
It is used to set specified media type. |
Body
| Name | Data Type | Description |
|---|---|---|
body
|
object |
Properties
tracks
|
array [] |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
playlist-snapshot
|
object |
Properties
snapshot_id
|
string |
The version identifier for the modified playlist. Can be supplied in other requests to target a specific playlist version. |
Request
Path
| Name | Data Type | Description |
|---|---|---|
playlist_id
|
string |
The Spotify playlist ID. |
user_id
|
string |
The user's Spotify user ID. |
Query
| Name | Data Type | Description |
|---|---|---|
market
|
string |
The market (an ISO 3166-1 alpha-2 country code) |
fields
|
string |
A comma-separated list of fields to filter query |
offset
|
integer Default value: 0
|
The index of the first item to return |
limit
|
integer Default value: 20Minimum: 0 Maximum: 50 |
The maximum number of items to return |
Header
| Name | Data Type | Description |
|---|---|---|
Accept
|
string |
It is used to set specified media type. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
playlist-track-page
|
object |
Properties
total
|
integer |
The total number of items available to return. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
previous
|
string |
URL to the previous page of items. (null if none) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
|
integer |
The offset of the items returned (as set in the query or by default). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
next
|
string |
URL to the next page of items. (null if none) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
limit
|
integer |
The maximum number of items in the response (as set in the query or by default). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items
|
array [playlist-track] |
The requested data. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href
|
string |
A link to the Web API endpoint returning the full result of the request. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request
Path
| Name | Data Type | Description |
|---|---|---|
playlist_id
|
string |
The Spotify playlist ID. |
user_id
|
string |
The user's Spotify user ID. |
Query
| Name | Data Type | Description |
|---|---|---|
uris
|
string |
A comma-separated list of Spotify track URIs to add. A maximum of 100 tracks can be added in one request. |
position
|
integer |
The position to insert the tracks, a zero-based index |
Header
| Name | Data Type | Description |
|---|---|---|
Accept
|
string |
It is used to set specified media type. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
playlist-snapshot
|
object |
Properties
snapshot_id
|
string |
The version identifier for the modified playlist. Can be supplied in other requests to target a specific playlist version. |
Request
Path
| Name | Data Type | Description |
|---|---|---|
playlist_id
|
string |
The Spotify playlist ID. |
user_id
|
string |
The user's Spotify user ID. |
Header
| Name | Data Type | Description |
|---|---|---|
Accept
|
string |
It is used to set specified media type. |
Body
| Name | Data Type | Description |
|---|---|---|
body
|
object |
Properties
uris
|
array [] |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
playlist-snapshot
|
object |
Properties
snapshot_id
|
string |
The version identifier for the modified playlist. Can be supplied in other requests to target a specific playlist version. |
Request
Path
| Name | Data Type | Description |
|---|---|---|
playlist_id
|
string |
The Spotify playlist ID. |
user_id
|
string |
The user's Spotify user ID. |
Query
| Name | Data Type | Description |
|---|---|---|
market
|
string |
The market (an ISO 3166-1 alpha-2 country code) |
fields
|
string |
A comma-separated list of fields to filter query |
Header
| Name | Data Type | Description |
|---|---|---|
Accept
|
string |
It is used to set specified media type. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
playlist
|
object |
Properties
uri
|
string |
Spotify URI of the playlist. |
||||||||||||||||||||||||||||||||||||||||||||
type
|
string |
The object type: 'playlist'. |
||||||||||||||||||||||||||||||||||||||||||||
tracks
|
playlist-track-page | |||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||
snapshot_id
|
string |
The version identifier for the current playlist. Can be supplied in other requests to target a specific playlist version |
||||||||||||||||||||||||||||||||||||||||||||
public
|
boolean |
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. |
||||||||||||||||||||||||||||||||||||||||||||
owner
|
user-profile | |||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||
name
|
string |
The name of the playlist. |
||||||||||||||||||||||||||||||||||||||||||||
images
|
array [image] |
The cover art for the album in various sizes, widest first. |
||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||
id
|
string |
The Spotify ID of the playlist. |
||||||||||||||||||||||||||||||||||||||||||||
href
|
string |
A link to the Web API endpoint providing full details of the playlist. |
||||||||||||||||||||||||||||||||||||||||||||
followers
|
||||||||||||||||||||||||||||||||||||||||||||||
external_urls
|
object |
Known external URLs for this album. |
||||||||||||||||||||||||||||||||||||||||||||
description
|
string |
The playlist description. Only returned for modified, verified playlists, otherwise null. |
||||||||||||||||||||||||||||||||||||||||||||
collaborative
|
boolean |
True if the owner allows other users to modify the playlist. |
||||||||||||||||||||||||||||||||||||||||||||
Request
Path
| Name | Data Type | Description |
|---|---|---|
playlist_id
|
string |
The Spotify playlist ID. |
user_id
|
string |
The user's Spotify user ID. |
Header
| Name | Data Type | Description |
|---|---|---|
Accept
|
string |
It is used to set specified media type. |
Body
| Name | Data Type | Description |
|---|---|---|
body
|
object |
Properties
public
|
boolean | |
name
|
string |
Responses
Request
Path
| Name | Data Type | Description |
|---|---|---|
user_id
|
string |
The user's Spotify user ID. |
Query
| Name | Data Type | Description |
|---|---|---|
offset
|
integer Default value: 0
|
The index of the first item to return |
limit
|
integer Default value: 20Minimum: 0 Maximum: 50 |
The maximum number of items to return |
Header
| Name | Data Type | Description |
|---|---|---|
Accept
|
string |
It is used to set specified media type. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
playlist-simple-page
|
object |
Properties
total
|
integer |
The total number of items available to return. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
previous
|
string |
URL to the previous page of items. (null if none) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
|
integer |
The offset of the items returned (as set in the query or by default). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
next
|
string |
URL to the next page of items. (null if none) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
limit
|
integer |
The maximum number of items in the response (as set in the query or by default). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items
|
array [playlist-simple] |
The requested data. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href
|
string |
A link to the Web API endpoint returning the full result of the request. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request
Path
| Name | Data Type | Description |
|---|---|---|
user_id
|
string |
The user's Spotify user ID. |
Header
| Name | Data Type | Description |
|---|---|---|
Accept
|
string |
It is used to set specified media type. |
Body
| Name | Data Type | Description |
|---|---|---|
body
|
object |
Properties
public
|
boolean | |
name
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
playlist
|
object |
Properties
uri
|
string |
Spotify URI of the playlist. |
||||||||||||||||||||||||||||||||||||||||||||
type
|
string |
The object type: 'playlist'. |
||||||||||||||||||||||||||||||||||||||||||||
tracks
|
playlist-track-page | |||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||
snapshot_id
|
string |
The version identifier for the current playlist. Can be supplied in other requests to target a specific playlist version |
||||||||||||||||||||||||||||||||||||||||||||
public
|
boolean |
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. |
||||||||||||||||||||||||||||||||||||||||||||
owner
|
user-profile | |||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||
name
|
string |
The name of the playlist. |
||||||||||||||||||||||||||||||||||||||||||||
images
|
array [image] |
The cover art for the album in various sizes, widest first. |
||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||
id
|
string |
The Spotify ID of the playlist. |
||||||||||||||||||||||||||||||||||||||||||||
href
|
string |
A link to the Web API endpoint providing full details of the playlist. |
||||||||||||||||||||||||||||||||||||||||||||
followers
|
||||||||||||||||||||||||||||||||||||||||||||||
external_urls
|
object |
Known external URLs for this album. |
||||||||||||||||||||||||||||||||||||||||||||
description
|
string |
The playlist description. Only returned for modified, verified playlists, otherwise null. |
||||||||||||||||||||||||||||||||||||||||||||
collaborative
|
boolean |
True if the owner allows other users to modify the playlist. |
||||||||||||||||||||||||||||||||||||||||||||
Request
Path
| Name | Data Type | Description |
|---|---|---|
user_id
|
string |
The user's Spotify user ID. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
user-profile
|
object |
Properties
uri
|
string |
The Spotify URI for the user. |
||||||||||
type
|
string |
The object type: 'user' |
||||||||||
id
|
string |
The Spotify ID for this user. |
||||||||||
href
|
string |
A link to the Web API endpoint for this user. |
||||||||||
followers
|
followers | |||||||||||
Properties
|
||||||||||||
external_urls
|
object |
Known external URLs for this user. |
||||||||||
displayName
|
string |
The name displayed on the user's profile. |
||||||||||
Models
Properties
| Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
uri
|
string |
The Spotify URI for the album. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
|
string |
The object type: 'album'. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tracks
|
track-simple-page | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
release_date_precision
|
string |
The precision with which release_date value is known: 'year', 'month', or 'day'. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
release_date
|
string |
The date the album was first released, for example '1981-12-15'. Depending on the precision, it might be shown as '1981' or '1981-12'. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
popularity
|
integer |
The popularity of the album. The value will be between 0 and 100, with 100 being the most popular. The popularity is calculated from the popularity of the album's individual tracks. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name
|
string |
The name of the album. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
images
|
array [image] |
The cover art for the album in various sizes, widest first. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string |
The Spotify ID for the album. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href
|
string |
A link to the Web API endpoint providing full details of the album. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
genres
|
array [string] |
A list of the genres used to classify the album. For example: 'Prog Rock', 'Post-Grunge'. (If not yet classified, the array is empty.) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
external_urls
|
object |
Known external URLs for this album. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
external_ids
|
object |
Known external IDs for this album. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
copyrights
|
array [object] |
The copyright statements of the album. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
available_markets
|
array [string] |
The markets in which the album is available: ISO 3166-1 alpha-2 country codes. Note that an album is considered available in a market when at least 1 of its tracks is available in that market. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
artists
|
array [artist] |
The artists of the album. Each artist object includes a link in href to more detailed information about the artist. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
album_type
|
string |
The type of the album: one of 'album', 'single', or 'compilation'. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
| Name | Data Type | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
uri
|
string |
The Spotify URI for the album. |
|||||||||||||
type
|
string |
The object type: 'album'. |
|||||||||||||
name
|
string |
The name of the album. |
|||||||||||||
images
|
array [image] |
The cover art for the album in various sizes, widest first. |
|||||||||||||
Properties
|
|||||||||||||||
id
|
string |
The Spotify ID for the album. |
|||||||||||||
href
|
string |
A link to the Web API endpoint providing full details of the album. |
|||||||||||||
external_urls
|
object |
Known external URLs for this album. |
|||||||||||||
available_markets
|
array [string] |
The markets in which the album is available: ISO 3166-1 alpha-2 country codes. Note that an album is considered available in a market when at least 1 of its tracks is available in that market. |
|||||||||||||
album_type
|
string |
The type of the album: one of 'album', 'single', or 'compilation'. |
|||||||||||||
Properties
| Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
total
|
integer |
The total number of items available to return. |
|||||||||||||||||||||||||||||||||||||||||||||||
previous
|
string |
URL to the previous page of items. (null if none) |
|||||||||||||||||||||||||||||||||||||||||||||||
offset
|
integer |
The offset of the items returned (as set in the query or by default). |
|||||||||||||||||||||||||||||||||||||||||||||||
next
|
string |
URL to the next page of items. (null if none) |
|||||||||||||||||||||||||||||||||||||||||||||||
limit
|
integer |
The maximum number of items in the response (as set in the query or by default). |
|||||||||||||||||||||||||||||||||||||||||||||||
items
|
array [album-simple] |
The requested data. |
|||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||
href
|
string |
A link to the Web API endpoint returning the full result of the request. |
|||||||||||||||||||||||||||||||||||||||||||||||
Properties
| Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
total
|
integer |
The total number of items available to return. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
previous
|
string |
URL to the previous page of items. (null if none) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
|
integer |
The offset of the items returned (as set in the query or by default). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
next
|
string |
URL to the next page of items. (null if none) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
limit
|
integer |
The maximum number of items in the response (as set in the query or by default). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items
|
array [track-simple] |
The requested data. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href
|
string |
A link to the Web API endpoint returning the full result of the request. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
| Name | Data Type | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
uri
|
string |
The Spotify URI for the artist. |
|||||||||||||
type
|
string |
The object type: 'artist' |
|||||||||||||
popularity
|
integer |
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. |
|||||||||||||
name
|
string |
The name of the artist. |
|||||||||||||
images
|
array [image] |
Images of the artist in various sizes, widest first. |
|||||||||||||
Properties
|
|||||||||||||||
id
|
string |
The Spotify ID for the artist. |
|||||||||||||
href
|
string |
A link to the Web API endpoint providing full details of the artist. |
|||||||||||||
genres
|
array [string] |
A list of the genres the artist is associated with. For example: 'Prog Rock', 'Post-Grunge'. (If not yet classified, the array is empty.) |
|||||||||||||
followers
|
followers | ||||||||||||||
Properties
|
|||||||||||||||
external_urls
|
object |
Known external URLs for this artist. |
|||||||||||||
Properties
| Name | Data Type | Description |
|---|---|---|
uri
|
string |
The Spotify URI for the artist. |
type
|
string |
The object type: 'artist' |
name
|
string |
The name of the artist. |
id
|
string |
The Spotify ID for the artist. |
href
|
string |
A link to the Web API endpoint providing full details of the artist. |
external_urls
|
object |
Known external URLs for this artist. |
Properties
| Name | Data Type | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name
|
string |
The name of the category. |
|||||||||||||
id
|
string |
The Spotify category ID of the category. |
|||||||||||||
icons
|
array [image] | ||||||||||||||
Properties
|
|||||||||||||||
href
|
string |
A link to the Web API endpoint returning full details of the category. |
|||||||||||||
Properties
| Name | Data Type | Description | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
total
|
integer |
The total number of items available to return. |
||||||||||||||||||||||||||||||||
previous
|
string |
URL to the previous page of items. (null if none) |
||||||||||||||||||||||||||||||||
offset
|
integer |
The offset of the items returned (as set in the query or by default). |
||||||||||||||||||||||||||||||||
next
|
string |
URL to the next page of items. (null if none) |
||||||||||||||||||||||||||||||||
limit
|
integer |
The maximum number of items in the response (as set in the query or by default). |
||||||||||||||||||||||||||||||||
items
|
array [category] |
The requested data. |
||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||
href
|
string |
A link to the Web API endpoint returning the full result of the request. |
||||||||||||||||||||||||||||||||
Properties
| Name | Data Type | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
uri
|
string |
The Spotify URI for the user. |
||||||||||
type
|
string |
The object type: 'user' |
||||||||||
product
|
string |
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 scope. |
||||||||||
id
|
string |
The Spotify ID for this user. |
||||||||||
href
|
string |
A link to the Web API endpoint for this user. |
||||||||||
followers
|
followers | |||||||||||
Properties
|
||||||||||||
external_urls
|
object |
Known external URLs for this user. |
||||||||||
email
|
string |
The user's email address, as entered by the user when creating their account. 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 scope. |
||||||||||
displayName
|
string |
The name displayed on the user's profile. |
||||||||||
country
|
string |
The country of the user, as set in the user's account profile. An ISO 3166-1 alpha-2 country code. This field is only available when the current user has granted access to the user-read-private scope. |
||||||||||
birthdate
|
string |
The user's date-of-birth. This field is only available when the current user has granted access to the user-read-birthdate scope. |
||||||||||
Properties
| Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
playlists
|
playlist-simple-page | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
message
|
string |
A sentence describing the context for the featured playlists. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Information about the followers of the artist.
Properties
| Name | Data Type | Description |
|---|---|---|
total
|
integer |
The total number of followers. |
href
|
string |
A link to the Web API endpoint providing full details of the followers; null if not available. |
Properties
| Name | Data Type | Description |
|---|---|---|
width
|
integer |
The image width in pixels. If unknown: null or not returned. |
url
|
string |
The source URL of the image. |
height
|
integer |
The image height in pixels. If unknown: null or not returned. |
Properties
| Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
uri
|
string |
Spotify URI of the playlist. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type
|
string |
The object type: 'playlist'. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tracks
|
playlist-track-page | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
snapshot_id
|
string |
The version identifier for the current playlist. Can be supplied in other requests to target a specific playlist version |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
public
|
boolean |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
owner
|
user-profile | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name
|
string |
The name of the playlist. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
images
|
array [image] |
The cover art for the album in various sizes, widest first. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string |
The Spotify ID of the playlist. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href
|
string |
A link to the Web API endpoint providing full details of the playlist. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
followers
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
external_urls
|
object |
Known external URLs for this album. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description
|
string |
The playlist description. Only returned for modified, verified playlists, otherwise null. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
collaborative
|
boolean |
True if the owner allows other users to modify the playlist. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
| Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
uri
|
string |
Spotify URI of the playlist. |
||||||||||||||||||||||||||||||||||||||
type
|
string |
The object type: 'playlist'. |
||||||||||||||||||||||||||||||||||||||
tracks
|
||||||||||||||||||||||||||||||||||||||||
snapshot_id
|
string |
The version identifier for the current playlist. Can be supplied in other requests to target a specific playlist version |
||||||||||||||||||||||||||||||||||||||
public
|
boolean |
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. |
||||||||||||||||||||||||||||||||||||||
owner
|
user-profile | |||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
name
|
string |
The name of the playlist. |
||||||||||||||||||||||||||||||||||||||
images
|
array [image] |
The cover art for the album in various sizes, widest first. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
id
|
string |
The Spotify ID of the playlist. |
||||||||||||||||||||||||||||||||||||||
href
|
string |
A link to the Web API endpoint providing full details of the playlist. |
||||||||||||||||||||||||||||||||||||||
external_urls
|
object |
Known external URLs for this album. |
||||||||||||||||||||||||||||||||||||||
collaborative
|
boolean |
True if the owner allows other users to modify the playlist. |
||||||||||||||||||||||||||||||||||||||
Properties
| Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
total
|
integer |
The total number of items available to return. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
previous
|
string |
URL to the previous page of items. (null if none) |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
|
integer |
The offset of the items returned (as set in the query or by default). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
next
|
string |
URL to the next page of items. (null if none) |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
limit
|
integer |
The maximum number of items in the response (as set in the query or by default). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items
|
array [playlist-simple] |
The requested data. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href
|
string |
A link to the Web API endpoint returning the full result of the request. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
| Name | Data Type | Description |
|---|---|---|
snapshot_id
|
string |
The version identifier for the modified playlist. Can be supplied in other requests to target a specific playlist version. |
Properties
| Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
track
|
track | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_local
|
boolean |
Whether this track is a local file or not. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
added_by
|
user-profile | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
added_at
|
string |
The date and time the track was added in ISO 8601 format. Note that some very old playlists may return null in this field. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
| Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
total
|
integer |
The total number of items available to return. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
previous
|
string |
URL to the previous page of items. (null if none) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
|
integer |
The offset of the items returned (as set in the query or by default). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
next
|
string |
URL to the next page of items. (null if none) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
limit
|
integer |
The maximum number of items in the response (as set in the query or by default). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items
|
array [playlist-track] |
The requested data. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href
|
string |
A link to the Web API endpoint returning the full result of the request. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
| Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
track
|
track | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
added_at
|
string |
The date and time the track was added in ISO 8601 format. Note that some very old playlists may return null in this field. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
| Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
total
|
integer |
The total number of items available to return. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
previous
|
string |
URL to the previous page of items. (null if none) |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
|
integer |
The offset of the items returned (as set in the query or by default). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
next
|
string |
URL to the next page of items. (null if none) |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
limit
|
integer |
The maximum number of items in the response (as set in the query or by default). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items
|
array [saved-track] |
The requested data. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href
|
string |
A link to the Web API endpoint returning the full result of the request. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
| Name | Data Type | Description |
|---|---|---|
tracks
|
||
artists
|
||
albums
|
Properties
| Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
uri
|
string |
The Spotify URI for the track. |
|||||||||||||||||||||||||||||||||||||||||||||||
type
|
string |
The object type: 'track'. |
|||||||||||||||||||||||||||||||||||||||||||||||
track_number
|
integer |
The number of the track. If an album has several discs, the track number is the number on the specified disc. |
|||||||||||||||||||||||||||||||||||||||||||||||
preview_url
|
string |
A URL to a 30 second preview (MP3 format) of the track. |
|||||||||||||||||||||||||||||||||||||||||||||||
name
|
string |
The name of the track. |
|||||||||||||||||||||||||||||||||||||||||||||||
linked_from
|
|||||||||||||||||||||||||||||||||||||||||||||||||
is_playable
|
boolean |
Part of the response when Track Relinking is applied. If true, the track is playable in the given market. Otherwise false. |
|||||||||||||||||||||||||||||||||||||||||||||||
id
|
string |
The Spotify ID for the track. |
|||||||||||||||||||||||||||||||||||||||||||||||
href
|
string |
A link to the Web API endpoint providing full details of the track. |
|||||||||||||||||||||||||||||||||||||||||||||||
external_urls
|
object |
Known external URLs for this track. |
|||||||||||||||||||||||||||||||||||||||||||||||
external_ids
|
object |
Known external IDs for the track. |
|||||||||||||||||||||||||||||||||||||||||||||||
explicit
|
boolean |
Whether or not the track has explicit lyrics (true = yes it does; false = no it does not OR unknown). |
|||||||||||||||||||||||||||||||||||||||||||||||
duration_ms
|
integer |
The track length in milliseconds. |
|||||||||||||||||||||||||||||||||||||||||||||||
disc_number
|
integer |
The disc number (usually 1 unless the album consists of more than one disc). |
|||||||||||||||||||||||||||||||||||||||||||||||
available_markets
|
array [string] |
A list of the countries in which the track can be played, identified by their ISO 3166-1 alpha-2 code. |
|||||||||||||||||||||||||||||||||||||||||||||||
artists
|
array [artist-simple] |
The artists who performed the track. Each artist object includes a link in href to more detailed information about the artist. |
|||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||
album
|
album-simple | ||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||
Properties
| Name | Data Type | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
uri
|
string |
The Spotify URI for the track. |
||||||||||||||||||||||
type
|
string |
The object type: 'track'. |
||||||||||||||||||||||
track_number
|
integer |
The number of the track. If an album has several discs, the track number is the number on the specified disc. |
||||||||||||||||||||||
preview_url
|
string |
A URL to a 30 second preview (MP3 format) of the track. |
||||||||||||||||||||||
name
|
string |
The name of the track. |
||||||||||||||||||||||
linked_from
|
||||||||||||||||||||||||
is_playable
|
boolean |
Part of the response when Track Relinking is applied. If true, the track is playable in the given market. Otherwise false. |
||||||||||||||||||||||
id
|
string |
The Spotify ID for the track. |
||||||||||||||||||||||
href
|
string |
A link to the Web API endpoint providing full details of the track. |
||||||||||||||||||||||
external_urls
|
object |
Known external URLs for this track. |
||||||||||||||||||||||
explicit
|
boolean |
Whether or not the track has explicit lyrics (true = yes it does; false = no it does not OR unknown). |
||||||||||||||||||||||
duration_ms
|
integer |
The track length in milliseconds. |
||||||||||||||||||||||
disc_number
|
integer |
The disc number (usually 1 unless the album consists of more than one disc). |
||||||||||||||||||||||
available_markets
|
array [string] |
A list of the countries in which the track can be played, identified by their ISO 3166-1 alpha-2 code. |
||||||||||||||||||||||
artists
|
array [artist-simple] |
The artists who performed the track. Each artist object includes a link in href to more detailed information about the artist. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
Properties
| Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
total
|
integer |
The total number of items available to return. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
previous
|
string |
URL to the previous page of items. (null if none) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset
|
integer |
The offset of the items returned (as set in the query or by default). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
next
|
string |
URL to the next page of items. (null if none) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
limit
|
integer |
The maximum number of items in the response (as set in the query or by default). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items
|
array [track-simple] |
The requested data. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
href
|
string |
A link to the Web API endpoint returning the full result of the request. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
| Name | Data Type | Description |
|---|---|---|
artists
|
Properties
| Name | Data Type | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
uri
|
string |
The Spotify URI for the user. |
||||||||||
type
|
string |
The object type: 'user' |
||||||||||
id
|
string |
The Spotify ID for this user. |
||||||||||
href
|
string |
A link to the Web API endpoint for this user. |
||||||||||
followers
|
followers | |||||||||||
Properties
|
||||||||||||
external_urls
|
object |
Known external URLs for this user. |
||||||||||
displayName
|
string |
The name displayed on the user's profile. |
||||||||||
Authentication
'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1
Spotify supports OAuth 2.0 for authenticating all API requests.
Flow:implicitAuthorization URL:
https://accounts.spotify.com/authorizeScopes:
user-read-emailuser-follow-readuser-library-readuser-read-privateuser-follow-modifyuser-library-modifyuser-read-birthdateplaylist-read-privateplaylist-modify-publicplaylist-modify-privateplaylist-read-collaborative
'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1
Spotify supports OAuth 2.0 for authenticating all API requests.
Flow:authorizationCodeAuthorization URL:
https://accounts.spotify.com/authorizeToken URL:
https://accounts.spotify.com/api/tokenScopes:
user-read-emailuser-follow-readuser-library-readuser-read-privateuser-follow-modifyuser-library-modifyuser-read-birthdateplaylist-read-privateplaylist-modify-publicplaylist-modify-privateplaylist-read-collaborative
Metadata (Technical Details)
| Origin - Format | raml |
| Origin - Url | https://raw.githubusercontent.com/spotify/web-api/master/specifications/raml/api.raml |
| Origin - Version | 0.8 |
| Provider Name | spotify.com |
| API Version | v1 |