Get Several Albums

AlbumBulkRetrieveResponse Albums.BulkRetrieve(, )

GET/albums

Get Spotify catalog information for multiple albums identified by their Spotify IDs.

ParametersExpand Collapse

AlbumBulkRetrieveParams parameters

required string ids

A comma-separated list of the Spotify IDs for the albums. Maximum: 20 IDs.

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 AlbumBulkRetrieveResponse:

required IReadOnlyList<Album> Albums

required string ID

The Spotify ID for the album.

required AlbumType AlbumType

The type of the album.

Accepts one of the following:

required IReadOnlyList<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.

required ExternalUrlObject ExternalUrls

Known external URLs for this album.

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

string Spotify

The Spotify URL for the object.

required string Href

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

required IReadOnlyList<ImageObject> Images

The cover art for the album in various sizes, widest first.

required Long? Height

The image height in pixels.

required string Url

The source URL of the image.

required Long? Width

The image width in pixels.

Boolean Published

required string Name

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

required string ReleaseDate

The date the album was first released.

required ReleaseDatePrecision ReleaseDatePrecision

The precision with which release_date value is known.

Accepts one of the following:

required Long TotalTracks

The number of tracks in the album.

JsonElement Type

The object type.

required string Uri

The Spotify URI for the album.

IReadOnlyList<SimplifiedArtistObject> Artists

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

string ID

The Spotify ID for the artist.

ExternalUrlObject ExternalUrls

Known external URLs for this artist.

Boolean Published

string Spotify

The Spotify URL for the object.

string Href

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

string Name

The name of the artist.

Boolean Published

Type Type

The object type.

string Uri

The Spotify URI for the artist.

IReadOnlyList<CopyrightObject> Copyrights

The copyright statements of the album.

Boolean Published

string Text

The copyright text for this content.

string Type

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

ExternalIDObject ExternalIds

Known external IDs for the album.

string Ean

International Article Number

string Isrc

International Standard Recording Code

Boolean Published

string Upc

Universal Product Code

DeprecatedIReadOnlyList<string> Genres

Deprecated The array is always empty.

string Label

The label associated with the album.

Long Popularity

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

Boolean Published

AlbumRestrictionObject Restrictions

Included in the response when a content restriction is applied.

Boolean Published

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:

Tracks Tracks

The tracks of the album.

required string Href

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

required Long Limit

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

required string? Next

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

required Long Offset

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

required string? Previous

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

required Long Total

The total number of items available to return.

IReadOnlyList<SimplifiedTrackObject> Items

string ID

The Spotify ID for the track.

IReadOnlyList<SimplifiedArtistObject> Artists

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

string ID

The Spotify ID for the artist.

ExternalUrlObject ExternalUrls

Known external URLs for this artist.

Boolean Published

string Spotify

The Spotify URL for the object.

string Href

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

string Name

The name of the artist.

Boolean Published

Type Type

The object type.

string Uri

The Spotify URI for the artist.

IReadOnlyList<string> AvailableMarkets

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

Long DiscNumber

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

Long DurationMs

The track length in milliseconds.

Boolean Explicit

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

ExternalUrlObject ExternalUrls

External URLs for this track.

Boolean Published

string Spotify

The Spotify URL for the object.

string Href

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

Boolean IsLocal

Whether or not the track is from a local file.

Boolean IsPlayable

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

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.

string ID

The Spotify ID for the track.

ExternalUrlObject ExternalUrls

Known external URLs for this track.

Boolean Published

string Spotify

The Spotify URL for the object.

string Href

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

Boolean Published

string Type

The object type: "track".

string Uri

The Spotify URI for the track.

string Name

The name of the track.

Deprecatedstring? PreviewUrl

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

Boolean Published

TrackRestrictionObject Restrictions

Included in the response when a content restriction is applied.

Boolean Published

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.

Long TrackNumber

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

string Type

The object type: "track".

string Uri

The Spotify URI for the track.

Boolean Published

Get Several Albums

AlbumBulkRetrieveParams parameters = new()
{
    Ids = "382ObEPsp2rxGrnsizN5TX,1A2GTWGtFfWp7KSQTwWOyo,2noRn2Aes5aoNVsU6iWThc"
};

var response = await client.Albums.BulkRetrieve(parameters);

Console.WriteLine(response);

{
  "albums": [
    {
      "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

{
  "albums": [
    {
      "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
      }
    }
  ]
}