Get Album Tracks

albums().listTracks(, ) : AlbumListTracksPage

GET/albums/{id}/tracks

Get Spotify catalog information about an album’s tracks. Optional parameters can be used to limit the number of tracks returned.

ParametersExpand Collapse

params: AlbumListTracksParams

id: Optional<String>

The Spotify ID of the album.

limit: Optional<Long>

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

minimum1

maximum50

market: Optional<String>

An ISO 3166-1 alpha-2 country code. If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with the user account will take priority over this parameter.
Note: If neither market or user country are provided, the content is considered unavailable for the client.
Users can view the country that is associated with their account in the account settings.

offset: Optional<Long>

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

ReturnsExpand Collapse

class SimplifiedTrackObject:

id: Optional<String>

The Spotify ID for the track.

artists: Optional<List<SimplifiedArtistObject>>

The artists who performed the track. Each artist object includes a link in href to more detailed information about the artist.

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.

href: Optional<String>

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

name: Optional<String>

The name of the artist.

published: Optional<Boolean>

type: Optional<Type>

The object type.

uri: Optional<String>

The Spotify URI for the artist.

availableMarkets: Optional<List<String>>

A list of the countries in which the track can be played, identified by their ISO 3166-1 alpha-2 code.

discNumber: Optional<Long>

The disc number (usually 1 unless the album consists of more than one disc).

durationMs: Optional<Long>

The track length in milliseconds.

explicit: Optional<Boolean>

Whether or not the track has explicit lyrics ( true = yes it does; false = no it does not OR unknown).

externalUrls: Optional<ExternalUrlObject>

External URLs for this track.

published: Optional<Boolean>

spotify: Optional<String>

The Spotify URL for the object.

href: Optional<String>

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

isLocal: Optional<Boolean>

Whether or not the track is from a local file.

isPlayable: Optional<Boolean>

Part of the response when Track Relinking is applied. If true, the track is playable in the given market. Otherwise false.

linkedFrom: Optional<LinkedTrackObject>

Part of the response when Track Relinking is applied and is only part of the response if the track linking, in fact, exists. The requested track has been replaced with a different track. The track in the linked_from object contains information about the originally requested track.

id: Optional<String>

The Spotify ID for the track.

externalUrls: Optional<ExternalUrlObject>

Known external URLs for this track.

published: Optional<Boolean>

spotify: Optional<String>

The Spotify URL for the object.

href: Optional<String>

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

published: Optional<Boolean>

type: Optional<String>

The object type: "track".

uri: Optional<String>

The Spotify URI for the track.

name: Optional<String>

The name of the track.

DeprecatedpreviewUrl: Optional<String>

A URL to a 30 second preview (MP3 format) of the track.

published: Optional<Boolean>

restrictions: Optional<TrackRestrictionObject>

Included in the response when a content restriction is applied.

published: Optional<Boolean>

reason: Optional<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.

trackNumber: Optional<Long>

The number of the track. If an album has several discs, the track number is the number on the specified disc.

type: Optional<String>

The object type: "track".

uri: Optional<String>

The Spotify URI for the track.

Get Album Tracks

package dev.cjav.spotted.example

import dev.cjav.spotted.client.SpottedClient
import dev.cjav.spotted.client.okhttp.SpottedOkHttpClient
import dev.cjav.spotted.models.albums.AlbumListTracksPage
import dev.cjav.spotted.models.albums.AlbumListTracksParams

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

    val page: AlbumListTracksPage = client.albums().listTracks("4aawyAB9vmqN3uQ7FjRGTy")
}

{
  "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",
      "artists": [
        {
          "id": "id",
          "external_urls": {
            "published": true,
            "spotify": "spotify"
          },
          "href": "href",
          "name": "name",
          "published": true,
          "type": "artist",
          "uri": "uri"
        }
      ],
      "available_markets": [
        "string"
      ],
      "disc_number": 0,
      "duration_ms": 0,
      "explicit": true,
      "external_urls": {
        "published": true,
        "spotify": "spotify"
      },
      "href": "href",
      "is_local": true,
      "is_playable": true,
      "linked_from": {
        "id": "id",
        "external_urls": {
          "published": true,
          "spotify": "spotify"
        },
        "href": "href",
        "published": true,
        "type": "type",
        "uri": "uri"
      },
      "name": "name",
      "preview_url": "preview_url",
      "published": true,
      "restrictions": {
        "published": true,
        "reason": "reason"
      },
      "track_number": 0,
      "type": "type",
      "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",
      "artists": [
        {
          "id": "id",
          "external_urls": {
            "published": true,
            "spotify": "spotify"
          },
          "href": "href",
          "name": "name",
          "published": true,
          "type": "artist",
          "uri": "uri"
        }
      ],
      "available_markets": [
        "string"
      ],
      "disc_number": 0,
      "duration_ms": 0,
      "explicit": true,
      "external_urls": {
        "published": true,
        "spotify": "spotify"
      },
      "href": "href",
      "is_local": true,
      "is_playable": true,
      "linked_from": {
        "id": "id",
        "external_urls": {
          "published": true,
          "spotify": "spotify"
        },
        "href": "href",
        "published": true,
        "type": "type",
        "uri": "uri"
      },
      "name": "name",
      "preview_url": "preview_url",
      "published": true,
      "restrictions": {
        "published": true,
        "reason": "reason"
      },
      "track_number": 0,
      "type": "type",
      "uri": "uri"
    }
  ],
  "published": true
}