Web API •References / Users / Get User's Top Items

Get User's Top Items

Get the current user's top artists or tracks based on calculated affinity.

Authorization scopes

Request

type
string
Required
The type of entity to return. Valid values: artists or tracks
Allowed values: "artists", "tracks"
time_range
string
Over what time frame the affinities are computed. Valid values: long_term (calculated from several years of data and including all new data as it becomes available), medium_term (approximately last 6 months), short_term (approximately last 4 weeks). Default: medium_term
Default: time_range=medium_termExample: time_range=medium_term
limit
integer
The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
Default: limit=20Range: 0 - 50Example: limit=10
offset
integer
The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.
Default: offset=0Example: offset=5

Response

Pages of artists or tracks

href
string
Required
A link to the Web API endpoint returning the full result of the request
Example: "https://api.spotify.com/v1/me/shows?offset=0&limit=20"
limit
integer
Required
The maximum number of items in the response (as set in the query or by default).
Example: 20
next
string
Required
Nullable
URL to the next page of items. ( null if none)
Example: "https://api.spotify.com/v1/me/shows?offset=1&limit=1"
offset
integer
Required
The offset of the items returned (as set in the query or by default)
Example: 0
previous
string
Required
Nullable
URL to the previous page of items. ( null if none)
Example: "https://api.spotify.com/v1/me/shows?offset=1&limit=1"
total
integer
Required
The total number of items available to return.
Example: 4
items
array of oneOfs
Required
Will be one of the following:
- Known external URLs for this artist.
  spotify
  string
  The Spotify URL for the object.
  Information about the followers of the artist.
  href
  string
  Nullable
  This will always be set to null, as the Web API does not support it at the moment.
  total
  integer
  The total number of followers.
  genres
  array of strings
  A list of the genres the artist is associated with. If not yet classified, the array is empty.
  Example: ["Prog rock","Grunge"]
  href
  string
  A link to the Web API endpoint providing full details of the artist.
  id
  string
  The Spotify ID for the artist.
  Images of the artist in various sizes, widest first.
  url
  string
  Required
  The source URL of the image.
  Example: "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228"
  height
  integer
  Required
  Nullable
  The image height in pixels.
  Example: 300
  width
  integer
  Required
  Nullable
  The image width in pixels.
  Example: 300
  name
  string
  The name of the 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.
  type
  string
  The object type.
  Allowed values: "artist"
  uri
  string
  The Spotify URI for the artist.
- The album on which the track appears. The album object includes a link in href to full information about the album.
  album_type
  string
  Required
  The type of the album.
  Allowed values: "album", "single", "compilation"Example: "compilation"
  total_tracks
  integer
  Required
  The number of tracks in the album.
  Example: 9
  available_markets
  array of strings
  Required
  The markets in which the album is available: ISO 3166-1 alpha-2 country codes. NOTE: an album is considered available in a market when at least 1 of its tracks is available in that market.
  Example: ["CA","BR","IT"]
  Required
  Known external URLs for this album.
  spotify
  string
  The Spotify URL for the object.
  href
  string
  Required
  A link to the Web API endpoint providing full details of the album.
  id
  string
  Required
  The Spotify ID for the album.
  Example: "2up3OPMp9Tb4dAKM2erWXQ"
  Required
  The cover art for the album in various sizes, widest first.
  url
  string
  Required
  The source URL of the image.
  Example: "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228"
  height
  integer
  Required
  Nullable
  The image height in pixels.
  Example: 300
  width
  integer
  Required
  Nullable
  The image width in pixels.
  Example: 300
  name
  string
  Required
  The name of the album. In case of an album takedown, the value may be an empty string.
  release_date
  string
  Required
  The date the album was first released.
  Example: "1981-12"
  release_date_precision
  string
  Required
  The precision with which release_date value is known.
  Allowed values: "year", "month", "day"Example: "year"
  Included in the response when a content restriction is applied.
  reason
  string
  The reason for the restriction. Albums may be restricted if the content is not available in a given market, to the user's subscription type, or when the user's account is set to not play explicit content. Additional reasons may be added in the future.
  Allowed values: "market", "product", "explicit"
  type
  string
  Required
  The object type.
  Allowed values: "album"
  uri
  string
  Required
  The Spotify URI for the album.
  Example: "spotify:album:2up3OPMp9Tb4dAKM2erWXQ"
  Required
  The artists of the album. Each artist object includes a link in href to more detailed information about the artist.
  Known external URLs for this artist.
  spotify
  string
  The Spotify URL for the object.
  href
  string
  A link to the Web API endpoint providing full details of the artist.
  id
  string
  The Spotify ID for the artist.
  name
  string
  The name of the artist.
  type
  string
  The object type.
  Allowed values: "artist"
  uri
  string
  The Spotify URI for the artist.
  The artists who performed the track. Each artist object includes a link in href to more detailed information about the artist.
  Known external URLs for this artist.
  spotify
  string
  The Spotify URL for the object.
  Information about the followers of the artist.
  href
  string
  Nullable
  This will always be set to null, as the Web API does not support it at the moment.
  total
  integer
  The total number of followers.
  genres
  array of strings
  A list of the genres the artist is associated with. If not yet classified, the array is empty.
  Example: ["Prog rock","Grunge"]
  href
  string
  A link to the Web API endpoint providing full details of the artist.
  id
  string
  The Spotify ID for the artist.
  Images of the artist in various sizes, widest first.
  url
  string
  Required
  The source URL of the image.
  Example: "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228"
  height
  integer
  Required
  Nullable
  The image height in pixels.
  Example: 300
  width
  integer
  Required
  Nullable
  The image width in pixels.
  Example: 300
  name
  string
  The name of the 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.
  type
  string
  The object type.
  Allowed values: "artist"
  uri
  string
  The Spotify URI for the artist.
  available_markets
  array of strings
  A list of the countries in which the track can be played, identified by their ISO 3166-1 alpha-2 code.
  disc_number
  integer
  The disc number (usually 1 unless the album consists of more than one disc).
  duration_ms
  integer
  The track length in milliseconds.
  explicit
  boolean
  Whether or not the track has explicit lyrics ( true = yes it does; false = no it does not OR unknown).
  Known external IDs for the track.
  isrc
  string
  International Standard Recording Code
  ean
  string
  International Article Number
  upc
  string
  Universal Product Code
  Known external URLs for this track.
  spotify
  string
  The Spotify URL for the object.
  href
  string
  A link to the Web API endpoint providing full details of the track.
  id
  string
  The Spotify ID for the track.
  is_playable
  boolean
  Part of the response when Track Relinking is applied. If true, the track is playable in the given market. Otherwise false.
  Part of the response when 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.
  Included in the response when a content restriction is applied.
  reason
  string
  The reason for the restriction. Supported values:
  
  market - The content item is not available in the given market.
  
  product - The content item is not available for the user's subscription type.
  
  explicit - The content item is explicit and the user's account is set to not play explicit content.
  
  Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.
  name
  string
  The name of the track.
  popularity
  integer
  The popularity of the track. The value will be between 0 and 100, with 100 being the most popular.
  The popularity of a track is a value between 0 and 100, with 100 being the most popular. The popularity is calculated by algorithm and is based, in the most part, on the total number of plays the track has had and how recent those plays are.
  Generally speaking, songs that are being played a lot now will have a higher popularity than songs that were played a lot in the past. Duplicate tracks (e.g. the same track from a single and an album) are rated independently. Artist and album popularity is derived mathematically from track popularity. Note: the popularity value may lag actual popularity by a few days: the value is not updated in real time.
  preview_url
  string
  Nullable
  A link to a 30 second preview (MP3 format) of the track. Can be null
  Important policy note
  track_number
  integer
  The number of the track. If an album has several discs, the track number is the number on the specified disc.
  type
  string
  The object type: "track".
  Allowed values: "track"
  uri
  string
  The Spotify URI for the track.
  is_local
  boolean
  Whether or not the track is from a local file.