Get Album

AlbumRetrieveResponse albums().retrieve(, )

GET/albums/{id}

Get Spotify catalog information for a single album.

ParametersExpand Collapse

AlbumRetrieveParams params

Optional<String> id

The Spotify ID of the album.

Optional<String> market

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.

ReturnsExpand Collapse

class AlbumRetrieveResponse:

String id

The Spotify ID for the album.

AlbumType albumType

The type of the album.

Accepts one of the following:

ALBUM("album")

SINGLE("single")

COMPILATION("compilation")

List<String> availableMarkets

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.

ExternalUrlObject externalUrls

Known external URLs for this album.

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.

String href

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

List<ImageObject> images

The cover art for the album 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

String name

The name of the album. In case of an album takedown, the value may be an empty string.

String releaseDate

The date the album was first released.

ReleaseDatePrecision releaseDatePrecision

The precision with which release_date value is known.

Accepts one of the following:

YEAR("year")

MONTH("month")

DAY("day")

long totalTracks

The number of tracks in the album.

JsonValue; type

The object type.

String uri

The Spotify URI for the album.

Optional<List<SimplifiedArtistObject>> artists

The artists of the album. Each artist object includes a link in href to more detailed information about the artist.

Optional<String> id

The Spotify ID for the artist.

Optional<ExternalUrlObject> externalUrls

Known external URLs for this artist.

Optional<Boolean> published

Optional<String> spotify

The Spotify URL for the object.

Optional<String> href

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

Optional<String> name

The name of the artist.

Optional<Boolean> published

Optional<Type> type

The object type.

Optional<String> uri

The Spotify URI for the artist.

Optional<List<CopyrightObject>> copyrights

The copyright statements of the album.

Optional<Boolean> published

Optional<String> text

The copyright text for this content.

Optional<String> type

The type of copyright: C = the copyright, P = the sound recording (performance) copyright.

Optional<ExternalIdObject> externalIds

Known external IDs for the album.

Optional<String> ean

International Article Number

Optional<String> isrc

International Standard Recording Code

Optional<Boolean> published

Optional<String> upc

Universal Product Code

DeprecatedOptional<List<String>> genres

Deprecated The array is always empty.

Optional<String> label

The label associated with the album.

Optional<Long> popularity

The popularity of the album. The value will be between 0 and 100, with 100 being the most popular.

Optional<Boolean> published

Optional<AlbumRestrictionObject> restrictions

Included in the response when a content restriction is applied.

Optional<Boolean> published

Optional<Reason> reason

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.

Accepts one of the following:

MARKET("market")

PRODUCT("product")

EXPLICIT("explicit")

Optional<Tracks> tracks

The tracks of the album.

String href

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

long limit

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

Optional<String> next

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

long offset

The offset of the items returned (as set in the query or by default)

Optional<String> previous

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

long total

The total number of items available to return.

Optional<List<SimplifiedTrackObject>> items

Optional<String> id

The Spotify ID for the track.

Optional<List<SimplifiedArtistObject>> artists

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

Optional<String> id

The Spotify ID for the artist.

Optional<ExternalUrlObject> externalUrls

Known external URLs for this artist.

Optional<Boolean> published

Optional<String> spotify

The Spotify URL for the object.

Optional<String> href

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

Optional<String> name

The name of the artist.

Optional<Boolean> published

Optional<Type> type

The object type.

Optional<String> uri

The Spotify URI for the artist.

Optional<List<String>> availableMarkets

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

Optional<Long> discNumber

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

Optional<Long> durationMs

The track length in milliseconds.

Optional<Boolean> explicit

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

Optional<ExternalUrlObject> externalUrls

External URLs for this track.

Optional<Boolean> published

Optional<String> spotify

The Spotify URL for the object.

Optional<String> href

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

Optional<Boolean> isLocal

Whether or not the track is from a local file.

Optional<Boolean> isPlayable

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

Optional<LinkedTrackObject> linkedFrom

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.

Optional<String> id

The Spotify ID for the track.

Optional<ExternalUrlObject> externalUrls

Known external URLs for this track.

Optional<Boolean> published

Optional<String> spotify

The Spotify URL for the object.

Optional<String> href

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

Optional<Boolean> published

Optional<String> type

The object type: "track".

Optional<String> uri

The Spotify URI for the track.

Optional<String> name

The name of the track.

DeprecatedOptional<String> previewUrl

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

Optional<Boolean> published

Optional<TrackRestrictionObject> restrictions

Included in the response when a content restriction is applied.

Optional<Boolean> published

Optional<String> reason

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.

Optional<Long> trackNumber

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

Optional<String> type

The object type: "track".

Optional<String> uri

The Spotify URI for the track.

Optional<Boolean> published

Get Album

package dev.cjav.spotted.example;

import dev.cjav.spotted.client.SpottedClient;
import dev.cjav.spotted.client.okhttp.SpottedOkHttpClient;
import dev.cjav.spotted.models.albums.AlbumRetrieveParams;
import dev.cjav.spotted.models.albums.AlbumRetrieveResponse;

public final class Main {
    private Main() {}

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

        AlbumRetrieveResponse album = client.albums().retrieve("4aawyAB9vmqN3uQ7FjRGTy");
    }
}

{
  "id": "2up3OPMp9Tb4dAKM2erWXQ",
  "album_type": "compilation",
  "available_markets": [
    "CA",
    "BR",
    "IT"
  ],
  "external_urls": {
    "published": true,
    "spotify": "spotify"
  },
  "href": "href",
  "images": [
    {
      "height": 300,
      "url": "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228\n",
      "width": 300,
      "published": true
    }
  ],
  "name": "name",
  "release_date": "1981-12",
  "release_date_precision": "year",
  "total_tracks": 9,
  "type": "album",
  "uri": "spotify:album:2up3OPMp9Tb4dAKM2erWXQ",
  "artists": [
    {
      "id": "id",
      "external_urls": {
        "published": true,
        "spotify": "spotify"
      },
      "href": "href",
      "name": "name",
      "published": true,
      "type": "artist",
      "uri": "uri"
    }
  ],
  "copyrights": [
    {
      "published": true,
      "text": "text",
      "type": "type"
    }
  ],
  "external_ids": {
    "ean": "ean",
    "isrc": "isrc",
    "published": true,
    "upc": "upc"
  },
  "genres": [
    "string"
  ],
  "label": "label",
  "popularity": 0,
  "published": true,
  "restrictions": {
    "published": true,
    "reason": "market"
  },
  "tracks": {
    "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

{
  "id": "2up3OPMp9Tb4dAKM2erWXQ",
  "album_type": "compilation",
  "available_markets": [
    "CA",
    "BR",
    "IT"
  ],
  "external_urls": {
    "published": true,
    "spotify": "spotify"
  },
  "href": "href",
  "images": [
    {
      "height": 300,
      "url": "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228\n",
      "width": 300,
      "published": true
    }
  ],
  "name": "name",
  "release_date": "1981-12",
  "release_date_precision": "year",
  "total_tracks": 9,
  "type": "album",
  "uri": "spotify:album:2up3OPMp9Tb4dAKM2erWXQ",
  "artists": [
    {
      "id": "id",
      "external_urls": {
        "published": true,
        "spotify": "spotify"
      },
      "href": "href",
      "name": "name",
      "published": true,
      "type": "artist",
      "uri": "uri"
    }
  ],
  "copyrights": [
    {
      "published": true,
      "text": "text",
      "type": "type"
    }
  ],
  "external_ids": {
    "ean": "ean",
    "isrc": "isrc",
    "published": true,
    "upc": "upc"
  },
  "genres": [
    "string"
  ],
  "label": "label",
  "popularity": 0,
  "published": true,
  "restrictions": {
    "published": true,
    "reason": "market"
  },
  "tracks": {
    "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
  }
}