Skip to content
DocumentationAPI Reference

Get Followed Artists

me().following().bulkRetrieve(FollowingBulkRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : FollowingBulkRetrieveResponse
GET/me/following

Get the current user's followed artists.

ParametersExpand Collapse
params: FollowingBulkRetrieveParams
type: Type

The ID type: currently only artist is supported.

ARTIST("artist")
after: Optional<String>

The last artist ID retrieved from the previous request.

limit: Optional<Long>

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

minimum1
maximum50
ReturnsExpand Collapse
class FollowingBulkRetrieveResponse:
artists: Artists
cursors: Optional<Cursors>

The cursors used to find the next set of items.

after: Optional<String>

The cursor to use as key to find the next page of items.

before: Optional<String>

The cursor to use as key to find the previous page of items.

published: Optional<Boolean>

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

href: Optional<String>

A link to the Web API endpoint returning the full result of the request.

items: Optional<List<ArtistObject>>
id: Optional<String>

The Spotify ID for the artist.

externalUrls: Optional<ExternalUrlObject>

Known external URLs for this artist.

published: Optional<Boolean>

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

spotify: Optional<String>

The Spotify URL for the object.

followers: Optional<FollowersObject>

Information about the followers of the artist.

href: Optional<String>

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

published: Optional<Boolean>

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

total: Optional<Long>

The total number of followers.

genres: Optional<List<String>>

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

href: Optional<String>

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

images: Optional<List<ImageObject>>

Images of the artist in various sizes, widest first.

height: Optional<Long>

The image height in pixels.

url: String

The source URL of the image.

width: Optional<Long>

The image width in pixels.

published: Optional<Boolean>

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

name: Optional<String>

The name of the artist.

popularity: Optional<Long>

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.

published: Optional<Boolean>

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

type: Optional<Type>

The object type.

uri: Optional<String>

The Spotify URI for the artist.

limit: Optional<Long>

The maximum number of items in the response (as set in the query or by default).

URL to the next page of items. ( null if none)

published: Optional<Boolean>

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

total: Optional<Long>

The total number of items available to return.

Get Followed 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.following.FollowingBulkRetrieveParams
import dev.cjav.spotted.models.me.following.FollowingBulkRetrieveResponse

fun main() {
    val client: SpottedClient = SpottedOkHttpClient.fromEnv()

    val params: FollowingBulkRetrieveParams = FollowingBulkRetrieveParams.builder()
        .type(FollowingBulkRetrieveParams.Type.ARTIST)
        .build()
    val response: FollowingBulkRetrieveResponse = client.me().following().bulkRetrieve(params)
}
{
  "artists": {
    "cursors": {
      "after": "after",
      "before": "before",
      "published": true
    },
    "href": "href",
    "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"
      }
    ],
    "limit": 0,
    "next": "next",
    "published": true,
    "total": 0
  }
}
Returns Examples
{
  "artists": {
    "cursors": {
      "after": "after",
      "before": "before",
      "published": true
    },
    "href": "href",
    "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"
      }
    ],
    "limit": 0,
    "next": "next",
    "published": true,
    "total": 0
  }
}