Get User's Top Artists

TopListTopArtistsPage me().top().listTopArtists(, )

GET/me/top/artists

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

ParametersExpand Collapse

TopListTopArtistsParams params

Optional<Long> limit

The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

minimum1

maximum50

Optional<Long> offset

The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

Optional<String> timeRange

Over what time frame the affinities are computed. Valid values: long_term (calculated from ~1 year of data and including all new data as it becomes available), medium_term (approximately last 6 months), short_term (approximately last 4 weeks). Default: medium_term

ReturnsExpand Collapse

class ArtistObject:

Optional<String> id

The Spotify ID for the artist.

Optional<ExternalUrlObject> externalUrls

Known external URLs for this artist.

Optional<Boolean> published

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

Optional<String> spotify

The Spotify URL for the object.

Optional<FollowersObject> followers

Information about the followers of the artist.

Optional<String> href

This will always be set to null, as the Web API does not support it at the moment.

Optional<Boolean> published

Optional<Long> total

The total number of followers.

Optional<List<String>> genres

A list of the genres the artist is associated with. If not yet classified, the array is empty.

Optional<String> href

A link to the Web API endpoint providing full details of the artist.

Optional<List<ImageObject>> images

Images of the artist in various sizes, widest first.

Optional<Long> height

The image height in pixels.

String url

The source URL of the image.

Optional<Long> width

The image width in pixels.

Optional<Boolean> published

Optional<String> name

The name of the artist.

Optional<Long> popularity

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.

Optional<Boolean> published

Optional<Type> type

The object type.

Optional<String> uri

The Spotify URI for the artist.

Get User's Top Artists

package dev.cjav.spotted.example;

import dev.cjav.spotted.client.SpottedClient;
import dev.cjav.spotted.client.okhttp.SpottedOkHttpClient;
import dev.cjav.spotted.models.me.top.TopListTopArtistsPage;
import dev.cjav.spotted.models.me.top.TopListTopArtistsParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        SpottedClient client = SpottedOkHttpClient.fromEnv();

        TopListTopArtistsPage page = client.me().top().listTopArtists();
    }
}

{
  "href": "https://api.spotify.com/v1/me/shows?offset=0&limit=20\n",
  "limit": 20,
  "next": "https://api.spotify.com/v1/me/shows?offset=1&limit=1",
  "offset": 0,
  "previous": "https://api.spotify.com/v1/me/shows?offset=1&limit=1",
  "total": 4,
  "items": [
    {
      "id": "id",
      "external_urls": {
        "published": true,
        "spotify": "spotify"
      },
      "followers": {
        "href": "href",
        "published": true,
        "total": 0
      },
      "genres": [
        "Prog rock",
        "Grunge"
      ],
      "href": "href",
      "images": [
        {
          "height": 300,
          "url": "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228\n",
          "width": 300,
          "published": true
        }
      ],
      "name": "name",
      "popularity": 0,
      "published": true,
      "type": "artist",
      "uri": "uri"
    }
  ],
  "published": true
}

Returns Examples

{
  "href": "https://api.spotify.com/v1/me/shows?offset=0&limit=20\n",
  "limit": 20,
  "next": "https://api.spotify.com/v1/me/shows?offset=1&limit=1",
  "offset": 0,
  "previous": "https://api.spotify.com/v1/me/shows?offset=1&limit=1",
  "total": 4,
  "items": [
    {
      "id": "id",
      "external_urls": {
        "published": true,
        "spotify": "spotify"
      },
      "followers": {
        "href": "href",
        "published": true,
        "total": 0
      },
      "genres": [
        "Prog rock",
        "Grunge"
      ],
      "href": "href",
      "images": [
        {
          "height": 300,
          "url": "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228\n",
          "width": 300,
          "published": true
        }
      ],
      "name": "name",
      "popularity": 0,
      "published": true,
      "type": "artist",
      "uri": "uri"
    }
  ],
  "published": true
}